The Test Tag agent is a location type agent that provides self-test functionality for store operators to verify that sensors and light trees are working correctly.
When this agent is notified of a topic matching the value of the tagTopic property, the data is checked to see if it matches one of any of the testTagIds property values. If there is a match, the agent enters test mode.
The agent then begins to play the sequence of topics defined in the outputTopics property. A delay defined in the lightDelay property occurs between each of the topics defined in the outputTopics property.
The agent remains in test mode until it receives the topic configured in the tagAggregationTopic property or until the number of milliseconds defined in the testModeTimeout property has been reached, whichever occurs first. If the tag aggregation topic occurs before the timeout value, the agent exits test mode and begins to play the sequence of topics defined in the aggregationOutputTopics. The same delay defined in the lightDelay property occurs between each of those topics. If the timeout value is reached but no tag aggregation topic is received, then agent exits test mode but does not continue to wait for the topic.
For the properties below, you can enter either strings or variables. If you enter a variable, the value is substituted from the database when the XML configuration file is generated. Refer to Using variables for property values for details on what variables can be substituted.
Property | Description |
---|---|
aggregationOutputTopics | The sequence of topics that TestTagAgent will output when exiting test mode |
lightDelay | Delay in milliseconds that occurs between each of the topics listed in the aggregationOutputTopics property. This property must be greater than or equal to the duration delays defined in the Light Tree agent for each of the lights, or the behavior is undefined. |
log.level | The level of logging to use with this agent. If the value is empty then the system log level will be used. The Alert agent must be running in order to set this property. |
outputTopics | The sequence of topics that TestTagAgent will output when entering test mode |
portal.id | The portal ID associated with this agent |
portal.name | The portal name associated with this agent |
qos | Messaging Quality of Service. A value of 0 means at most once. A value of 1 means at least once. A value of 2 means exactly once. |
source.id | The source ID for generic events in this agent |
tagAggregationTopic | The topic that signals the end of the test mode |
tagTopic | The topic that TestTagAgent listens for entering test mode |
testModeTimeout | A number in milliseconds that signals the end of the test mode |
testTagIds | Any prefix up to and including the full tag id. The agent will enter test mode if any tagId starts with this string. |
tracing | Displays trace output. The Alert agent must be running in order to set this property. |