SAP SuccessFactors

HRIS Data Via STFP

Overview

SFTP (Secure File Transfer Protocol) is a secure service for sending files another over the internet. You can send data directly from SAP SuccessFactors using SFTP. This method utilizes the full file and deletes any rows that are not present in each transfer.

If you want to utilize a manual csv upload, skip to

step 2⁠

⁠

Step 1: Configure connection via SFTP

Search and click “Security Center” and select "Other Keys"

Press "Add" in the upper left corner then name the SSH Key

Choose "Authentication Key (SSH)" from the "Category" dropdown

Click "Generate and Save"

⁠

Download the Public Key from the key instance.

Locate and right-click the downloaded file, select "Open With"

Open the file with TextEdit

Copy the entire SSH Key, including the "---- BEGIN SSH2 PUBLIC KEY ----" to "---- END SSH2 PUBLIC KEY ----" lines

Paste the key into your Link modal

⁠

Step 2: Create a custom report in SAP SuccessFactors

You will be guided on how to create a custom report with fields that you wish to send securely via SFTP. This guide covers how to create

Employee information (2a⁠

) and

Employment information (2b⁠

) custom reports.

Regardless of which report you are creating, first search and click “Integration Center”

⁠

Click "My Integrations" then "+ Create" in the upper right corner

Select "Scheduled Simple File Output Integration"

You may now proceed to

Employee information (2a⁠

) or jump ahead to

Employment information (2b⁠

) depending on your specific data requirements.

⁠

2a. Create an Employees Report

Assuming you've already followed the setup in

Step 2⁠

. To generate an Employee Personal Information report, type "PerPersonal" in the Entity Name search field and select Personal Information.

It is required that you include the employee id aka "Person ID External (personIdExternal)" in field 1.

You can find all the fields required for your use case in our

SFTP Report Template⁠

. Please note that the fields must *exactly* match how they appear in that file.

⁠

If you don't need any more fields, you may proceed to

Step 3⁠

Optional: If you want to include employee number or employee date of birth, you'll need to access PerPersonal's relational table by checking "personNav" (item 56), see screenshot below.

⁠

Once you've added the fields that you need, press Select on the bottom right

Set the Report's Header Type to "Simple Header"

Press next to proceed to "Configure Fields"

⁠

Click the "+ Add" button

Add Field" from the dropdown

⁠

"Expand the "Entity Tree View" dropdown

To add multiple fields at a time, make sure to check the "Add Another" checkbox.

⁠

Now select personNav

Then select any biographical information that you want to include in your report

personId

Date of Birth

Emails

In the “Entity Tree View”, select personNav and select emailNav (to Email Information-Business)

After selecting this field, click the column header and rename the column to Work Email

Re-navigate to the “Entity Tree View”, select personNav and select emailNav (to Email Information-Personal)

After selecting this field, click the column header and rename the column to Personal Email

⁠

⁠

Press "cancel" once you're done. Don't worry all of the fields that you added above are automatically saved.

Once you have added all of the fields you need for this Employee Report, press "Next" until you reach Destination Settings. Then follow the instruction in

Step 3 of this guide.⁠

⁠

2b. Create an Employments Report

Assuming you've already followed the setup in

Step 2⁠

. To generate an Employment History Information report, type "EmpJob" in the Entity Name search field then select Job Information (EmpJob).

It is required that you check the following boxes

Box 2: Start Date (startDate)

Box 26: User ID (employmentNav to Employment Details)

⁠

⁠

Checking box 26 should generate the Person ID External-Employment Details column in your report. This is required for the Employments report.

You may also include any other fields that you wish to share in this report but here are some recommended fields.

User ID (userId)

Company (company)

Department (department)

FLSA Status (flsaStatus)

Is Fulltime Employee (isFulltimeEmployee)

Job Classification (jobCode)

Job Title (jobTitle)

Location (location)

⁠

To access additional fields, we'll also need to access EmpJob's relational table.

Select the checkboxes in the "Navigations" portion of the window for any fields relevant to your use case.

For:

cost center, select Cost Center (costCenterNav to Cost Center)

department, select Department (departmentNav to Department)

business unit code select, Business Unit (businessUnitNav to Business Unit)

termination date, select User ID (employmentNav to Employment Details)

job title, select Position (positionNav to Position)

termination date, currency, frequency, picklist label or pay comp value, select Employment Type (employmentTypeNav to PicklistOption)

⁠

Once you've added the fields that you need, press Select on the bottom right

Set the Report's Header Type to "Simple Header"

Press next to proceed to "Configure Fields"

⁠

To include additional fields from EmpJob's relational tables. Click the "+ Add" button and select "+ Add Field". If you don't have any additional fields to include, skip ahead to

Step 3 of this guide.⁠

⁠

To select multiple fields without the modal closing, please check the "Add Another" checkbox at the bottom of the modal before adding fields:

⁠

To add any of the following fields, select from "Entity Tree View" in order left-most to right-most column. Then "Add AssociationSelected Field".

For...

cost center, select Cost Center (Cost Center)

department, select Department (Department)

business unit code

select select businessUnitNav (to Business Unit)

then select Business Unit Code (externalCode)

termination date, select User ID (employmentNav to Employment Details)

job title, select Position (positionNav to Position)

supervisor id, select Supervisor

termination date,

select employmentNav

then select Termination Date (endDate)

start date

select comInfoNav (to Compensation Information)

select empPayCompRecurring (to Compensation)

then select Start Date (startDate)

a warning popup may appear, select "Yes"

currency

select comInfoNav (to Compensation Information)

select empPayCompRecurring (to Compensation)

then select Currency (currencyCode)

a warning popup may appear, select "Yes"

frequency

select comInfoNav (to Compensation Information)

select empPayCompRecurring (to Compensation)

then select Frequency (frequency)

a warning popup may appear, select "Yes"

pay amount

select comInfoNav (to Compensation Information)

select empPayCompRecurring (to Compensation)

then select Amount (paycompvalue)

a warning popup may appear, select "Yes"

username

Select userNav

then select Username (username)

picklist label

select employmentTypeNav

then select the picklistLabels -> label

a warning popup may appear, select "Yes"

job title

select positionNav (to Position)

then select Job Title (jobTitle)

Example of how to get to start date.

⁠

Once you've added all of the fields you need for this Employment Report, press "Next" until you reach Destination Settings. Then follow the instruction in

Step 3 of this guide.⁠

⁠

Step 2c. Manual CSV Upload

If you are planning to use the manual CSV upload method you should download the custom report(s) that you created above. Then simply upload into the Linking modal and you're done!

Step 3: Setup secure file transfer schedule

In the Destination Settings window, please populate the following fields using the information provided from the Linking modal.

⁠

For the following fields, use the unique values (not the necessarily the values in the screenshot) generated by your linking modal.

SFTP Server Host Address: "Host"

SFTP User Name: "Username"

Port: "Port"

File Folder: "Path"

Then populate the rest of these fields:

Authentication Type: Certificate based Authentication

Authentication Key: Select the key generated from

Step 1⁠

⁠

File Name Prefix:

if you are sending

Employee information (2a⁠

), use "employee_info"

if you are sending

Employment information (2b⁠

), use "employment_info"

Date Suffix Format: None

File Extension: csv

⁠

Set Occurs to the preferred schedule value, then click Next.

⁠

To send the file immediately select "Run Now"

Confirm by clicking "Save and Continue"

Or for a later scheduled occurrence select "Set Schedule".

The "Integration Name" has to be unique but you can name it anything

⁠

Process complete! 🎉

Your all done, you will now be receiving files containing employee information, employment information or both at the scheduled occurrence that you set.

⁠

Important Notes

PGP public key

If you prefer to send PGP-encrypted files, please find the required public key at the bottom of this page. Note that SFTP (Secure File Transfer Protocol) encrypts all data being transferred, including user authentication and the actual files, even if you do not configure PGP.

⁠

BoonAPIKeyRSA.asc

⁠