Employee Sync

Follow

Synchronize (Sync) automatically creates, updates, or deletes employees/users in Jobvite ATS.

Audience

Administrator

Prerequisites

Manual sync is required before the first run of the SFTP. This initial sync establishes the field mapping that the SFTP sync will use. Additionally, any changes to the file format sent via SFTP will require a manual sync to update the field mapping first.

Use Cases

  • Employee sync processes create new employees/users in Jobvite ATS by adding First Name, Last Name, Email, or the appropriate roles.
  • The employee sync process can update information for existing employees/users, for example:
    • New email address
    • Change in role(s)
  • Employee sync process can delete existing employees/users (requires End Date to be past or current date – cannot be future)

 Best Practices

  • Sync should be performed regularly to ensure that employees/users who need access to the system can do so, and that those who are no longer your company's employees can no longer access Jobvite ATS.
  • Include Employee ID/User ID to ensure no duplicate employees are added.
  • Test your imports in staging first to avoid losing information in your live/production environment.
    • Before testing with a large file, try testing with one line to see if any errors occur.
    • Especially if you have an integration, it's essential to work with Jobvite ATS and test in staging before updating to the new employee sync.
  • Before enabling the new sync, download your current employee list as a backup file.
  • Separate your upload files so that one file adds or Updates users and one file Deletes users—this ensures that all users aren't deleted by accidental error.
  • If the customer has custom roles, they must be added to the roles column as the role code, not the role name.

Employee Sync

There are three methods of Employee Sync:

  • Manual Sync
  • SFTP
  • API

Manual Sync

Manual Sync allows data to be imported from a file saved on a desktop. This is ideal for companies of any size looking to make a handful of changes.

Navigate to your user menu > Users.

Screenshot 2024-08-23 at 3.03.19 PM.png

 

Click Import Data and View Status Log.

Screenshot 2024-08-23 at 3.03.54 PM.png

Click Import Employees.

Screenshot 2024-08-23 at 3.04.28 PM.png

Click Upload File and select the CSV file from your desktop. NOTE: You can download the template for more information on the specific fields. For information about the Language Column Language Codes, please see Language Codes.

Screenshot 2024-08-23 at 3.04.54 PM.png

Select any desired options:

  • Send invite email to employees – When selected, an invite will be sent to each new user to validate their account.
  • Full Sync – When selected, any user not included in this file will be deleted/deactivated from the system.

Screenshot 2024-08-23 at 3.05.26 PM.png

Click Next.

Match the columns in your upload file to those enabled in Manage Employee Fields.

Screenshot 2024-08-23 at 3.05.57 PM.png

Screenshot 2024-08-23 at 3.06.21 PM.png

Click Submit.

SFTP

SFTP is more automated than Manual Sync. To configure SFTP, submit a Help Center ticket.

Once SFTP is enabled, the details will be shared with you. Inside Jobvite ATS, you can adjust the settings by navigating to your user menu > users, where SFTP Settings will be available. Click View Data Sync Settings to set up a schedule.

Screenshot 2024-08-23 at 3.07.37 PM.png

Screenshot 2024-08-23 at 3.08.26 PM.png

API

API offers real-time integration between systems. Your IT team must send the data file to Jobvite ATS.

Language Codes

Language Language Code
English (United States) en-US
English (United Kingdom) en-GB
French (Canada) fr-CA
French (France) fr-FR
German (Germany) de-DE
Spanish (Spain) es-ES
Swedish (Sweden) sv-SE
Italian (Italy) it-IT
Chinese (China) zh-CN
Chinese (Hong Kong) zh-HK
Albanian (Albania) sq-AL
Arabic (Saudi Arabia) ar-SA
Belarusian (Belarus) be-BY
Bulgarian (Bulgaria) bg-BG
Croatian (Croatia) hr-HR
Czech (Czech Republic) cs-CZ
Danish (Denmark) da-DK
Dutch (Netherlands) nl-NL
Estonian (Estonia) et-EE
Finnish (Finland) fi-FI
Hebrew (Israel) he-IL
Hungarian (Hungary) hu-HU
Indonesian (Indonesia) id-ID
Japanese (Japan) ja-JP
Korean (South Korea) ko-KR
Latvian (Latvia) lv-LV
Lithuanian (Lithuania) lt-LT
Malay (Malaysia) ms-MY
Norwegian Bokmål (Norway) nb-NO
Polish (Poland) pl-PL
Portuguese (Brazil) pt-BR
Portuguese (Portugal) pt-PT
Romanian (Romania) ro-RO
Russian (Russia) ru-RU
Slovak (Slovakia) sk-SK
Slovenian (Slovenia) sl-SI
Thai (Thailand) th-TH
Turkish (Turkey) tr-TR
Ukrainian (Ukraine) uk-UA
Vietnamese (Vietnam) vi-VN
Maltese (Malta) mt-MT

Troubleshooting

Examples of errors include:

  • If individual records have errors, it will look like this:

Screenshot 2024-08-23 at 3.09.06 PM.png

  • If the entire file has an error, it will look like this:

Screenshot 2024-08-23 at 3.09.37 PM.png

Error Codes Message
E0001 Missing the entire Email column in the file
E0002 Missing the entire FirstName column in the file
E0003 Missing the entire LastName column in the file
E0009 The column/s {0} was not recognized and was ignored
W0001 The employee has no email address
W0002 The employee has an invalid email address
W0003 An employee's email address is used for multiple companies
W0004 Employee ID is expected but missing
W0005 Invalid role
W0006 Invalid department
W0007 Invalid location
W0008 Invalid subsidiary
W0009 Invalid region
W0010 The employee has no first name
W0011 The employee has no last name
W0012 The end date for user {0} is in the future
W0013 Employee id {0} appeared multiple times
W0014 Employee ID is missing
W0015 Start date format doesn't match company-level settings
W0016 End Date format doesn't match company-level settings
W0017 The user {0} was not found (When searching for employees from Email Address while associating employees)
W0018 Invalid Association for the employee {0} : {1} not found
W0019 Invalid User ID provided for employee {0}
W0020 User ID value not provided, but expected. Employee {0} already exists
W0021 The user {0} was not found (When searching for employees from the User ID)
W0022 Location: {0} is not associated with Region: {1}
Was this article helpful?
0 out of 3 found this helpful