System Settings

The System Settings pane defined settings that affect the overall behavior of Clarity:

Company Name: Displays at the top of the screen.
Master Server Location: Set as the localhost if this server is the "Master" server (a Clarity host which maintains the synchronized list of projects for the firm), otherwise use this to indicate where to send the project information to.
Use SSL: This web application should use SSL when accessing it.
Server Public Name: This should default to the name of the web server - but if you have an alternate name (such as a fully-qualified-domain name for an SSL certificate) that should be used instead, please fill it in here.
Use Additional Project Databases: An option to create a customizable second database for each Project, which can store non-CAD information.
Coordinator Can Create Projects: Is a Global Project Coordinator allowed to create projects? Or only Administrator roles?
Monthly Summary Email: Clarity sends anonymous task usage information to IMAGINiT for each server. However, if you would like to identify an email address for this server, we will collate a monthly report of usage and send it back to you.

The locations must be set as folders that accessible by the UserId running the Clarity Application pool (shown on the main server page). Verify that the required read/write or both permissions exist.

Project Artifact Path: Location where Clarity stores file-based artifacts created by the tasks.
Project Database Location: Location where the Project databases are created/stored. Note: If the SQL Server is installed on a separate server than the Clarity host, this setting should be left blank.
Backups Location: Location where Clarity stores backups created by the backup task. Note: It is recommended to set this location as a UNC folder, to facilitate the transfer of large zip files from the task servers the folder.
Templates Location: Location of template files.
Datasheet Template Location: Location of datasheet templates.
Datasheet Base Template Location: Base location of where datasheets are stored.
Email Template Folder: Location of where e-mail template messages are stored.
Certificate Temporary Path: A temporary location where certificates can be created during the certificate generation process.
Report Template Location: Location to store the default reports copied for every new Project.
Report Query Location: Location to find/store reports for all Projects.
OpenVPN Path: Location of the OpenVPN installation.
Task Action Plugins: Location where post-task action DLLs are stored.
Project Archive Location: Location for Project Archive files to be copied by default.

Task Processing

File System Buffer Multiple: Operating system option that enables you to set the amount of memory allocated to watching file-based projects to immediately detect changes. It is recommended to use multiples of 4 (4-16).
Task Schedule Only On Change Default: Enables you to set whether the Only On Change option is selected by default.
Task Target Count Warning: Enables you to set the required number of files that a task, targeted at files and set to the * wildcard, will ask to confirm the user's intention to run this task on all of the files.
Task Not Started Timeout: Error showing the amount of time that task has been unable to go from Created to In Progress.
Task In Progress Timeout: Error showing the amount of time the task has been unable to successfully complete.
Notify Admins/Coordinators of Error Tasks: Enables you to set whether or not to send global coordinators and administrators e-mail notifications of the tasks errors.
Claim All Tasks For Each Model: Option that displays when the task server sees multiple tasks in the queue for the same model.
True: Indicates that the task server should claim all of the tasks (in order to minimize the overhead of loading time). If the tasks take too long, it is recommended to distribute one model's tasks across multiple server, if multiple task servers exist.

Monitoring Service

Send New Project User Notifications: Alerts a project coordinator when users or groups are added to a project.
Metric Summary Time: Sets the time of day when Clarity should recompute all metric summaries.
Large Support File Scan Frequency: Sets the amount of days between each scan of support file size, in a Revit Server.
Support File Trigger Size: Sets the total megabyte support file size for any model and sends e-mail notification if it exceeds set number.
Send Build Change Notifications: Checks the Revit build numbers on models in a Project and sends e-mail notifications the project coordinators if the build number for a model changes.
Auto Tag Project Type: Apply a project tag automatically based on the type of project.
Auto Tag Revit Version: Apply a project tag automatically based on the Revit versions of models in the project.
Auto Tag Office: Apply a project tag automatically based on the project's office.
Dormant Project Alert Days: Send an alert about scheduled tasks running against projects where the models have not changed in this many days.

Clarity Client

Minimum Client Version: Ensures that Clients are at least running a minimum version of the Clarity Client.
Enable Model Activity Tracking: Opt into the collection of model activity (how much time was spent by users on each model).

Other

Days to Keep Legacy Task Data: The number of days to keep the full log data of every task, before it is cleaned up. This attempts to keep the database size under control by periodic cleaning out of old task log data (the basic information for each task will still remain).

Email Settings

The Email Settings tab enables you to configure the various emails that Clarity sends to users, such as Task Completions and Errors, Revit build change notifications, New User welcome, etc. Note that to set these setting, Clarity must have a valid set of SMTP email credentials.

Options set here differ based on the work environment, the mail server used, the options set for the mail server, etc. Some mail servers are configured to be very restrictive (require authorization and might only send email from the same user you provide credentials for).

To try out the settings:

Note: If your Exchange server is causing issues, opt for a Gmail address or any other mail service just for sending Clarity email.

Project Plugin

The Project Plugins tab enables you to provide credential information for certain integrations, such as the Bentley ProjectWise. For ProjectWise, you can specify:

On the Add Project page, Clarity scans all of the available datasources for this server. The default options configured above is the default datasource available. To use multiple datasources, you must configure a userId/password that exists on all datasources. These credentials are used for querying the files that exist, copying out files for processing, checking in/updating files with the Post Task Action, etc.

Paper Sizes

The Paper Sizes tab enables you configure a list of valid paper sizes to be used for PDF tasks. In this tab, you can Add, Edit or Delete Paper Sizes from the available list.

By using these paper sizes when you configure a paper size, rather than the paper sizes associated with a particular PDF driver (i.e. ClarityPDF, Bluebeam, etc) you have the flexibility to:

OAuth Settings

OAuth is a technology used to connect two systems together, using a set of credentials. OAuth enables Clarity to access other systems, such as BIM360, Dropbox, Box, etc.