Importing and Exporting Recurring Jobs

If you have a large number of recurring jobs, you can choose to import them using a comma delimited CSV format import file. You can also export recurring jobs created in the Scenarios user interface in the same format, for backup purposes.

Importing Recurring Jobs

To import a recurring jobs file:

 

1.Open the list menu in the upper left corner of the List panel and select the Recurring Jobs option. The Recurring Jobs list opens.

 
2.Click the More menu button to the right of the List panel, and then select the Import Recurring Jobs option in the menu that opens.

 
3.Drag and drop the CSV format file from its saved location into the dialog box. Alternatively, click Choose File, browse to the file on your computer, select it, and then click Open.

 
4.Click Manage Mappings. The Manage Mappings dialog box opens. From here you can use one of the following methods to map the columns in your import file to the columns in the Recurring Jobs list:

 
oIf you have used the column naming conventions described in the recurring job import file format table below, you can click Auto Map and the columns in your import file are mapped to the correct recurring job values automatically. You can use the Sort button to toggle between sorting the columns on the left alphabetically or in the order they appear in the file.
oIf you have previously saved a JSON file containing the column mappings, you can click Load to use the saved mappings.
oIf your import file uses your own custom column names, follow these steps:
a.Click a column name in the left panel, and then click the right-facing arrow .
b.Select the field in the right panel, and click Edit Mapping.
c.Select the field that matches the values contained in the import column.
d.Click OK.

 

 
Repeat this process for each column in your import file.
 

5.(Optional) When you have mapped your columns from the file to the Recurring Jobs list, you can perform any of the following actions:

 
oClick the left-facing arrow to remove the selected field from the Recurring Jobs list.
oClick Edit Mapping to change the mapping for the selected field.
oClick Clear to clear all mappings you have made and start over.
oClick Download to save the current mappings so that you can reuse them another time.
oClick the Settings button to select the formatting to use for dates.

 

6.When you have finished mapping all your columns from the import file to the Recurring Jobs list, click OK to complete the import.

Recurring Jobs Import File Format

Your recurring job import CSV files can contain some or all of the following columns:
 

Column Name

Value

schedule.id

The unique identifier of the recurring job.

schedule.name

The name of the recurring job.

schedule.schedule_type

The recurrence type of the recurring job. Can be "one_off", "daily", "weekly", "monthly_by_day_of_week", "monthly_by_day_of_month", "times_per_week", "times_per_month", "times_per_year".

schedule.base_date

The date the recurring job is based on. If blank, Scenarios chooses this date automatically when creating jobs.

schedule.earliest_date

The earliest date when jobs based on this recurring job can be created. If empty, the date of the earliest route is used.

schedule.latest_date

The latest date when jobs based on this recurring job can be created. If empty, the recurring job will recur indefinitely.

schedule.frequency

The number of times to create jobs based on this recurring job. Applicable to any recurring job type apart from "One off".

schedule.interval

At which interval to create jobs based on this recurring job. The interval depends on the schedule_type. For example, if the schedule_type is "daily" and the interval is 2, a job is created every 2 days.

schedule.allowed_variance_before

The number of days that jobs based on this recurring job can be scheduled before the base date.

schedule.allowed_variance_after

The number of days that jobs based on this recurring job can be scheduled after the base date.

schedule.allowed_days_of_week

The days of the week when jobs based on this recurring job can be completed. Formatted as a three character days delimited by a comma; for example, "mon,tue,wed". If empty, all days are allowed.

schedule.custom.[custom]

The custom fields associated with the recurring job.

job_template.location_name

The name of the recurring job location marker.

job_template.location_id

The ID of the job location marker. Can be supplied as an inline marker or as the ID of a marker (see Marker Import File Format).

job_template.lat

The latitude coordinates of the job location. Required if job_template.address is not provided.

job_template.lon

The longitude coordinates of the job location. Required if job_template.address is not provided.

job_template.lat_lon

The latitude and longitude coordinates of the job location. Required if job_template.address or job_template.lat and job_template.lon are not provided.

job_template.address

The formatted address of the job location, including the country. Required if job_template.lat_lon or job_template.lat and job_template.lon are not provided.

job_template.time_on_site

The length of time the driver is expected to spend at the job site.

job_template.time_window_start

The start time of the job's time window. Drivers can arrive at the job site between the job_template.time_window_start and job_template.time_window_end times.

job_template.time_window_end

The end time of the job's time window. Drivers can arrive at the job site between the job_template.time_window_start and job_template.time_window_end times.

job_template.time_window2_start

The start time of the job's second time window. Drivers can arrive at the job site between the job_template.time_window2_start and job_template.time_window2_end times.

job_template.time_window2_end

The end time of the job's second time window. Drivers can arrive at the job site between the job_template.time_window2_start and job_template.time_window2_end times.

job_template.priority

The priority of the job. Available priority values are "lowest", "low", "normal", "high", or "highest".

job_template.required_driver

The driver.id value of the driver required to complete this job.

job_template.forbidden_drivers

The driver.id values of the drivers forbidden from completing this job.

job_template.required_route_attributes

The route attributes that are required for the job to be assigned to a route.

job_template.disallowed_route_attributes

The route attributes that are not permitted for the job to be assigned to a route.

job_template.required_driver_attributes

The driver attributes that are required for the job to be assigned to a route.

job_template.disallowed_driver_attributes

The driver attributes that are not permitted for the job to be assigned to a route.

job_template.required_vehicle_attributes

The vehicle attributes that are required for the job to be assigned to a route.

job_template.load

The amount of load delivered or collected at the job site. Deliveries are formatted as positive numbers, and collections as negative numbers (for example, '-22' for a "Pickup" value of 22 units).

job_template.load_type

The loading type of the job: either 'delivery' or 'pickup'. Only provided as an import field, not in export files (where load or unload is indicated by a positive or negative job_template.load value).

job_template.loads.[metric]

The number of units of a given load type will be delivered or picked up at the customer site as part of this recurring job, for example job_template.load.pallets or job_template.load.cases.

job_template.custom.[custom]

The name and value of an arbitrary custom property associated with the recurring job (for example 'job_template.custom.alarmnumber').

job_template.attributes

The attributes associated with the job.

job_template.code

The code of the job.

job_template.notes

The notes for the job.

job_template.exit_location_name

The name of a job marker that is linked to this job. This linked stop will be routed to immediately after the completion of the primary job.

job_template.exit_location_id

The unique location identifier of the job that is linked to the job that can be created from this recurring job.

job_template.exit_lat

The latitude of the job that is linked to the job that can be created from this recurring job.

job_template.exit_lon

The longitude of the job that is linked to the job that can be created from this recurring job.

job_template.exit_lat_lon

The latitude and longitude coordinates of the job that is linked to the job that can be created from this recurring job.

job_template.exit_address

The address of the job that is linked to the job that can be created from this recurring job.

job_template.exit_time_on_site

The estimated time spent at the job that is linked to the job that can be created from this recurring job.

job_template.type

The type of job template. For example, "one_off" or "times_per_week".

Exporting Recurring Jobs

To export a recurring jobs file:

 

1.Open the list menu in the upper left corner of the Lists panel and select the Recurring Jobs option. The Recurring Jobs list opens.

 
2.Select the check box beside each recurring job you want to export in the grid and then click the More menu button to the right of the Lists panel, and select the Export Recurring Jobs option in the menu that opens.

 
3.Click Choose Columns and select the columns that you want to export. By default all columns are selected. Click Export.

 
4.The CSV format export file is saved to the default download location on your computer.