Knowledge Base: Tasks

  • Clarity PDF In Session Resolution Settings

    I thought it might be helpful to see some examples of what the in-session Appearance settings looked like and what the time differences and file size difference are.

    Time Saving Tip

    In a nutshell, unless you are printing 3d views for final prints, you can probably get away with Low for the raster settings for Appearance.

    Hardware

    In this test I am using the Clarity PDF driver the Task Server on my laptop

    • Windows 11
    • 13th Gen Intel(R) Core(TM) i7-13850HX 10 GHz
    • 64gb Ram
    • NVIDIA 6gb gpu

    Clarity 2025

    Same set each time with Raster set to Color

    Clarity PDF

  • Revit Database Export Config to Skip Tables

    This change is Revit version specific!

    If you are running into issues with the Revit DBExport task and want to skip certain categories, you can modify a config file to do that.

    Process

    This change is Revit version specific!

    • You will need to log onto the task server as the designated Clarity account
    • Exit the Clarity task tray
    • Make a copy of the highlighted config file for the version of Revit you want to change C:\Program Files\IMAGINiT Technologies\Clarity Task Server for Revit\202#\Plugins\RevitDBExport.dll.config
    • Change the extension from .config to .orig so we have a backup copy of the original settings
    • Modify
  • Task Sat in New Status too Long

    In order for tasks to run, the task servers must be online and logged in with the designated Clarity account at all times. 

    For 360 projects, the Autodesk identity token must also be valid, both on the task server and in the Clarity web portal.

    Task not Claimed

    Task Timeout: Task sat in a 'New' status for too long, not moving! TASKSERVER3: TaskServerOffline: Task Server unresponsive to ping. Last checkin was 5/8/2024 1:36:10 TASKSERVER1(WIN): TaskDisabled: The UNIFIEDSYNC type task is not available on this task server.TASKSERVER2(WIN): Unknown: Not sure...

    Or

    : RevitStartupProblem: Possible Revit startup problem (Dialog box, licensing, etc)

  • Clarity Database Export Errors

    Prior to running a Revit Database Export, there is no defined data for the parameters.  Once the first model is run, it sets those values, so all other models with the same parameter name, must have the same types of data set in the parameter or you will get errors.

    What that means is, if I look at the first example below BoxSize is expecting an integer, but in the model that it is running on now, it is formatted as a text parameter.  The data type must be the same in all models.

    Error Examples

    • An error occurred during export
  • How to Clear a Killed or Hung Task in Progress

    Issue

    If you tried to kill a task in the current tasks queue, or it shows that it has been in progress longer than expected, it's likely that Revit is unresponsive or has crashed.

    The task will eventually clear itself out of the list of current tasks, since only the task server can notice that the Revit.exe process is no longer running and mark it as "presumed dead".  

    The problem is, this could take some time, so if you want to hurry things along a bit you can try the process below.

    Resolution

    • Log onto the Task Server as the designated

  • How to Clear a Task Stuck in Claimed Status

    If a task is stuck in the claimed status, the task server started opening the model, but something happened during that process that hung things up.  We aren’t able to kill it from the Clarity web portal, so you either have to wait for it to time out, or manually kill it on the task server.

    If you are trying to get other tasks to run, you probably don’t want to wait for that to happen, so the resolution is to manually fix the issue on the task server.

    Causes:

    If we are waiting for a response in Revit while

  • Clarity BIMTrack Integration

    BIMTrack integration requires its own credentials to access all projects on BIMTrack for the Backup task and Upload post action.

    In BIMTrack, it is a two-legged OAuth Token, giving access to Clarity to a particular BIMTrack hub.

    There is NOT a different set of credentials per user.

    You only need one API token to have access to all projects on a BIMTrack hub.

    Setup

    • Go to your BIMTrack hub and retrieve the API Access token.

      • In BIMTrack - Hub Settings > Gear Icon > API Access Token

      • Go to the Clarity Server/Settings/OAuth page, BIMTrack and add credentials.

      • Enter the hub name

  • Clarity Task Error - Maximum Request Length Exceeded

    Update:  10/1/2024 with preferred method

    Error That error means that the file is too large to send back to the host via http so the config file needs to be modified to allow for larger file sizes. Task Error There was an exception running the extensions specified in the config file. ---> Maximum request length exceeded. If you exceed the default maximum file size which is 400000 you will need to fix a config file to accommodate processing larger file sizes, or enable uploading in chunks (preferred method).

    Resolution Options

    Preferred Method 

    On the Task Server

    Enable Upload in Chunks

  • Clarity Post Action Identity

    As of Clarity 2023 we have had the ability to set the task server to perform the post action locally.  This applies to all post actions.  The one thing to be aware of is, depending on the type of post action and where it is processed, the identity can be different.

  • Using the Clarity Task Utility

    What is the Clarity Task Utility?

    It is a Windows-based tool, installed with the Clarity Host software, which can do some batch updates on tasks and task definitions.

    Where is It?

    C:\Program Files\IMAGINiT Technologies\Tools\Clarity.TaskUtility

    What Can It Do?

    • Manage Current Tasks
      • Select the tasks in the grid, then for the selected tasks:
        • Kill Them (request that Revit be shutdown if it's working on them)
        • Delete them (remove them if Revit has not yet claimed them)
        • Reprioritize them to a new priority level
    • Manage Task Definitions
      • Select the tasks in the grid, then for the selected tasks:
        • Batch Copy them to
  • Clarity Tasks with Worksets None

    You can increase productivity by running some of your tasks with Worksets set to None.  This will improve the open time, dramatically in some cases, depending on the size of the file and the number of links.

    Below is a list of tasks that can run with worksets set to None without impacting the output from the task.

    Revit Tasks

    • Backup Project
    • Backup Revit Server
    • BIM360/ACC Publish
    • BIM 360 Migrate
    • Family Upgrader
    • Harvest Families
    • Index Families
    • Index Model Families
    • Model Checker
    • Model Metrics
    • Model Review
    • Model Upgrader
    • Performance Advisor
    • Quantity Snapshot
    • Revit Audit and Compact
    • Revit Database Export
      • Unless you
  • 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 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