Skip to main content

Creating and uploading CSV file for Advanced User Sync

To get user data and profile information into the Jive Advanced User Sync add-on, you need to export the data from the source system into CSV (Comma Separated Values) format.

CSV file editor apps​

Many people use Microsoft Excel to create and edit these files, but any application that can create a CSV file works. You should save the result as CSV format, even though Excel will try by default to save as XLS or XLSX which will not work with the sync. For more information, see Import or export text (.txt or .csv) files on Microsoft portal at https://support.office.com/en-us/article/https://support.office.com/en-us/article/Import-or-export-text-txt-or-csv-files-5250ac4c-663c-47ce-937b-339e391393ba.

Uploading CSV files​

You must upload the CSV file to the Jive SFTP server by using the address and credentials provided to you by Support.

The CSV file should be placed in the /storage/user_sync/ directory.

CSV file fields​

Here you find the list of CSV fields and fill-in rules for preparing CSV data files for upload.

CSV fields​

The CSV file should be formatted to include the following fields in the particular order:

  • User Details (required):
    • Primary Key
      • It can be Username, Email, or SAML ID.
    • First Name
    • Last Name
    • Email Address
    • Username
    • Enabled/Disabled flag
      • This field cannot be blank. Each row must contain enabled/disabled, true/false, 1/0 Boolean values.
    • Username of Manager
      • This is used for the Org Chart.
    • Permission Groups
      • You can specify several groups by separating them with vertical lines |.
    • Profile Details (optional)
      • Up to 550 profile fields can be synchronized.

For example files, see User Sync Add-On Example Files on Thrive.

Requirements for formatting data in fields​

  • Encoding: The files must be UTF-8 encoded.
  • Primary key: The Primary Key must always be the first field and must contain a username, email, or SAML ID to be used to uniquely identify this user and search for it in Jive.
  • Order of fields: The order of the fields is important for the user sync to work correctly.
  • Dates: Dates must be formatted differently depending upon which field you are mapping to. Any Jive default date fields will be in UTC+offset standard format. For example, a date in Jive can look like this: 1997-07-16T19:20+01:00. Any profile field that you custom created must be in standard MM/DD/YYYY format.
  • Enabled/Disabled Flag: The Enabled/Disabled field is required, and each row must have a value. This cannot be blank. True/False or 1/0 are acceptable.
  • Addresses and multi-select fields: Portions of the address field and other multi-select fields should always be separated by a vertical line | with no spaces in between. For example, an address may look like this: Street|Street2|City|State|Country|ZIP.
  • Headers: If the add-on settings indicate that the CSV file has column headers, then they must exist in the file for the process to work. If the settings indicate that there are no headers, none should exist in the file.
  • Bad information: Each row of your CSV file must contain valid data. Jive will not create or update users where invalid information is provided.
  • Empty fields: If you want to pass an empty or null value, make sure the comma delimiters are included with nothing in between them.
  • Text with commas: If you want to pass text that includes commas, such as biographies, titles, or free-form text, you need to enclose the entire field value in double-quotes. For example, a title may look like this: "Director, Support".

Processing CSV files​

By default, only users that exist within the CSV file are processed. Any user that exists in Jive but not in the CSV file will not be modified. If you would like to deactivate any user that does not exist in your CSV file, submit a support case at Support. The support team will put in a request to have this option changed for you.

Attention

Special notes on file data: If more than one record is found for a user, only the first record will be processed. It's important to be sure that your source data is clean, valid CSV, and it is recommended that the duplicates are removed before going into Jive.

Related

Setting up and administering Advanced User Sync