https://github.com/autodesk-platform-services/aps-bim360-acc-reports
Visuals reports of models for BIM360 and ACC.
https://github.com/autodesk-platform-services/aps-bim360-acc-reports
acc bim360 sample
Last synced: 7 months ago
JSON representation
Visuals reports of models for BIM360 and ACC.
- Host: GitHub
- URL: https://github.com/autodesk-platform-services/aps-bim360-acc-reports
- Owner: autodesk-platform-services
- License: mit
- Created: 2023-01-09T21:54:10.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-30T14:52:56.000Z (over 1 year ago)
- Last Synced: 2025-02-06T16:57:37.647Z (9 months ago)
- Topics: acc, bim360, sample
- Language: JavaScript
- Homepage: https://visual-reports.autodesk.io
- Size: 5.93 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Visual Reports of Models
[](http://opensource.org/licenses/MIT)
[](https://aps.autodesk.com/en/docs/oauth/v2/developers_guide/overview/)
[](https://aps.autodesk.com/api/data-management-cover-page/)
[](https://aps.autodesk.com/api/model-derivative-cover-page/)
[](https://aps.autodesk.com/api/viewer-cover-page/)
## Thumbnail
# Description
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](https://tutorials.autodesk.io/tutorials/hubs-browser/) in the section *Hubs Browser* and *Dashboard*. The original implementation was based on [Jim Awe - LMVNavTest](https://github.com/JimAwe/LmvNavTest) (Deprecated).
## Live version
[https://visual-reports.autodesk.io](https://visual-reports.autodesk.io/)
# Setup
## Prerequisites
1. **BIM 360 or ACC Account**: must be Account Admin to add the app integration. [Learn about provisioning](https://tutorials.autodesk.io/#provision-access-in-other-products).
2. **APS Account**: Learn how to create a APS Account, activate subscription and create an app at [this tutorial](https://tutorials.autodesk.io/#create-an-account).
3. **Visual Code** or any other text-based tool.
4. **JavaScript** basic knowledge with **jQuery**.
5. [NodeJS](https://nodejs.org).
### Run locally
Install [NodeJS](https://nodejs.org).
Clone this project or download it. It's recommended to install [GitHub desktop](https://desktop.github.com/). 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=<>
export APS_CLIENT_SECRET=<>
export APS_CALLBACK_URL=<>
export SERVER_SESSION_SECRET=<> # 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=<>
set APS_CLIENT_SECRET=<>
set APS_CALLBACK_URL=<>
set SERVER_SESSION_SECRET=<> # phrase used to encrypt/decrypt server session cookies
npm run dev
Open the browser: [http://localhost:3000](http://localhost:3000).
**Important:** do not use **npm start** locally, this is intended for PRODUCTION only with HTTPS (SSL) secure cookies.
## Packages used
All APS NPM packages are included by default, see complete list of what's available at [NPM website](https://www.npmjs.com/~aps.sdk). OAuth, Model Derivative and OSS are used. Some other non-Autodesk packaged are used, including [express](https://www.npmjs.com/package/express) and its session/cookie middlewares ([express-session](https://www.npmjs.com/package/express-session) and [cookie-parser](https://www.npmjs.com/package/cookie-parser)) for user session handling. The front-end uses [bootsrap](https://www.npmjs.com/package/bootstrap) and [jquery](https://www.npmjs.com/package/jquery).
## Tips & tricks
For local development/testing, consider use [nodemon](https://www.npmjs.com/package/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.
## Further Reading
Documentation:
- [BIM 360 or ACC API Provisioning](https://tutorials.autodesk.io/#provision-access-in-other-products)
- [Data Management API](https://developer.autodesk.com/en/docs/data/v2/overview/)
- [Viewer](https://developer.autodesk.com/en/docs/viewer/v7)
Tutorials:
- [View BIM 360 or ACC Models](https://tutorials.autodesk.io/tutorials/hubs-browser/)
Blogs:
- [APS Blog](https://aps.autodesk.com/categories/bim-360-api)
- [Field of View](https://fieldofviewblog.wordpress.com/), a BIM focused blog
- [Autodesk Construction Cloud Unified Products: Does it Affect My Application?](https://aps.autodesk.com/blog/autodesk-construction-cloud-unified-products-does-it-affect-my-application)
- [Autodesk Build and Other Autodesk Construction Cloud Unified Products Launch](https://aps.autodesk.com/blog/autodesk-build-and-other-autodesk-construction-cloud-unified-products-launch)
## Troubleshooting
1. **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](https://tutorials.autodesk.io/#provision-access-in-other-products). This requires the Account Admin permission.
2. **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.
3. **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](http://opensource.org/licenses/MIT).
Please see the [LICENSE](LICENSE) file for full details.
## Written by
Jaime Rosales D.
[](https://twitter.com/AfroJme)
APS Partner Development
APS Developer Portal