Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/autodesk-platform-services/aps-acc-takeoff-cost
ACC Takeoff to Cost Sample: A sample demonstrates displaying package information from Autodesk Takeoff product, and calculate the budget based on the quantity of takeoff items and price which is stored in database.
https://github.com/autodesk-platform-services/aps-acc-takeoff-cost
autodesk-construction-cloud bim360api cost-management nodejs sample takeoff
Last synced: 9 days ago
JSON representation
ACC Takeoff to Cost Sample: A sample demonstrates displaying package information from Autodesk Takeoff product, and calculate the budget based on the quantity of takeoff items and price which is stored in database.
- Host: GitHub
- URL: https://github.com/autodesk-platform-services/aps-acc-takeoff-cost
- Owner: autodesk-platform-services
- License: mit
- Created: 2022-12-13T04:42:03.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-30T15:56:50.000Z (about 1 year ago)
- Last Synced: 2024-04-16T14:11:34.730Z (8 months ago)
- Topics: autodesk-construction-cloud, bim360api, cost-management, nodejs, sample, takeoff
- Language: JavaScript
- Homepage:
- Size: 2.32 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ACC Takeoff to Cost Sample
[](https://nodejs.org/)
[](https://www.npmjs.com/)
[](http://developer.autodesk.com/)
[](http://developer.autodesk.com/)
[](http://developer.autodesk.com/)
[](http://developer.autodesk.com/)
[](http://developer.autodesk.com/)
[](http://opensource.org/licenses/MIT)
[](http://developer.autodesk.com/)
## Description
This sample demonstrates displaying package information from Autodesk Takeoff product, and calculate the budget based on the quantity of takeoff items and price which is stored in database.
The sample also provides the ability to import the generated budgets directly into Cost Management.
## Thumbnail
## Demonstration
[](http://www.youtube.com/watch?v=dkAdC8BMQRw "Export Autodesk Takeoff packages to Cost as budgets")
# Web App Setup
## Prerequisites
1. **APS Account**: Learn how to create a APS Account, activate subscription and create an app at [this tutorial](https://tutorials.autodesk.io/).
2. **ACC Account**: must be Account Admin to add the app integration. [Learn about provisioning](https://aps.autodesk.com/blog/bim-360-docs-provisioning-forge-apps).
3. **Autodesk Takeoff**: Create ACC project, activate Takeoff, get started with Autodesk Takeoff according to [the guide](https://help.autodesk.com/view/TAKEOFF/ENU/?guid=Getting_Started_Takeoff)
4. **Cost Management**: Create ACC project, activate Cost Management, setup project to create **Budget Code Template** for Cost Management according to [the guide](https://help.autodesk.com/view/BUILD/ENU/?guid=Cost_Income_Settings)
4. **Node.js**: basic knowledge with [**Node.js**](https://nodejs.org/en/).
5. **JavaScript** basic knowledge with **jQuery**
6. **MongoDB**: noSQL database, learn more. Or use a online version via Mongo Altas (this is used on this sample)
For using this sample, you need an Autodesk developer credentials. Visit the [APS Developer Portal](https://developer.autodesk.com), sign up for an account, then [create an app](https://developer.autodesk.com/myapps/create). For this new app, use **http://localhost:3000/api/aps/callback/oauth** as Callback URL. Finally take note of the **Client ID** and **Client Secret**.
## Running locally
Install [NodeJS](https://nodejs.org), version 14 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-acc-takeoff-cost
Install the required packages using `npm install`.
**MongoDB**
[MongoDB](https://www.mongodb.com) is a no-SQL database based on "documents", which stores JSON-like data. For testing purpouses, you can either use local or live. For cloud environment, try [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) (offers a free tier). With MongoDB Atlas you can set up an account for free and create clustered instances, intructions:
1. Create an account on MongoDB Atlas.
2. Create a free version of cluster, use the default setting, but name it as `apssample` for example.
3. Whitelist the IP address to access the database, [see this tutorial](https://docs.atlas.mongodb.com/security-whitelist/). If the sample is running on Heroku, you'll need to open to all (IP `0.0.0.0/0`).
4. Create a new user to access the database, please keep the **user name** and **password** to be used in the following connection.
5. At this point, you can click **Connect** button to check your **connection string** to the MongoDB cluster, the connection string should be in the form like
`mongodb+srv://:@-.mongodb.net`. Set environment variable `OAUTH_DATABASE` with your url in the following step. [Learn more here](https://docs.mongodb.com/manual/reference/connection-string/)
6. Create a database named **PriceBook**, a collection named **DinningRoom**, then according to your takeoff types, add a couple of price item in the format of:
{
"Type": "Door",
"Price": 836,
"Unit": "nr"
}
There are several tools to view your database, [Robo 3T](https://robomongo.org/) (formerly Robomongo) is a free lightweight GUI that can be used. When it opens, follow instructions [here](https://www.datduh.com/blog/2017/7/26/how-to-connect-to-mongodb-atlas-using-robo-3t-robomongo) to connect to MongoDB Atlas.
**Environment variables**
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 OAUTH_DATABASE="mongodb+srv://:@-.mongodb.net>>"
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=<>
set OAUTH_DATABASE="mongodb+srv://:@-.mongodb.net>>"
npm start
Windows (use **PowerShell**)
npm install
$env:APS_CLIENT_ID="YOUR CLIENT ID FROM DEVELOPER PORTAL"
$env:APS_CLIENT_SECRET="YOUR CLIENT SECRET"
$env:APS_CALLBACK_URL="YOUR CALLBACK URL"
$env:OAUTH_DATABASE="mongodb+srv://:@-.mongodb.net>>"
npm start
## Using the app
Open the browser: [http://localhost:3000](http://localhost:3000).
**Please follow the steps to setup the app:**
1. Make sure to [Create ACC project, activate Takeoff and Cost Management, setup project for Cost Management](https://help.autodesk.com/view/DOCS/ENU/?guid=Create_Project), a **Budget Code Template** must be created before adding or importing budget items.
2. Work with Autodesk Takeoff, upload 3D models or 2D Sheets, create a couple of packages, takeoff types and takeoff items.
**Operate with App after setup, please watch the [Video](https://youtu.be/dkAdC8BMQRw) for the detail usage**
1. Select takeoff package under ACC project, it will generate the quantity info for each takeoff item, and calculate the budget based on the quantity and price which is stored in database as Price Book, then display you the result in table.
2. Click `Send to Cost`, it will import the generated budgets directly into Cost Management.
## 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?template=https://github.com/Autodesk-Platform-Services/aps-acc-takeoff-cost)
## Limitation
- Only 3D model connected to takeoff item is supported to be viewed in APS Viewer at this moment. The 2D Sheet which connected to takeoff item is not supported in this app, this is due to our known API limitation, the viewable information of 2D Sheet is not exposed from current API, this request is already passed to engineering team, let us know if this is an important requirement for your user case.
## Tips & Tricks
- **Cannot see my ACC projects**: Make sure to provision the APS App Client ID within the ACC Account to get access to document, ACC indeed uses BIM 360 Admin Settings, this requires the Account Admin permission.[learn more here](https://aps.autodesk.com/blog/bim-360-docs-provisioning-forge-apps).
- Only ACC projects are listed, BIM 360 projects are not supported.
- Before using the app, user needs to activate and setup takeoff service, upload 3D models or 2D Sheets, create a couple of packages, takeoff types and takeoff items.
- The sample requires a price database which is built based on MongoDB, you can create and configurate it according to the steps above, or you can use the default database for a try.
- User needs to activate **Cost Management**, and create **Budget Code Template** in cost project setting manually. Please check [Budget Settings](https://help.autodesk.com/view/BUILD/ENU/?guid=Cost_Income_Settings) for details.
- **Budget Code** is required to create a budget, currently, a random budget code with specified digits length will be automatically generated for each budget.
## Further Reading
**Document**:
- [Data Management API](https://developer.autodesk.com/en/docs/data/v2/overview/)
- [BIM 360 API](https://aps.autodesk.com/en/docs/bim360/v1/overview/) and [App Provisioning](https://aps.autodesk.com/blog/bim-360-docs-provisioning-forge-apps)
- [ACC API](https://aps.autodesk.com/en/docs/acc/v1/overview/)
- [How to use ACC Takeoff](https://help.autodesk.com/view/TAKEOFF/ENU/?guid=Getting_Started_Takeoff)
- [How to use ACC Cost Management](https://help.autodesk.com/view/BUILD/ENU/?guid=Cost_Overview)
**Tutorials**:
- [View ACC or BIM 360 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
## 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
Zhong Wu [@johnonsoftware](https://twitter.com/johnonsoftware), [Autodesk Partner Development](http://aps.autodesk.com)