Installing Autodesk BIM Plugin

Table of Contents

Overview

This article explains how to install and configure the Autodesk BIM plugin for KanBo, including the required setup steps and integration prerequisites. After completing the installation, you can synchronize KanBo spaces with Autodesk BIM projects and manage BIM issues directly from KanBo.

For more information about synchronization options and daily usage, see the KanBo Autodesk BIM Integration article.

Prerequisites

Please make sure you have created a service account in your Autodesk environment with write access to all projects in Autodesk BIM 360 that can be synced with KanBo. It is important that you do not use your personal Autodesk account for this; otherwise, all changes in Autodesk BIM 360 resulting from KanBo changes will be registered in Autodesk BIM 360 as your actions.

Creating and adding the Autodesk Forge App

  1. Go to your Autodesk Forge Apps, log in with an account that has the permission to create apps on Autodesk Forge.
  1. Enter the name and description for your app. For the callback URL, enter your KanBo URL followed by “/auth/bim/oauth.” Leave the Website URL field empty.
  1. Select the BIM 360 API and the Data Management API, then select Create App
  1. The following screen will now appear:
  1. Copy the Client ID and the Client Secret and save them somewhere.
  2. Go to your BIM 360 Administration Center.
  3. Select Settings > Applications.
  1. Select Add custom integration.
  2. In the next window, leave both options selected and go Next.
  1. Select I’m the developer, then select Next.
  1. Check the I have saved the account ID information securely box.
  2. Paste in the Client ID you saved before.
  3. Enter the app name, scroll down, and select Save.

Configuring KanBo

Before continuing with the configuration of the appsettings.json file for KanBo, please verify that the "KanBo.BimPlugin.dll" file is present in the /plugins folder of your KanBo installation. If not, contact support@kanbo.com for the plugin files.

  1. Open your KanBo appsettings.json file. You need to add two lines here:

    • Add
      { "Path": "KanBo.BimPlugin.dll" };
      into the "assemblies" array. It should look like this:
      "assemblies": [ { "Path": "KanBo.BimPlugin.dll" } ]

    • Add 
      {
        "type": "job.bim-sync",
        "name": "bim-sync",
        "repeat": "1h",
        "client-id": "CLIENTID",
        "client-secret": "CLIENTSECRET"
      },
      anywhere in the "plugins" section of your appsettings.json file. Replace the "CLIENTID" and "CLIENTSECRET" with the Client ID and Client Secret You have saved before. We recommend starting the sync once every hour ("1h"), but if you need it more frequently, you can set it to 15 minutes ("15m").

  2. After adding those lines, save the appsettings.json file. Note that saving the configuration will not result in KanBo being restarted. To enable the BIM plugin, you must restart your KanBo app manually.

  3. It is very important that you use an Autodesk service account with write access to the Autodesk BIM projects that your teams select for synchronization with KanBo.

    4. DO NOT USE YOUR PERSONAL AUTODESK ACCOUNT HERE

    For this step, start an Incognito (Chrome) or InPrivate (Edge) window or tab to ensure that you are logging in with the correct Autodesk BIM 360 credentials.

  4. Go to your KanBo, and add "/auth/bim/use-my-token" to the URL of your KanBo (for example: https://mykanbo.com/auth/bim/use-my-token). After logging in to KanBo, you should see this message. Autodesk BIM 360 will also prompt you to enter your service account credentials. 

  5. Select Allow. You are allowing KanBo Sync to update issues in Autodesk BIM 360 when changes are made to the corresponding KanBo cards.
  6. If your configuration is correct, you will see this message and your KanBo will be integrated with your Autodesk BIM 360 environment.

Was this article helpful?

Please, contact us if you have any additional questions.