Importing Employee Standard Hours

To change standard hours in bulk for multiple employees, you may want to set up your proposed hours and then import them to save time on data entry.

All general importer advice applies

Please see Importing Data for general tips on CSV handling and dealing with data formats for these importers.

Import order matters

This is possible using the 2 importers:

Employee Standard Hours Headers
Employee Standard Hours Days

These must be imported in order (Headers before days).

The commencement Date from a Header has to already exist for an employee so they can have Days imported for them.

For current data templates, always check the “Download full template” option from the employee importer.

At time of publication (May 2024), the data template included the following fields for each Importer:

Employee Standard Hours Headers

Repeatedly importing standard hour headers will overwrite the values against any existing standard hour headers without an error or notifying the user than an record already exists.

Column name	Type	Valid Values	Purpose / Usage notes
employeeId	INTEGER or STRING	Employee ID Value from Employees list or Exact String of Employee Full Name from Employees list	Required Identify which employee to upload against.
commencedAt	DATE	ISO formatted date: YYYY-MM-DD	Required When the standard hours take effect.
concludedAt	DATE	ISO formatted date: YYYY-MM-DD	Optional When the standard hours stop applying.
rosterable	BOOLEAN	Boolean TRUE / FALSE	Required Controls: “Add these standard hours to the roster”
locked	BOOLEAN	Boolean TRUE / FALSE	Required Controls: “Lock the roster to these standard hours”
contractedHours	DECIMAL	Decimal, must be positive.	Optional The number of hours an employee is contracted for across the entire standard hours period.

Contracted Hours

The Contracted Hours field must be a positive decimal value.

This figure is the maximum number of hours someone can work under their contract, and is used by some alerts.

The number covers the entire Standard Hours rotation, this means if your pattern rotates over more than 1 week, you need to put a higher value here.:

New of Weeks Standard Hours shift pattern covers	Example value if 38 hours per week	Example value if 40 hours per week
1	38	40
2	76	80
3	114	120
4	152	160

Incorrect values in the Contracted Hours field can result in leave not calculating correctly, as the leave engine won’t generate hours of leave past their contracted hours in a given shift cycle.

Employee Standard Hours Days

Repeatedly importing standard hour days will overwrite the values against any existing standard hour days without an error or notifying the user than an record already exists.

There is no circumstance where it will allow you to delete an incorrect day once uploaded, which means the Standard Hours need to be deleted from the employee entirely if the day is wrong.

Column name	Type	Valid Values	Purpose / Usage notes
employeeId	INTEGER or STRING	Employee ID Value from Employees list or Exact String of Employee Full Name from Employees list	Required Identify which employee to upload against. Note: The value here is the employee’s full name according to the Employee list.
commencedAt	DATE	ISO formatted date: YYYY-MM-DD	Required Which Standard Hours Header is this day record part of.
week	INTEGER	1,2,3,4	Required. The number of weeks a shift cycle rotates over.
day	INTEGER	0,1,2,3,4,5,6	Required The position of a day in the roster week. See notes for further information.
locationId	INTEGER or STRING	LocationID value (Database value) or the exact string of the location name from the locations list.	Required Controls: “Lock the roster to these standard hours”
positionId	INTEGER or STRING	PositionD value (Database value) or the exact string of the position name from the positions list.	Required The number of hours an employee is contracted for across the entire standard hours period.
shiftStartTime	STRING hh:mm	hh:mm Time value in 24 hour format. Must be formatted with a leading 0 if AM, EG: Invalid: 8:00 Valid: 08:00	Required Start time of shift
shiftEndTime	STRING hh:mm	hh:mm Time value in 24 hour format. Must be formatted with a leading 0 if AM, EG: Invalid: 8:00 Valid: 08:00	Required End time of shift If before the Start time, indicates that the shift finishes on the following day.
breakStartTime	STRING hh:mm	hh:mm Time value in 24 hour format. Must be formatted with a leading 0 if AM, EG: Invalid: 8:00 Valid: 08:00	Optional Start time of break. leave blank for no break.
breakEndTime	STRING hh:mm	hh:mm Time value in 24 hour format. Must be formatted with a leading 0 if AM, EG: Invalid: 8:00 Valid: 08:00	Optional Start time of break. leave blank for no break.

day

The Day field is ordinal based on the Commencement date.

For example the following commencement dates/Day of weeks the values 0 through 6 stand for:

Commencement Date	Commencement Day of week is:	0	1	2	3	4	5	6
6/05/2024	Mon	Mon	Sun	Sat	Fri	Thur	Wed	Tue
7/05/2024	Tue	Tue	Mon	Sun	Sat	Fri	Thur	Wed
8/05/2024	Wed	Wed	Tue	Mon	Sun	Sat	Fri	Thur
9/05/2024	Thur	Thur	Wed	Tue	Mon	Sun	Sat	Fri
10/05/2024	Fri	Fri	Thur	Wed	Tue	Mon	Sun	Sat
11/05/2024	Sat	Sat	Fri	Thur	Wed	Tue	Mon	Sun
12/05/2024	Sun	Sun	Sat	Fri	Thur	Wed	Tue	Mon