This sample demostrated how to upgrade Revit project/family/template to the latest version using Design Automation for Revit API, including upgrade one file or one folder.
- Create a Revit Plugin to be used within AppBundle of Design Automation for Revit. Please check PlugIn
- Create your App, upload the AppBundle, define your Activity, you can simply use the
**Configure**
button in the Web Application to create the Appbundle & Activity. - Create the Web App to call the workitem.
- APS Account: Learn how to create a APS Account, activate subscription and create an app at this tutorial.
- Visual Code: Visual Code (Windows or MacOS).
- ngrok: Routing tool, download here
- Revit 2023: required to compile changes into the plugin
- JavaScript ES6 syntax for server-side.
- JavaScript basic knowledge with jQuery
For using this sample, you need an Autodesk developer credentials. Visit the Autodesk Developer Portal, sign up for an account, then create an app. For this new app, use http://localhost:3000/api/aps/callback/oauth as Callback URL, although is not used on 2-legged flow. Finally take note of the Client ID and Client Secret.
Install NodeJS, version 14 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/Autodesk-Platform-Services/aps-upgrade-revit-files
Install the required packages using npm install
.
Run ngrok http 3000
to create a tunnel to your local machine, then copy the address into the APS_WEBHOOK_URL
environment variable. Please check WebHooks for details.
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=<<YOUR CLIENT ID FROM DEVELOPER PORTAL>>
export APS_CLIENT_SECRET=<<YOUR CLIENT SECRET>>
export APS_CALLBACK_URL=<<YOUR CALLBACK URL>>
export APS_WEBHOOK_URL=<<YOUR DESIGN AUTOMATION FOR REVIT CALLBACK URL>>
export DESIGN_AUTOMATION_NICKNAME=<<YOUR DESIGN AUTOMATION FOR REVIT NICK NAME>>
export DESIGN_AUTOMATION_ACTIVITY_NAME=<<YOUR DESIGN AUTOMATION FOR REVIT ACTIVITY NAME>>
export DESIGN_AUTOMATION_ACTIVITY_ALIAS=<<YOUR DESIGN AUTOMATION FOR REVIT ACTIVITY ALIAS>>
npm start
Windows (use Node.js command line from Start menu)
npm install
set APS_CLIENT_ID=<<YOUR CLIENT ID FROM DEVELOPER PORTAL>>
set APS_CLIENT_SECRET=<<YOUR CLIENT SECRET>>
set APS_CALLBACK_URL=<<YOUR CALLBACK URL>>
set APS_WEBHOOK_URL=<<YOUR DESIGN AUTOMATION FOR REVIT CALLBACK URL>>
set DESIGN_AUTOMATION_NICKNAME=<<YOUR DESIGN AUTOMATION FOR REVIT NICK NAME>>
set DESIGN_AUTOMATION_ACTIVITY_NAME=<<YOUR DESIGN AUTOMATION FOR REVIT ACTIVITY NAME>>
set DESIGN_AUTOMATION_ACTIVITY_ALIAS=<<YOUR DESIGN AUTOMATION FOR REVIT ACTIVITY ALIAS>>
npm start
Note. environment variable examples:
- APS_CALLBACK_URL:
http://localhost:3000/api/aps/callback/oauth
- APS_WEBHOOK_URL:
http://808efcdc123456.ngrok.io/api/aps/callback/designautomation
The following are optional:
- DESIGN_AUTOMATION_NICKNAME: Only necessary if there is a nickname, APS client id by default.
- DESIGN_AUTOMATION_ACTIVITY_NAME: Only necessary if the activity name is customized, FileUpgraderAppActivity by default.
- DESIGN_AUTOMATION_ACTIVITY_ALIAS: Only necessary if the activity alias is customized, dev by default.
Open the browser: http://localhost:3000, there are 2 ways to upgrade files:
- Select Revit file in BIM360 Hub from Source File/Folder, Right Click and select
Upgrade to Revit 2023
. It will create a new version after successfully upgraded. - Select Source Folder and Destination Folder, then click
Upgrade
, it will upgrade all the files under the folder to destinated folder.Note
: When you deploy the app, you have to open theConfigure
button to create the AppBundle & Activity before running the upgrade feature, please check the video for the steps at https://youtu.be/1NCeH7acIko
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.
Watch this video as reference on how to deploy samples to Heroku.
The Autodesk APS packages is included by default. Some other non-Autodesk packaged are used, including socket.io, express.
Documentation:
- Design Automation API
- BIM 360 API and App Provisioning
- Data Management API
Desktop APIs:
- Before using the sample to call the workitem, you need to setup your Appbundle & Activity of Design Automation, you can simply use the
Configure
button in the Web Application to create the Appbundle & Activity(https://youtu.be/1NCeH7acIko).
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"
- For Demo purpose, we only support 5 files to be upgraded as maximum
- Only support upgrading to Revit 2023
- Override is not implemented yet
- Only support upgrade file from/to BIM360
- Client JavaScript requires modern browser
This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.
Zhong Wu @johnonsoftware, Autodesk Partner Development