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

Forbidden Characters

As a rule, all of the symbols below should be avoided, in both file names and folder names to reduce the likelihood of issues in various environments.  An underscore _ as a separator is always acceptable.

The table below shows what and where a symbol not allowed (No) or is allowed (Yes) or not specifically listed as not allowed.

• Don’t add a space at the beginning or end of a file or folder name. 
• Use less than 260 characters in file or folder paths, 245 for Egnyte.

Current Clarity version at this posting:  2024.1.2

2/9/2024

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. 

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.

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 the following into a folder on the machine or on your network… For example C:\Clarity\Updates

Host

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

Task Servers

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

Updater Files

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

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

Interested in seeing what is coming in the next version of Clarity?

Come to our webinar on October 18.

Click Here to Register

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

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

Clarity Task Server 2024 has a feature which does its best to auto-select whatever projects your are performing tasks on within your Desktop Connector environment. This is an inexact approach, but it is all that Autodesk allows us to do (we've pushed them for an API, or a change in behavior to better support Task Servers).

When 16.3 Desktop Connector was released, some customers saw problems with our automation to auto-select projects. On August 3rd, we released a task server update that mitigates the issues that were seen.

We still recommend staying on Desktop Connector 15.8 for as long as

6/27/2023

For clients using named user licensing, Autodesk has started enforcing that one named user cannot be logged in on 3 machines at the same time doing work.  When that happens, you will see the following warning, which will only allow you to have this user account accessing software on one machine at a time.

What Autodesk has told us in these cases is: The legitimate way of using Clarity with named-user licenses, is to have each task server have a separate email (user license) for each task server, just as if you had robotic interns sitting at each one doing

Introduction

These prerequisites are required for all types of Clarity host.

This guide does not cover the full configuration and operation of the software – merely the host system requirements and prerequisites.

Hardware/Operating System Requirements

Clarity requires a server-class Windows Server operating system to be the central web server. 

A dedicated server is highly recommended.  Whether you will be using Revit Server in your environment or not, the prerequisites are the same for Clarity so the System requirements below should be referenced.

I highly recommend that you go with the Performance requirements, but no less than the Value for either

The Clarity Team is pleased to announce the availability of Clarity 2024.

What's In This Release?

• Support for Revit 2020 thru Revit 2024 (with limited support for Revit 2019, via an older Task Server).
• New integration mechanisms with BIM 360 / ACC and General Web Triggers to make tasks fire.
• More metadata integration mechanisms, including pushing Revit metadata to BIM360 during Publish
• Significant enhancements to the Unified Sync task
• Automatic management of selected projects in Desktop Connector 16.x

For more Release Notes, click here.

How Do I Get It?

The designated contact for your firm will receive email(s) in the

Issue

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
    • Select Check to see what Hubs/Projects you can see with that Oauth 
      • https://imaginit.helprace.com/i484-clarity-how-to-reset-the-360-oauth-credentials
  • 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.
      • It should at least be set to Project

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

We recommend that the task servers be at least comparable to workstations used in production, if not stronger, especially if you are planning on running multiple sessions of Revit and or multiple logins. 

When referring to the Revit System Requirements I recommend that you go with the performance requirements.  If you choose to use virtualization be aware that graphic intense tasks will not perform as well without a physical graphics card.

System Requirements

Please refer to the link below for specific information.

Revit System Requirements

Operating Systems:  Windows 10 or 11

Supported Versions of Revit

Revit 2019-2023

Software Licensing

Any

Clarity 2023.1 has been released!

You can see what's new in this webinar:

https://resources.imaginit.com/building/whats-new-in-clarity-2023-1

For the documentation showing what's new, check out:

https://s3.amazonaws.com/IMAGINiTSoftware/Documentation/Clarity/2023.1/index.htm#t=Releases%2FCurrent%20Release.htm

On December 1, the designated technical contact within your company should have received via email the download link to install the new version of each software.

If you've got questions, please contact the IMAGINiT Support Center at support (at) rand.com.

Thanks!

• Open the Clarity task tray, select the Server and Edit
• On the Host Info tab, note the identity set on the configuration tab for the server.
• OK out of the task tray
• Exit the Clarity task tray
• Go to Services and note the identity assigned to the Clarity Windows task server
• Stop the Clarity Windows Task Server service
• Uninstall Clarity Task Server Installation from the control panel
• Browse to the following folder and move the IMAGINiT.lic file to the desktop so you don't have to relicense the software if you are reinstalling the same version.
  • C:\Program Files\IMAGINiT Technologies\Clarity Task Server

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

For the silent install please refer to this article:  https://imaginit.helprace.com/i285-clarity-client-for-revit-silent-install-options - Alternatively, if your deployment system would prefer to work with MSIs, it's possible just by running the executable to retrieve the underlying MSI from the %TEMP% folder, and copy it elsewhere for usage. Other Configuration:

The other configuration cannot be dealt with in scripts, you will have to push config files out to people. The following are the relevant configuration files:

This has relevant info about what information to send in (unauthenticated), plus the "DefaultServerForMetrics" indicates what server it should be sent to when not authenticated. This also includes the