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

The Clarity App Must Be Active

If you haven't already added the app, here are instructions on how to Add the Clarity App

The very first requirement is that the Clarity App be Active in 360/ACC

360 Project Configuration

The Oauth identity setup in Clarity must be a project member of all projects you want to add to Clarity. That identity must also be a part of the document management team with appropriate permissions to the folders you need to access to be able to perform the tasks you want to run on the project.

You likely have multiple 360

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 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 circumstance of concurrent

If you are trying to update the software and are running into the following error message

Could not load file or assembly Ionic.zip, you will need to copy the file from another location to resolve the issue.

Resolution

Log onto the host as the Application Pool identity

Through File Explorer, browse to: C:\Program Files\IMAGINiT Technologies\Clarity Monitoring Service

Copy the "Ionic.Zip.dll" file to a network location that you can access from the task server. Copy that dll into the following folder on your task server: 

C:\Program Files\IMAGINiT Technologies\Clarity Task Server for Revit Make sure it isn't blocked by right clicking and

If you want to set up Office Locations to specify for Task Servers, there are a few places that needs to be set.

In the Clarity Web Portal

• Log into the Clarity web portal as an Admin
• On the Server tab, Offices, add the office locations.
• Once you assign an office to a project, it will increase the number of projects.
• Once you assign an Office Location to a task server, it will increase the number of Task Servers.

On the Task Servers

• Log onto the task server as the designated Clarity account
• Open the Clarity Task Tray
• On the

Reboot the machine after upgrading if you haven’t done so already, this may fix the issue.

The 503 Error means there is an issue with the application pools, typically this means they aren't running and the most common reason is the credentials.

Log onto the host machine as the Clarity service account

Check the Application Pools Open IIS (Internet Information Services) Select Application Pools on the Left

There are three Clarity application pools Right click on each one in turn and stop the service if it is running

Right click again and go to Advance Settings

Select Identity then select

I thought it might be helpful to see some examples of what the in-session Appearance settings looked like and what the time differences and file size difference are.

Time Saving Tip

In a nutshell, unless you are printing 3d views for final prints, you can probably get away with Low for the raster settings for Appearance.

Hardware

In this test I am using the Clarity PDF driver the Task Server on my laptop

• Windows 11
• 13th Gen Intel(R) Core(TM) i7-13850HX 10 GHz
• 64gb Ram
• NVIDIA 6gb gpu

Clarity 2025

Same set each time with Raster set to Color

Clarity PDF

If you changed the password to the account you use to run your Clarity services, this will stop Clarity from functioning properly until the password is updated in all locations it is used.

Host

On the Host this identity is generally used for the following:

IIS

• ClarityReportingAppPool
• ClarityWebAppPool
• ClarityWebServicesAppPool

To Update

• Right Click and select Advanced Settings
• Select Identity, then the ...
•       
• Select Set
•      
• Enter the Domain\Username, then password and confirm.
• Start the Application Pool
• Repeat for the other two.

Services

• Monitoring Service
• Clarity AD Sync Service

To update

• Right click and select Properties

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

Issue

There is a security feature in Clarity, if you try to log into the web portal, or through the task server configuration with the incorrect password more than the number of times set in settings, the account will be disabled.  

You can modify this setting from the Server tab, Settings.

The task servers commonly use the Clarity@rand.com login, this account is sometimes also used in the Clarity Active Directory Synch tool on the host on the Clarity tab, you will want to update it there as well.

You will need to update it in all locations or it will

In order to enable Clarity to access ACC projects, the account manager must specifically enable access at the Account level.

To enable access:

1. Sign into the ACC portal as an Account Admin:  https://acc.autodesk.com/
2. Select the Apps icon
3. Select the IMAGINiT Clarity app and Install

   2. We only need access to Document Management
4. The icon will change to look like the image below and will show as Active.
5. The published files should show up in Clarity after about 5 – 10 minutes.

  Note: The Clarity ACC integration relies on the Forge interface for Project/model information; therefore, the models do not exist

Upgrading Clarity to a new version of the software requires running the Setup.exe.  While it is not as simple as running the Updater from the desktop, it is not overly complex.

There are video links below on the install process as well as blog links.  If you would like assistance with the install, please contact your sales representative to get some Design Assist hours (perhaps 2 hours) for a typical installation.

IMPORTANT NOTE

It is recommended that you have a current backup of the RandRevit database.

If Backup System Database is set to True in the General System Settings, you should

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 (not typically recommended due to permission issues). 

When referring to the Revit System Requirements.

Do not go with anything lower than the Value, but Performance is recommended, or value with double the ram if you have large models with multiple links.

If you choose to use virtualization, be aware that graphic intense tasks will not perform as well without a physical graphics card.  Refer to the Virtualization section below.

Want to see what’s updated in Clarity?

Clarity updates are issued as needed, rather than on a schedule, so you can check to see what is in each update in the links below.

Update Links 

Check your version(s) below for the latest notes and updates. Keeping up to date with the most current Clarity Version is always a good practice and may help prevent Task issues that may arise during your daily workflow.

 2025.1                                                    

Issue

You replaced a task server, but you can still see the old one on the Task Servers list

Cause

The task servers will drop off the last after Clarity hasn’t seen them for 21 days, unless there are still projects assigned to it.

You can force the removal as long as there are not projects assigned to the task server.

Solution

In the Clarity web portal, Task tab, Task Servers, select the task server to see if there are any projects assigned to it. 

If there are Projects assigned, you will need to go to each of the projects

The ClarityClient2021ClientRevit.exe is built with InstallShield, which supports most MSI-style options, including passing them thru to the MSI.

See this link for install options for the Clarity Client installer: 

https://docs.revenera.com/installshield21helplib/helplibrary/IHelpSetup_EXECmdLine.htm

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

If you need to change the path, the version or any other setting specified in the project settings you will need to edit the project.

How to Edit the Project

From the Project Home page, select the pencil and checkbox in the upper right corner, Edit Project.

Select the Project Type tab

To Change the Version of Revit in the Project

If you need to change the version of Revit used for the project select update version. 

This will not upgrade models, it simply sets the version of Revit used to perform tasks.

On the Project Type tab, select Update

The monitoring logs, with the default settings, will roll over at 100kb.

If you have a large amount of data, they will likely roll over too quickly for us to find the information we need for diagnostics.  To resolve this, and capture more data, we need to modify a config file.

Log onto the host machine as the Clarity Service Account

Go to the following folder:

• C:\Program Files\IMAGINiT Technologies\Clarity Monitoring Service

• Make a copy of this file: Log4net.config and rename the copy extension to .ORIG

• Edit the Log4net.config with Notepad

• Change the value as shown below to increase the file size

Issue:

Error sending task diagnostics from the host when things are locked down due to security reasons.

If sending diagnostics normally works, then clearing the logs folder will likely resolve the issue and this configuration change is not needed.

Please refer to the following blog to clear the logs folder:  https://imaginit.helprace.com/i602-how-to-clear-the-task-server-logs-folder

 Process:

1. Log onto the task server as the designated Clarity account
2. Exit the Clarity task tray and stop the Clarity Windows task server service in Services
3. Zip the content of the logs folder (replace the highlighted value with your version of Clarity if different): C:\ProgramData\IMAGINiT Technologies\Clarity Task Server 2024\Logs
4. Delete