Please be aware:  If you have Clarity with Revit Server, the Clarity Host install will need to be done off hours when no one is accessing the models.  If you have Clarity with just file based and or 360 projects, then you can do the install at any time.

While the upgrade is not as easy as our “patching” updates, it’s not too hard. These are “setup.exe” installations, and if you follow the instructions below, you are unlikely to run into any issues.

If you don't feel comfortable doing the upgrade yourself and would like to have us assist you

Issue

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

Prerequisite

.NET 6.0 Runtime installed

Download Link

Make sure the service is set to Log On as the Clarity Service account.

Issue:

The Journaling service won’t stay running even though the dotnet 6 is installed.

Solution:

We need to make a configuration change to the appsettings.json file in this folder on the host:  C:\Program Files\IMAGINiT Technologies\Clarity Journal Service

Process

Make a backup of the appsettings.json file and change the extension to .orig

Modify the .json file in Notepad.

Add the line below, (highlighted in green in the screen shot) after the password but before the “

;TrustServerCertificate=True

If you get

If a task is stuck in the claimed status, the task server started opening the model, but something happened during that process that hung things up.  We aren’t able to kill it from the Clarity web portal, so you either have to wait for it to time out, or manually kill it on the task server.

If you are trying to get other tasks to run, you probably don’t want to wait for that to happen, so the resolution is to manually fix the issue on the task server.

Causes:

If we are waiting for a response in Revit while

For certain types of tasks, addins are required.

We recommend only installing the addins needed for tasks. 

Some Autodesk addins install automatically with the software, but others are a separate install.  If they are not on this list, please do not install them as they may interfere with the Clarity software.

Please also be aware that some addins can cause ownership issues when processing tasks.

Additionally, some addins are build specific and may vary by Clarity version.  Please refer to the information below.

Revit Addins

Additionally, you will need to install the necessary add ins per version as needed for

Please make sure you have your Authorization code prior to starting the upgrade. 

ANNUAL LICENSES

If you have annual licenses let us know the activation count needs to be reset.  Please provide your current authcode which can be found in the IMAGINiT.lic file on the task server in this folder:  C:\Program Files\IMAGINiT Technologies\Clarity Task Server for Revit\License

Email us that information at Support@rand.com

INSTALL PROCESS

1. On the task servers log in as the designated Clarity account.
2. Make sure the new version of Revit is already installed, including addins needed for tasks.
   1. Revit 2023-24 only supported OS is Windows 10 or

Most customers using Clarity, also have projects in 360, so your account administrator should have received an email from Autodesk stating that the Issues Version 1.0 will no longer be supported.

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

BIMTrack integration requires its own credentials to access all projects on BIMTrack for the Backup task and Upload post action.

In BIMTrack, it is a two-legged OAuth Token, giving access to Clarity to a particular BIMTrack hub.

There is NOT a different set of credentials per user.

You only need one API token to have access to all projects on a BIMTrack hub.

Setup

• Go to your BIMTrack hub and retrieve the API Access token.

  • In BIMTrack - Hub Settings > Gear Icon > API Access Token

  • Go to the Clarity Server/Settings/OAuth page, BIMTrack and add credentials.

  • Enter the hub name

There are certain types of errors that will kill a Revit task.  Previously it was necessary to manually modify a config file.

In Clarity 2025, you can now just make the configuration changes in the Clarity task tray.

Make sure you log onto the task server as the designated Clarity account

Error Handling Overrides

• Open the Clarity task tray
• On the Revit tab

On the Revit tab, under Revit Error Handling Option, there are a few options, if you want to make selections you will want to set it to specified.

• None
  • No overrides
• Detached Only
  • This would only apply

For those who are security-minded, there are some nuances to understand about the BIM360 Security Model, when used with Clarity or with any BIM360-enabled tool.

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

If you are unable to use the updater tool to automatically download and install the updates due to network restrictions, you can download them and run them manually.

DOWNLOADS

First you will need to download and extract the following into a folder on the machine or on your network… For example C:\Clarity\Updates

Host

• http://s3.amazonaws.com/IMAGINiTSoftware/Updates/ClarityHost2023.zip

Task Servers

• http://s3.amazonaws.com/IMAGINiTSoftware/Updates/ClarityTask2023.zip

Updater Files

Download the updater files from the links below and place them in the same folder as the extracted content above.  For this it will just bring up a web page with that text so just right click on the page and

Update:  10/1/2024 with preferred method

Error That error means that the file is too large to send back to the host via http so the config file needs to be modified to allow for larger file sizes. Task Error There was an exception running the extensions specified in the config file. ---> Maximum request length exceeded. If you exceed the default maximum file size which is 400000 you will need to fix a config file to accommodate processing larger file sizes, or enable uploading in chunks (preferred method).

Resolution Options

Preferred Method 

On the Task Server

Enable Upload in Chunks

The Clarity Windows Task Server will process tasks that don’t require opening Revit. 

Some of the setup is inside of the Clarity Revit Task Tray, but since this runs as a service by default, the rest happens in the properties of the service itself.

Settings in the Clarity Task Tray for Revit

To limit the Windows tasks run on the task server, open the Clarity task tray, select the Server and Edit, go to the Tasks tab, expand Windows and Uncheck any tasks you don’t want processed on this task server.

Settings for the Service

Open the Services panel and select the

As you begin to have projects that you want to migrate from older versions of Revit to BIM360, Clarity now (in 2019.1.6) has some updates that can help you with this process.

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.

As of Clarity 2023 we have had the ability to set the task server to perform the post action locally.  This applies to all post actions.  The one thing to be aware of is, depending on the type of post action and where it is processed, the identity can be different.

There are cleanup options in the Clarity task tray, which if checked will try to run once a day about 24 hours after the task tray was started last. Note: We cannot do the cleanup if Revit is running, so if tasks are always running, the cleanup may not occur. There could also be permission issues with deleting things as well at times.

So, if you want to clean up things manually, I have listed the locations below where you can regain some drive space.

You may also want to consider using the Windows Task Scheduler to clean things up.

What is the Clarity Task Utility?

It is a Windows-based tool, installed with the Clarity Host software, which can do some batch updates on tasks and task definitions.

Where is It?

C:\Program Files\IMAGINiT Technologies\Tools\Clarity.TaskUtility

What Can It Do?

• Manage Current Tasks
  • Select the tasks in the grid, then for the selected tasks:
    • Kill Them (request that Revit be shutdown if it's working on them)
    • Delete them (remove them if Revit has not yet claimed them)
    • Reprioritize them to a new priority level
• Manage Task Definitions
  • Select the tasks in the grid, then for the selected tasks:
    • Batch Copy them to

Since Clarity 2020, it's been possible to specify worksets on a given task. If you've run the RevitDBExport task, then you could see the worksets to choose from on the "Basic" tab.

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

Issue

If you are unable to send diagnostics from the Clarity web portal completed task id, sometimes clearing the content of the logs folder will resolve the issue.

Process

• Log onto the task server as the designated Clarity account
• Exit the Clarity task tray, by right clicking on the Clarity icon and select Exit
• Open Services and Stop the Clarity Windows Task Server Service
• From File Explorer browse to the logs folder for your version of Clarity
• Example: C:\ProgramData\IMAGINiT Technologies\Clarity Task Server 2024\Logs
  • You can zip the logs folder if you want an archive copy or need to send them

You can increase productivity by running some of your tasks with Worksets set to None.  This will improve the open time, dramatically in some cases, depending on the size of the file and the number of links.

Below is a list of tasks that can run with worksets set to None without impacting the output from the task.

Revit Tasks

• Backup Project
• Backup Revit Server
• BIM360/ACC Publish
• BIM 360 Migrate
• Family Upgrader
• Harvest Families
• Index Families
• Index Model Families
• Model Checker
• Model Metrics
• Model Review
• Model Upgrader
• Performance Advisor
• Quantity Snapshot
• Revit Audit and Compact
• Revit Database Export
• Unless you