Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiskang/aps-revit-dwg-export-bim360
This sample demonstrated how to export Revit views to DWGs using Design Automation for Revit API.
https://github.com/yiskang/aps-revit-dwg-export-bim360
autodesk-designautomation revit sample
Last synced: 21 days ago
JSON representation
This sample demonstrated how to export Revit views to DWGs using Design Automation for Revit API.
- Host: GitHub
- URL: https://github.com/yiskang/aps-revit-dwg-export-bim360
- Owner: yiskang
- License: mit
- Created: 2022-10-13T09:20:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T16:12:18.000Z (about 1 month ago)
- Last Synced: 2024-11-25T17:24:24.941Z (about 1 month ago)
- Topics: autodesk-designautomation, revit, sample
- Language: JavaScript
- Homepage:
- Size: 8.7 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sample - Export DWGs from Revit files with Design Automation
[](https://nodejs.org/)
[](https://www.npmjs.com/)
[](http://aps.autodesk.com/)
[](http://aps.autodesk.com/)
[](http://autodesk.com/revit)
[](http://opensource.org/licenses/MIT)
# Description
This sample demonstrated how to export Revit views to DWGs using Design Automation for Revit API.
### Note
This project is just a code sample demonstrating the possibilities of implementing an Revit DWG exporter using Revit API, and run it on APS Design Automation API for Revit, which means we don't cover all tests on this sample. So, it would be fail in particular cases that we don't consider or we don't cover in the tests.
Therefore, please don't use it on your production applications directly. If you want to use this sample directly on your production applications, then you must use this sample at your own risk.
# Thumbnail
# Demonstration
Here is the video demonstrating how this sample works quickly.
[](http://www.youtube.com/watch?v=VGxAMOBiqB0 "Demo how to export 2D&3D DWGs from the selected Revit model views.")
# Main Parts of The Work
1. Create a Revit Plugin to be used within AppBundle of Design Automation for Revit. Please check `PlugIn`folder within the [DWGExporter](./DWGExporter/), which is pointing to my [DA4R-DwgExporter](https://github.com/yiskang/DA4R-DwgExporter/) sample using [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
2. Create your App, upload the AppBundle, define your Activity and test the workitem with the Postman collection under [Postman Collection](./DWGExporter/PostmanCollection/), or you can refer ([https://youtu.be/1NCeH7acIko](https://youtu.be/1NCeH7acIko)) and simply use the `Configure` button in the Web Application to create the Appbundle & Activity.
3. Create the Web App to call the workitem.
# Web App Setup
## Prerequisites
1. **APS Account**: Learn how to create a APS Account, activate subscription and create an app at [this tutorial](http://aps.autodesk.com/tutorials/#/account/).
2. **Visual Code**: Visual Code (Windows or MacOS).
3. **ngrok**: Routing tool, [download here](https://ngrok.com/)
4. **Revit 2023**: required to compile changes into the plugin
5. **JavaScript** syntax for server-side.
6. **JavaScript** basic knowledge with **jQuery**
For using this sample, you need an Autodesk developer credentials. Visit the [APS Developer Portal](https://aps.autodesk.com), sign up for an account, then [create an app](https://aps.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 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/yiskang/aps-revit-dwg-export-bim360
Install the required packages using `npm install`.
### ngrok
Install [ngrok](https://ngrok.com)
Run `ngrok http 3000` to create a tunnel to your local machine, and join the address with `/api/aps/callback/designautomation` (e.g. `http://8cc1f77a.ngrok.io/api/aps/callback/designautomation`), then copy it into the `APS_WEBHOOK_URL` environment variable. Please check [WebHooks](https://aps.autodesk.com/en/docs/webhooks/v1/tutorials/configuring-your-server/) for details.
### 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. For example:
Mac OSX/Linux (Terminal)
npm install
export APS_CLIENT_ID=obQDn8P0GanGFQha4ngKKVWcxwyvFAGE
export APS_CLIENT_SECRET=abcdefgh12345678
export APS_CALLBACK_URL=http://localhost:3000/api/aps/callback/oauth
export APS_WEBHOOK_URL=http://875bd739.ngrok.io/api/aps/callback/designautomation
export DESIGN_AUTOMATION_NICKNAME=MyDaNickname
export DESIGN_AUTOMATION_ACTIVITY_NAME=ExportDwgActivity+dev
npm start
Windows (use **Node.js command line** from Start menu)
npm install
set APS_CLIENT_ID=obQDn8P0GanGFQha4ngKKVWcxwyvFAGE
set APS_CLIENT_SECRET=abcdefgh12345678
set APS_CALLBACK_URL=http://localhost:3000/api/aps/callback/oauth
set APS_WEBHOOK_URL=http://875bd739.ngrok.io/api/aps/callback/designautomation
set DESIGN_AUTOMATION_NICKNAME=MyDaNickname
set DESIGN_AUTOMATION_ACTIVITY_NAME=ExportDwgActivity+dev
npm start
Windows (use **PowerShell** or **PowerShell Core**)
npm install
$env:APS_CLIENT_ID='obQDn8P0GanGFQha4ngKKVWcxwyvFAGE'
$env:APS_CLIENT_SECRET='abcdefgh12345678'
$env:APS_CALLBACK_URL='http://localhost:3000/api/aps/callback/oauth'
$env:APS_WEBHOOK_URL='http://875bd739.ngrok.io/api/aps/callback/designautomation'
$env:DESIGN_AUTOMATION_NICKNAME='MyDaNickname'
$env:DESIGN_AUTOMATION_ACTIVITY_NAME='ExportDwgActivity+dev'
npm start
### Using the app
Open the browser: [http://localhost:3000](http://localhost:3000), there are 2 ways to upgrade files:
1. Select Revit file version in BIM360 Hub to view the Model, Select parameters which you want to `export all`|`selective export`, Click 'Execute'.
2. After DA4R processing, it will show up a **Download** link on the top of the progress bar.
`Note`: When you deploy the app, you have to open the `Configure` button to create the AppBundle & Activity before running the Export|Import feature, please check the video for the steps at [https://youtu.be/1NCeH7acIko](https://youtu.be/1NCeH7acIko)
## 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, Callback URL and Revit Design Automation variables for APS.
[](https://heroku.com/deploy?template=https://github.com/yiskang/aps-revit-dwg-export-bim360)
Watch [this video](https://www.youtube.com/watch?v=Oqa9O20Gj0c) as reference on how to deploy samples to Heroku.
## Packages used
The [Autodesk APS](https://www.npmjs.com/package/forge-apis) packages is included by default. Some other non-Autodesk packaged are used, including [socket.io](https://www.npmjs.com/package/socket.io), [express](https://www.npmjs.com/package/express).
## Further Reading
Documentation:
- This sample is based on [Learn APS Tutorial](https://github.com/Autodesk-APS/learn.forge.viewhubmodels/tree/nodejs), please check details there about the basic framework if you are not familar.
- [Design Automation API](https://aps.autodesk.com/en/docs/design-automation/v3/developers_guide/overview/)
- [BIM 360 API](https://aps.autodesk.com/en/docs/bim360/v1/overview/) and [App Provisioning](https://aps.autodesk.com/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/)
- [Data Management API](httqqqps://aps.autodesk.com/en/docs/data/v2/overview/)
Desktop APIs:
- [Revit](https://knowledge.autodesk.com/support/revit-products/learn-explore/caas/simplecontent/content/my-first-revit-plug-overview.html)
## Tips & Tricks
- Before using the sample to call the workitem, you need to setup your Appbundle & Activity of Design Automation, you can follow my Postman script to understand the whole process, or you can simply use the `Configure` button in the Web Application to create the Appbundle & Activity([https://youtu.be/1NCeH7acIko](https://youtu.be/1NCeH7acIko)).
## 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"
## Limitation
- Be aware of the version of [socket.io](https://www.npmjs.com/package/socket.io) used in the [index.html](./public/index.html). It should be the same version installed with the npm.
- Before using the sample to call the workitem, you need to setup your Appbundle & Activity of Design Automation, you can follow my Postman script to understand the whole process, or you can simply use the `Configure` button in the Web Application to create the Appbundle & Activity([https://youtu.be/1NCeH7acIko](https://youtu.be/1NCeH7acIko)).
- Currently Revit Cloud Worksharing is not supported by this sample. The scenario that this sample demonstrates is applicable only with a file-based Revit model license.
- Client JavaScript requires modern browser.
- Currently, the sample supports Design Automation engine 2023, you can use `Configure` button to delete|create different versions of Design Automation Revit engine.
## 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
Eason Kang [in/eason-kang-b4398492/](https://www.linkedin.com/in/eason-kang-b4398492), [Developer Advocacy and Support Team](http://aps.autodesk.com)