Employee CSV Format
Previous Topic  Next Topic 

Employee Fields


Field

Description

Format

Login Name

Employee login name. If this field is present in the CSV data then a value is required, and is always required when adding new employees.

Text (80 chars max)

Password

Employee password. This field is not exported but can be imported. Updating an employee's password through an import creates an expired password - the employee will be asked to enter a new one the next time they log in.

Text (40 chars max)

First Name

First name.

Text (80 chars max)

Last Name

Last name. If this field is present in the CSV data then a value is required, and is always required when adding new employees.

Text (80 chars max)

ID

Employee ID. This field is not required, but if present and the value is not blank then it must be unique for all employees.

Text (80 chars max)

Status

Employee status. Possible value are:

Value

Description

Active

Employee can log into system.

Inactive

Employee cannot log into system, and does not show up on reports, etc. by default.

Locked

Employee cannot log into system, but shows up on reports, etc. by default. An employee can become locked due to too many unsuccessful login attempts.

Text

Permission Level

The default permission level, for example Employee.

Text

Employee Type

The type of employee.

Text

Policy

The policy for this employee.

Text

Job Title

Job title.

Text (80 chars max)

Reporting Group

The name of the primary or reporting group.

Text

First Day

The first day of employment.

Date

Last Day

The last day of employment.

Date

Scheduled Work Days

The scheduled days of the week that are considered work. This is formatted as a list of names of the days of the week separated by spaces, for example "Mon Tue Wed Thu Fri". The name of the day can be the standard abbreviation or the full name, as appropriate for the language of the locale of the user doing the import.

Text

Scheduled Hours

The number of hours the employee is scheduled to work each week.

Number

Scheduled Start

The time of day the employee is scheduled to start work or "punch in".

Time

Scheduled Finish

The time of day the employee is scheduled to finish work or "punch out".

Time

Email

Email address.

Text (80 chars max)

Phone

Phone number.

Text (40 chars max)

Mobile

Mobile phone number.

Text (40 chars max)

Fax

Fax number.

Text (40 chars max)

Timesheet Template

The timesheet template for this employee.

Text

Timesheet Memory

This controls whether rows and hours are carried forward from the previous timesheet to new timesheets. Possible values are:

Value

Description

None

None (or a blank value) indicates no rows or hours will be carried forward.

Rows

Timesheet rows will be carried forward from previous timesheet.

Rows and Hours

Timesheet rows and hours will be carried forward from previous timesheet.

Text

Punched In

A "Yes"/"No" value indicating whether the employee is punched in or not. This is a read-only value and will be ignored if imported.

Text

Locale

Locale. The locale determines how dates and numbers are formatted. Locale are specified using ISO codes, and possible values are defined in the Locale Codes appendix.

Text (5 chars max)

Time Zone

Time zone. Time zones are specified using Olson IDs, and possible values are defined in the Time Zone Codes appendix.

Text (40 chars max)

Bill Rate

The default bill rate. This can be a named rate, or a custom numeric value.

Text or Number

Pay Rate

The default pay rate. This can be a named rate, or a custom numeric value.

Text or Number

Groups

The list of groups this employee is a member of. If a user belongs to multiple groups then each group is separated by a carriage return. If formatting an import file using Excel you can enter multiple lines in a cell using ALT+ENTER (also called a "hard" carriage return).


Depending upon your integration needs, you may want to narrow the scope of which groups are set in the import file.  By default, if the Groups column is present, the user is removed from ALL groups and placed in the group(s) specified in the import file.  If you want to only set their permission groups and not alter reporting groups or crews they are in, you can append the ":P" suffix to the column header: "Groups:P". The following suffixes can be used:


Suffix

Description

Groups:P

Takes the user out of all permission groups (groups that do not have the Reporting Group or Crew type checked) and adds them to the groups specified in the import file.  If no groups are specified in the import file then they will belong to no permission groups. This will not remove the user from any reporting or crew groups they may currently be members of.

Groups:NC

Takes the user out of any groups that are not crew groups, and adds them to the groups in the import file.  In other words, this suffix will ensure the list of crews a user is a member of will not be changed.


Text

Notes

Notes about this employee.

Text (2000 chars max)

Approver

The name of the primary timesheet approver for the employee. The name can be a login name, employee ID, or full name (either "first last" or "last, first" is accepted).

Text

Approver Backup

The name of the backup timesheet approver for the employee. The name can be in the form of a login name, employee ID, or full name (either "first last" or "last, first" is accepted).

Text