Available in real-time and big data analytics.
The Filter by Time Range tool filters features using a specified time before, time after, or time range. Each feature's Start time key field value is evaluated by the time range specified. Features that the specified time range evaluates as true are retained.
Examples
The following are example uses of the Filter by Time Range tool:
- A real-time analytic uses the Filter by Time Range tool to retain only the incoming records from a feed in which the feature Start time key field value is After 2019-09-01 06:00.
- A big data analytic uses the Filter by Time Range tool to retain only the incoming records from a feed in which the feature Start time key field value is Between 2019-09-01 15:00 to 2019-09-15 03:00.
Usage note
Keep the following in mind when working with the Filter by Time Range tool:
The Filter by Time Range tool filters features based upon the defined Start time key field value. The Start time key field is specified when you configure a feed or a source.
Parameters
The following are the parameters for the Filter by Time Range tool:
Parameter | Description | Data type |
---|---|---|
Input Layer | The layer that is filtered. | Features |
Time Range | A time range that evaluates all of the records to filter the incoming data. Records evaluated as true are retained, and records evaluated as false are discarded. The Time Range options include Before, After, and Between. Use the time picker to choose a single date and time (Before or After) or a range of date and time (Between). | String |
Output layer
The Filter by Time Range tool does not alter incoming features; the output layer contains the same fields and attribute values as the incoming features.
Consideration and limitation
Consider the following when using the Filter by Time Range tool:
Velocity tools expect source data dates and times to be stored in UTC. Arcade functions such as ChangeTimeZone can be used to convert data represented in a local time zone to UTC.