Available in real-time analytics.
The Control Event Volume tool filters events with multiple observations based on a time span and count. New track observations that fall below the count threshold for the time span are retained. New track observations that exceed the count threshold for the time span are discarded.
Examples
The following are example use cases for the tool:
- A construction company wants to be notified when a vehicle unexpectedly leaves a job site. They want to be notified when it first occurs and once more if it continues. The locations of the vehicles are reported every five minutes. To avoid sending an email every five minutes when a vehicle's location remains outside a job site, the Control Event Volume tool can be configured to allow two events (emails in this case) every hour. This ensures that an email is sent the first time a vehicle is outside a job site and again five minutes later if it remains outside the job site. No additional messages are sent for that vehicle until an hour has passed.
- A temperature sensor reports the temperature every 10 seconds. Operations personnel want to receive a text message when the temperature is beyond safe levels. To avoid sending a text message every 10 seconds when the temperature is reported to be too hot, the Control Event Volume tool can be configured to allow one event (text message in this case) every three minutes. A text message is sent the first time the temperature exceeds safe levels and three minutes later if the temperature continues to exceed the safe level.
Usage note
Keep the following in mind when working with the tool:
- This tool only processes events with a unique track ID. A Track ID key field must be identified on the input dataset to use this tool.
- This tool supports features with point, polyline, polygon, or no geometry types.
Parameters
The following are the parameters for the tool:
Parameter | Description | Data type |
---|---|---|
Interval (in seconds) | The time span during which each track observation is evaluated for filtering. The interval repeats as long as the analytic is running. The default is 60. | String |
Max events per interval | The total number of repeat track observations that can be processed in an interval. The default is 1. | Integer |
Track ID fields | The fields that uniquely identify features to be processed. Options include: Select all, Select inverse, or Select none. | Fields |
Considerations and limitations
Consider the following when working with the tool:
This tool discards track observations that exceed the Max events per interval parameter value for the current interval. These events are not cached or queued. If maintaining all track observations is important, consider branching the analytic to store the same data as features in a feature layer or cloud storage output.