Selectors
Selectors provide filters on OMD data, allowing the algorithm to select the requested objects for further processing. For example, a trip-related algorithm will require a resource selector and a data range selector to identify the trip objects the algorithm must process.
ResourceSelector
By default, the resource selector will retrieve all resources within a configuration. By specifying properties, the resources will be filtered accordingly. Do not specify any property at all if the algorithm must run on all resources of the configurations.
| Property | Description | Default | Example |
|---|---|---|---|
| includeInactive | A Boolean value, indicating that the selector must include all resources, regardless of their inactive flag. | false | true |
| resource | Specifies the id of the resource for which the algorithm is to be executed. | N/A | 101-1 |
| territory | Specifies the name of the territory for which the algorithm is to be executed. | N/A | T101 |
| user | All resources within the territories individually assigned to this user are selected. Note that this property will not select any resource if the user has all territory permission, but no individual territory assignment. | N/A | Batch-User01 |
DateRangeSelector
Date ranges can be specified by an offset and the number of days. Note that the range can move into both directions, forward and back in time.
| Property | Description | Default | Example |
|---|---|---|---|
| offset | An offset value of -1 indicates yesterday, a value of 0 indicates today and so forth. | 0 | 2 |
| days | The day property, defaulting to 1, indicates how many days are to be unplanned. If the offset is negative, the days will go back in time (offset, offset - 1, ...). If the offset is positive, the days will move forward in time (offset, offset + 1, ...). | 1 | 12 |
SLASelector
The SLASelector compiles a set of tasks by their latest date/time, within a range of hours, relative to execution time, or relative to an optional date range selector's set of dates.
| Property | Description | Default | Example |
|---|---|---|---|
| hoursFuture | Limits the number of future hours [h]. | 10 |
60 |
| hoursPast | Limits the number of hours in the past [h]. | 10 |
12 |
| workWeekends | Take days on weekends into account. | true |
false |
| holidayCalendar | Name of a holiday calendar, specifying spare days not taken into account. | N/A | standard |