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

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

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

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

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.

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

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

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

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

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

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

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

There are several factors that control or impact task processing, please refer to the information below.

Types of Task Servers

There are several types of Task Servers that can be enabled in the Clarity task tray.  For each of these, the proper identity must be associated to it.  For Revit tasks, the logged in windows session should be the designated Clarity account.  For the Windows task server, the service account identity needs to be the “log on” in that service.  Forge requires credentials and a key.

• Clarity Revit Task Server
  • This will process tasks that require opening the Revit model.

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

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

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

Using the Adobe PDF Driver in Clarity on a Task Server requires one unusual step.

The necessary registry keys for Clarity to work with do not exist until you have opened the Adobe PDF options dialog, where you can see the options for "Prompt the User" and the default folder location (the dialog looks different in different versions of Adobe Acrobat/Distiller).

If you have not done this step, you may see an error such as this in your task server, and the task server WILL NOT CLAIM the PDF task.

(10/28/21)

At present, the best combination that we are seeing for stability seems to be:

• Desktop Connector: 14.10.0.1456  / AdSSO: 12.3.3.1803

Other "Known Good Combinations" include:

• Desktop Connector: 14.11.0.1476  / AdSSO: 12.2.2.1802
• NO Desktop Connector (if you can live without it) / AdSSO:12.3.3.1803

You can see the versions you have installed in the Control Panel, Programs and Features.

As you know, the Desktop Connector releases come out every month, so it's difficult to keep track of exactly which combinations work best. If you don't see your version combination listed above, it may still be fine - but if you're encountering issues with

Issue

You are replacing a task server, but you don’t know the process for doing so.

Solution

Contact our support team at support@rand.com and let us know the name of the machine being retired and the authcode in the current license file so we can reset the activation count.

The task server license file is located in the following folder on the task server.

C:\Program Files\IMAGINiT Technologies\Clarity Task Server for Revit\License

We need the 16 digit code, it will look something like this: 1234-ABCD-5678-EFGH

On the Task Server you are Retiring

• Exit the Clarity task server task tray
• Stop the