SFTP Integration to Workday - sending HRIS data via flat file.

SFTP (Secure File Transfer Protocol) allows for the secure transmission of files across the internet. Workday supports automated data transfers as well as manual uploads through CSV files.

Step 1: Build a Custom Report in Workday

  1. In your Workday instance, search for and select Create Custom Report.

  2. Configure the report using the following settings:

    • Report Name: Choose any name you'd like.

    • Report Type: Select Advanced.

    • Temporary Report: Leave unchecked.

    • Enable As Web Service: Check this box.

    • Optimized for Performance: Leave unchecked.

    • Data Source: Use All Active and Terminated Workers.

⚠️ If you don’t see this data source, make sure the Optimized for Performance checkbox is not selected.

Click OK to proceed.

sftp1


Step 2: Add Required Fields to the Report

Under the Columns tab:

  1. Add fields by selecting the appropriate Business Object and then choosing the specific Field.

  2. Some fields may require an XML Alias Override. These will be clearly indicated in your field documentation.

  3. While most field choices are up to you, a few are mandatory and will be listed as such.

ℹ️ Workday will auto-generate XML aliases for standard fields. Manual override is only necessary when noted.

SCR-20240711-phlt-2

You have the flexibility to choose which fields to include in your report! However, note that there are a few mandatory fields that you must incorporate, which are specified in the "Notes" column below.

Important: When you enter the field values in the Workday user interface, the system will automatically generate the XML Aliases for you. Therefore, you don’t need to manually manage the XML Aliases for each field.

sftp3


Step 3: Define Group Column Headings

Still under the Columns tab, scroll down to the Group Column Headings section. Workday requires group headers for certain Business Objects. Use the table below as a guide:

You may choose to exclude some Group Column Headings if you did not select the corresponding fields in Step 2.

sftp4

Business Object

Group Column Heading XML Alias

Worker

Worker_group

Position

Position_group

Job Family Job_Family_group
Company Company_group
Pay Group Pay_Group_group

Only include group headings for the objects you've used in your report.


Step 4a: Create an SSH Key Pair

  1. Search for Create x509 Private Key Pair in Workday.

  2. Enter a memorable name and an optional description.
    sftp5

  3. Click OK.

  4. Workday will generate both public and private keys.

sftp6Copy the full public key, including the header and footer lines:

-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----

Paste this key into a text file and send it to your CSM to setup

Please make sure you have the sftp information from your CSM 


Step 4b: (Optional) Create a PGP Key

If you'd like to encrypt the exported data with PGP:

  1. Search for Create PGP Public Key.

  2. Give it a name and provide the public key (found below).

  3. Save and retain it for use in Step 4.

    sftp7

Step 5: Set Up the Report Schedule via EIB -

Before proceeding with this step, ensure that you have obtained the SFTP information from your Corporate Gift Customer Success Manager (CSM).

 

  1. Search for and select Create EIB.

  2. Provide a name and select Outbound.

    image (28)
  3. On the Get Data tab:

    • Data Source Type: Custom Report

    • Custom Report: Select the report created earlier

    • Alternate Output Format: CSV


      sftp9

  4. Move to the Transform tab:

    • Transformation Type: None

    sftp10

  5. Proceed to the Deliver tab and complete the following:

Field Value
Delivery Method SFTP
SFTP Address sftp://<value send from Corporategift>
Directory Value provided from Corporategift
Authentication Method SSH Authentication
User ID As provided by Corporategift
SSH Key Select the key pair from Step 4
File Name Employee Information.csv
Encryption (Optional) Choose your PGP key and enable ASCII Armored

 

sftp11

sftp12

Continue to the Summary page, review your settings, and click OK.

Check with your CSM if the SFTP connection is now working correctly.

Step 5: Set Up the Report Schedule via EIB

  1. Search for and select Create EIB.

  2. Provide a name and select Outbound.

  3. On the Get Data tab:

    • Data Source Type: Custom Report

    • Custom Report: Select the report created earlier

    • Alternate Output Format: CSV

  4. Move to the Transform tab:

    • Transformation Type: None

  5. Proceed to the Deliver tab and complete the following:

Field Value
Delivery Method SFTP
SFTP Address sftp://<value from Corporategift>
Directory As provided in the Corporategift
Authentication Method SSH Authentication
User ID As provided by Corporategift
SSH Key Select the key pair from Step 4
File Name Employee Information.csv
Encryption (Optional) Choose your PGP key and enable ASCII Armored

 

Continue to the Summary page, review your settings, and click OK.

Check with your CSM if the SFTP connection is now working correctly.

Step 6: Finalize Scheduling in Workday

In Workday, on the Integration System screen:

  1. Open the More Options menu (three dots).

  2. Go to Integration > Launch / Schedule.

    sftp13
  3. Set your preferred schedule (daily is recommended).

    sftp14
  4. If Daily Recurrence is selected, configure the timing under the Schedule tab and leave other fields at their default values.

    sftp15

✅ Setup Complete

Your data will sync automatically based on the schedule you set. Please note that file uploads are limited to 250MB. If you require a higher limit, contact your support representative.


Troubleshooting Tips

If you're experiencing issues with data syncing:

  • Confirm the EIB User ID is correctly set to the latest one from CG.

  • Make sure the following fields are included:

    • employee_id

    • manager_id (if applicable)

    • position_id

  • The report must be named Employee Information.csv

  • Format must be CSV

  • The SSH key must include the full certificate block (BEGIN and END lines).


Additional Notes

Employee and Manager IDs
Workday can format employee and manager IDs differently. Use the Worker’s Manager > Workday ID field, and rename its alias to manager_id.

Worker Status and Deleted Employees
While the worker status field isn’t required, including it is strongly recommended to identify active vs. inactive records.

  • Missing employees from a sync are flagged as deleted.

  • Those marked with status terminated are explicitly treated as such.

  • Deleted ≠ Terminated unless clearly defined.

Filtering Employees
To send only a portion of your employee records, apply filters when configuring your custom report — ideally between Steps 2 and 3.

PGP Public Key
Even without a PGP key, SFTP ensures secure transmission. However, if preferred, use the public PGP key provided on the integration page for encryption.