This article is a guide to let you know the values we accept in the SFTP process that would correspond to fields within Lattice. For columns with more than one word, Lattice will accept an underscore in between (Ex. Preferred_First_Name).
All files must include the following columns at a minimum:
Status
at least one Name field (see Name Fields below for options)
Work Email
Job Title
Manager
Status Field
For column headers, we will accept any of these:
Status
Active
Active Status
The values we accept for each column header are listed in the table below.
Column Header Name | Active | Deactivated |
Status |
|
|
Active or Active Status |
|
|
Name Fields
It is required to include employee names in the SFTP file. Recommended best practice for updating names is to include the following columns:
Legal First Name
Legal Last Name
Preferred First Name
Preferred Last Name
Note: If only legal name columns are provided in the file and preferred names are excluded, upon user creation, the Preferred First Name and Preferred Last Name will be populated to match the legal name. On future syncs, preferred names will not be overwritten. This is an option available if you want users to control their own preferred name directly in Lattice.
If only preferred name columns are included and legal names are excluded, the Legal First Name and Legal Last Name will be left blank in Lattice.
Alternative Name options:
Name
Full name
First name
Last name
Note: these header labels will upload the exact same values for both legal and preferred name values in Lattice and is not recommended.
All Other Fields
Some fields have multiple acceptable column headers, any of which will import to the same field in Lattice. For example, your file could include the header “Email” or “Email address” and either would successfully update the Work Email field in Lattice.
Field Label in Lattice | Accepted Column Headers | Required? | Data Expected in this column | Additional Notes |
Work Email | Email | Yes | Email address | This is the unique identifier used to match existing employee records, unless an External User ID is included in the file. This value must be unique to each employee record. |
Job Title | Title | Yes | Text |
|
Manager | Manager | Yes | Email address OR Employee ID | This must contain the email address of the manager, not their name. |
External User ID | External User ID | No | Alphanumeric string | If included, External User ID is prioritised as a unique identifier for user records above Email. It should be an alphanumeric ID that will be unique to each employee and will never change. |
Start Date | Start date | No | Date | We recommend putting dates in format YYYY-MM-DD. |
Department | Department | No | Text |
|
Birthdate | Birthdate | No | Date | We recommend putting dates in format YYYY-MM-DD. |
Gender Identity | Gender | No | Text | Expected values are "male", "female", "non-binary" or "nonbinary". Any other values will be skipped and left blank in the user profile. |
Phone Number | Phone Number | No | Phone number | Lattice does not have a requirement for phone number format. |
Timezone | Timezone | No | TZ identifier | The values for timezones will need to input the values (TZ Identifier) for tz database names. For example, "America/New_York" or "America/Los_Angeles" are valid TZ identifiers. |
Groups* | Latticegroups | No | Comma-separated list | This column should contain a comma-separated list of Group names for groups that already exist in Lattice. Learn more about groups here. |
Job Function | Job Function | No | Text | Part of the Job Architecture field group. See What is Job Architecture? for more details. |
Job Type | Job Type | No | Text | Part of the Job Architecture field group. See What is Job Architecture? for more details. |
Job Level | Job Level | No | Text | Part of the Job Architecture field group. See What is Job Architecture? for more details. |
Pay Zone | Pay Zone | No | Text | Optionally used for assigning Compensation Bands alongside Job Architecture fields. |
Compensation Fields | Compensation Fields | Compensation Fields | Compensation Fields | Compensation Fields |
Base pay amount | Base pay amount | Not required, but must be assigned before using Lattice Compensation | Number | Do not include any currency symbols ($) or commas. |
Currency / Base Pay Currency | Currency | Not required, but must be assigned before using Lattice Compensation | 3-digit Currency Code | See Supported Currency for Lattice Compensation for a complete list of accepted values. |
Pay Effective Date / Base Pay Effective Date | Pay effective date | Not required, but must be assigned before using Lattice Compensation | Date | We recommend putting dates in format YYYY-MM-DD. |
Pay Type | Pay type | Not required, but must be assigned before using Lattice Compensation | "Hourly" or "Salary" |
|
Bonus amount | Bonus amount | No |
| Must be a currency value, not a percent. |
Variable pay amount | Variable pay amount | No |
| Must be a currency value, not a percent. |
Custom Fields
Finally, note that you can include custom fields in the SFTP process so long as they have already been created in Lattice prior to upload. The formatting in the column header must match what you have set as the name of the field in Lattice.
When syncing a custom multiple-choice field, Lattice will automatically add any new field options to the dropdown list if they are included in the SFTP file, even if the option has not yet been added to the field in Lattice.