Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/autodesk-platform-services/aps-model.properties-versions.difference
Model Properties version diff:This sample demonstrates the use case of comparing two versions of a model by Model Properties API. The result is visualized as added, removed and updated items from the previous version. Change can be geometry as well as among properties.
https://github.com/autodesk-platform-services/aps-model.properties-versions.difference
autodesk-bim360 autodesk-construction-cloud autodesk-model-properties javascript nodejs sample viewer-sdk
Last synced: 27 days ago
JSON representation
Model Properties version diff:This sample demonstrates the use case of comparing two versions of a model by Model Properties API. The result is visualized as added, removed and updated items from the previous version. Change can be geometry as well as among properties.
- Host: GitHub
- URL: https://github.com/autodesk-platform-services/aps-model.properties-versions.difference
- Owner: autodesk-platform-services
- License: mit
- Created: 2022-11-29T14:35:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T13:40:36.000Z (10 months ago)
- Last Synced: 2024-04-16T14:11:44.603Z (9 months ago)
- Topics: autodesk-bim360, autodesk-construction-cloud, autodesk-model-properties, javascript, nodejs, sample, viewer-sdk
- Language: JavaScript
- Homepage:
- Size: 4.29 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BIM 360/ACC Model Properties API: Compare Versions - Nodejs
[](https://nodejs.org/)
[](https://www.npmjs.com/)
[]()
[](https://APS.autodesk.com/en/docs/oauth/v2/reference/http/)
[](https://APS.autodesk.com/api/data-management-cover-page/)
[]( https://APS.autodesk.com/en/docs/acc/v1/overview/field-guide/model-properties/)
[](http://opensource.org/licenses/MIT)
[](http://developer.autodesk.com/)
# Description
This sample demonstrates the use case of comparing two versions of a model by **Model Properties API**. The result is visualized as added, removed and updated items from the previous version. Change can be geometry as well as among properties.
# Thumbnail
# Demonstration
[](https://youtu.be/z0aL5xMbQP0 "APS Model Differences by Index API of BIM360")
# Setup
## Prerequisites
1. **APS Account**: Learn how to create a APS Account, activate subscription and create an app at [this tutorial](https://aps.autodesk.com/tutorials/#/account/). For this new app, use **http://localhost:3000/api/aps/callback/oauth** as Callback URL. Finally take note of the **Client ID**, **Client Secret** and Callback URL.
2. **BIM 360 or ACC Account**: must be Account Admin to add the app integration. [Learn about provisioning](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps).
3. Upload two model versions to one folder in BIM360 or ACC.
4. **Node.js**: basic knowledge with [**Node.js**](https://nodejs.org/en/).
5. Basic knowledge with **html5**,**JavaScript**, **css**,**jQuery**, **bootstrap**.
6. Basic knowledge with **Data Management API with BIM 360 or ACC**,and **Viewer SDK**.
7. **ngrok**: Routing tool, [download here](https://ngrok.com/)
## Running locally
Install [NodeJS](https://nodejs.org), version 8 or newer.
Clone this project or download it (this `nodejs` branch only). 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-model.properties-versions.difference
Install the required packages using `npm install`. Set the environment variables with your client ID, client secret, callback url 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=<>
npm start
Windows (use **Node.js command line** from Start menu)
npm install
set APS_CLIENT_ID=<>
set APS_CLIENT_SECRET=<>
set APS_CALLBACK_URL=<>
npm start
OR, set environment variables at [launch.json](/.vscode/launch.json) for debugging.
## Use Cases
1. Open the browser: [http://localhost:3000](http://localhost:3000). Please watch the [Video](https://youtu.be/sJmeiK3xYTU) for the detail and usage.
2. After the user logging succeeds, the code will start to extract all hubs, all projects, folders and model versions.
3. Click one model version, the corresponding model data will be loaded in left Viewer SDK. Click another model version, the corresponding model data will be loaded in right Viewer SDK.
4. Click the **Diff** button, the code will start to request diff indexing by Model Properties API on the server side.
5. After the diff-indexing is completed, all added items (in new model version) will be listed in the {Added Items} table. All removed items (in old model version) will be listed in the {Removed Items} table. All changed items (in the two model versions) will be listed in the {Changed Items} table.
6. Click the switches __All Added__, ___All Removed__, __All Changed__ to check the differences in two views.
7. Click one item in {Added Items} table. The new item will be focused in the right view. The corresponding location in left view will be also zoomed in (but no element because this item does not exist in old version)
8. Similarly, click one item in {Removed Items} table. The old item will be focused in left view. The corresponding location in right view will be also zoomed in (but no element because this item has been removed in new version).
9. Click one item in {Changed Items} table. The item will be focused in both views. The table will also tell if geometry is changed, if properties are changed, and the changed properties list. Open the **properties panel** in both Viewers and check the changed values.
## Deployment
To deploy this application to Heroku, the **Callback URL** for APS 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 APS.
[](https://heroku.com/deploy?autodesk-platform-services/aps-model.properties-versions.difference)
### 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 server.js --ignore www/**, where the **--ignore** parameter indicates that the app should not restart if files under **www** folder are modified.
### Troubleshooting
After installing Github desktop for Windows, on the Git Shell, if you see a ***error setting certificate verify locations*** error, use the following:
git config --global http.sslverify "false"
# Further Reading
- [Data Management API](https://developer.autodesk.com/en/docs/data/v2/overview/)
- [Viewer](https://developer.autodesk.com/en/docs/viewer/v6)
- [Model Properties API Reference](https://forge.autodesk.com/en/docs/acc/v1/reference/http/index-v2-index-jobs-batch-status-post/)
- [Model Properties API Walkthrough in PowerShell Core](https://github.com/Autodesk-Forge/forge-model-properties.powershell)
- [Postman Collection for Model Properties](https://github.com/Autodesk-Forge/forge-model.properties-postman.collection)
- [Querying Model Properties](https://forge.autodesk.com/en/docs/acc/v1/tutorials/model-properties/query)
- [Tracking Changes in Model Versions](https://forge.autodesk.com/en/docs/acc/v1/tutorials/model-properties/diff)
- [Query Language Reference](https://forge.autodesk.com/en/docs/acc/v1/tutorials/model-properties/query-ref)
### Blogs
- [APS Blog](https://forge.autodesk.com/categories/bim-360-api)
- [Field of View](https://fieldofviewblog.wordpress.com/), a BIM focused blog
## 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
Xiaodong Liang [@coldwood](https://twitter.com/coldwood), Developer Advocacy and Support, Autodesk