Migrate Revit Cloud Worksharing Models with Revit Automation

Description

This sample demonstrates how to migrate Revit Cloud Worksharing (RCW) models from one BIM 360/ACC project to another using Design Automation for Revit API. The application supports migrating RCW models (C4RModel type) to the latest Revit versions (2025, 2026) and can handle individual files or entire folders.

Live Demo

https://rcw-migrator.autodesk.io/

Watch the following video:

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, you can simply use the **Configure** button in the Web Application to create the Appbundle & Activity.
3. Create the Web App to call the workitem for RCW model migration.

Web App Setup

Prerequisites

1. APS Account: Learn how to create a APS 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 2025 or 2026: required to compile changes into the plugin
5. JavaScript ES6 syntax for server-side.
6. JavaScript basic knowledge with jQuery
7. BIM 360 or ACC Account: Required for accessing and migrating RCW models

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.

Running locally

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-revit-rcw-migrate-automation

Install the required packages using npm install.

ngrok

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.

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=<<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>>
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>>
npm start

Note. environment variable examples:

• APS_CALLBACK_URL: http://localhost:3000/callback/oauth
• APS_WEBHOOK_URL: http://808efcdc123456.ngrok.io/callback/designautomation

The following are optional:

• APS_AUTOMATION_NICKNAME: Only necessary if your APS app has a nickname, otherwise APS Client ID will be used by default.
• APS_AUTOMATION_ACTIVITY_NAME: Only necessary if the activity name is customized, RCWMigratorAppActivity will be used by default.
• APS_AUTOMATION_ALIAS: Only necessary if the activity alias is customized, dev by default.

Using the app

Open the browser: http://localhost:3000, migrate RCW models: Select Source Folder containing multiple RCW models and Destination Folder, then click Upgrade. It will migrate all RCW models under the source folder to the destination folder.

Note:

• Before using the app, you must click the Configure button to create the AppBundle & Activity. Please check the video for the steps at https://youtu.be/1NCeH7acIko
• Only Revit Cloud Worksharing (RCW) models (C4RModel type) are supported. Standard Revit files (RVT, RFA, RTE) are not supported by this migrator.

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.

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

Packages used

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

Further Reading

Documentation:

• Design Automation API
• BIM 360 API and App Provisioning
• Data Management API
• Revit Cloud Worksharing API

Desktop APIs:

• Revit

Tips & Tricks

• Before using the sample to migrate RCW models, 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).
• Make sure the source file is a Revit Cloud Worksharing (RCW) model, not a standard Revit file.
• Ensure you have appropriate permissions in both source and destination BIM 360/ACC projects.

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

• For Demo purpose, we only support 5 files to be migrated as maximum
• Only supports migrating to Revit 2025 or 2026
• Only supports Revit Cloud Worksharing (RCW) models (C4RModel type)
• Only supports migration between BIM 360/ACC projects
• Migrating linked Revit models is not supported
• Client JavaScript requires modern browser

License

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

Written by

Zhong Wu @johnonsoftware, Autodesk Partner Development