Knowledge Base

  • Clarity Task Server Office Location Configuration

    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
  • Clarity Task Basics Setup-Above the Line

    This blog is to cover the basic task setup Above the Line

    When I say ‘above the line’ I am referring to the area shown below which is common to most tasks.

    I am using a PDF task in this example, but this will apply to most Task types.

    Above the Line

    This is where you will set the basic settings of the task

    1. Name

      1. The name of the task: I tend to name mine relevant to what type of task it is and how they are set up
        1. In the example above PDF is the type of task, E1
  • Clarity Client Functionality

    The Clarity Client addin for Revit which can be used for Revit Server Security projects, but can also be used for a variety of tasks and change order tools with all kinds of Projects.

    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 /
  • Clarity 2026 Host System Requirements

    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 users.

    Projects must be stored on a physical drive meeting the requirements below.  NAS or

  • Clarity Navisworks Task Setup Reference

    Task Processor:  Revit Task Server

    Requirements:  Navisworks Exporter Installed for Revit (version specific)

    Above the Line

    Basic Above the Line task setup information can be found at the following blog post

    https://imaginit.helprace.com/i746-clarity-task-basics-setup-above-the-line

    Navisworks Task Setup

    1. Specify the view(s) you want to export by using a view set, or expression
      1. Selecting the ….. brings up options to use Expressions or View/SheetSet Selection options
      2. Expression example for views that contain 3D Navis
        1. View Name=~3D Navis
        2. If you have done a Revit Database Export on the model, you can see the sets that are available to export if you prefer to
  • How to Force an Update to Rerun

    If an update doesn’t run properly for some reason, but it shows that it is the correct version, we can’t run the updater again.

    To get around this issue we can modify the UpdateVersion.txt file to a lower value so that we can rerun the update.

    Host

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

    Task Server

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

    Process

    You will need to edit the UpdateVersion.txt file in Notepad.

    The locations are shown above depending on if you need to rerun the Host or the Task Server update.

    In the example below, I am on version 26.0.9,

  • Clarity Auto Create ACC Project Setting

    If you have Clarity set to Auto Create ACC projects in a specified hub, there are some things you need to be aware of in order for them to actually be created.

    You need to be logged in as a Global Admin to make these changes.

    Settings

    • Server tab, Settings, General tab, BIM360
    • If you set this to True, you will want to fill in the name of the hub we will be looking for to create projects from, typically your default hub name.
    • You can specify a Project Template to base the new projects off of.
      • The project template
  • Clarity and Active Directory Logins

    If you opt to use Active Directory for logging into Clarity, there are a few things to review so you understand how this is set up and what we are looking for when we check against the users Active Directory credentials.

    When logging into the Web Portal you will not use your email address, you will use your Active Directory credentials

    We cannot reset your password, so that link on this login page will not work with this type of login

    There are two places Active Directory integration is configured, one to add/update users to the web portal and one

  • How to Remove a Retired Task Server

    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

  • Clarity Task Schedule Only On Change

    The Only on Change setting is intended to save unnecessary tasks from running, so if nothing has changed in the model, the task does not run.

    What Determines if the Task Runs

    When setting a task schedule to Only on Change, that means that even though that task is set to run at a set day/time, it will only run if one of the following occurs:

    • The date of the target file changed in Clarity since the last time it ran?

      • You can see that date on the Project Home page or

      • The Files tab for that file

        • If a

  • Clarity 2026 Manual Update Process

     

    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 machines, do not unzip them: For example C:\Clarity\Updates Host http://s3.amazonaws.com/IMAGINiTSoftware/Updates/ClarityHost2026.zip Task Servers http://s3.amazonaws.com/IMAGINiTSoftware/Updates/ClarityTask2026.zip Updater Files Download the updater files from the links below and place them in the same folder as the content above.  For the txt files it will just bring up a web page with that text so just right click on the page and save

  • Clarity 2026 Task Server Requirements

     

    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. LICENSE COMPLIANCE Task servers are

  • Clarity Client Download Links

    The add-in adds an icon to the Revit ribbon.  This addin installs for multiple versions of Revit.

    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

  • Revit DWG Task Setup Reference

    The DWG task is a Revit Task Server task to export DWGs from the Revit model.

    They will be exported in the default version of Autocad set up in the Revit model Export Settings if a specific version is not specified in the task setup.

    This would be the version you would see when you export manually from Revit by default.

    Above the Line Settings

    These are the same as all other tasks and can be referenced in this blog post:  https://imaginit.helprace.com/i746-clarity-task-basics-setup-above-the-line

    Worksets:  All or those specifically needed to produce the dwgs if you want to be selective.

    DWG

  • How to Set Clarity Service Recover Options

    You can set recovery options on the Clarity services so that they automatically restart if they stop.

    The Clarity Services on the host and the Clarity Windows Task Server, will need their properties modified to Automatically restart if the service stops, otherwise someone will need to log onto the machine and manually restart them.

    The Host services:

    • Clarity Monitoring Service
    • Clarity Active Directory Synch
    • Clarity Journaling Service

    The Task Server service

    • Clarity Windows Task Server

    How to Set the Service Properties

    In the Services dialog, select the Clarity Service, right-click and select Properties.  In the example I am showing the

  • Best Practices when naming a new Hub in a different region

    Clarity began supporting BIM 360 in 2015, when only the US region was available. As Autodesk expanded its cloud offerings to include additional regions, customers now have the option to host hubs in multiple locales, such as EMEA and Canada.

    When working with hubs across multiple regions, proper naming conventions are essential for smooth operation. We strongly recommend that customers use unique naming conventions for their hubs that clearly indicate the region where each hub is hosted. For example, you might name your hubs "CompanyName-US", "CompanyName-EMEA", or "CompanyName-Canada".

    While Clarity may function with identically named hubs across different regions, this

  • Clarity Client How To Set the Default Server for Metrics

    If you don’t want to have to sign into the Clarity Client so that the users machine will track metrics like file open and sync times as well as untracked models, you can modify a config file to control this.

    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
  • Clarity 2025 Host System Requirements

    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

  • How to Check if a Clarity Update is Available

    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.

    2026.0

    • https://s3.amazonaws.com/IMAGINiTSoftware/Updates/ClarityHost2026_History.txt
    • https://s3.amazonaws.com/IMAGINiTSoftware/Updates/ClarityTask2026_History.txt

    2025.1                                              

  • Clarity Task Tray Proxy Config for Sending Task Diagnostics from Completed Task ID

    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