The Batch Tag Report agent creates batched tag messages based on the number of tags to be batched or the time between batching.
For performance reasons, it is more efficient to group tag reads into fewer multi-tag batch events for transmission to WebSphere® Sensor Events.
This agent is useful for cases where many tags are sent individually. This means Data Capture and Delivery processes the individual tag reads and send them to the WebSphere Sensor Events one at a time, which can overload the connection or server in high-load situations. This agent groups single tag reads into fewer batch events, sending those batched events to the WebSphere Sensor Events instead. Typical usage would insert the Batch Tag Report agent between the reader and the ID Transformation agent.
By default, tag reads flow from the reader to the ID Transformation agent, to the Event Transformation agent, and then to WebSphere Sensor Events. If the Batch Tag Report agent is inserted, the tag reads then flow from the reader to the Batch Tag Report agent, to the ID Transformation agent, to the Event Transformation agent, and then to WebSphere Sensor Events.
The Batch Tag Report agent should subscribe to the output from the reader, which is also the input to the ID Transformation agent. To set this configuration, copy the topics from the ID Transformation agent transform.from property to the Batch Tag Report agent subscribe.topics property.
The ID Transformation agent should subscribe to the output from the Batch Tag Report agent. To set this configuration, copy the topics from the Batch Tag Report agent publish.topic property to the ID Transformation agent transform.from property.
This configuration enables all tag reads to go from the reader to the Batch Tag Report agent, which then sends tag batch events to the ID Transformation agent and then to theWebSphere Sensor Events.
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 agent property values for details on what variables can be substituted.
Property | Description |
---|---|
batch.threshold | The minimum number of tag read events that will
trigger a batched tag report. Once the value set for this property
is reached, a Tag report is issued. Note:
|
handle.duplicate | Determines how to handle a duplicate tag. The options are: keepLast, keepFirst, and publish |
log.level | The level of logging to use with this agent. If the value is empty then the system log level will be used. |
portal.id | The portal ID associated with this agent. |
portal.name | The portal name associated with this agent. |
publish.delay.ms | The number of milliseconds to wait for a full batched tag report to be created. If the time set for this property elapses, the current events are published. |
publish.topic | Publish summary reports to this topic |
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. |
subscribe.topics | Subscribe reports to this topic |
tracing | Displays trace output. |