Click or drag to resize
Schedule table
Print this page

Use the Schedule table to create Job templates. Each schedule specifies the parameters for a specific job type and location along with other details about the job.

A schedule also provides information about using the schedule to create jobs from the template. For example, you can create a schedule to create jobs on a daily, weekly, monthly, or yearly basis, and you can specify the number of jobs to create when the schedule runs.

This topic contains the following sections:

Note Note

This table supports Response integrations for Fleet accounts.

Requirements

When you create a schedule, you must provide values for the StartDate and at least one ServiceTimeWindow in the TimeWindows column.

You can specify up to two service time windows for a schedule. However, both windows must apply to the same set of days.

Note that the following columns are create-only and cannot be updated after the schedule has been created:

  • AnchorDate
  • PeriodCount
  • PeriodType
  • StartDate
  • Frequency
  • TimeWindows Days

When you write templates that access this table, follow these requirements:

  1. Specify the Symbolic Name for the table version to use:

    TableID = Schedule-1.0

  2. Specify an Intent that this table supports:

    • Retrieve
    • Create
    • Update
    • CreateOrUpdate
    • Delete

  3. Input templates: In your [Output] section, be sure to map an input value to every table column that is flagged as being a primary key or required.

Schedule column descriptions

This list includes each column's name, which you use in expressions to retrieve data, and data type, which defines how the data is retrieved.

Column Data Type Description
Id Id (primary key) The ID of a schedule.
Name Text A name for the schedule.
StartDate Timestamp Required. The first possible date that jobs created from this schedule can be serviced. This field is create-only and cannot be updated.
EndDate Timestamp The last possible target date that jobs created from this schedule can be serviced.
AnchorDate Timestamp A date that is used as a target date for creating jobs from this schedule. For example, if you specify a date on the first Monday of a month, the schedule creates jobs that target Mondays based on the schedule PeriodType, every Monday for weekly schedules, and the first Monday of each month for monthly schedules. This field is create-only and cannot be updated.
PeriodType EnumType Indicates whether this schedule is used to create jobs over a daily, weekly, monthly, or yearly period. This field is create-only and cannot be updated.
PeriodCount Number Indicates the number of periods between scheduled job creation. For example, if you want to create jobs every other week, set the PeriodType to Week and the PeriodCount to 2. This field is create-only and cannot be updated.
Frequency Number Indicates the number of jobs that the schedule creates in a period. For example, if you want the schedule to create six jobs a week, set PeriodType to Week and Frequency to 6. This field is create-only and cannot be updated.
AllowedVarianceBefore Number Number of days before the scheduled date that a job created from this schedule can be serviced.
AllowedVarianceAfter Number Number of days after the scheduled date that a job created from this schedule can be serviced.
TimeWindows Array<ServiceTimeWindow> Specifies a window of time when jobs created from this schedule can be serviced. You can specify one or two service time windows for a job. When you specify two service time windows, both windows must have the same value for Days. The Days value is create-only and cannot be updated.
MarkerId Id<Marker> The ID of Marker for the jobs created from this schedule.
TerritoryId Id<Territory> (read-only) The ID of the territory inherited from the marker.
Priority EnumType The Priority of jobs created from this schedule. Values: Lowest, Low, Normal, High, Highest
JobTypeId Id<JobType> The ID of the Job type for jobs created from this schedule.
FixedTimeOnSite TimeInterval The fixed time on site for jobs created from the schedule.
Code Text Free-form text that can be used to categorize jobs created from this schedule.
Notes Text Free-form notes added to the job definition created from this schedule.
Load Map<Text,Number> Specifies the load details of the job created from the schedule. Load data is relevant only on accounts that have been configured with the Load Management feature.
PreferredDriverId Id<Driver> The ID of preferred driver for jobs created from the schedule.
ForbiddenDriverIds Set<Id<Driver>> A list of drivers that will cause routing violations if they are assigned to the job.
RequiredDriverTags Set<Text> A list of tags that a driver must have to be assigned to the job instantiated by the schedule.
RequiredVehicleTags Set<Text> A list of tags that a vehicle must have to be assigned to the job instantiated by the schedule.
Tags Set<Text> A list of tags assigned to the job instantiated by the schedule.
PreJobDepotRequirements Set<Text> A list of tags that an earlier depot in the route must have to avoid routing violations. Note that the tags must already be assigned for the account. You cannot create new tags here.
PostJobDepotRequirements Set<Text> A list of tags that a later depot in the route must have to avoid routing violations. Note that the tags must already be assigned for the account. You cannot create new tags here.

Additional columns:

Column Data Type Description
CustomerId Id (read-only, all Fleet tables) The ID of the customer/owner.
CustomerFullName Text (read-only, all Fleet tables) The human-readable full name of the customer/owner.
Custom columns
Column Data Type Description
Custom.name Text Specifies a user-defined custom column name to store additional information in the table. If the column name contains non-alphanumeric characters, enclose the value in brackets, for example Custom.[Special column].