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

Issue

If you tried to kill a task in the current tasks queue, or it shows that it has been in progress longer than expected, it's likely that Revit is unresponsive or has crashed.

The task will eventually clear itself out of the list of current tasks, since only the task server can notice that the Revit.exe process is no longer running and mark it as "presumed dead".  

The problem is, this could take some time, so if you want to hurry things along a bit you can try the process below.

Resolution

• Log onto the Task Server as the designated

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.

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

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

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

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

Due to a new project limit restriction on the 16.x versions of the Desktop Connector, we have added a new setting in the Clarity task tray, that will allow us to swap out the least used project, with a new one.

IMPORTANT NOTE:

If the screen is left in a locked state, it is not possible for any UI Automation to run. This is a Microsoft limitation from a security perspective.  That means that in order for this to work and swap projects, the machine must remain unlocked.

Desktop Connector

You will need to make sure you first select the

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

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

Issue

You are trying to test something manually in Revit on the task server, and the Task dialog is launching when you launch Revit, even though the Clarity Task Tray is exited.

Cause

When the Clarity Task Tray for Revit is running, it puts an addin in the addins folder while Revit launches to pick up a task, when we are done with the task, we try to delete it...if we are unable to delete it due to permissions issues generally, then that dialog will come up even though the task tray is not running.

Resolution

You need to make

Windows path length limitations will come into play when the fully qualified file name exceeds 260 characters, or the directory name is greater than 248 characters.

The error will look like this in the AdminWebservice Log

TaskService - UploadFile(): Exception while uploading file System.Web.Services.Protocols.SoapException: Unable to create target folder on server! PathTooLongException ---> System.IO.PathTooLongException: The specified path, file name, or both are too long. The fully qualified file name must be less than 260 characters, and the directory name must be less than 248 characters.

There is a configuration change that can be made on the task servers (versions 22.1.11

There is now a way in Clarity 2024, to configure an override when there is an error opening the model like the one shown below.

For Clarity 2025 refer to this blog:  https://imaginit.helprace.com/i659-clarity-2025-task-tray-configuration-for-error-overrides 

Error: One or more dimension references are or have become invalid.

This configuration change is done at your own risk and will apply to all models on this task server that have the configuration files modified.

WARNING

This modification will allow us to delete the dimension(s) so we can continue processing the task, this means that those elements will not show up in the model for that task. 

This change is on a per Revit version basis.

For Clarity 2025, Refer to this blog post:  https://imaginit.helprace.com/i659-clarity-2025-task-tray-configuration-for-error-overrides 

There is a way to say “Continue Loading” for this kind of Schema Conflict dialog.

We are currently programmed to always hit “Do not load” for that specific issue, because there’s a risk of data loss.  When we do that it kills the task.

IMPORTANT NOTE

Please be aware, this configuration change is at your own risk, and you understand that it will change the model during the task, and you are ok with that.  For most tasks, we don't save the changes

This is done at your own risk and will apply to all models on this task server that have the configuration files modified.

WARNING Modifying the ClarityTaskTray.exe.config and setting it to “true” will “Always hit the OK button, if there is one”, we feel like this is at least a little bit dangerous, so we don’t have it on by default.  There will still be dialogs this won't work on, since not all dialogs have an OK response.

Make a copy of the original config file before modifying it so you have a backup. If you edit the config file incorrectly

The Revit DBExport task is the most common task used in Clarity.  This will export information that populates tables in the database.  That information will populate for Data Sheets, Reports and various dropdown selection dialogs for other tasks.

There is no physical output for this task.

This document will help you decide what settings you need set, to get the information you need.

Time Saver Note

The Revit Database Export task can be run with worksets closed (NONE) to improve efficiency without compromising the data exported, however if you need svg images for datasheets or reports, worksets will need to

The Navisworks conversion and Autocad tasks are run as a Clarity Windows Task Server task.

The following must be done on each task server that will be running the tasks.

Start by logging onto the task server as the designated Clarity account.

Clarity Task Automation Service Configuration

In the Clarity task tray, you must set it to use the Clarity Windows Task server.

On the Configuration tab, Edit the Server

Expand Windows and make sure that the tasks you want to process are selected.  Ok out of dialogs.

Services

Set the logged-on Clarity Windows user account as the Log

The process is the same as in Windows 10, but they did a better job of hiding it.

To add a form

• Go to Control Panel\Hardware and Sound\Devices and Printers • Select the printer you want to add a form to • Select Print Server Properties • In the Print Server Properties dialog, Forms tab • Create New Form • Enter name and dimensions (These are intentionally entered backward in here) • • Save Form

Which tasks report Metrics in Clarity?

Model Metrics has most of them, then Performance Advisor.  for other tasks or configuration settings that pull model information, please refer to the information below for additional information.

Metrics Tasks and Configurations

1. Model Metrics
2. Performance Advisor
3. BIM Interoperability Model Checker
4. ClarityClient
5. The Task Server open time
6. Index Model Families

Model Metrics

Help Link

Metrics Captured:

• # of Sheets
• # of Views Not on Sheets
• # of Families
• # of Families Used
• # of InPlace Families
• # of Hosted Families
• # of Purgeable Families
• # of Links
• # of CAD Links
• # of Revit Links