Job template CSV uploads

To create new job templates, you create a CSV file with the appropriate information. This article guides you through the various formats and fields to use for a successful CSV upload.

Because there is a vast range of data that can be included in a job template, the data in the CSV is split into sections and subsections. This article gives an overview of the main sections first. Click on the section name in the table to drill down into the subsections.

When you have created and uploaded a new template, you can edit the template from Settings → Templates → Job template. For more information about editing existing job templates, see the editing job templates article.

CSV file format

All valid CSV files are supported, with values in single quotation marks and comma separated. The data in the file is split into subsections. For example, data relating to the job fields are kept separate by appending job: to the front of the header. So job:data specifies custom data in the job field, while stop:data specifies custom data in the stop field.

You can append additional tags using colons. For example, the size_limit attribute requires a minnimum and maximum value, which you can specify using job:attribute_requirement:size_limit:min and job:attribute_requirement:size_limit:max headers.

Columns and headers

The column names in the job template CSV form the mandatory first row file which identifies how to interpret the data presented in the subsequent rows. Each column should begin with a header value, such as stop:address. All other rows in the column specifies inputs to the matching job template field, such as the address for that stop.

The column names are formed by joining attributes related to the type of data with the colon (:) symbol. For example, columns starting with job: refers to data related to the job section, such as the job:data column which refers to custom data related to the job. Similarly, columns starting with stop: refers to data related to the stop section, such as the stop:data column which refers to custom data related to the stop.

Make sure your uploaded CSV does not have duplicate columns with the same header. If you import a file with duplicate headers, it could return an error, or you might find that the first column is uploaded, but all subsequent columns are ignored.

All headers must be in lowercase and underscore-separated, meaning a multi-word field name is spaced out using _ characters. For example, for a field called Example Reference, you would use example_reference.

Empty columns, and columns that do not have a header are ignored. Additionally, columns with an empty or unrecognised column name are also ignored.

Rows

The data in each row, after the columns or headers, specifies the details of a single job template. When rows share the same value for the id or ext_ref column, this indicates that the the information belongs to the same job template with multiple stop details.

You can optionally specify details of a single stop belonging to the job template in each row by providing values for the stop section columns. If the CSV contains no stop section columns or all of the stop section columns have empty values for the row, the job template is created with no stop details.

You can specify multiple stops for the same job template by specifying multiple rows with the same job template id or ext_ref column. The stop columns of each row are used to create individual stops for the job template in the order specified in the CSV. The values of the first row of each group of job template rows are used for all other fields.

There are some columns which require a special data format. Columns that include lists expect a comma separated list of IDs or references. Some columns are able to accept JSON data. You can provide this in a string which parses to JSON.

Sections

The data in the CSV is split into subsections. This table gives an overview of the main sections. Click the section to drill down into the subsections.

Section	Column Prefix	Example	Purpose
Attribute requirements	`attribute_requirement:`	`attribute_requirement:size_limit:min`	Attribute requirements for created Jobs.
Driver rules	`driver:`	`driver:allowed_ids`	Driver preferences and rules for created Jobs.
Job	`job:`	`job:name`	Information for created Jobs.
Job custom data	`job:data:`	`job:data:client_details:contact_name`	Custom data for created Jobs.
Job template	No prefix	`id`	Job Template related information.
Stop	`stop:`	`stop:address`	Information related to Stops for created Jobs.
Stop capacity costs	`stop:capacity_cost:`	`stop:capacity_cost:capacity_id:100`	Capacity costs of Stop for created Jobs.
Stop custom data	`stop:data:`	`stop:data:delivery_instructions`	Custom data of Stops for created Jobs.
Vehicle rules	`vehicle_rule:`	`vehicle_rule:allowed_ids`	Vehicle preferences and rules for created Jobs.
Vehicle type rules	`vehicle_type_rule:`	`vehicle_type_rule:allowed_ids`	Vehicle type preferences and rules for created Jobs.

Attribute requirements

The attribute requirement column names have three components, for example attribute_requirement:is_heavy_vehicle:expected

The prefix: attribute_requirement:
The Attribute external reference or ID that the requirement applies to: is_heavy_vehicle
The parameter: :expected

You can specify multiple sets of columns to indicate attribute requirements for different attributes.

Column	Requirement	Accepted values	Example	Comments
`attribute_requirement:[attribute_ext_ref_or_id]:expected`	Optional. Must not be specified if a value is specified for: `attribute_requirement:[attribute_ext_ref_or_id]:max` `attribute_requirement:[attribute_ext_ref_or_id]:min`	`false` `true`	`false`	Sets the value requirement for a boolean-type Attribute.
`attribute_requirement:[attribute_ext_ref_or_id]:max`	Optional. Must not be specified if a value is specified for: `attribute_requirement:[attribute_ext_ref_or_id]:expected`	Number	`100`	Sets the maximum value requirement for a range-type Attribute.
`attribute_requirement:[attribute_ext_ref_or_id]:min`	Optional. Must not be specified if a value is specified for: `attribute_requirement:[attribute_ext_ref_or_id]:expected`	Number	`2000`	Sets the minimum value requirement for a range-type Attribute.
`attribute_requirement:[attribute_ext_ref_or_id]:pass_if_absent`	Optional. If specified, a value must be specified for at least one of the following columns: `attribute_requirement:[attribute_ext_ref_or_id]:expected` `attribute_requirement:[attribute_ext_ref_or_id]:max` `attribute_requirement:[attribute_ext_ref_or_id]:min`	`false` `true`	`true`	If set to `true`, the requirement for the Attribute will be considered as satisfied if no values are specified for the Attribute.

Driver rules

Driver Rule column names have two components, for example driver:allowed_ids

The prefix: driver:
The parameter: allowed_ids

Column	Requirement	Accepted values	Example	Comments
`driver:allowed_ext_refs`	Optional. Referenced Driver must not overlap with a value specified for: `driver:allowed_ids`	External references of existing Drivers, delimited by comma (`,`)	`driver_a,driver_b`	Sets the allowed Drivers for created Jobs
`driver:allowed_ids`	Optional. Referenced Driver must not overlap with a value specified for: `driver:allowed_ext_refs`	IDs of existing Drivers, delimited by comma (`,`)	`21,22`	Sets the allowed Drivers for created Jobs

Job

Job column names have two components, for example job:name

The prefix: job:
The parameter: name

Column	Requirement	Accepted values	Example	Comments
`job:name`	Required	Text	`Morning Delivery Run`	Display name of Job Template and its created Jobs.
`job:priority_ext_ref`	Optional. Must not be specified if a value is specified for: `job:priority_id`	External reference of an existing Priority	`lowest_priority`	Sets the Priority for created Jobs.
`job:priority_id`	Optional. Must not be specified if a value is specified for: `job:priority_ext_ref`	ID of an existing Priority	`43`	Sets the Priority for created Jobs.

Job custom data

Job custom data column names have two components, for example

job:data:[custom-data]

The prefix: job:data:
The custom data key or key path: [custom-data]
- For single level keys, replace with a text value: key
- For multi level keys, replace with a text values delimited by a colon (:): nested:path:key

You can specify multiple sets of columns to indicate different job custom data.

Column	Requirement	Accepted values	Example	Comments
`job:data:[custom-data]`	Optional. A unique value must be specified for `[custom-data]` if specified. For multi-level `[custom-data]`, any of the values leading to the final level must not conflict with a value at the final level.	Text	`External Driver ID 123`	Custom data for created Jobs

Job template

Job template columns have no special formatting requirements.

Column	Requirement	Accepted values	Example	Comments
`ext_ref`	Required	Text complying with the accepted external reference format: NowGo API Reference	`morning_delivery_run`	External reference of Job Template.
`icon`	Optional	Text	`star`	Icon to display for Job Template when pinned. See list of valid icons.
`id`	Optional. Required when referencing an existing Job Template.	Text	`41`	System generated ID of Job Template. Used to identify existing Job Templates for the `Create and update existing` and `Create, update and archive missing` outcomes.
`pinned`	Optional.	`false` `true`	`false`	Indicates whether the Job Template should be included in a separate convenience shortlist when creating a new Job. A maximum of eight (8) Job Templates can be pinned.

Stop

Stop CSV column names have two components, for example

stop:action_ext_ref

The prefix: stop:
The parameter: action_ext_ref

You can create a job template with more than one stop:

Create more than one row with valid stop:... data.
Ensure that the id or ext_ref field is the same between all matching rows.
Stops are created in the order they are listed in. For example, if your template specifies a job with a pickup and a dropoff, with the pickup coming first, put the row with the pickup stop data before the row with the dropoff stop data.

Column	Requirement	Accepted values	Example	Comments
`stop:action_ext_ref`	Optional. Must not be specified if a value is specified for `stop:action_id`	External reference of an existing Action.	`pickup`	Sets the Action of the Stop for created Jobs.
`stop:address`	Required. Must not be specified if a value is specified for: `stop:location_ext_ref` `stop:location_id`	Text	`1 Martin Place`	Sets the address component of the Stop location for created Jobs.
`stop:action_id`	Optional. Must not be specified if a value is specified for: `stop:action_ext_ref`	ID of an existing Action	`44`	Sets the Action of the Stop for created Jobs.
`stop:assignment_requires_driver_acknowledgement`	Optional.	`false` `true`	`true`	If set to `true`, the Driver must acknowledge the Stop prior to any further interactions with it.
`stop:autocomplete_rule:can_complete_out_of_sequence`	Optional	`false` `true`	`false`	If set to `true`, the Stop will automatically be marked as completed when the Driver satisfies the Autocomplete Rule conditions, regardless of the order of Stop on the Driver’s delivery list.
`stop:autocomplete_rule:radius_metres`	Optional. Required if a value is specified for: `stop:autocomplete_rule:can_complete_out_of_sequence` `stop:autocomplete_rule:trigger_type`	Number.	`100`	Sets the radius (in metres) of the Autocomplete Rule condition.
`stop:autocomplete_rule:trigger_type`	Optional. Mandatory if a value is specified for any of the following columns in the row: `stop:autocomplete_rule:can_complete_out_of_sequence` `stop:autocomplete_rule:radius_metres`	`enter` `leave` `enter_or_leave`	`enter`	Sets the type of activity of the Autocomplete Rule condition: `enter`: Driver approaches the destination. `leave`: Driver leaves the destination. `enter_or_leave`: Driver approaches or leaves the destination.
`stop:business_name`	Optional	Text	`Business Pty. Ltd.`	Sets the business name of the Stop recipient for created Jobs.
`stop:contact_email`	Optional	Text	`[email protected]`	Sets the email address of the Stop recipient for created Jobs.
`stop:contact_name`	Optional	Text	`Test User`	Sets the contact name of the Stop recipient for created Jobs.
`stop:contact_phone`	Optiona	Valid phone number starting with the international country code (e.g. `+61`).	`+61412345678`	Sets the contact phone number of the Stop recipient for created Jobs.
`stop:country`	Optional. Required if a value is specified for: `stop:address` `stop:locality` `stop:postal_code` `stop:state` Must not be specified if a value is specified for: `stop:location_ext_ref` `stop:location_id`	Text	`Australia`	Sets the country component of the Stop location for created Jobs.
`stop:latitude`	Optional	Number	`-33.33`	Sets the latitude component of the Stop location for created Jobs.
`stop:locality`	Optional. Required if a value is specified for: `stop:address` `stop:country` `stop:postal_code` `stop:state` Must not be specified if a value is specified for: `stop:location_ext_ref` `stop:location_id`	Text	`North Ryde`	Sets the locality component of the Stop location for created Jobs.
`stop:longitude`	Optional	Number	`151.11`	Sets the longitude component of the Stop location for created Jobs.
`stop:location_group_ext_ref`	Optional	External reference of existing Location Group.	`macqurie_business_park`	Sets the Location Group of the Stop for created Jobs.
`stop:location_group_id`	Optional	ID of existing Location Group.	`45`	Sets the Location Group of the Stop for created Jobs.
`stop:location_ext_ref`	Optional. Must not be specified if a value is specified for: `stop:address` `stop:country` `stop:location_id` `stop:locality` `stop:postal_code` `stop:state`	External reference of existing Location.	`test_location_ref`	Sets the Location of the Stop for created Jobs.
`stop:location_id`	Optional. Must not be specified if a value is specified for: `stop:address` `stop:country` `stop:location_ext_ref` `stop:locality` `stop:postal_code` `stop:state`	ID of existing Location.	`46`	Sets the Location of the Stop for created Jobs.
`stop:location_time`	Optional	Number	`120`	Sets the location time, in seconds, of the Stop for created Jobs.
`stop:postal_code`	Optional. Required if a value is specified for: `stop:address` `stop:country` `stop:locality` `stop:state` Must not be specified if a value is specified for: `stop:location_ext_ref` `stop:location_id`	Text	`2000`	Sets the postal code component of the Stop location for created Jobs.
`stop:service_time`	Optional	Number	`60`	Sets the service time, in seconds, of the Stop for created Jobs.
`stop:state`	Optional Required if a value is specified for: `stop:address` `stop:country` `stop:locality` `stop:postal_code` Must not be specified if a value is specified for: `stop:location_ext_ref` `stop:location_id`	Text	`NSW`	Sets the state component of the Stop location for created Jobs.
`stop:time_window_start`	Optional	24 hour time format	`06:00`	Sets the earliest time that the Stop activity should be conducted for created Jobs.
`stop:time_window_end`	Optional	24 hour time format	`17:00`	Sets the latest time that the Stop activity should be conducted for created Jobs.
`stop:visible_to_driver`	Optional	`false` `true`	`true`	If set to `false`, the Stop will not be visible by Drivers.

Stop capacity costs

Stop capacity costs column names have three components, for example stop:capacity_cost:capacity_ext_ref:weight

The prefix: stop:capacity_cost:
The type of Capacity identifier that the cost applies to: capacity_ext_ref:
The Capacity identifier that the cost applies to: weight

You can specify multiple sets of columns to indicate capacity costs for different capacities.

Column	Requirement	Accepted values	Example	Comments
`stop:capacity_cost:capacity_ext_ref:[capacity_ext_ref]`	Optional. Must not be specified if a value is specified for: `stop:capacity_cost:capacity_id:[capacity_id]`	Number	`200`	Sets the Capacity Cost of the Stop for the specified Capacity for created Jobs.
`stop:capacity_cost:capacity_id:[capacity_id]`	Must NOT be specified if a value is specified for any of the following columns in the row: `stop:capacity_cost:capacity_ext_ref:[capacity_ext_ref]`	Number	`300`	Sets the Capacity Cost of the Stop for the specified Capacity for created Jobs.

Stop custom data

Stop custom data column names have two components, for example stop:data:[custom-data]

The prefix: stop:data:
The custom data key or key path: [custom-data]
- For single level keys, replace with a text value: key
- For multi level keys, replace with a text values delimited by a colon (:): nested:path:key

You can specify multiple sets of columns to indicate different Stop custom data.

Column	Requirement	Accepted values	Example	Comments
`stop:data:[custom-data]`	Optional. A unique value must be specified for `[custom-data]` if specified. For multi-level `[custom-data]`, any of the values leading to the final level must not conflict with a value at the final level.	Text	`Stop Sequence ID 123`	Custom data of Stop for created Jobs.

Vehicle rules

Vehicle Rule column names have two components, for example vehicle_rule:allowed_ids

The prefix: vehicle_rule:
The parameter: allowed_ids

Column	Requirement	Accepted values	Example	Comments
`vehicle_rule:allowed_ext_refs`	Optional. Referenced Vehicle must not overlap with a value specified for: `vehicle_rule:allowed_ids` `vehicle_rule:disallowed_ext_refs` `vehicle_rule:disallowed_ids`	External references of existing Vehicles, delimited by comma (`,`).	`mitsu_triton,toyota_hiace`	Sets the allowed Vehicles for created Jobs.
`vehicle_rule:allowed_ids`	Optional. Referenced Vehicle must not overlap with a value specified for: `vehicle_rule:allowed_ext_refs` `vehicle_rule:disallowed_ext_refs` `vehicle_rule:disallowed_ids`	IDs of existing Vehicles, delimited by comma (`,`).	`41,42`	Sets the allowed Vehicles for created Jobs.
`vehicle_rule:disallowed_ext_refs`	Optional. Referenced Vehicle must not overlap with a value specified for: `vehicle_rule:allowed_ext_refs` `vehicle_rule:allowed_ids` `vehicle_rule:disallowed_ids`	External references of existing Vehicles, delimited by comma (`,`).	`mitsu_triton,toyota_hiace`	Sets the disallowed Vehicles for created Jobs.
`vehicle_rule:disallowed_ids`	Optional. Referenced Vehicle must not overlap with a value specified for: `vehicle_rule:allowed_ext_refs` `vehicle_rule:allowed_ids` `vehicle_rule:disallowed_ext_refs`	IDs of existing Vehicles, delimited by comma (`,`).	`41,42`	Sets the disallowed Vehicles for created Jobs.
`vehicle_rule:dispreferred_ext_refs`	Optional. Referenced Vehicle must not overlap with a value specified for: `vehicle_rule:dispreferred_ids` `vehicle_rule:preferred_ext_refs` `vehicle_rule:preferred_ids`	External references of existing Vehicles, delimited by comma (`,`).	`mitsu_triton,toyota_hiace`	Sets the dispreferred Vehicles for created Jobs.
`vehicle_rule:dispreferred_ids`	Optional. Referenced Vehicle must not overlap with a value specified for: `vehicle_rule:dispreferred_ext_refs` `vehicle_rule:preferred_ext_refs` `vehicle_rule:preferred_ids`	IDs of existing Vehicles, delimited by comma (`,`).	`41,42`	Sets the dispreferred Vehicles for created Jobs.
`vehicle_rule:preferred_ext_refs`	Optional. Referenced Vehicle must not overlap with a value specified for: `vehicle_rule:dispreferred_ext_refs` `vehicle_rule:dispreferred_ids` `vehicle_rule:preferred_ids`	External references of existing Vehicles, delimited by comma (`,`).	`mitsu_triton,toyota_hiace`	Sets the preferred Vehicles for created Jobs.
`vehicle_rule:preferred_ids`	Optional. Referenced Vehicle must not overlap with a value specified for: `vehicle_rule:dispreferred_ext_refs` `vehicle_rule:dispreferred_ids` `vehicle_rule:preferred_ext_refs`	IDs of existing Vehicles, delimited by comma (`,`).	`41,42`	Sets the preferred Vehicles for created Jobs.

Vehicle type rules

Vehicle type rule column names have two components, for example vehicle_type_rule:allowed_ids

The prefix: vehicle_type_rule:
The parameter: allowed_ids

Column	Requirement	Accepted values	Example	Comments
`vehicle_type_rule:allowed_ext_refs`	Optional. Referenced Vehicle Type must not overlap with a value specified for: `vehicle_rule:allowed_ids` `vehicle_rule:disallowed_ext_refs` `vehicle_rule:disallowed_ids`	External references of existing Vehicle Types, delimited by comma (`,`).	`truck_ext_ref,van_ext_ref`	Sets the allowed Vehicles for created Jobs.
`vehicle_type_rule:allowed_ids`	Optional. Referenced Vehicle Type must not overlap with a value specified for: `vehicle_rule:allowed_ext_refs` `vehicle_rule:disallowed_ext_refs` `vehicle_rule:disallowed_ids`	IDs of existing Vehicle Types, delimited by comma (`,`).	`41,42`	Sets the allowed Vehicles for created Jobs.
`vehicle_type_rule:disallowed_ext_refs`	Optional. Referenced Vehicle Type must not overlap with a value specified for: `vehicle_rule:allowed_ext_refs` `vehicle_rule:allowed_ids` `vehicle_rule:disallowed_ids`	External references of existing Vehicle Types, delimited by comma (`,`).	`truck_ext_ref,van_ext_ref`	Sets the disallowed Vehicles for created Jobs.
`vehicle_type_rule:disallowed_ids`	Optional. Referenced Vehicle Type must not overlap with a value specified for: `vehicle_rule:allowed_ext_refs` `vehicle_rule:allowed_ids` `vehicle_rule:disallowed_ext_refs`	IDs of existing Vehicle Types, delimited by comma (`,`).	`41,42`	Sets the disallowed Vehicles for created Jobs.
`vehicle_type_rule:dispreferred_ext_refs`	Optional. Referenced Vehicle Type must not overlap with a value specified for: `vehicle_rule:dispreferred_ids` `vehicle_rule:preferred_ext_refs` `vehicle_rule:preferred_ids`	External references of existing Vehicles, delimited by comma (`,`).	`truck_ext_ref,van_ext_ref`	Sets the dispreferred Vehicles for created Jobs.
`vehicle_type_rule:dispreferred_ids`	Optional. Referenced Vehicle Type must not overlap with a value specified for: `vehicle_rule:dispreferred_ext_refs` `vehicle_rule:preferred_ext_refs` `vehicle_rule:preferred_ids`	IDs of existing Vehicle Types, delimited by comma (`,`).	`41,42`	Sets the dispreferred Vehicles for created Jobs.
`vehicle_type_rule:preferred_ext_refs`	Optional. Referenced Vehicle Type must not overlap with a value specified for: `vehicle_rule:dispreferred_ext_refs` `vehicle_rule:dispreferred_ids` `vehicle_rule:preferred_ids`	External references of existing Vehicle Types, delimited by comma (`,`).	`truck_ext_ref,van_ext_ref`	Sets the preferred Vehicles for created Jobs.
`vehicle_type_rule:preferred_ids`	Optional. Referenced Vehicle Type must not overlap with a value specified for: `vehicle_rule:dispreferred_ext_refs` `vehicle_rule:dispreferred_ids` `vehicle_rule:preferred_ext_refs`	IDs of existing Vehicle Types, delimited by comma (`,`).	`41,42`	Sets the preferred Vehicles for created Jobs.

Supported icon values

address-book
address-card
align-justify
anchor
angles-down
angles-left
angles-right
angles-up
asterisk
bag-shopping
ban
barcode
bell
bicycle
binoculars
bolt
bookmark
box-archive
briefcase
building
building-columns
calculator
calendar
calendar-check
calendar-xmark
certificate
chart-area
chart-column
clipboard
clone
comment-dots
compass
cube
ear-listen
envelope
face-smile
flag
hashtag
heart
house
inbox
info
leaf
link
magnifying-glass
map-pin
note
paperclip
phone
podcast
recycle
scale-balanced
share-nodes
signal
signs-post
star
tag
temperature-full
tree
trophy
truck
truck-medical
up-down-left-right
user
users
wheelchair
wrench

CSV fields for Shifts