Input Table | The input table to iterate. | Table View; Feature Layer |
Time Step Interval
| Specifies the time interval that will be used to create temporal slices.
Only whole numbers are valid inputs. - Minutes—The data will be divided by minutes.
- Hours—The data will be divided by hours.
- Days—The data will be divided by days.
- Weeks—The data will be divided by weeks.
- Months—The data will be divided by months.
- Years—The data will be divided by years.
- Decades—The data will be divided by decades.
- Centuries—The data will be divided by centuries.
| Time Unit |
Start Time Field
| A field that will be used to define the temporal extent and query to create temporal slices. The temporal extent can be altered by specifying a different datetime value in the Iteration Start Time parameter. | Field |
End Time Field
(Optional) | A field that will be used to define the end of the temporal extent and query to create temporal slices. The field can be added if the data has separate date fields for start and end time.
If the data has a single field for start and end time, leave this parameter blank or set it to the same field as the Start Time Field value. | Field |
Iteration Start Time
(Optional) | Creates a subset of the data starting on and after the specified datetime value. | Date |
Snap Iteration Start Datetime To Data (Optional) | Specifies whether the start of the iteration will be aligned with the closest date in the data. - Checked—The start of the iteration will be aligned with the closest date in the data that is on or after the date specified for the Iteration Start Time parameter.
For example, if the Iteration Start Time parameter value is 2022-01-01 and the data starts from 2022-01-06, the iteration will start from 2022-01-06 and divide the data by the time interval defined by the Time Step Interval parameter. In the case of a one-month step interval, the slice with be 2022-01-06 to 2022-02-06, and so on. - Unchecked—The start of the iteration will be aligned with the date specified for the Iteration Start Time parameter. This is the default.
For example, if the Iteration Start Time parameter value is 2022-01-01 and the data starts from 2022-01-06, the iteration will still start from 2022-01-01 and divide the data by the time interval defined by the Time Step Interval parameter. In the case of a one-month step interval, the slice with be 2022-01-01 to 2022-02-01, and so on.
| Boolean |
Iteration End Time
(Optional) | Creates a subset of the data ending on and before the specified datetime value. | Date |
Snap Iteration End Datetime To Data (Optional) | Specifies whether the end of iteration will be aligned with the closest date in the data. - Checked—The end of iteration will be aligned with the closest date in the data that is on or before the date specified for the Iteration End Time parameter.
For example, if the Iteration End Time parameter value is 2022-12-31 and the data ends at 2022-12-28, the iteration will end at 2022-12-28. The last slice can be smaller than the defined time step interval. - Unchecked—The end of iteration will be aligned with the closest date specified for the Iteration End Time parameter. This is the default.
For example, if the Iteration End Time parameter value is 2022-12-31 and the data ends at 2022-12-28, the iteration will end at 2022-12-31. The last slice will be divided pursuant to the time interval but will end based on the Iteration End Time datetime value specified.
| Boolean |
Include Start (Optional) | Specifies whether the start time will be included in each time slice. - Checked—The start time will be included in each time slice. This is the default.
- Unchecked—The start time will not be included in each time slice.
| Boolean |
Include End (Optional) | Specifies whether the end time will be included in each time slice. Checking both Include Start and Include End will result in counting the same event twice. If an event occurred at the ending of the previous slice, it will also be counted in the following slice (include start). This may be useful in continuous events. For example, a fire has been burning for three days and you want to know the total number of new and existing fire records - Checked—Values less than or equal to the end time will be included.
- Unchecked—Values less than the end time will be included. This is the default.
| Boolean |
Skip Null Values (Optional) | Specifies whether rows with null datetime values will be included. This parameter is available when the Start Time Field and End Time Field parameter values have different date fields. - Checked—Rows with null datetime values will not be included. This is the default.
- Unchecked—Rows with null datetimes values will be included.
Uncheck this parameter in the following cases: - The Start Time Field parameter value is null—Any row with a null value in the Start Time Field parameter value will be included in every temporal slice until the end of the time extent from the End Field parameter value.
- The End Time Field parameter value is null—Any row with a null value in the End Time Field parameter value will be included in every temporal slice unless it doesn't fall within the time slice query for that temporal slice.
- Both the Start Time Field and End Time Field parameter values are null—Any row with a null value in the Start Field and End Field parameter values will be included in each temporal slice.
| Boolean |
Format Output Time String (Optional) | Specifies whether reserved characters will be removed from the output Start Time and End Time parameter values. Only alphanumeric and underscore characters will be retained. - Checked—Reserved characters will be removed from the output Start Time and End Time parameter values. For example, if the datetime value is 2022-01-01 08:30:00, the formatted string will be 2022_01_01_08_30_00.
- Unchecked—Reserved characters will not be removed from the output Start Time and End Time parameter values. This is the default.
| Boolean |
Skip Empty Slices (Optional) | Specifies whether empty (row count = 0) time slices will be removed. An empty time slice contains no rows. - Checked—Empty time slices will be removed. For example, the input data has no records for 2022-01-02 and 2022-01-03. With a one-day interval from 2022-01-01 to 2022-01-05, this option allows you to skip these two time slices and no empty layer will be returned. This is the default.
- Unchecked—Empty times slices will not be removed. For example, the input data has no records for 2022-01-02 and 2022-01-03. With a one-day interval from 2022-01-01 to 2022-01-05, this option allows you to keep these two time slices and empty layers will be returned.
| Boolean |