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

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

Issue:

Port changes with new email sending library called MailKit.

Cause:

Customers were starting to run into occasional issues where we had problem sending email with TLS/SSL, and because it was related to a Microsoft Component for sending mail that they’ve deprecated. In Clarity 2022 we brought in a new email sending library called “MailKit”.

It turns out that Mailkit behaves a bit differently than the original Microsoft component.

- It basically ignores the “Use SSL” option you specify, and infers the setting from the port number. MailKit said: “You do not have a valid certificate for this mail server”.

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

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

Autodesk has previously announced that they are discontinuing support for a Forge API used to upload models to BIM360. They are basically stepping out of the middle, and encouraging all Forge developers to upload directly to Amazon S3. This discontinuance is planned for September 30, 2022. (interested in more info? See Here)

In order to be fully supported for all features of integration with BIM360, you must be updated to at least the following Clarity Updates to not encounter problems (depending on your Clarity version):

Older versions are not currently planned to be supported.

Updates are applied by running the

Issue:

The log files are rolling over too fast to help with troubleshooting.  When we request diagnostics for a task that ran into an issue, these logs, along with the journal if it is a Revit task are what we use to determine what happened.  If they are out of date, we can't see what happened.  Changing the configuration to larger files and/or more will cover a larger time span.

Solution:

Increase the file size and/or the number of logs.

There are three different types of logs, they record different information based on the type of task.  The log configuration

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

We're excited to announce the release of Clarity 2023!

This includes a wide variety of features including:

• Support for Revit 2023 / Revit Server 2023
• More Tools for Task Monitoring and Alerts
• Usability Enhancements
• Optional Auto-Create of new BIM360 Projects
• New and Improved Tasks, including  Audit/Purge/Compact, Export STL/OBJ/SAT, and enhanced PyRevit support
• and much more...

You can read all about the release notes here:

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

What's New Webinar Recording is here:

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

All permanent license customers should have received their new Authorization Codes via email on May 17th.

All subscription customers should receive communication with how to coordinate with support

Hi folks - 

In reviewing the feedback from the survey here, we saw that a lot of people had updated to our recently recommended Desktop Connector (15.4) - but were still encountering issues with tokens.

We continued to work with Autodesk on why this was - and we recently realized that a significant percentage of companies that deployed Desktop Connector 15.4 or 15.5 STILL did not get the update to ADSSO that was supposed to be included in these updates. It is not clear why. But the key to fixing the token issue is technically not with Desktop Connector but

Interested in what's coming in Clarity 2023? Even better, interested in giving us 30, 60 or 90 minutes for beta testing to make sure we've got it right for you?

Come to our sneak peek webinar for Clarity 2023:

https://attendee.gotowebinar.com/register/739984941998158607?source=a2u4u00000100n1AAA

Hi folks - 

We hope that you've seen our link about the Autodesk Desktop Connector update making some significant improvements in the BIM360 Revit token issue.

We were hoping that you could take a super quick survey just to tell us your experience with it.

We're working with Autodesk on the issue, and they'd like to know if what they've done has "moved the needle" or not.

Survey here:

https://s.surveyanyplace.com/clarityusers2022

Thank you for your time!