Knowledge Base

  • Clarity 2024 Task Server Config to Auto Select 360 DC Projects

    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

  • Clarity Revit Database Export Settings

    The Revit DBExport task is the most common task used in Clarity.  This will export information that populates tables in the database.  That information will populate for Data Sheets, Reports and various dropdown selection dialogs for other tasks.

    There is no physical output for this task.

    This document will help you decide what settings you need set, to get the information you need.

    Time Saver Note

    The Revit Database Export task can be run with worksets closed (NONE) to improve efficiency without compromising the data exported, however if you need svg images for datasheets or reports, worksets will need to

  • Clarity Task Processing - Task Order and Identity

    There are several factors that control or impact task processing, please refer to the information below.

    Types of Task Servers

    There are several types of Task Servers that can be enabled in the Clarity task tray.  For each of these, the proper identity must be associated to it.  For Revit tasks, the logged in windows session should be the designated Clarity account.  For the Windows task server, the service account identity needs to be the “log on” in that service.  Forge requires credentials and a key.

    • Clarity Revit Task Server
      • This will process tasks that require opening the Revit model.
  • Clarity Task Dialog Open in Revit When Task Tray Exited

    Issue

    You are trying to test something manually in Revit on the task server, and the Task dialog is launching when you launch Revit, even though the Clarity Task Tray is exited.

    Cause

    When the Clarity Task Tray for Revit is running, it puts an addin in the addins folder while Revit launches to pick up a task, when we are done with the task, we try to delete it...if we are unable to delete it due to permissions issues generally, then that dialog will come up even though the task tray is not running.

    Resolution

    You need to make

  • Clarity Model Metrics Sources from Tasks and Configuration Files

    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
  • Clarity Task Server Configuration to Shorten the Artifact Path

    Windows path length limitations will come into play when the fully qualified file name exceeds 260 characters, or the directory name is greater than 248 characters.

    The error will look like this in the AdminWebservice Log

    TaskService - UploadFile(): Exception while uploading file System.Web.Services.Protocols.SoapException: Unable to create target folder on server! PathTooLongException ---> System.IO.PathTooLongException: The specified path, file name, or both are too long. The fully qualified file name must be less than 260 characters, and the directory name must be less than 248 characters.

    There is a configuration change that can be made on the task servers (versions 22.1.11

  • Clarity and FIPS

    You want to know if you can enable FIPs on Clarity machines.

    What is FIPS? FIPS stands for Federal Information Processing Standards These are standards and guidelines for federal computer systems that are developed by National Institute of Standards and Technology (NIST) in accordance with the Federal Information Security Management Act (FISMA) and approved by the Secretary of Commerce.

    If you are working on government projects, this is something that will likely apply to you.

    You can find out more about FIPS at the link below. https://www.nist.gov/standardsgov/compliance-faqs-federal-information-processing-standards-fips#2

    Clarity General Information Clarity should sense that FIPS is enabled. This information will

  • Clarity Override to Delete Dimensions (Clarity 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. 

  • Clarity Schema Conflict Overrides (Clarity 2024)

    This change is on a per Revit version basis.

    For Clarity 2025, Refer to this blog post:  https://imaginit.helprace.com/i659-clarity-2025-task-tray-configuration-for-error-overrides 

    There is a way to say “Continue Loading” for this kind of Schema Conflict dialog.

    We are currently programmed to always hit “Do not load” for that specific issue, because there’s a risk of data loss.  When we do that it kills the task.

    IMPORTANT NOTE

    Please be aware, this configuration change is at your own risk, and you understand that it will change the model during the task, and you are ok with that.  For most tasks, we don't save the changes

  • Clarity Task Server Configuration to Always Hit OK

    This is done at your own risk and will apply to all models on this task server that have the configuration files modified.

    WARNING Modifying the ClarityTaskTray.exe.config and setting it to “true” will “Always hit the OK button, if there is one”, we feel like this is at least a little bit dangerous, so we don’t have it on by default.  There will still be dialogs this won't work on, since not all dialogs have an OK response.

    Make a copy of the original config file before modifying it so you have a backup. If you edit the config file incorrectly

  • Clarity Windows Task Server Pre-Requisites for Autocad & NW Conversion

    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

  • How to Add a Paper Size to Windows 11

    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

  • Using the Adobe PDF Driver

    Using the Adobe PDF Driver in Clarity on a Task Server requires one unusual step.

    The necessary registry keys for Clarity to work with do not exist until you have opened the Adobe PDF options dialog, where you can see the options for "Prompt the User" and the default folder location (the dialog looks different in different versions of Adobe Acrobat/Distiller).

    If you have not done this step, you may see an error such as this in your task server, and the task server WILL NOT CLAIM the PDF task.

  • Autodesk Desktop Connector and AdSSO

    (10/28/21)

    At present, the best combination that we are seeing for stability seems to be:

    • Desktop Connector: 14.10.0.1456  / AdSSO: 12.3.3.1803

    Other "Known Good Combinations" include:

    • Desktop Connector: 14.11.0.1476  / AdSSO: 12.2.2.1802
    • NO Desktop Connector (if you can live without it) / AdSSO:12.3.3.1803

    You can see the versions you have installed in the Control Panel, Programs and Features.

    As you know, the Desktop Connector releases come out every month, so it's difficult to keep track of exactly which combinations work best. If you don't see your version combination listed above, it may still be fine - but if you're encountering issues with

  • Clarity How to Retire a Task Server

    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
  • 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
  • How to Increase the Size of the Logs on the Task Server

    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

  • How to Perform a Clean Uninstall of Clarity Task Servers

    • 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
  • Switching Clarity Task Servers to Autodesk SSO

    General Information

    Clarity Web Portal

    If you turn on Autodesk SSO – you don’t have to change how you sign into the Clarity web app. They are independent.

    Task Servers

    Clarity will work fine with Autodesk SSO, but there are some things to be aware of that will need to change on and for the task servers.

    The accounts that will be used for the task servers, although not physical users, still must conform to the same rules for Autodesk SSO.

    On the Autodesk Side

    The account must be a real domain account which is able to receive emails and

  • Calculations in Clarity Datasheets

    One of the features we are occasionally asked for - that we do support within Clarity, and recently noticed it was missing from the documentation, is the ability to do calculations within a datasheet.

    For example, you have the "Target Area" and the "Actual Area", but what if you wanted to show the percentage?

    To do so, you can use the EVALUATE keyword.

    EVALUATE takes a statement inside of curly braces { } - and runs it through a C# evaluation tool.

    The EVALUATE step happens AFTER it has already "parsed" in the various parameter values. For example:

    EVALUATE{[Room:Area]/[Room:TargetArea]*100}

    Other