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:
- Open the list menu in the upper left corner of the List panel and select the Recurring Jobs option. The Recurring Jobs list opens.
- 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.
- 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.
- 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:
- If 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.
- If you have previously saved a JSON file containing the column mappings, you can click Load to use the saved mappings.
- If your import file uses your own custom column names, follow these steps:
- Click a column name in the left panel, and then click the right-facing arrow
.
- Select the field in the right panel, and click Edit Mapping.
- Select the field that matches the values contained in the import column.
- Click OK.
- Click a column name in the left panel, and then click the right-facing arrow
Repeat this process for each column in your import file. - (Optional) When you have mapped your columns from the file to the Recurring Jobs list, you can perform any of the following actions:
- Click the left-facing arrow
to remove the selected field from the Recurring Jobs list.
- Click Edit Mapping to change the mapping for the selected field.
- Click Clear to clear all mappings you have made and start over.
- Click Download to save the current mappings so that you can reuse them another time.
- Click the Settings
button to select the formatting to use for dates.
- Click the left-facing arrow
- 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. |
schedule.base_date |
The date the recurring job is based on. If |
schedule.earliest_date |
The earliest date when jobs based on this |
schedule.latest_date |
The latest date when jobs based on this |
schedule.frequency |
The number of times to create jobs |
schedule.interval |
At which interval to create jobs based on |
schedule.allowed_variance_before |
The number of days that jobs based on |
schedule.allowed_variance_after |
The number of days that jobs based on |
schedule.allowed_days_of_week |
The days of the week when jobs based |
schedule.custom.[custom] |
The custom fields associated with the |
job_template.location_name |
The name of the recurring job location |
job_template.location_id |
The ID of the job location marker. Can |
job_template.lat |
The latitude coordinates of the job |
job_template.lon |
The longitude coordinates of the job |
job_template.lat_lon |
The latitude and longitude coordinates of |
job_template.address |
The formatted address of the job |
job_template.time_on_site |
The length of time the driver is expected |
job_template.time_window_start |
The start time of the job's time window. |
job_template.time_window_end |
The end time of the job's time window. |
job_template.time_window2_start |
The start time of the job's second time |
job_template.time_window2_end |
The end time of the job's second time |
job_template.priority |
The priority of the job. Available |
job_template.required_driver |
The driver.id value of the driver |
job_template.forbidden_drivers |
The driver.id values of the drivers |
job_template.required_route_attributes |
The route attributes that are required |
job_template.disallowed_route_attributes |
The route attributes that are not |
job_template.required_driver_attributes |
The driver attributes that are required |
job_template.disallowed_driver_attributes |
The driver attributes that are not |
job_template.required_vehicle_attributes |
The vehicle attributes that are required |
job_template.required_depot_earlier_attributes |
The required depots that the driver |
job_template.required_depot_later_attributes |
The required depots that the driver |
job_template.load |
The amount of load delivered or |
job_template.load_type |
The loading type of the job: either |
job_template.loads.[metric] |
The number of units of a given load |
job_template.custom.[custom] |
The name and value of an arbitrary |
job_template.attributes |
The attributes associated with the job. |
job_template.code |
The code of the job. |
job_template.description |
A free-form description of the recurring job. |
job_template.notes |
The notes for the job. |
job_template.exit_location_name |
The name of a job marker that is linked |
job_template.exit_location_id |
The unique location identifier of the job |
job_template.exit_lat |
The latitude of the job that is linked |
job_template.exit_lon |
The longitude of the job that is linked |
job_template.exit_lat_lon |
The latitude and longitude coordinates |
job_template.exit_address |
The address of the job that is linked to |
job_template.exit_time_on_site |
The estimated time spent at the job |
job_template.type |
The type of job template. For |
Exporting Recurring Jobs
To export a recurring jobs file:
- Open the list menu in the upper left corner of the Lists panel and select the Recurring Jobs option. The Recurring Jobs list opens.
- 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.
- Click Choose Columns and select the columns that you want to export. By default all columns are selected. Click Export.
- The CSV format export file is saved to the default download location on your computer.
The unique identifier of the recurring job.
Comments
0 comments
Please sign in to leave a comment.