When working with hubs across multiple regions, proper naming conventions are essential for smooth operation. We strongly recommend that customers use unique naming conventions for their hubs that clearly indicate the region where each hub is hosted. For example, you might name your hubs "CompanyName-US", "CompanyName-EMEA", or "CompanyName-Canada".

While Clarity may function with identically named hubs across different regions, this configuration has not been thoroughly tested and could lead to unexpected behavior. Using distinct names helps prevent confusion in Clarity and other integrated services, and ensures reliable performance across your organization's projects.

While this enhancement can be applied to any model in your project, it was specifically designed to address the limitations of bridged models.In the image below, multiple files are selected in the project's Files area to "Open as Published." This ensures Clarity operations run against the latest published versions of these models.

If you haven't already added the app, here are instructions on how to Add the Clarity App

The very first requirement is that the Clarity App be Active in 360/ACC

360 Project Configuration

The Oauth identity setup in Clarity must be a project member of all projects you want to add to Clarity. That identity must also be a part of the document management team with appropriate permissions to the folders you need to access to be able to perform the tasks you want to run on the project.

You likely have multiple 360 credentials for the different task servers and the primary one used to add projects.  Each of those identities needs to be assigned to all projects in 360 that you want to add to Clarity, and each of those also has to be part of the Docs team.

Autodesk Device Limit

Autodesk is starting to crack down on running under the same 360 identity on multiple machines. 

In order to be in compliance we recommend you have a 360 identity for each task server.

More information is available at this blog link:  https://imaginit.helprace.com/i537-autodesk-device-limit-reached-warning-on-task-servers

360 Permissions and License

It will also be necessary for you to have the appropriate permissions to access the live model, including a valid ACC license for the task server 360 identity.   For a Collaborated file, that will require a Collaboration Pro license for each Task Server identity accessing 360 models.

It is not required that the member be a project admin, but they will need the proper permission assignments to the folders if not.

Clarity Oauth

The Oauth identity assigned to the project must be added and valid in the Clarity web portal order for us to see the published models in the project in 360.

Clarity Monitoring Service

The Monitoring service must be running in order for us to scan projects.

You can see the status of the Monitoring Service on the Server tab, Central Host page

Checking to See What Projects the Oauth Has Access To

If you select Check, you can see what Hubs and Projects that Oauth has access to.

Anything with an arrow beside it means you can expand the list to see the Projects.

If you don't see the hub/project here, we don't have access to it with that Oauth identity.

Adding a 360 Project to Clarity

Go to the Projects tab, Add a Project.

For 360 Projects you must specify the version of the Revit files so we know what version of Revit to process the files with.  If you specify the wrong version, the Revit tasks will never be claimed, and you will need to Edit the Project to fix the version.

To enable access:

1. Sign into the ACC portal as an Account Admin:  https://acc.autodesk.com/
2. Select the Apps icon
   1. 
3. Select the IMAGINiT Clarity app and Install

   1. 

   2. We only need access to Document Management
4. The icon will change to look like the image below and will show as Active.
5. The published files should show up in Clarity after about 5 – 10 minutes.

 


Note: The Clarity ACC integration relies on the Forge interface for Project/model information; therefore, the models do not exist in Clarity until they are published to the cloud.

Once published, Clarity tasks will continue to retrieve the latest version available inside of Revit, as long as the Oauth is valid and the Clarity Monitoring service is running. 

Please make sure that Clarity software is kept up to date.
​​​​​​​

How to Edit the Project

From the Project Home page, select the pencil and checkbox in the upper right corner, Edit Project.

Select the Project Type tab

To Change the Version of Revit in the Project

If you need to change the version of Revit used for the project select update version. 

This will not upgrade models, it simply sets the version of Revit used to perform tasks.

On the Project Type tab, select Update Version

Select the new version from the dropdown, then Update

To Change All Other Settings in the Project

Select Edit                                                                                                          Make your modifications and update

Request Rescan and Check File Filters

After you have made changes go back to the Pencil and Checkbox and Request Rescan.

If you have File Filters set you will want to check those too

Projects are showing as Stale in Clarity

Cause/Things to Check

• Autodesk Health
  • Were there Autodesk outages that may have affected things?
    • https://health.autodesk.com/

• In Clarity

  • Is the Clarity Monitoring Service still running?
    • Stop/Start the service to rescan everything
      • Server tab, Central Host
        • 
  • Is the Oauth for that project still valid?
    • Server tab, Settings, Oauth
      • https://imaginit.helprace.com/i484-clarity-how-to-reset-the-360-oauth-credentials
  • Select Check to see what Hubs/Projects you can see with that Oauth 
    • IF YOU DON'T SEE THE HUB WHEN YOU CHECK, THERE IS SOMETHING WRONG WITH THE APP IN ACC.
      • Try removing the app and reinstalling it and verify it is active. 
    • If you see the Hub, but not the Project, check the project permissions in 360/ACC for the Oauth identity assigned to the project in Clarity
      • Try removing and adding that identity to see if that resolves the issue
    
    
    • 
  • Edit the project and go to the Project Type tab, Edit and re-select the Oauth for the project to reset it.
    • Reset the Sub Folder.
      • Generally, It should at least be set to Project Files\
      • https://imaginit.helprace.com/i603-how-to-edit-a-360-project-in-clarity
  • Do you see the models on the project home page?  We must see them here in order for them to be available for tasks.

  In 360

  • Is that account active in the project in 360?
  • Is the Oauth identity still assigned to the project?
  • Is that identity also part of the document management team? 
  • Is the project still active in 360?
    • If the project has been archived in 360 it will show as stale regardless of the Oauth and Monitoring status.
  • Is the Clarity App still Active?
    • If you uninstall the app and reinstall it does the hub/project show up? 
    • 

Diagnostics

Please stop/start the Clarity Monitoring service then wait about 10 minutes and send all of the logs

Server tab, Logs

Or from this folder on the host.
Host
C:\ProgramData\IMAGINiT Technologies\Clarity\Logs

THESE ARE REFRESHED BY THE MONITORING SERVICE SO PLEASE MAKE SURE IT IS RUNNING.

360 projects that are in Clarity require that the 360 Oauth identity be Valid so that we can see the Project and files.

This identity must be a member of each project you want to add to Clarity and also be assigned to the document management team.

Symptoms of an invalid Oauth

• Can’t add new 360 projects because they don’t show up on the list of available projects for the hub
• 360 Post actions will not work
• Projects are showing as stale
• Files not showing on the project home page or as task targets

Reauthenticating the Oauth

• Log into the Clarity web portal as an admin
• Go to the Server tab, Settings, Oauth
• In the same browser session, open a new tab and SIGN OUT OF ACC/Forma
• If you don't sign out as yourself, it will update or ADD your credentials. 
  • If you have Autodesk SSO you will need to sign in from somewhere that will allow you to sign in with those credentials.
• Select Add or Update Credentials
• Sign in as the credentials you need to update
• Select Allow

Setting Up an Oauth Alert

At the bottom of the Oauth tab is an option to add an email address to be alerted if the Oauth becomes invalid

Invalid Oauth Email Notification

If it becomes invalid you will receive an email similar to the one shown below.

Getting Help

If you have checked all of the items above and are still having issue please open a support case by emailing Support@rand.com .  You will receive an email with your case number.

We will need the following diagnostics from the Server tab, Logs in the Clarity web portal.  Please send a days worth of logs.  Please include your case number with the diagnostics.

• AdminWebservice
• Monitoring

If you are receiving an email like the one below from a task server, that means we think that the token is invalid somewhere, it could be for a specific version of software.

Why Does this Happen?

Since we don’t see this with all clients, on all versions, we don’t have a definitive answer to that.

A common scenario we see this happen is when varied versions of Revit are launched on the task server, with varied updates, since they register differently in the different versions.

We have a few clients that seem to experience this issue more than others, and we have not found a common reason for this.

How We Try to Monitor the Token

There is no API available to validate token session status.

Our current approach relies on parsing Autodesk log files to determine session validity, which helps us proactively detect when a Revit user isn't authenticated on the task servers - a situation that would prevent tasks from executing.

This implementation carries inherent brittleness: if Autodesk modifies their log format or output, we'll need to update our parsing logic accordingly. We've reassessed this approach and identified several improvements to reduce false positives and provide clearer feedback to users.

To Clear the Error

Log onto the task server as the designated Clarity account

The issue can often be cleared up by using the desktop icon "Launch Task Server" for an older and newer version of Revit.

Best Practice

Autodesk Software
I would recommend that you uninstall any older unused versions of Autodesk software and make sure the installed versions are up to date or at least equivalent to what is used in production.

Also make sure that the Autodesk Licensing Service, Single Sign On Component and Identity Manager stay fairly up to date.

You can access these from Autodesk Access in the Task Tray in the lower right corner

If you are running Windows Task Server tasks, that will also include Autocad and Navisworks products

Clarity Folders
I would also recommend that you keep the Clarity install folders clean, sometimes folders don't get removed due to permission issues.

The program files folder should have these folders for Clarity 2026.
C:\Program Files\IMAGINiT Technologies\Clarity Task Server for Revit

For the supported version of the Desktop Connector, please refer to the following blog post

https://imaginit.helprace.com/i734-clarity-task-servers-and-the-desktop-connector

Error when trying to add a 360 project and prerequisites have already been done.

There are no BIM360 - Unified Projects found

Resolution

Check the following files on the host

• C:\Program Files\IMAGINiT Technologies\Clarity Monitoring Service\ClarityMonitoringService.exe.config
• C:\inetpub\wwwroot\CentralAdministrator\Web.config

  <system.net>

    <defaultProxy>

      <proxy bypassonlocal="True" usesystemdefault="False"/>

    </defaultProxy>

  </system.net>

Change the highlighted text above to “True”, and then restart the monitoring service.

Log Errors

Monitoring

INFO [3] 2021-10-20 16:34:44,513 BIM360CachedProjects - Starting 1/1 token scan. Token Details: (1, OAUTHNAME (Primary))
INFO [3] 2021-10-20 16:34:44,528 BIM360Api - Initialize in-memory access token from database storage. (Token expired.)
ERROR [3] 2021-10-20 16:35:05,579 OAuthTokenDataAccess - Error Response from RefreshToken, StatusCode: 0, Exception: Exception: WebException: Unable to connect to the remote server ==> Inner: SocketException: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond 40.114.51.68:80. Sent tokenId A360 and Token 9Epr......
INFO [3] 2021-10-20 16:35:05,579 BIM360Api - Loading all BIM360 projects in all Hubs.
INFO [3] 2021-10-20 16:35:05,579 BIM360Api - Initialize in-memory access token from database storage. (Token expired.)

 ==> Inner: SocketException: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond 40.114.51.68:80. Sent tokenId A360 and Token 9Epr......
INFO [15] 2021-10-20 16:38:47,859 ProjectScanManager - Crawling Files..

May need to also check these settings

Settings, Network & Internet

Proxy

The example below is how the email starts.

Subject:  Action Required: BIM 360 Issues v.1.0 API Shutdown – FINAL ALERT

These integrations will not function properly after August 15

Dear BIM 360 Account Administrator,

The deprecation deadline for the BIM 360 Issues version 1.0 API has been extended to August 15, 2023. After August 15, the BIM 360 Issues version 1.0 API will no longer be available.

We noticed you still use BIM 360 Issues API v1 with the integrations listed below. These integrations will not function properly after August 15:

What you need to know:

This affects only the "Backup Project" task when run on a BIM360 project, only if you have the option selected to include Issues.

This has already been addressed in the 2024 version of the software and an update will be released for 2023.1. 

You can see the posted updates here:

• 2023.1:  http://s3.amazonaws.com/IMAGINiTSoftware/Updates/ClarityTask2023_1_History.txt
• 2024.0:  https://s3.amazonaws.com/IMAGINiTSoftware/Updates/ClarityTask2024_History.txt

Older versions will not be updated to address this issue.  You can still run the backup task, you just will need to set Include Issues to No.

If you want to include Issues, you will need to upgrade Clarity to a version that supports this.

In the older BIM360 Teams-based approach, Clarity used what is called "Three-legged-Oauth" to connect to A360/BIM360. This meant that we requested access, and you supplied a user whose credentials would be used to access A360/BIM360. The Clarity server at your facility could see ONLY the hubs/projects that the designated user was able to see. 

In the new BIM360, Autodesk created an additional step - an application-based permission for Clarity. BIM360 administrators must enable access to Clarity for their whole hub/account. Within this setup there are two options:

     - Account Administration - allow Clarity access to read and write all user/project information (WE DO NOT NEED THIS)
     - Document Management - allow Clarity access to read and write all file information (WE DO NEED THIS)

In order for Clarity to have ANY access to the data, Clarity must be given access to the Document Management integration, which implies access to all files in all projects in the hub/account.

Things that are important to understand:

   - Clarity does NOT use this access. Clarity continues to only use the designated user's credentials to access data, and can only see the projects, files and folders that the designated user can see. Clarity can only update the files that the designated user can update.

   - From a security perspective, however, Clarity is operating with potentially more permissions than it needs (or wants).

   - IMAGINiT is working with Autodesk to make a clearer mechanism which allows only the access that we want (user-based).

For example: 

- Need to upgrade from C4R/Revit 2018 to BIM360/Revit 2019? We can help with that!

- Migrate from one BIM360 hub/project to another

Using Clarity for the Migration Process

In most cases, these processes take several steps:

1. Getting the models out - either using the PublishRevitModel, or A360Download to pull files out of where they are currently residing, into a local UNC path on disk.

   - For A360/BIM360, depending on your version of Revit, you might want to (or need to) use Published models to migrate. If so, consider running the C4RPublish task to force the latest versions of the models to publish.

   - If you use the A360Download task, consider using the new option to "Unzip" the RVT files.

2. While it's possible to directly have this happen as part of the "UpdateRevitFromDisk" task, it's probably better to run a standalone server task to Upgrade the models to a newer version of Revit (this way you can see and resolve any issues).

3. Pushing the models into BIM360 - create the project within Clarity, pointing to the new BIM360 project location. Then setup the "UpdateRevitFromDisk" task, with the "Scope" set to the project. This will look at all files in the "From Folder", and will set them all up within the BIM360 as cloud shared Revit models.

    - You can have the files dropped into the top-level folder and then re-path them later if necessary, or you can setup a "To Folder" subfolder (specifying just the name of the "Subfolder" to drop the models into).

Starting in Clarity 2021, it is also possible to specify worksets with BIM360 projects (in this case you must have run the RevitDBExport task at least once).

You can use these workset settings to:

• Improve performance by not opening all worksets
• Control visibility

On the "Advanced" tab, it's also possible to specify wildcards - as well as negative wildcards (such as "don't show anything that includes the word LINK in it).

One final note: tasks will be bundled together based on common workset choices. If one task specifies ALL worksets, and another has specified other specific worksets, these tasks will not run together (the model will be opened twice). You may also define a task sequence, and apply the workset choices at the task sequence level (which will override the individual task workspace settings).