How do I connect Oculo to Autodesk Forma?

When would I use this guide?

• You are an admin for the Oculo and Autodesk systems, and want to enable the integration for your team
• You want your team to use Autodesk sign in to access Oculo
• You want the ability to view Oculo directly from the Autodesk Forma platform
• You want to create Autodesk Issues using Oculo data

Overview

The Oculo integration for Autodesk Forma lets your team create Forma Build issues from inside Oculo. When you raise an issue from Oculo, you can push the issue into your Forma project along with the image and a floorplan location (image), and a link back to the Oculo scene. Both are kept in sync, resulting in one issue list, in the tool your team already uses, with the 360° context still one click away.

Setting the integration up is a one-time job split across three parts:

1. An Autodesk Forma hub administrator installs the Oculo app from the Forma app gallery

2. An Autodesk Forma project administrator prepares the specific Build project: adding a custom issue field called "Oculo link" and creating a folder for the captured images
3. You collect four ID values from Autodesk Forma and send them to your Oculo Customer Success Manager, who will complete the configuration on the Oculo side for you

You cannot finish this on your own: the last step requires Oculo to enter your configuration details into our system. Plan for a short back-and-forth with your Oculo contact rather than expecting the integration to go live the moment you finish in Forma.

Part 1: Install the Oculo app in Forma

1. Navigate to Hub Admin in Autodesk Forma.
   
2. Select Apps.
   
3. Find the Oculo app in the app gallery, then select Install.
   
4. On the next screen, select Authorise and Install.
   

The authorisation screen tells you what permissions Oculo is being granted. Oculo requests read and write access to Hub administration (including project creation, service activation, business partner directory and member directory) and to Files (including access to folders, files, models and issues). Once you have authorised it, the first part of the configuration is complete.

Part 2: Configure your Forma Build project

This part is done per project, by a Forma project administrator, on the specific project you want to integrate with Oculo.

Step 1: Add the "Oculo link" custom field

This custom field is what holds the link back to the Oculo Issue. Without it, Oculo cannot provide a link from the Forma Issue to the Oculo Issue it came from.

1. Go to the Forma project that you want to integrate with Oculo.
2. Go to the Build page.
3. Select Issues.
   
   
   
   
4. Under the Settings menu on the far right-hand side, select Customised fields.
   
   
5. Create a new field called Oculo link with the type Text.
   
   
6. Check that the Oculo link field now appears in the list on the Settings page.
   
7. Select the Types tab. For each issue category, click into it, go to Manage fields and select +Add customised field. Select Oculo link and add it.
   
8. Repeat for all categories.

Step 2: Create a folder for the Oculo images

This folder is where Oculo stores the captured images from the Oculo interface that get attached to your Forma Issues.

1. Go to the Forma project that you want to integrate with Oculo.
2. Go to Build, then Files.
   
3. Under Project Files, click Add a subfolder.
   
4. Name the folder Oculo (or something similar).
5. Make sure every user who will raise issues from Oculo has permission to write to this folder.

Part 3: Collect the four configuration details for Oculo

To finish the setup, Oculo needs four pieces of technical information from your Forma environment. These are retrieved manually today, so you will need to copy each one out and send it across.

1. Forma Hub ID

1. Navigate to Hub Admin in Autodesk, then select Settings.
2. The Hub ID is listed on the Account settings page under Advanced. It looks like f6b81f06-770a-49fd-b27a-52brbaad7a34.

2. Forma project ID (URL)

1. Navigate to Build in the Forma project.
2. Copy the URL in your browser. For example: https://acc.autodesk.eu/build/home/projects/64et2b3e-0b41-a422-ba44-01e700ae8351

3. Forma folder ID

1. Navigate to the Oculo folder you created in Part 2, under Files in Forma Build.
2. Copy the URL. For example: https://acc.autodesk.eu/build/files/projects/6ae62b3e-0b41-4422-b744-01e700ae8351?folderUrn=urn%3Aadsk.wipemea%3Afs.folder%3Cco.KxpWd33ISyuWZOZYCb39Jg&viewModel=detail&moduleId=folder

Send the details to Oculo

Send these four items back to your Oculo Customer Success Manager, or to help@oculo.ai:

1. The Forma hub ID: 
2. The Forma project URL: 
3. The Forma folder URL:

Related articles

• Oculo <> Autodesk Integration - guide
• Using Oculo from within Forma - how to setup the Oculo Partner Card in Autodesk

Need help? Contact help@oculo.ai if you have any questions about setting up the Autodesk integration.