CenTrak TruView

Definitions

RTLS — Real-Time Location System.

Tag — A tag is a physical device that tracks the location for people. There are two types in CenTrak TruView— one for residents, and another for staff.

RTLS Events — These are events triggered by the CenTrak TruView system, e.g., a tag firing a duress alarm.

Setup

See the Data Servers page for information on configuring driver communication.

Compatibility

The CenTrak TruView integrated system is compatible with CenTrak TruView v5.0.0.12.

Prerequisites


Software	Minimum Version
IPFusion — CenTrak TruView	1.1
Centrak TruView API	5.0.0.12
.NET Framework	4.7.2

Important: Contact the CenTrak TruView team to have the API enabled on your system.

When completing your setup, be sure to have the CenTrak TruView documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.


Purpose	Default Value	Configurable
Communication Settings	3008	Yes
Dataserver	9673	Yes
Debug Tools	9674	No

Communication Configuration

In the integrated system configuration panel, you will find the Communication Settings. The following information is required:

Table 1. Connection Settings
Address	The address of the CenTrak TruView server.
Port	The port for the connection to the CenTrak TruView server.

Table 2. Authentication
Username	The username for the account used for the Runtime connection to CenTrak TruView.
Password	The password for the CenTrak TruView account.

Note: Red X indicates an invalid or out of range value given for field.

Assets

Tag

Tag assets are not defined in Designer; however, a placeholder asset called the DefaultTag is available to enable the configuration of Workflows for tag assets. This asset is automatically added to the project on creation of an integrated system instance and will have a unique ID that counts towards the license limit. Alarms on this asset will display the zone it is located within. If the tag has initialized but not entered a zone yet, the zone listed is Unknown Zone. This will be updated once the tag enters a zone. If the tag leaves that zone area but does not enter a new one, the last known zone for the tag will be displayed.

Supported States


Normal	The asset is online and in its default state.
Fault	An issue has been detected in a connected asset.
Acknowledged	An asset alarm has been acknowledged.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.
Resident Geo Pendant	A duress alarm triggered by a resident tag.
Staff Geo Pendant	A duress alarm triggered by a staff tag.
Roaming	A resident tag has roamed into a disallowed area for that resident.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Acknowledge	Acknowledge an asset alarm.
Reset	Resets the asset to its true hardware state.
Cancel	Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Zone

A zone is an area on the RTLS system site map that can be used to identity the approximate location of tags on a Map. The zone assets behave uniquely for a few reasons:

Acts as a storage for a collection of tags that are defined by the CenTrak TruView system. Each zone will only store the collection of tags that are currently in that specific zone.
Does not represent the status of the zone, but rather the status of the tags within the zone.
Does not have its own set of commands, but rather the commands of the tags in an alarm state within the zone.
If multiple tags are in an alarm state within a zone, the zone will display the tag with the highest priority followed by the oldest alarm that is unacknowledged.
A zone that has no tags in an alarm state is not available for selection.

Required Property Grid Fields


IR ID	The identifier of the zone within the CenTrak TruView system.

View all properties

Supported States


Normal	The asset is online and in its default state.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.
Fault	An issue has been detected in a connected asset.
Acknowledged	An asset alarm has been acknowledged.

See the Configure a Status Table page for more information on configuring status tables.

Pull Cord

The pull cord asset represents a pull cord station in the CenTrak TruView integrated system.

Required Property Grid Fields


PullCord ID	The identifier of the pull cord within the CenTrak TruView system.

View all properties

Supported States


Normal	The asset is online and in its default state.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.
Fault	An issue has been detected in a connected asset.
Acknowledged	An asset alarm has been acknowledged.
Pull Cord	The cord on the station has been pulled.
Jack Button Press	The pull cord station button has been pushed.
Jack Removal	The pull cord has been removed from its station.

See the Configure a Status Table page for more information on configuring status tables.

System

The system asset is a representation of the connection state of the RTLS system.

View all properties

Supported States


Normal	The asset is online and in its default state.
Fault	An issue has been detected in a connected asset.
Acknowledged	An asset alarm has been acknowledged.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Acknowledge	Acknowledge an asset alarm.
Reset	Resets the asset to its true hardware state.
Cancel	Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Workflow Integration

Asset Events

Asset events are events used to trigger Workflow actions on an asset level. For more information about Workflows, see the Workflows section.

Zone Asset

All zone asset events can access the Last Tag Entered, Last Tag Exited, Highest Priority Tag In Alarm, Newest Tag in Alarm and Selected Tag Asset. The Caption and Logging Description on the tag properties use the tag IR ID.

Table 3. Zone Properties
Item ID	The unique identifier for this item.
Item Type	The Type of item this is.
Asset Type Name	The name of the type of asset this is.
Caption	A label for the asset.
Current Status Alarm Type ID	The ID of the type of the last alarm on this asset.
Current Status Alarm Type Name	The name of the type of alarm last on this asset.
Current Status Name	The name of the current asset status.
Executed Command	The command touched at the time of the Workflow being triggered. If the trigger was not from command execution, this value is blank.
In Alarm	Whether this asset is currently in an alarmed state.
In Current Posting	Whether this asset is included in the current active alarm postings.
Integrated System Owner ID	The ID of the Integrated System this asset belongs to.
Is Selected	Whether this asset is currently selected or not.
Last Alarm Time In	The date and time of when this asset was last in an alarmed state.
Logging Description	Description of the asset to be used in the logs.
Name	The value for this property is the Description configured via the property grid when the item is selected in Designer.
Touched Command	The command touched in the command panel for this asset.

On Tag Exited

This event occurs when a tag exits a zone.

Important: Tag location updates only occur while the tag is in a roaming or duress state.

Table 4. Properties
Item ID	The ID of the zone asset this trigger fired for.
Contains Selected Tag	Whether this zone contains a tag that is currently selected.
Containing Tag in Alarm	Whether the zone contains a tag in an alarmed state.

On Tag Entered

This event occurs when a tag enters a zone.

Important: Tag location updates only occur while the tag is in a roaming or duress state.

Table 5. Properties
Item ID	The ID of the zone asset this trigger fired for.
Contains Selected Tag	Whether this zone contains a tag that is currently selected.
Containing Tag in Alarm	Whether the zone contains a tag in an alarmed state.

On Tag Alarm

This event occurs when a tag is in an alarmed state.

Table 6. Properties
Item ID	The ID of the zone asset this trigger fired for.
Contains Selected Tag	Whether this zone contains a tag that is currently selected.
Containing Tag in Alarm	Whether the zone contains a tag in an alarmed state.

Tag Asset

Table 7. Tag Properties
Item ID	The unique identifier for this item.
Item Type	The Type of item this is.
Asset Type Name	The name of the type of asset this is.
Caption	A label for the asset.
Current Status Alarm Type ID	The ID of the type of the last alarm on this asset.
Current Status Alarm Type Name	The name of the type of alarm last on this asset.
Current Status Name	The name of the current asset status.
Executed Command	The command touched at the time of the Workflow being triggered. If the trigger was not from command execution, this value is blank.
In Alarm	Whether this asset is currently in an alarmed state.
In Current Posting	Whether this asset is included in the current active alarm postings.
Integrated System Owner ID	The ID of the Integrated System this asset belongs to.
Is Selected	Whether this asset is currently selected or not.
Last Alarm Time In	The date and time of when this asset was last in an alarmed state.
Logging Description	Description of the asset to be used in the logs.
Tag ID	The unique identifier given to a tag by the CenTrak TruView system.
Tag Name	The user provided Name to a tag assigned in the CenTrak TruView system.
Touched Command	The command touched in the command panel for this asset.
Zone Asset ID	The unique identifier given to a zone by the CenTrak TruView system.

System Events

System events are events used to trigger Workflow actions at the system level. For more information about Workflows, see the Workflows section.

Alert Level Changed

The Alert Level Changed event is triggered when a CenTrak TruView alarm has updates for its Alert Level.

Table 8. Alert Level Payload Properties
Alert ID	The unique identifier of the alert.
Alert Level	The current escalation level for the alarm.
Alert Type Name	The main type classification of the alert for the alarm.
First Name	The first name of the resident initiating the alert.
Is Active	The flag indicating whether the alarm and its alert are still active in the CenTrak TruView system.
Is Repeated	The flag indicating whether the Alert Level Changed trigger received is due to the alert being re-notified.
Last Name	The last name of the resident initiating the alert.
Location Building Name	The building where the alarm and its alert were received.
Location Floor Name	The floor where the alarm and its alert were received.
Notification Extensions	The comma-separated list of staff phone extensions that will be called when the tag alert escalates. Note: This field will only populate when alerts are sent to one or more staff.
Object ID	The unique identifier of the entity that fired the alarm or escalated the alert level.
Object Type	The type of the entity that fired the alarm or escalated the alert level.
Sub Alert Type Name	The specific type of alert for the alarm.

Note: Toggling Continuous Notifications to On and configuring the Repeat Level option in the latest Alert Level Notification will continue to fire alarm alerts indefinitely until the alarm has been processed in the CenTrak TruView system.

The following three properties are default in every object and are unlikely to apply when used with the Alert Level Changed event.

Table 9. Default Properties
Item ID	The value will be AlertLevelChangedEventId.
Item Type	The value will be AlertLevelChangedEventType.
Name	The value will be Alert Level Payload.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.

Alarms not coming in Runtime for Second System Instance

This system does not currently support multiple instances. It is recommended to only use one instance for a project.

Connection Issues

Ensure Communication Settings and asset configuration is correct.
Ensure the system hardware is connected to the same network as Runtime.
Check if the Integrated System driver service is running.
Verify the Integrated System dataserver addresses are correct.
Ensure other software on the Workstation is not using the same port as the driver.

Selected Asset Navigation not Working Correctly

When you select an asset in the alarm grid or via a Workflow, it automatically navigates you to that assets map. In the event this does not occur properly, it is likely your asset is either a duplicate, or hidden.

To see if your asset is a duplicate, check if other assets of that type contain the same settings. If you find that it is a duplicate, it is recommended to:

Delete the extra asset.
Note: If there are any references to this asset in Workflows, those will be broken by deleting this.
If you wish to place this asset in multiple locations, right-click the remaining asset and select Copy.
In the location you wish to duplicate this asset, right-click and select Paste. This will duplicate only the icon, but not the asset itself.

If your asset is hidden, it will not be navigated to on selection. If you do wish to navigate to a specific map, you can create a Workflow which changes the active map in a Map Container to the one desired.