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 Options tab, enter the name of the Office Location
  • 
• Save the configuration and close the Task Tray dialog.

In a Project

Task Server Office Fallbacks

Fallbacks allows for times when an office is too busy to process tasks, but other offices are idle and can process the task.

Keep in mind that if other offices are used, the identity on the task server will need to be able to access the project with the same permissions as the original office.

To set an office fallback, go to the Tasks tab, Fallbacks, then select a fallback for each office.

In the Fallback dialog, specify the task server office and the number of minutes to wait then Create

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 is the paper size, Low is the resolution and it has 2 post actions.

2. Scope

   1. There are different options depending on the task
      1. File: This will run against specific models
      2. Project: This will run against ALL models
         1. If Project scope is chosen, Revit will load each model defined in the project. If the defined View/Sheet set exists, the views will be exported to the PDF. All sheets are sorted at the end based on their sheet order parameter. The consolidated PDF is then delivered to the project Artifacts folder.
      3. Server: Can only be configured from the global Tasks setup page
         1. Model Upgrader or Revit Server Backup are examples of a Server Scope Task.

1. Project

   1. Which project is this task running on (if applicable)

2. Target

   1. If this task is set to File Scope, which Model(s) is it running against
   2. 
      1. Models tab, select the checkboxs of the models you want to run against
         1. 
      2. Advanced tab, use an expression, or enter the name of the model you want to run against.
         1. 

3. Priority

   1. What priority in the task queue is this task set to?
      1. 1 being highest, 10 being lowest.
      2. There are other factors that impact this, please refer to the following blog for additional information: https://imaginit.helprace.com/i538-clarity-task-processing-task-order-and-identity

1. Worksets

   1. You can be selective about worksets, although most chose ALL.
      1. 
   2. There are quite a few tasks that can be run with Worksets set to None to increase productivity, please refer to the following blog post: https://imaginit.helprace.com/i465-clarity-tasks-with-worksets-none
      1. Basic: Shows all worksets from all models that a Revit DBExport task has run on.
         1. 
      2. Advanced: Allows you to use Wildcards to filter worksets
         1. 
      3. Model Filter: Allows you to select the model, then check the worksets you want on for that model.
         1. 

1. Post Action

   1. There are multiple options here, we won’t go into depth on these settings in this blog post.
   2. You can have multiple post actions.
      1. If you have a Move post action, it must be the last post action.

2. Frequency

   1. On Demand: You must manually launch this task
   2. Scheduled: This task runs on a set schedule
   3. Immediate on Sync to Central
   4. Web Trigger: The task runs as defined in the Web Trigger

3. Schedule

   1. If the task is set to run on a schedule, what are the settings for that schedule
   2. It is important that you are aware that tasks will always run on the task equivalent time on the Server.
      1. In the upper right of the Tasks tab, you can see the Server Time Zone
      2. Next to the Task Time Schedule, you can see Your Time Zone
   3. Only on Change
   4. Please refer to the following blog post for additional information: https://imaginit.helprace.com/i740-clarity-task-schedule-only-on-change

4. Launchable

   1. Can this task be launched from the Clarity Client or from the Project Banner when you are on the Project Home Page
      1. 
   2. What are the Launchable Parameters if any
   3. Is an Admin required to launch the task.

5. Email Notifications

   1. Should email notifications be sent out when this task is run?

6. Enabled

   1. Enabled: The task will run on schedule, if set to No, it will not run on schedule and would have to be launched manually in order to run.

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.

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 SAN devices will not work and they are also not supported by Autodesk at this time.  Please refer to the following Knowledge base articles for additional information

• https://knowledge.autodesk.com/support/autocad/troubleshooting/caas/sfdcarticles/sfdcarticles/Autodesk-support-for-Network-Attached-Storage-NAS-and-Storage-Area-Networks-SAN.html
• https://knowledge.autodesk.com/support/autocad/troubleshooting/caas/sfdcarticles/sfdcarticles/Support-for-non-Microsoft-networks.html

Hardware:

Hard drive space: 

Roughly 12 GB of free space for the Clarity installation, with substantial additions dependent on the amount and size of projects and tasks being utilized.

There is still a good amount of information that needs space on the C drive, even if the Projects and Artifacts are assigned to a different drive. 

Recommended Minimum

Minimum 500 GB C drive allocation to avoid issues later related to not enough hard drive space on the C drive. 

Additional drive for Data (Projects, Artifacts, Backups and Archives etc)

If also being stored on the C drive, increase the drive size accordingly.

We do not recommend that you install the Clarity Task Server software on the host since it is not a supported OS, but If you choose to use the host as a task server, additional drive space is required.

RAM: 

This is a difficult question, because it is dependent on the number of users, projects, and size of projects being managed. This is particularly important if the server is going to be performing Revit operations, the size of the Revit RAM requirement often dwarfs the other requirements.

Recommended Minimum

Minimum 16gb of ram on the host. 

Note:  If you plan on using the host as a task server, refer to the ram and hard drive space for Revit.

Virtualization

Most Clarity server deployments have taken place on Virtual Machines. Clarity supports VMware and Hyper-V based virtual machines.

You must ensure that the virtual machine has sufficiently performing processor, memory, and disk resources for appropriate performance.

Note:

Anyone going with a Virtual setup should be asked how the IOPS performance of their setup would compare to the kind of physical drive Autodesk is looking for.

Microsoft SQL Server

Clarity 2026 provides Microsoft SQL Express 2017 as its database.  SQL Server Express limits the maximum database size to 10GB.

If you plan to have more than 100 active projects, you may wish to consider a full SQL Server license (or a separate SQL Server). Microsoft SQL Server version 2016 thru 2022 are supported.

Can I Use My Existing SQL Server?

We are often asked if it is permissible to use an existing full version of Microsoft SQL Server (on a corporate server).

While this environment should work, it is not a fully tested configuration as of yet.

If this is an important issue, please raise it with your primary IMAGINiT contact.

Software/OS Prerequisites

Before deploying your Clarity Server, you must have the following prerequisite configuration set up for your Clarity Host.  The Revit Server prerequisites are required for all Clarity Host installations regardless of if you are going to be using Revit Server.

Contact support for more detailed information:  support@rand.com

Please reference the following Autodesk article for installing prerequisites on Windows Server  2016 ,  2019  or 2022 or Server 2025* (64-bit) *with limited internal testing 

Revit Server Installs (Optional)

• If you are going to be using Revit Server with Clarity, please install all necessary versions of Revit Server prior to the Clarity install and verify that you can get to the Revit Server admin without error.  Do not create any projects yet.

Autodesk Revit

If you are not using the host as a task server it is not necessary to install Revit.

User Identity

Because Clarity will likely need to access files on your network, you should decide in advance what UserId clarity should run under in order to give the appropriate permissions. 

By default, Clarity will run as a low-privilege system account on the local machine – but that account will likely not have sufficient access to retrieve files from the network.

To manage this access appropriately, IMAGINiT recommends defining a domain account for your “Clarity User” – which will define the permissions for the Clarity application.

Please reference the Help link or the Clarity Security Principle Setup document for the complete steps to configure Clarity to use this “Clarity User” for the following:

• CentralAdministrator Application Pools
• Clarity Monitoring Windows Service
• Microsoft SQL Server Database
• Clarity ADSync

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. 
   2. Selecting the ….. brings up options to use Expressions or View/SheetSet Selection options
   3. 
   4. 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 choose one of those instead.
         1. 
2. Specify how you want to name the output
   1. 
   2. Selecting the ….. brings up a dialog for naming options
   3. 
   4. If you are exporting multiple views, verify your naming setup.
   5. You must include the .nwc at the end
3. Error on Missing Links?
   1. Checked is Yes, unchecked is No
   2. If links are missing when processing the task, this will kill the task.
   3. 
4. Coordinates
   1. 

1. Parameter Option
   1. Specifies how Revit parameters are read. Select from the following options:
   2. 
      1. None - the file exporter does not convert parameters.
      2. Elements - the file exporter converts parameters for all found elements.
      3. All - the file exporter converts parameters for all found elements, including the referenced elements. As a result, extra property tabs are available in Autodesk Navisworks.

1. Faceting Factor
   1. Recommended value between 1-4, the higher the number the more facets
   2. 
2. Divide File into Levels
   1. Checked means yes, unchecked means no
      1. 
3. Convert Element Properties
   1. 
4. Export ElementIds
   1. 
5. Export Links
   1. If you want linked model geometry to export, this box needs to be checked.
   2. 
6. Export Parts
   1. 
7. Export Room as Attribute
   1. export data for each room into a single shared room attribute
   2. 
8. Export Room Geometry
   1. 
9. Export URLs
   1. 
10. Find Missing Materials
    1. Yes, the file exporter looks for a match for the materials missing from the export.
    2. 
11. Include Metadata File
    1. BIM360/ACC files only this will produce an XML format file with the Metadata information.
    2. 

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, I need to change the 9 to an 8 so I can rerun the updater

You will likely get an error when trying to save it back into the original folder, so save it to the desktop, then drag it back into the original folder and overwrite it.

Rerun the Update

Now you can rerun the update by right clicking on the update icon on the desktop and Run as Administrator. 

The updater will run since it thinks it needs the update.

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 is used in a similar fashion as when you create a project in clarity and you copy from "tasks, settings, project parameters, etc. in the user interface.
  • It does not do anything related to the version of the project.
• 

Requirements

• We will use the default Oauth credentials, so that identity must meet the requirements for adding a project to Clarity for that project.
  • https://imaginit.helprace.com/i618-clarity-requirement-for-adding-360-acc-projects
• The Oauth must be valid
  • https://imaginit.helprace.com/i484-clarity-how-to-reset-the-360-oauth-credentials
• Because Clarity needs to know what version of Revit will be used with a particular BIM360/ACC Project, the default behavior is that it WILL NOT create the Clarity project until there is a Revit model in the project to indicate to Clarity what the Revit version should be.
  • That model should be published.
• Alternatively, there is a low-level monitoring service setting which can force Clarity to immediately create based on a specific version number - which can be changed later if necessary.
  • Keep in mind that this is the version that we will assume tasks should run as!
  • You will need to modify the version used in the project if it is not correct so Revit tasks will process on live models!
    • https://imaginit.helprace.com/i603-how-to-edit-a-360-project-in-clarity

Forcing Auto Create for a Set Version of Revit

If you want to force the creation, even if the version is incorrect, you will need to modify a config file on the host.

• Log onto the host as the service account identity.
• You can see the identity that is running the Monitoring Service from the Server tab, Security, General
  • 
• Browse to the following folder on the host.
  • C:\Program Files\IMAGINiT Technologies\Clarity Monitoring Service
• Make a copy of the following config file and rename the extension to .ORIG so we have a copy of the original file in case we need it.
  • 
  • MonitoringService.exe.config
• Modify the config file with Notepad or Notepad++ as shown in my screenshot and set the default version you want to use between the “”
  • 
• You may get a permission error when trying to save the file, if so, do a SaveAs to the desktop then drag it back into the original folder and overwrite the file.
  • Make sure it is set to Save As all types and not to append as txt
  • 
• Restart the Monitoring Service

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 configuration has not been thoroughly tested and could lead to unexpected behavior. Using distinct names helps prevent confusion in Clarity and other integrated services, and ensures reliable performance across your organization's projects.

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 to log them in.

Active Directory Synch - Syncs Users Between AD & Clarity

One is in the Active Directory Synch tool located on the desktop of the Clarity host server.

There are several tabs that you need to configure, please refer to the help link below.  The AD server should match what you configure in the Clarity Web Portal.

https://s3.amazonaws.com/IMAGINiTSoftware/Documentation/Clarity/2026/System_Setup/Active_Directory_Integration.htm?rhsearch=Active%20Directory&rhhlterm=active%20directory

This tool is used to add/update and depending on setting, potentially remove users from Clarity when it synchronizes.

This runs in Services and only Synchronizes users between Active Directory and Clarity

This service has nothing to do with logging users into the Web Portal.

LOGIN ISSUE NOTE:

If a user is having issues logging in and was previously able to log in, the quick solution is to remove the user from the Clarity Users tab and run the Sync to add them again.   

If the issue is more global, it is likely a different issue and we will need the Clarity Host logs from the Server tab, Logs page to figure out the cause.

To force an Active Directory sync

Browse to the C:\Program Files\IMAGINiT Technologies\Clarity Active Directory Sync
then run the ClarityADSynchService.exe application.
It should bring up a UI – you will have to hit: Analyze and then Update to force the sync.

Diagnostics

C:\ProgramData\IMAGINiT Technologies\Clarity Active Directory Synch\Logs

Active Directory Authentication - Clarity Asks the AD Server to Verify Clarity User

The setting for logging users in is controlled in the Clarity Web Portal

https://s3.amazonaws.com/IMAGINiTSoftware/Documentation/Clarity/2026/index.htm#t=System_Setup%2FAuthentication_Options.htm&rhsearch=Active%20Directory&rhhlterm=active%20directory

Server tab, Authentication

Here you will enter the AD Server Name and AD Domain Query location (See Notes below)

Notes:

• If you use the Active Directory Global Catalog, you can specify only GC: for the server (and leave the Domain Query blank). This will query the Global Catalog instead. For more information on this, see the Active Directory deployment guide.

• For a simpler failover, it is also possible to list multiple Active Directory Servers, separated by commas. The system will try each server in the provided sequence.

• When working with the Connect module, the Server/Authentication page also enables you to set several options for identifying users and determining access rights. For more information on this, see the Authentication Options, under the Clarity Security Overview.

Clarity AD Login Requirements

Basic Requirement:

• The user must exist in Clarity
• Their account must have the Active Directory checkbox selected

What We Are Checking For

Clarity AD Synch looks for 4 attributes to exist to be able to create a user:
- First Name
- Last Name
- Sam Account Name
- Email

In AD we must have the following fields, shown in green below, on the General tab and the login name (Pre-Windows 2000) on the Account tab.

When a user attempts to login:

• We ask the AD Server (This information is seen in the Clarity web portal, Server tab, Authentication):
  • Is this a valid username/password combination? 
  • If so, what is the user's email? (and then we match it in the Clarity user database).
• If we can’t find a match for any one of those things there will be an error

The error will show up in the AdminConsole log and looks similar to this:

INFO  2023-10-26 14:23:33,942 UserService            - Unable to find the Active Directory user: LOGINNAME
INFO  2023-10-26 14:23:33,942 etoryAuthenticatedUser - Unable to login user: LOGINNAME
INFO  2023-10-26 14:23:33,942 HomeController         - Unsuccessful login attempt for LOGINNAME: Unable to find the selected user account.
INFO  2023-10-26 14:29:36,280 UserService            - GetDirectorySearchResult(ADSERVERNAME, DC=DOMAIN,DC=LOCAL, Secure): Error retreiving Search result
System.DirectoryServices.DirectoryServicesCOMException (0x8007052E): The user name or password is incorrect.
…
   at AdministratorConsole.Core.Services.UserService.GetDirectorySearchResult(String ldapServer, String userId, String password, String ldapDomain, String ldapAuthType)

The user name or password is incorrect.

This is a generic error and does not necessarily mean exactly that, sometimes the real issue is that the User doesn’t have an email address in AD, this can happen if the user was added manually rather than with the sync tool.

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 and remove the task server assignment.

Select the Project link in the Assigned Projects dialog to take you to the project.  Then go to the Tasks tab, Task Servers and change the task server assignments.

Once all project assignments are removed, go back to the Tasks Tab, Task Servers, select the task server again and Purge.

Go to the Server tab, Central Host and Stop then Start the Monitoring Service.

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 link changes in the target file, that will not cause the task to run.

  • The task definition changes since the last time the task ran

  • For a Project Scope task, if any model in the project changes, that would trigger the task to run.

Note:

If you need this to run on a set day/time regardless of change, do not check Only on Change.

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

While this enhancement can be applied to any model in your project, it was specifically designed to address the limitations of bridged models.In the image below, multiple files are selected in the project's Files area to "Open as Published." This ensures Clarity operations run against the latest published versions of these models.

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 Task Setup

DWG Help

Export Settings

In the task setup area, the Export Settings refers to the DWG/DXF Export Settings defined in the Revit Model. 

If you have a saved Setup in the model that you want to use, you can define that here and we will use those settings instead of you having to define them manually in the task.

If you have not done a Revit Database Export to see the DWG Setup from the model, you can just type it in.  It is case sensitive, so it must match exactly how it exists in the model.

If Export Settings are set to NONE, that means you are going to define things in the task.

If you want to specify an Export Setting from the model you will enter that information here by entering the name of the Export Settings from Revit:

View/Sheet Set to Export:      [ALL SHEETS ..... 

The default is ALL Sheets, but you can select the …. and choose by Expression or Set

View Expressions are very powerful and there are lots of options, I will not go into detail in this document, but you can find addition information in this help link.

Example

In this example I am looking for views that contain 3D Navis Coordination in their name.

View/Sheet Set

Sometimes it will be easier to use a view set than to try to use an expression to get the views you need.  The view sets are populated by running a Revit Database Export task on the model.

If you know the name of the set you can just type it in rather than run a database export, keep in mind it is case sensitive.

Export Individually – Depending on how you have this set, the naming options change.

• Do you want to export each view as its own dwg or combine them all into one file?

DWG Filename(s)  ..... 

• Your export settings determine the options available for naming.
  • If you select to export individually and you select the ….
  • You will see Sheets and Views under Data Type
  • 
• If you are not exporting individually, you will not see the same options under Data Type
  • 

Error on Missing Links 

• If this is set to yes (checked) and we cannot load some Revit links for any reason, we will kill the task.

Artifact Subfolder 

• Do you want a sub folder created under the Project Artifacts for this export?
• If you select this option, it will require you to enter the name of the folder or the parameter to fill in for the name.
  • Example: [Date] 
    • That will create a sub folder with the date for that model
• 

Zip Output Files 

• Do you want the output zipped, if this is toggled it will add another line to enter the name of the zip file.
  • This is a good option if you run into a situation where the filename is too long which happens sometimes when images are exported with the dwg files.
• If you select this option, a naming dialog will appear.
  • 

Force Apply View Template 

• Do you want to apply a view template to the views being exported?

Remove PCP Files 

• When the dwgs are produced it also includes the plot settings files, do want to keep those or discard them.

 Include View/Sheet Metadata File 

• For each view exported, extract the Revit parameters for the view/sheet and project information into XML format. This data can be used with specific post task actions to push the metadata into document management systems, such as ProjectWise or 360.

 Split Large Tasks? 

• This option can only be used if the task is exporting the files individually and the output is not zipped
• If you toggle this selection it will bring up a configuration dialog for you to specify the split settings
• 
  • When the "original" task starts, it will determine if it should split itself into multiple tasks. If so, it creates sub-tasks, and assigns those tasks what part-of-the-whole-task that they should be responsible for. These subtasks are launched, and will appear as independent tasks within the Current Task queue. They do not have a strong link to the original task - they will just have the same name (with the sub-set information appended to the name).
  • While the exact behavior of the original task is up to the task author, in most cases we believe that the original task will:
    • Take the first "batch" for itself and start the work.
    • NOT wait for the others to complete- just finish and close.
    • You can find out more information on the configuration, and any kinds of limitations about when a task can-or-cannot be split within the configuration help for each task.

In Session Settings

In session settings are used if you have not specified a DWG settings file.  Here you will configure how you want the export to run.

These settings are a condensed version of the tabs in the DWG/DXF Export Setup dialog inside of Revit.

All settings are pretty self-explanatory with the exception of Merge Views

Merge Views

This setting is the opposite of this setting in Revit

• If Merge Views is checked, a consolidated DWG will be created, meaning that the views will be blocks in the exported DWG.
• If unchecked, there will be separate DWGs for the views, and they will be external reference links in the DWG.

Notes

The notes section is in all tasks, and it' good practice to add information about the task setup.

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 Clarity Monitoring Service on the host, but the process is the same for all.

General tab

Typically the startup will be automatic, but depending on your network, it may need to be automatic delayed.

Logon Tab

The logon should typically be assigned to the designated Service account set up by your company to run the Clarity services and application pools. 

You will want to enter the domain\service account name and password then hit apply.

Recovery

Set each to Restart the Service

Ok to set the properties

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.

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 credentials for the different task servers and the primary one used to add projects.  Each of those identities needs to be assigned to all projects in 360 that you want to add to Clarity, and each of those also has to be part of the Docs team.

Autodesk Device Limit

Autodesk is starting to crack down on running under the same 360 identity on multiple machines. 

In order to be in compliance we recommend you have a 360 identity for each task server.

More information is available at this blog link:  https://imaginit.helprace.com/i537-autodesk-device-limit-reached-warning-on-task-servers

360 Permissions and License

It will also be necessary for you to have the appropriate permissions to access the live model, including a valid ACC license for the task server 360 identity.   For a Collaborated file, that will require a Collaboration Pro license for each Task Server identity accessing 360 models.

It is not required that the member be a project admin, but they will need the proper permission assignments to the folders if not.

Clarity Oauth

The Oauth identity assigned to the project must be added and valid in the Clarity web portal order for us to see the published models in the project in 360.

Clarity Monitoring Service

The Monitoring service must be running in order for us to scan projects.

You can see the status of the Monitoring Service on the Server tab, Central Host page

Checking to See What Projects the Oauth Has Access To

If you select Check, you can see what Hubs and Projects that Oauth has access to.

Anything with an arrow beside it means you can expand the list to see the Projects.

If you don't see the hub/project here, we don't have access to it with that Oauth identity.

Adding a 360 Project to Clarity

Go to the Projects tab, Add a Project.

For 360 Projects you must specify the version of the Revit files so we know what version of Revit to process the files with.  If you specify the wrong version, the Revit tasks will never be claimed, and you will need to Edit the Project to fix the version.

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 SAN devices will not work and they are also not supported by Autodesk at this time.  Please refer to the following Knowledge base articles for additional information

• https://knowledge.autodesk.com/support/autocad/troubleshooting/caas/sfdcarticles/sfdcarticles/Autodesk-support-for-Network-Attached-Storage-NAS-and-Storage-Area-Networks-SAN.html
• https://knowledge.autodesk.com/support/autocad/troubleshooting/caas/sfdcarticles/sfdcarticles/Support-for-non-Microsoft-networks.html

Hardware:

Hard drive space: 

Roughly 12 GB of free space for the Clarity installation, with substantial additions dependent on the amount and size of projects and tasks being utilized.

There is still a good amount of information that needs space on the C drive, even if the Projects and Artifacts are assigned to a different drive. 

Recommended Minimum

Minimum 500 GB C drive allocation to avoid issues later related to not enough hard drive space on the C drive. 

Additional drive for Data (Projects, Artifacts, Backups and Archives etc)

If also being stored on the C drive, increase the drive size accordingly.

We do not recommend that you install the Clarity Task Server software on the host since it is not a supported OS, but If you choose to use the host as a task server, additional drive space is required.

RAM: 

This is a difficult question, because it is dependent on the number of users, projects, and size of projects being managed. This is particularly important if the server is going to be performing Revit operations, the size of the Revit RAM requirement often dwarfs the other requirements.

Recommended Minimum

Minimum 16gb of ram on the host. 

Note:  If you plan on using the host as a task server, refer to the ram and hard drive space for Revit.

Virtualization

Most Clarity server deployments have taken place on Virtual Machines. Clarity supports VMware and Hyper-V based virtual machines.

You must ensure that the virtual machine has sufficiently performing processor, memory, and disk resources for appropriate performance.

Note:

Anyone going with a Virtual setup should be asked how the IOPS performance of their setup would compare to the kind of physical drive Autodesk is looking for.

Microsoft SQL Server

Clarity 2025 provides Microsoft SQL Express 2017 as its database.  SQL Server Express limits the maximum database size to 10GB.

If you plan to have more than 100 active projects, you may wish to consider a full SQL Server license (or a separate SQL Server). Microsoft SQL Server version 2016 thru 2022 are supported.

Can I Use My Existing SQL Server?

We are often asked if it is permissible to use an existing full version of Microsoft SQL Server (on a corporate server).

While this environment should work, it is not a fully tested configuration as of yet.

If this is an important issue, please raise it with your primary IMAGINiT contact.

Software/OS Prerequisites

Before deploying your Clarity Server, you must have the following prerequisite configuration set up for your Clarity Host.  The Revit Server prerequisites are required for all Clarity Host installations regardless of if you are going to be using Revit Server.

Contact support for more detailed information:  support@rand.com

Please reference the following Autodesk article for installing prerequisites on Windows Server  2016 ,  2019  or 2022 are supported. 

Revit Server Installs (Optional)

• If you are going to be using Revit Server with Clarity, please install all necessary versions of Revit Server prior to the Clarity install and verify that you can get to the Revit Server admin without error.  Do not create any projects yet.

Autodesk Revit

If you are not using the host as a task server it is not necessary to install Revit.

User Identity

Because Clarity will likely need to access files on your network, you should decide in advance what UserId clarity should run under in order to give the appropriate permissions. 

By default, Clarity will run as a low-privilege system account on the local machine – but that account will likely not have sufficient access to retrieve files from the network.

To manage this access appropriately, IMAGINiT recommends defining a domain account for your “Clarity User” – which will define the permissions for the Clarity application.

Please reference the Help link or the Clarity Security Principle Setup document for the complete steps to configure Clarity to use this “Clarity User” for the following:

• CentralAdministrator Application Pools
• Clarity Monitoring Windows Service
• Microsoft SQL Server Database
• Clarity ADSync