Job Upload File Format
The table below lists all of the columns available for inclusion in a job upload CSV file.
Note the following:
-
The Description, Duration, Skills and WorkType columns are mandatory. These are checked as part of the file upload.
-
All other columns are optional, although some are paired - for example, if you include a Start Date column, you must also include a corresponding End Date.
-
The Maximum Size, where applicable, refers to the maximum number of characters that can be used in that column. This is checked as part of the file upload.
-
The columns in the file can be in any order.
-
If any column names not listed in this table are included in the first line of the file, this will generate an error.
-
The checks listed under Extended Validation are performed when you select Validate during the file upload process.
|
Column Name |
Mandatory? |
Maximum Size |
Extended Validation |
|---|---|---|---|
|
Identity.Reference |
No |
50 |
Reference does not already exist in World. |
|
GroupReference |
No |
50 |
|
|
CatalogueReference |
No |
10 |
|
|
ClientReference |
No |
50 |
|
|
World.Reference |
No |
50 |
If present, must match the name of the World where the file is uploaded. |
|
Description |
Yes |
2048 |
|
|
Duration |
Yes |
|
Must be greater than 0. |
|
Origin |
No |
10 |
|
|
Priority |
No |
50 |
|
|
Emergency |
No |
|
|
|
SpecialInstructions |
No |
2048 |
|
|
VisitComplete |
No |
10 |
|
|
VisitStatus |
No |
20 |
|
|
Status |
No |
20 |
If present:
|
|
Skills |
Yes |
|
Skills must not be duplicated. Field cannot be blank. |
|
WorkType |
Yes |
20 |
|
|
Location.Address |
No |
512 |
Must be supplied if any other address details are provided. |
|
AddressDetail.GeoX |
No |
|
Must be >= -90 or <= 90 |
|
AddressDetail.GeoY |
No |
|
Must be >= -180 or <= 180 |
|
AddressDetail.HouseNo |
No |
10 |
|
|
AddressDetail.Line1 |
No |
50 |
|
|
AddressDetail.Line2 |
No |
50 |
|
|
AddressDetail.Line3 |
No |
50 |
|
|
AddressDetail.Line4 |
No |
50 |
|
|
AddressDetail.Line5 |
No |
50 |
|
|
AddressDetail.Name |
No |
255 |
|
|
AddressDetail.PostCode |
No |
10 |
|
|
Location.Reference |
No |
20 |
|
|
ActualDate.StartDate |
No |
|
|
|
ActualDate.EndDate |
No |
|
|
|
AppointmentDate.StartDate |
No |
|
If an appointment start date is provided, then an appointment end date must also be provided. The appointment start date cannot be after the appointment end date. |
|
AppointmentDate.EndDate |
No |
|
If an appointment end date is provided, then an appointment start date must also be provided. The appointment end date cannot be before the appointment start date. |
|
AppointmentSlotTemplate |
No |
|
|
|
DispatchDate |
No |
|
|
|
Dispatched |
No |
|
|
|
DueDate |
No |
|
DueStart cannot be after DueDate. |
|
DueStart |
No |
|
DueStart cannot be after DueDate, or after DueEnd. |
|
DueEnd |
No |
|
DueEnd cannot be before DueStart. |
|
MandatoryResource.Username |
No |
50 |
Resource must exist. |
|
PreferredResource.Username |
No |
50 |
Resource must exist. Resource references must not be duplicated. Can be the mandatory reference if that is also provided. |
|
ProhibitedResource.Username |
No |
50 |
Resource must exist. Resource references must not be duplicated. Cannot include the mandatory reference, allocated reference or preferred resources if provided. |
|
AllocatedTo.Username |
No |
50 |
Resource must exist. |
|
RelatedJob.References |
No |
50 |
Number of RelatedJob.Types must equal the number of references. Related references must not be duplicated. |
|
RelatedJob.Types |
No |
50 |
Type correlates across both sides of the related link. |
|
PendingRelations |
No |
|
|
|
ScheduleDate.StartDate |
No |
|
If a schedule start date is provided, then a schedule end date must also be provided. The schedule start date cannot be after the schedule end date. |
|
ScheduleDate.EndDate |
No |
|
If a schedule end date is provided, then a schedule start date must also be provided. The schedule end date cannot be before the schedule start date. |
|
ContactExtension.DateOfBirth |
No |
|
Date of birth may not be in the future. Date of birth may not be after date of death. |
|
ContactExtension.DateOfDeath |
No |
|
Date of death may not be in the future. Date of death may not be before date of birth. |
|
ContactExtension.Gender |
No |
20 |
|
|
ContactExtension.ID |
No |
20 |
|
|
ContactExtension.IDLabel |
No |
20 |
|
|
ContactExtension.PreferredName |
No |
35 |
|
|
Contact.Email |
No |
255 |
|
|
Contact.HomePhone |
No |
20 |
|
|
Contact.MobilePhone |
No |
20 |
|
|
Contact.WorkPhone |
No |
20 |
|
|
Contact.Name |
No |
255 |
Must be supplied if providing any other contact details. |
|
Contact.Title |
No |
100 |
|
|
Contact.URL |
No |
255 |
|
|
BandingGroup |
No |
50 |
Alphanumeric only. |
|
Timezone |
No |
50 |
Must be a valid time zone, or mapped time zone if they have been set up. |