ucc-ce-itinaec/bim360appstore-viewer-nodejs-visual.reports

BIM360 project dashboard example: Demonstrates how to extract properties from BIM360 elements and generate a project dashboard

bim360appstore-viewer-nodejs-visual.reports

This sample application demonstrates how to extract properties from elements and generate a project dashboard

Project based on Jim Awe - LMVNavTest (Depracated) https://github.com/JimAwe/LmvNavTest

Thumbnail

Live version

https://bim360reports.autodesk.io

Setup

Prerequisites

1. BIM 360 Account: must be Account Admin to add the app integration. Learn about provisioning.
2. Forge Account: Learn how to create a Forge Account, activate subscription and create an app at this tutorial.
3. Visual Studio: Either Community (Windows) or Code (Windows, MacOS).
4. JavaScript basic knowledge with jQuery

Run locally

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-forge/bim360appstore-viewer-nodejs-visual.reports

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 FORGE_CLIENT_ID=<<YOUR CLIENT ID FROM FORGE DEVELOPER PORTAL>>
export FORGE_CLIENT_SECRET=<<YOUR FORGE CLIENT SECRET>>
export FORGE_CALLBACK_URL=<<YOUR CALLBACK URL FROM FORGE DEVELOPER PORTAL>>
npm run dev

Windows (use Node.js command line from Start menu)

npm install
set FORGE_CLIENT_ID=<<YOUR CLIENT ID FROM FORGE DEVELOPER PORTAL>>
set FORGE_CLIENT_SECRET=<<YOUR FORGE CLIENT SECRET>>
set FORGE_CALLBACK_URL=<<YOUR CALLBACK URL FROM FORGE DEVELOPER PORTAL>>
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.

Deployment

To deploy this application to Heroku, the Callback URL for Forge must use your .herokuapp.com address. After clicking on the button below, at the Heroku Create New App page, set your Client ID, Secret and Callback URL for Forge.

Watch this video on how deploy samples to Heroku.

Packages used

All Autodesk Forge 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.

Tips & tricks

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 server.js --ignore www/, where the --ignore parameter indicates that the app should not restart if files under www folder are modified.

Further Reading

Documentation:

• BIM 360 API and App Provisioning
• Data Management API
• Viewer

Tutorials:

• View BIM 360 Models
• Retrieve Issues

Blogs:

• Forge Blog
• Field of View, a BIM focused blog

Troubleshooting

1. Cannot see my BIM 360 projects: Make sure to provision the Forge App Client ID within the BIM 360 Account, learn more here. This requires the Account Admin permission.

2. error setting certificate verify locations error: may happen on Windows, use the following: git config --global http.sslverify "false"

License

This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.

Written by

Jaime Rosales D.

Forge Partner Development
Forge Developer Portal