Add-in Tools

• Change Request
  • To access the data editing features in Clarity to review, approve or reject data changes
• Launch Tasks
  • If you launch an enabled task on the current model
• Show Project
  • This is a link to the project associated to the open model
• Model Metrics
  • Run Model Metrics on the open model
• Model Event
  • Report a model event on the open model
• Other Functions / Settings
  • Remove an accelerator
  • Send Diagnostics
  • Check for updates
  • Auto-login
  • Send Revit Server warnings to host
  • Send Revit Server errors to host
  • Send Open/Sync times to host
  • Send Model Working times to host

The add-in adds an IMAGINiT tab to the Revit ribbon

Before you are connected to the host server

After you connect to the host server

 Space Planning Module (Optional Addon)

If your host server has the Space Planning Module installed, you will also see that panel

Connect

To sign in, select the Connect icon

Enter your Server name, you will enter the name seen on the Server tab, Settings, Server Public Name

Secure:  If your site is secure you will select this toggle (https:)

UserID: You will log in with the same credentials you use on the Clarity web portal

Connect then Close

If you use Single Sign On, it will direct you to your SSO login page.

Change Requests

If you have a Global role of Change Request Editor and are assigned to the project in Clarity, if there are changes available, then you will be able to see and review the requests in Revit.

Help link

Tasks

Tasks must be set to Launchable to be available to run from Revit

You must be assigned to the project or have a Global role that allows you access to tasks.

Show Project

This will open the project in the Clarity Project Home page in the web portal. 

Be aware that if you have two projects set up in Clarity, that are pointing to the same project in 360, it will open the first one that was created.

You will still need to log into the web page.

Model Metrics

Model Event

You can report a model event

Add notes on what happened

https://s3.amazonaws.com/IMAGINiTSoftware/Documentation/Clarity/2026/index.htm#t=User_Guide%2FModel_Events.htm&rhsearch=model%20event&rhhlterm=model%20events%20event

Tools

Diagnostics

Diagnostics will give us more information for diagnosing issues with the software.

Select Collect Data, this will gather the information and the journal, then submit.

 Error Report Dialog

If you run into this dialog, please submit the diagnostics for us to review so we can try to resolve the issue.

Make sure to provide your name and email address before sending.

The image shows the Revit ribbon when a model that is setup in a Clarity Project is open.

2026

http://s3.amazonaws.com/IMAGINiTSoftware/ClarityClient2026.0.zip

2025

http://s3.amazonaws.com/IMAGINiTSoftware/ClarityClient2025.zip

2024

http://s3.amazonaws.com/IMAGINiTSoftware/ClarityClient2024.zip

Note:  This will only track when you open a file that is workshared.

To Set Default Server for Metrics

You will need to edit a config file on the users machine to make this change.

• The config file location is in the following location for all versions of Revit.
  • C:\ProgramData\IMAGINiT Technologies\ClarityClient.dll.config 
  • Make a backup copy of the file before changing anything and change the .config to .ORIG
  • 
  • Open the .config file in Notepad and add your server name between the "".
  • 
  • If you would also like to track model time and idle time, make the following changes shown above for those two items.
  • Saveas
    • 

  • If you get an error saving the file, save it to the desktop, then move it into the folder and overwrite. 

    Make sure it is still seen as a configuration file or it will not work.

This information is sent back to Clarity once Revit is closed.

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 Send Open/Synch Times to host, etc.

• C:\ProgramData\IMAGINiT Technologies\ClarityClient\ClarityClient.dll.config

If you want to adjust the behavior of the updates that are released (do you want it to check for updates on the internet and ask people to update, or less often, or point to your own internal update location).

• C:\ProgramData\IMAGINiT Technologies\ClarityClient\IMAGINiTUpdater.exe.config

This contains the default options that are shown in the drop-down list for the "Connect" screen. It includes the Clarity Server, which type of Clarity Server, and whether the SSL and SSO checkboxes should be checked.

• C:\ProgramData\IMAGINiT Technologies\ClarityClient\RecentServers2013.txt

This is similar to the ClarityClient.dll.config settings defined above, but is intended as a per-user or per-machine override. The one notable thing that you could put in there is the "AutoLogin", (yes/no), which will attempt to login the user if their credentials have been stored.

• C:\ProgramData\IMAGINiT Technologies\ClarityClientSettings.xml

User Credentials that are stored. These are stored in the user folder:

• C:\Users\<user>\AppData\Local\IMAGINiT Technologies\Clarity\Servers.txt

It is not really possible to pre-populate this with their stored password, it is encrypted.