forge-revit-fbx-export-bim360

by yiskang

GitHub Readme.md

Export FBXs from Revit files with Design Automation

Node.js npm Platforms Data-Management Design-Automation

Windows .NET Revit-2019

Advanced MIT

Description

This sample demonstrated how to export Revit 3D views to FBXs using Design Automation for Revit API.

Thumbnail

thumbnail

thumbnail

Main Parts of The Work

  1. Create a Revit Plugin to be used within AppBundle of Design Automation for Revit. Please check PlugIn
  2. Create your App, upload the AppBundle, define your Activity and test the workitem with the Postman collection under Postman Collection, or you can refer (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. Forge Account: Learn how to create a Forge Account, activate subscription and create an app at this tutorial.
  2. Visual Code: Visual Code (Windows or MacOS).
  3. ngrok: Routing tool, download here
  4. Revit 2019: required to compile changes into the plugin
  5. JavaScript ES6 syntax for server-side.
  6. JavaScript basic knowledge with jQuery

For using this sample, you need an Autodesk developer credentials. Visit the Forge Developer Portal, sign up for an account, then create an app. 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, version 8 or newer.

Clone this project or download it (this nodejs branch only). It's recommended to install GitHub desktop. To clone it via command line, use the following (Terminal on MacOSX/Linux, Git Shell on Windows):

git clone https://github.com/yiskang/forge-revit-fbx-export-bim360

Install the required packages using npm install.

ngrok

Install ngrok

Run ngrok http 3000 to create a tunnel to your local machine, and join the address with /api/forge/callback/designautomation (e.g. http://8cc1f77a.ngrok.io/api/forge/callback/designautomation), then copy it into the FORGE_WEBHOOK_URL environment variable. Please check WebHooks 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 FORGE_CLIENT_ID=obQDn8P0GanGFQha4ngKKVWcxwyvFAGE
export FORGE_CLIENT_SECRET=abcdefgh12345678
export FORGE_CALLBACK_URL=http://localhost:3000/api/forge/callback/oauth
export FORGE_WEBHOOK_URL=http://875bd739.ngrok.io/api/forge/callback/designautomation
export DESIGN_AUTOMATION_NICKNAME=MyDaNickname
export DESIGN_AUTOMATION_ACTIVITY_NAME=ExportFbxActivity+dev
npm start

Windows (use Node.js command line from Start menu)

npm install
set FORGE_CLIENT_ID=obQDn8P0GanGFQha4ngKKVWcxwyvFAGE
set FORGE_CLIENT_SECRET=abcdefgh12345678
set FORGE_CALLBACK_URL=http://localhost:3000/api/forge/callback/oauth
set FORGE_WEBHOOK_URL=http://875bd739.ngrok.io/api/forge/callback/designautomation
set DESIGN_AUTOMATION_NICKNAME=MyDaNickname
set DESIGN_AUTOMATION_ACTIVITY_NAME=ExportFbxActivity+dev
npm start

Windows (use PowerShell or PowerShell Core)

npm install
$env:FORGE_CLIENT_ID='obQDn8P0GanGFQha4ngKKVWcxwyvFAGE'
$env:FORGE_CLIENT_SECRET='abcdefgh12345678'
$env:FORGE_CALLBACK_URL='http://localhost:3000/api/forge/callback/oauth'
$env:FORGE_WEBHOOK_URL='http://875bd739.ngrok.io/api/forge/callback/designautomation'
$env:DESIGN_AUTOMATION_NICKNAME='MyDaNickname'
$env:DESIGN_AUTOMATION_ACTIVITY_NAME='ExportFbxActivity+dev'
npm start

Using the app

Open the browser: 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

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, Callback URL and Revit Design Automation variables for Forge.

Deploy

Watch this video as reference on how to deploy samples to Heroku.

Packages used

The Autodesk Forge packages is included by default. Some other non-Autodesk packaged are used, including socket.io, express.

Further Reading

Documentation:

Desktop APIs:

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).

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 used in the 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).
  • Currently Revit Cloud Worksharing is not supported by the Design Automation. The scenario that this sample demonstrates is applicable only with a file-based Revit model license.
  • It takes time for BIM360 to automatically translate the new uploaded Revit file version, please wait for a while to see the viewable and properties.
  • Client JavaScript requires modern browser.
  • Currently, the sample supports Design Automation engine 2019 & 2020, you can use Configure button to delete|create different versions of Design Automation Revit engine.
  • Currently, the sample only supports list out the 3D views configured within the chosen view sets of the Publish Settings.

License

This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.

Written by

Eason Kang
Forge Partner Development
https://developer.autodesk.com/
https://forge.autodesk.com/blog