Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/autodesk-forge/forge-takeoff.exchange.csv
This sample demonstrates importing|exporting data of Autodesk Takeoff from|to a CSV file.
https://github.com/autodesk-forge/forge-takeoff.exchange.csv
autodesk-construction-cloud autodesk-takeoff excel javascript nodejs
Last synced: about 6 hours ago
JSON representation
This sample demonstrates importing|exporting data of Autodesk Takeoff from|to a CSV file.
- Host: GitHub
- URL: https://github.com/autodesk-forge/forge-takeoff.exchange.csv
- Owner: Autodesk-Forge
- License: mit
- Created: 2021-11-03T17:52:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T16:28:07.000Z (6 months ago)
- Last Synced: 2024-05-28T00:48:10.675Z (6 months ago)
- Topics: autodesk-construction-cloud, autodesk-takeoff, excel, javascript, nodejs
- Language: JavaScript
- Homepage: https://autodesk-takeoff-exchange.herokuapp.com/
- Size: 3.22 MB
- Stars: 2
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# forge-takeoff.exchange.csv
[](https://nodejs.org/)
[](https://www.npmjs.com/)
[](http://developer.autodesk.com/)
[](http://developer.autodesk.com/)
[](http://developer.autodesk.com/)
[](http://opensource.org/licenses/MIT)
[](http://developer.autodesk.com/)
## Description
### The sample includes the following 2 main features:
1. Support takeoff project set up, include setting measurement system, importing/updating/exporting takeoff classification systems from/to csv file.
2. Support handling takeoff items under package, include creating package, list takeoff items under current package or all packages, you can also export these information to a csv file.
### To use the sample, you can check the following tasks:
#### Items:
- Display Autodesk Takeoff Inventory in **readable form** or **raw form** in two tables (one for the items grouped and other for all items).
- Export Autodesk Takeoff Inventory from **current** or **all** packages available in **readable form** or **raw form** from both tables to a CSV file.
#### Project Settings
- Display Takeoff Measurement System currently defined and an interface to modify it (when possible).
- Display Classifications systems from available classification systems.
- Export classifications from available classification systems.
- Import and Update classification systems (when possible).
## Thumbnail
## Live version
You can run this sample live here:
https://autodesk-takeoff-exchange.herokuapp.com
and the recording demonstrating how to run here:
https://www.youtube.com/watch?v=pZlKA6NftKY
# Web App Setup
## Prerequisites
1. **Forge Account**: Learn how to create a Forge Account, activate subscription and create an app at [this tutorial](http://learnforge.autodesk.io/#/account/).
2. **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. **Autodesk Takeoff**: Create ACC project, activate Takeoff module, according to [the guide](https://knowledge.autodesk.com/support/takeoff/learn-explore/caas/CloudHelp/cloudhelp/ENU/Takeoff-GS/files/Getting-Started-Takeoff-html.html)
4. **Node.js**: basic knowledge with [**Node.js**](https://nodejs.org/en/).
5. **JavaScript** basic knowledge with **jQuery**
For using this sample, you need an Autodesk developer credentials. Visit the [Forge 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/forge/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-Forge/forge-takeoff.exchange.csv
Install the required packages using `npm install`.
**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 FORGE_CLIENT_ID=<>
export FORGE_CLIENT_SECRET=<>
export FORGE_CALLBACK_URL=<>
npm start
Windows (use **Node.js command line** from Start menu)
npm install
set FORGE_CLIENT_ID=<>
set FORGE_CLIENT_SECRET=<>
set FORGE_CALLBACK_URL=<>
npm start
## Using the app
Open the browser: [http://localhost:3000](http://localhost:3000).
**Please watch the [Video](https://www.youtube.com/watch?v=_SJVh2si40Y) for the detail setup and usage, or follow the steps:**
- **Setup the app before using the App**
1. Make sure to [Create ACC project, activate and configure Takeoff module](https://knowledge.autodesk.com/support/takeoff/learn-explore/caas/CloudHelp/cloudhelp/ENU/Takeoff-GS/files/Getting-Started-Takeoff-html.html).
- **Operate with App after setup**
1. Once you select a project, the sample will load the packages available. **With project and package/classification selected, the takeoff items will be retrieved in the table.**
2. When **Items** panel is selected, the sample shows a list of packages available and display the content of the selected one in two tables. The first Table shows the data classified according to the selected options and the second table shows each individual takeoff item. At the right side it shows UI to handle **Export** based on **grouped items** or **list of all items** for the selected package or the whole project.
3. When **Project Settings** panel is selected, the sample shows a list of classification systems available, also list information of the current selected classfication system. At the right side it shows UI to handle **Measurement System**, **Import Classification**, **Update Classification** (these first three might be disables depending on usage on your project) and **Export Classification**.
## 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.
[](https://heroku.com/deploy?template=https://github.com/Autodesk-Forge/forge-takeoff.exchange.csv)
## Known issues
1. For the extraction as CSV, the fileds containing commas are replaced by blank spaces, so they're not mistaken as another column.
## Tips & Tricks
1. **When Importing or Updating, the first line of the csv is reserved for header and is ignored.**
2. **Be aware of the limitations when creating and updating classification system or changing measurement systems.**
3. **After changing between tabs or projects, it might take some seconds to show the proper buttons and check what is available to change. It's a good practice to wait the loading and then perform the tasks.**
## Troubleshooting
1. **Cannot see my ACC projects**: Make sure to provision the Forge App Client ID within the ACC Account, [learn more here](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps). This requires the Account Admin permission.
## Further Reading
**Document**:
- This sample is based on [Learn Forge Tutorial](https://github.com/Autodesk-Forge/learn.forge.viewhubmodels/tree/nodejs), please check details there about the basic framework if you are not familar.
- [Data Management API](https://developer.autodesk.com/en/docs/data/v2/overview/)
- [ACC API](https://developer.autodesk.com/en/docs/bim360/v1/overview/) and [App Provisioning](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps)
- [Autodesk Takeoff API](https://forge.autodesk.com/en/docs/acc/v1/tutorials/takeoff/)
- [TAKEOFF API UPDATE BLOG](https://forge.autodesk.com/blog/takeoff-api-enhancement-write-access-settings-classifications-and-packages)
- [Create ACC project, activate and configure Takeoff module](https://knowledge.autodesk.com/support/takeoff/learn-explore/caas/CloudHelp/cloudhelp/ENU/Takeoff-GS/files/Getting-Started-Takeoff-html.html)
- [View BIM 360/ACC Models Tutorial](http://learnforge.autodesk.io/#/tutorials/viewhubmodels)
**Blogs**:
- [Forge Blog](https://forge.autodesk.com/blog/autodesk-takeoff-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.
# Change History
## Improve Date: 2022-4-18
- Support setting up takeoff project, including measurement system, importing/updating/exporting takeoff classification systems from/to csv file.
## Written by
João Martins [@JooPaulodeOrne2](http://twitter.com/JooPaulodeOrne2), [Developer Advocate and Support](http://forge.autodesk.com)