/design.automation-nodejs-dwg-data.extractor

[DEPRECATED] This app lets you extract blocks, layers and dependents information from your DWG data, hosted on BIM360 or Fusion Team, into an Excel document

Primary LanguageJavaScriptMIT LicenseMIT

This code sample is deprecated, please use V3 Forge Design Automation API.

Export to Excel

alt text

Description

This sample application demonstrates how to extract information (layers, blocks and dependents) from an AutoCAD drawing on your BIM360 or Fusion account, into an Excel document. The sample code demonstates 3-legged OAuth to BIM360 / Fusion, a simple viewer extension and code to extract AutoCAD drawing metadata into an Excel document.

Live version

http://autode.sk/dwg2xlsdemo

Setup

Follow the instructions found in the README of the DWG Query Activity Client Application repository to create a new custom activity that this app will use to extract AutoCAD drawing metadata to Excel.

The steps a developer needs to go through to setup the app are

Developer Flow

The steps a user will go through when using the app are

User Flow

For using this sample, you need to log into your Autodesk developer account. Visit the Forge Developer Portal and sign up for an account, then create an app. When asked for the 'callback URL' in your new app, use http://localhost:3000/api/forge/callback/oauth. Finally take note of the Client ID and Client Secret.

Run locally

Install NodeJS.

Clone this project or download it. 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/mazerab/design.automation-nodejs-dwg-data.extractor

To run it, install the required packages, set the enviroment variables with your callback URL, 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=<<YOUR CLIENT ID FROM FORGE DEVELOPER PORTAL>>
export FORGE_CLIENT_SECRET=<<YOUR FORGE CLIENT SECRET>>
export FORGE_CALLBACK_URL=<<YOUR FORGE CLIENT CALLBACK URL>>
npm run dev

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

npm install
set FORGE_CLIENT_ID=<<YOUR CLIENT ID FROM FORGE DEVELOPER PORTAL>>
set FORGE_CLIENT_SECRET=<<YOUR FORGE CLIENT SECRET>>
set FORGE_CALLBACK_URL=<<YOUR FORGE CLIENT CALLBACK URL>>
npm run dev

Open the browser: http://localhost:3000.

Important: do not use npm start locally, this is intended for PRODUCTION only with HTTPS (SSL) secure cookies.

Deploy on Heroku

To deploy this application to Heroku, the Callback URL & redirect_uri 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 the correct callback URL.

Deploy

Watch this video on how deploy this sample to Heroku.

Packages used

All Autodesk Forge NPM packages are included by default, see complete list of what's available at NPM website. OAuth, Model Derivative, Design Automation and OSS are used. Some other non-Autodesk packaged are used, including express and its session/cookie middlewares (express-session and cookie-parser) for user session handling. The front-end uses bootstrap and jquery.

Tips & tricks

For local development/testing, consider use nodemon package, which auto restart your node application after any modification on your code. To install it, use:

sudo npm install -g nodemon

Then, instead of npm run dev, use the following:

npm run nodemon

Which executes nodemon server.js --ignore www/, where the --ignore parameter indicates that the app should not restart if files under www folder are modified.

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"

License

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

Written by

Bastien Mazeran, @bastien-mazeran, Autodesk Enterprise Priority Support