This sample application demonstrates how to extract models properties of Autodesk360/BIM360/Autodesk Construction Cloud (ACC) and generate a project dashboard. Also shows a nested view with 2d views of the model (if available).
This sample is based on the APS tutorials in the section Hubs Browser and Dashboard. The original implementation was based on Jim Awe - LMVNavTest (Deprecated).
https://visual-reports.autodesk.io
- BIM 360 or ACC Account: must be Account Admin to add the app integration. Learn about provisioning.
- APS Account: Learn how to create a APS Account, activate subscription and create an app at this tutorial.
- Visual Code or any other text-based tool.
- JavaScript basic knowledge with jQuery.
- NodeJS.
Install NodeJS.
Clone this project or download it. It's recommended to install GitHub desktop. To clone it via command line, use the following (Terminal on MacOSX/Linux, Git Shell on Windows):
git clone https://github.com/autodesk-platform-services/aps-bim360-acc-reports.git
To run it, install the required packages, set the enviroment variables with your client ID & secret and finally start it. Via command line, navigate to the folder where this repository was cloned and use the following:
Mac OSX/Linux (Terminal)
npm install
export APS_CLIENT_ID=<<YOUR CLIENT ID FROM APS DEVELOPER PORTAL>>
export APS_CLIENT_SECRET=<<YOUR APS CLIENT SECRET>>
export APS_CALLBACK_URL=<<YOUR CALLBACK URL FROM APS DEVELOPER PORTAL>>
export SERVER_SESSION_SECRET=<<secret-phrase>> # phrase used to encrypt/decrypt server session cookies
npm run dev
Windows (use Node.js command line from Start menu)
npm install
set APS_CLIENT_ID=<<YOUR CLIENT ID FROM APS DEVELOPER PORTAL>>
set APS_CLIENT_SECRET=<<YOUR APS CLIENT SECRET>>
set APS_CALLBACK_URL=<<YOUR CALLBACK URL FROM APS DEVELOPER PORTAL>>
set SERVER_SESSION_SECRET=<<secret-phrase>> # phrase used to encrypt/decrypt server session cookies
npm run dev
Open the browser: http://localhost:3000.
Important: do not use npm start locally, this is intended for PRODUCTION only with HTTPS (SSL) secure cookies.
All APS NPM packages are included by default, see complete list of what's available at NPM website. OAuth, Model Derivative and OSS are used. Some other non-Autodesk packaged are used, including express and its session/cookie middlewares (express-session and cookie-parser) for user session handling. The front-end uses bootsrap and jquery.
For local development/testing, consider use nodemon package, which auto restart your node application after any modification on your code. To install it, use:
sudo npm install -g nodemon
Then, instead of npm run dev, use the following:
npm run nodemon
Which executes nodemon ./start.js. The flag option --ignore www/ indicates that the app should not restart if files under specific folder (such as www) are modified.
Documentation:
Tutorials:
Blogs:
- APS Blog
- Field of View, a BIM focused blog
- Autodesk Construction Cloud Unified Products: Does it Affect My Application?
- Autodesk Build and Other Autodesk Construction Cloud Unified Products Launch
-
Cannot see my BIM 360 or ACC projects: Make sure to provision the APS App Client ID within the BIM 360 or ACC Account, learn more here. This requires the Account Admin permission.
-
Cannot load Autodesk360 model: In Autodesk360, the model is not translated by default until the end user loads the model one time in Autodesk360, or the developer posts job to translate.
-
error setting certificate verify locations error: may happen on Windows, use the following:
git config --global http.sslverify "false"
This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.
Jaime Rosales D.
APS Partner Development
APS Developer Portal