Input file specification

Input files for the Data Loader in Sage People must match the following specification:

Property Supported options Notes
Format

Text

Comma-separated Value (CSV)

Enclose fields containing commas in double quotes.

You can optionally enclose all fields in double quotes.

Record termination

Carriage return

Line feed (CR LF)

Don't include carriage returns in fields. The system interprets these as end of record markers.
Character encoding UTF-8 Essential if your data includes Unicode characters beyond the basic ASCII set. UTF-8 (UCS Transformation Format-8 bit) can represent every character in the Unicode character set.
First record Names of fields contained in the file. Use the API names for the fields as we supply in the customer-specific mapping templates.
Maximum file size 10,000 records When uploading larger amounts of data, split the content over two or more files.

Alternative file formats

As alternatives to CSV format, the Data Loader can use input files in the following formats:

  • Tab-separated Value (TSV)

  • Pipe delimited

As with other character-delimited formats, ensure you enclose fields with the delimiting character in the field content in double quotes. This avoids the system interpreting those characters as end of field markers.

Additional guidelines

You can choose to create your own template files rather than using the Sage People Template Generator. Make sure that your templates follow these rules:

  • Separate field names with the field delimiter you’re going to use for the data file. Use the same delimiter consistently, don't mix commas, tabs, and pipes.

    Use the correct object prefixes for fields that aren't Team Member object fields. This ensures the system identifies fields correctly. For example, Start Date and End Date fields exist in multiple objects and you must prefix Employment Start Date or Salary Start Date.

    Consistently represent dates in either dd/mm/yyyy or mm/dd/yyyy format. Don't mix formats in a single file. The separator between date components isn't important. you can use slash (/), stop (.), hyphen (-), or underscore (_). But the Data Loader expects to find the following format and will fail to load if the dates don't comply:

    <2 digits><separator><2 digits><separator><4 digits>

  • Microsoft Excel isn't ideal as an application for generating the source CSV files because:

    • It tends to corrupt data. For example, the system truncates leading zeros from fields by default

    • Standard Excel Save As... CSV doesn't produce UTF-8 character encoding

    You can use an alternative spreadsheet application like LibreOffice Calc, which avoids many of the limitations of Excel for CSV preparation.

    However, if your'e familiar with the potential problems of Excel and the necessary workarounds, use Excel to template and prepare your source data for uploading:

    1. Save Excel files in CSV format

    2. Open the CSV files in an application such as Notepad++ or Sublime Text

    3. Save the files with UTF-8 character encoding

Tip

Many Windows programs including Microsoft Notepad add bytes at the start of a UTF-8 encoded file. This is to produce a UTF-8 encoding of the Unicode byte order mark (BOM). The system often calsses files encoded in this way as UTF-8 BOM, or UTF-8 with BOM.

The Data Loader returns an error if you attempt to load a CSV file encoded as UTF-8 BOM. This is a common cause of data load failures. Check for BOM encoding when data loads fail for no other clear reason. Pass any UTF-8 BOM files through an application such as Notepad++ or Sublime Text to strip the BOM and produce a clean UTF-8 encoded file.