Quuppa ILS

The Quuppa ILS integrated system provides real-time location tracking.

Definitions

RTLS — Real-Time Location System.

Tag — A tag is a physical device that tracks the location for people.

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

Setup

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

Compatibility

The Quuppa ILS integrated system is compatible with Quuppa ILS V2.2 Web API.

Prerequisites

Software Minimum Version
IPFusion — Quuppa ILS 1.0
.NET Framework 4.7.2

When completing your setup, be sure to have the Quuppa ILS documentation available for reference.

Ports

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

Purpose Default Value Configurable
UDP Listening Endpoint 1024 Yes
Web Api Connection 2048 Yes
Dataserver 9675 Yes
Debug Tools 9676 No

Quuppa UDP Push Target

In the Quuppa system a UDP Push target must be set up to point to each driver instance. In the Quuppa Site Planner:

  1. Right-click UDP/Logging Targets and open the UDP/Logging editor.
  2. Configure these settings:
    1. Output Format: defaultLocationAndData
    2. Trigger Mode: AnyDataUpdate

Tag Visuals

The Quuppa ILS integrated system can be used with the location surface map item to display the tags exact location based on its coordinates. These settings are used to specify the tag visuals and which location surface a tag will be displayed in.

Coordinate Systems Mapping

The coordinate systems mapping settings are used to map coordinate systems from Quuppa to the location surfaces in your project.

Note: It is recommended to ensure that all of your coordinate systems and their total areas are represented with location surfaces in the project.
Location Surface Name In the drop-down, select the location surface this mapping is for. The values for their names are from the Identifier field in the location surface properties.
Coordinate System ID The ID of the coordinate system in the Quuppa ILS server.
Start Position (x) This determines the starting position within the coordinate system to be displayed on the location surface. If the entire coordinate system is being displayed, this can be set to 0.
End Position (x) This determines the ending position within the coordinate system to be displayed on the location surface. If the entire coordinate system is being displayed, this can be set to 0.

Tag Indicator Image

The tag indicator image settings are used to configure the image representing the tag in a location surface. If no image resource is selected, a red dot is used instead.

Communication Configuration

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

Table 1. Quuppa UPD Listening Endpoint Settings
Port The port used to recieve UDP calls from Quuppa ILS.
Table 2. Quuppa Web Api Connection Settings
Address The address of the Quuppa ILS Web Api endpoint.
Port The port for the connection to the Quuppa ILS Web Api endpoint.
Note: Red X indicates an invalid or out of range value given for field.

Assets

Tag

Tag assets are not defined in Designer. Instead, the tag assets are defined in the RTLS system and are automatically imported into Runtime. 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.
Button One Pressed This is a configurable status.
Button Two Pressed This is a configurable status.

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 Quuppa ILS 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

Zone ID The identifier of the zone within the Quuppa ILS 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.

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, and Selected Tag Asset. The Caption and Logging Description on the tag properties use the tag ID.

On Tag Initialized

This event occurs when a tag is initially loaded into Runtime.

Table 3. Properties
Item ID

The ID of the zone asset this trigger fired for.
Last Tag Entered The ID of the last tag to enter this zone.
Last Tag Exited The ID of the last tag to exit this zone.
Highest Priority Tag in Alarm The ID of the tag in this zone with the highest priority alarm.
Newest Tag in Alarm The ID of the tag which most recently became alarmed.
Selected Tag Asset The ID of the tag which is currently selected in this zone.
On Tag Exited
This event occurs when a tag exits a zone.
Table 4. Properties
Item ID

The ID of the zone asset this trigger fired for.
Last Tag Entered The ID of the last tag to enter this zone.
Last Tag Exited The ID of the last tag to exit this zone.
Highest Priority Tag in Alarm The ID of the tag in this zone with the highest priority alarm.
Newest Tag in Alarm The ID of the tag which most recently became alarmed.
Selected Tag Asset The ID of the tag which is currently selected in this zone.
On Tag Entered
This event occurs when a tag enters a zone.
Table 5. Properties
Item ID

The ID of the zone asset this trigger fired for.
Last Tag Entered The ID of the last tag to enter this zone.
Last Tag Exited The ID of the last tag to exit this zone.
Highest Priority Tag in Alarm The ID of the tag in this zone with the highest priority alarm.
Newest Tag in Alarm The ID of the tag which most recently became alarmed.
Selected Tag Asset The ID of the tag which is currently selected in this zone.
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.
Last Tag Entered The ID of the last tag to enter this zone.
Last Tag Exited The ID of the last tag to exit this zone.
Highest Priority Tag in Alarm The ID of the tag in this zone with the highest priority alarm.
Newest Tag in Alarm The ID of the tag which most recently became alarmed.
Selected Tag Asset The ID of the tag which is currently selected in this zone.

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.

Tag is not Displaying in the Expected Location Surface

If a tag is displaying in an unexpected location surface, or not at all, the location surface may be mapped to the incorrect coordinate system. To fix this:

  1. In the Quuppa ILS server, select the coordinate system from the navigation pane.
  2. In the Coordinate System pane, copy the ID.
  3. In Designer, open the Quuppa ILS integrated system configuration and navigate to Tag Visuals.
  4. Find the location surface this coordinate system is meant to display in. If it does not exist, Add it.
  5. Paste the copied ID into the Coordinate System ID textbox.

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:

  1. Delete the extra asset.
    Note: If there are any references to this asset in Workflows, those will be broken by deleting this.
  2. If you wish to place this asset in multiple locations, right-click the remaining asset and select Copy.
  3. 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.