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

• Project Database
• Tasks
• File Filters
• Datasheets
• Reports
• Project Artifacts
• Revit Models (via pre-existing Clarity backups)

This process can be used to take Projects offline (and bring them back later), or to migrate a Project from one server to another.

Notes About Archive Requirements:

• The project must be Active (not deactivated in Clarity)
  • You can see deactivated projects from the Projects tab by selecting the icon shown below.
    • 
    • To reactivate, put a checkmark in the box of the project and select Activate.
      • 
    • The database must be “Online”
      • If you have Clarity set to Auto-Deactivate projects, this takes the database offline also.
        • 
      • The project will have an X in SSMS and say (Offline)
        • 
      • To bring it back online you can right click on it, go to Tasks, Bring Online
      • Setting the project back to Active in the Clarity web portal will also bring it back online as long as there isn’t some other sort of issue connecting to the database.
        • 

Process

1. On the project home page, in the upper right pencil/checkbox select Archive Project

1. Select Create Archive

There are some settings to review before you archive, the most important item is where to save the file, there are restrictions because we are backing up the database also. 

The safe bet is to save it to the location specified in Settings for the Project Archive Location

Notes About Archive Location Restrictions

You typically cannot backup a SQL database to a network share folder because:

SQL is not running as you.
SQL is not running as the Web Application User.
SQL is running as the SQL User (LocalService often).

LocalService does not have access to that location.
Archives - for that reason - unless they've changed the user that SQL runs as - need to be written to a local folder on the server that the "LocalService" account can access.

1. Fill out the Output location and review the other settings, then select Archive Project

1. You will see the following page:

1. 
   Once the archive completes, you should receive an email stating that the archive has completed.

Errors During the Archive

If there are errors during the archive you can create a case by emailing support@rand.com or when you send in the host logs.  Please include the name of the project being archived and the host logs from the Server tab, Logs page that cover the time you tried to archive. 

Send AdminConsole and Monitoring logs.

The logs roll over quickly, so the closest to the time of the issue, the better to make sure the logs cover the timeframe we need.

https://imaginit.helprace.com/i730-how-to-send-in-diagnostics

This is currently a manual process.

• Backup of the Rand Revit database in SQL Express
  • https://imaginit.helprace.com/i732-how-to-manually-backup-the-randrevit-database
• Make a backup copy of the Web.config file in the following locations
  • C:\inetpub\wwwroot\CentralAdministrator
  • C:\inetpub\wwwroot\CentralWebservices
  • C:\inetpub\wwwroot\ClarityReporting
• Optional backup of the Project Databases in SQL Express (although these can be re-constituted from the Revit models)

Locations shown in the Web portal on the Server tab, Settings, General, File Locations 

• Optional backup of the Project Artifacts Folders
  
  • Default: C:\ProgramData\IMAGINiT Technologies\Clarity\RevitArtifacts
• Optional backup of the Datasheets Folders
  • Default: C:\inetpub\wwwroot\CentralAdministrator\Templates
• Optional backup of the Reports Folders
  • Default: C:\Program Files\IMAGINiT Technologies\Clarity Central Administrator\ReportTemplates
• Optional backup of the OpenVPN folder
  • Default: C:\Program Files (x86)\OpenVPN
• Optional Backup of the Clarity Backups folder
  • Default: C:\Program Files\IMAGINiT Technologies\Clarity Central Administrator\Backups
• Optional Backup of the Clarity Archives folder
  • Default: C:\Program Files\IMAGINiT Technologies\Clarity Central Administrator\Archives

Additional Location not listed in Settings

Optional: If you have customized the look of the Clarity web portal

• C:\inetpub\wwwroot\CentralAdministrator\Content\Layout.css

It's also a good idea to have an up to date backup in case of disaster recovery.

Connecting to the database

RDP into the machine where the SQL Database is installed, if you are using the SQL database installed with Clarity it will be on your host server.

• Log onto the server as the Clarity Service account that runs the services and application pools, this should allow you to Log into SQL with Windows Authentication
• Open the SQL Server Management Studio (SSMS)
  • You might want to pin this to the task bar
  • 
• Connect (example)
  • 

Backing Up the RandRevit Database 

• Expand Databases
• Right Click on RandRevit
  • Tasks
    • Backup
    • 
• In the Backup Database dialog
• 
• Select Add to add the backup location
  • 
• Browse to a location to save the backup and give it a name and ok out of all dialogs to save the backup with a .bak extension.
  • 
• Ok to backup
  • 
• When the backup completes you will see the following dialog
  • 

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

Select Set

Enter Domain\Credentials and password


OK out of all dialogs.
Repeat for all Clarity app pools
Start the app pools

Test the Clarity web portal connection.

It will be stressfully slow to connect the first time after restarting the application pools...but it should connect.

If there are still issues, zip the content of the logs folder and send that in.

C:\ProgramData\IMAGINiT Technologies\Clarity\Logs

If the issue is on the task server, open the Clarity task tray, go to the Logs tab and send in the diagnostics.

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 continue to become disabled.  I also recommend that you have another non AD admin account as a backup in case you have issues with logging in with AD and this account is disabled.

Resolution

• Log into the Clarity web portal as an admin.

• Go to the Tasks tab, Task Servers and Pause All task servers.

• Go to the Users tab, select the user account. Update the password and clear the disabled checkbox and select Update.

Updating Credentials on the Task Servers

• Log onto the task servers as their designated Clarity account

• Open the Clarity task tray, select the Server and Edit.  Update the password and OK.

  • 

• Repeat for all task servers

• Unpause the task servers

Checking the Clarity Active Directory Sync Settings

• Log onto the host as the application pool identity

• Launch the Clarity AD Sync application from the desktop icon

• on the Clarity tab, enter the proper password and test.

• Close the dialog

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 to 1mb.

• <maximumFileSize value="1000000" />

  • Or add another 0 to change them to 10 mb

  • 

• Save the file.

• If you get an error saving the file, do a Save As to the desktop. Make sure the Save as type is All types and Save.

  • 

• Copy back into the original folder and overwrite.

• Restart the Clarity Monitoring Service in Services.

On the host machine go to the folder below and edit the Log4net.config as follows:

C:\inetpub\wwwroot\CentralWebservices

Change the value as shown below to increase the file size to 1mb.

<maximumFileSize value="1000000" />

You can also increase the quantity if you like.  

 You may get an error when trying to save the file, so Save As and make sure that the Save as Type is as shown below

Save the file to the desktop, then drag it back into the original folder and overwrite

Port changes with new email sending library called MailKit.

Cause:

Customers were starting to run into occasional issues where we had problem sending email with TLS/SSL, and because it was related to a Microsoft Component for sending mail that they’ve deprecated. In Clarity 2022 we brought in a new email sending library called “MailKit”.

It turns out that Mailkit behaves a bit differently than the original Microsoft component.

- It basically ignores the “Use SSL” option you specify, and infers the setting from the port number.
MailKit said: “You do not have a valid certificate for this mail server”.

Resolution:

The quick workaround is to use a different port.
- If you set Port number 587 or 465, SSL is assumed.
- If you set Port 25, it is assumed not.

Error Example:

AdminWebservice log error
INFO 2022-07-12 00:04:57,399 [118] Logging - BIM360 Upload:7480: Uploading FILENAME.nwd to BIM360
ERROR 2022-07-12 00:05:00,408 [116] EmailHelper - Error sending email
MailKit.Net.Smtp.SmtpCommandException: 5.7.54 SMTP; Unable to relay recipient in non-accepted domain
at MailKit.Net.Smtp.SmtpClient.OnRecipientNotAccepted(MimeMessage message, MailboxAddress mailbox, SmtpResponse response)
at MailKit.Net.Smtp.SmtpClient.ProcessRcptToResponse(MimeMessage message, MailboxAddress mailbox, SmtpResponse response)
at MailKit.Net.Smtp.SmtpClient.<FlushCommandQueueAsync>d__66.MoveNext()

Setting an Automated Backup in Settings

There is a configuration for this in Settings on the General tab to Backup the System Database.

The system will attempt, once per week, to make a backup of the RandRevit centralized database to the Backups folder defined in settings.

Manually Backing up the Database

Connecting to the database

RDP into the machine where the SQL Database is installed, if you are using the SQL database installed with Clarity it will be on your host server.

• Log onto the server as the Clarity Service account that runs the services and application pools, this should allow you to Log into SQL with Windows Authentication

• Open the SQL Management Studio
  • You might want to pin this to the task bar
  • 
• Connect
  • 
• Expand Databases
• Right Click on RandRevit
  • Tasks
    • Backup
    • 
• In the Backup Database dialog verify the settings
  • 
• Select Add to add the backup location
  •  

• Browse to a location to save the backup and give it a name and ok out of all dialogs to save the backup with a .bak extension.
  • 
• Ok to backup
  • 
• When the backup completes you will see the following dialog
  • 

Symptoms

• When accessing the web portal you get a 503 error Service Unavailable
• Web app pools above will not stay started.

Things to Check

• Were any Windows Updates installed?
  • Update for Microsoft Windows (KB4601555)
    • May 11, 2021-KB4601555 Cumulative Update for .NET Framework 3.5 and 4.8 for Windows 10, version 1809 and Windows Server, version 2019 (microsoft.com)
  • Security Update for Microsoft Windows (KB5003243)
    • KB5003243: Servicing stack update for Windows 10, version 1809: May 11, 2021 (microsoft.com)
  • 

Event Logs

System Event Warning WAS Event 5021:

The identity of application pool ClarityWebAppPool is invalid. The user name or password that is specified for the identity may be incorrect, or the user may not have batch logon rights. If the identity is not corrected, the application pool will be disabled when the application pool receives its first request. If batch logon rights are causing the problem, the identity in the IIS configuration store must be changed after rights have been granted before Windows Process Activation Service (WAS) can retry the logon. If the identity remains invalid after the first request for the application pool is processed, the application pool will be disabled. The data field contains the error number.

Resolution

To resolve the issue add the App Pool identity used for Clarity to the Log on as batch job User rights assignment.  If the identity is part of a group policy you will need to add it to that then in an admin command prompt run gpupdate.  A reboot may be necessary.

.NET 6.0 Runtime installed

Download Link

Make sure the service is set to Log On as the Clarity Service account.

Issue:

The Journaling service won’t stay running even though the dotnet 6 is installed.

Solution:

We need to make a configuration change to the appsettings.json file in this folder on the host:  C:\Program Files\IMAGINiT Technologies\Clarity Journal Service

Process

Make a backup of the appsettings.json file and change the extension to .orig

Modify the .json file in Notepad.

Add the line below, (highlighted in green in the screen shot) after the password but before the “

;TrustServerCertificate=True

If you get an error saving the file, do a Save As and save it to the desktop, then move it into the folder and overwrite. 

Make sure it is still seen as a .json file or it will not work.

Start the Journaling Service in Services, it should now remain running.