Asset Captions and Logging Description

An asset's Caption and Logging Description properties are both used for naming the asset but serve two distinct purposes.

Caption

The Caption is the short and quick to understand on-screen name of the asset that can be visible to the operator. If an asset’s Caption needs to be displayed and there is limited room on the Map, use an abbreviation that describes the asset well enough for the operator to understand. However, if there is no room for the caption, it is best to hide it on the Map. A typical naming scheme for a cell door in a prison would include Unit Block + Cell number. For example, the Caption for Cell 13 of Unit A would be A13, and Cell 2 of the Bravo wing would be B2.

Note: If the Caption is left hidden, it is recommended to still give the asset a Caption. Even though it will not appear in Runtime, an asset’s caption appears in multiple places in Designer, such as the Project Explorer and Workflow editor. To identify or search for the asset in these places, the asset will need a Caption.

Logging Description:

The Logging Description is the name given to the asset that will appear in the logs. The Logging Description should be much more descriptive than the Caption and should include information such as the Unit Block, Floor Number, and Asset Number. To use the previous examples, the asset for Cell door 13 of Unit A would have a Logging Description of Unit A Cell 13 and Cell 2 on Floor 2 of the Bravo wing would have a Logging Description of Bravo Wing Floor 2 Cell 2. Elaborate Logging Descriptions make it easier for the user to identify and distinguish specific assets in the logs which adds clarity to the Activity Report.

The following are a few examples of Captions and Logging Descriptions:

Example:

Cell 15 Door on Floor 2 of Unit C

Caption: C15

Logging Description: Unit C Floor 2 Cell 15

South-East Camera in the Dining Hall

Caption: Nothing

Logging Description: Dining Hall South-East Camera

Intercom outside the West Perimeter Intake Gate

Caption: Nothing

Logging Description: West Perimeter Intake Gate – Outside Intercom