What is your integration use case?
Use case 1: I have not created any stakeholder profiles in my Ledgy account.
1. Connect SAP SuccessFactors with Ledgy
First, go to Company Settings > Data Management > HR system integration > Connect.
Scenario 1: Existing connection
If you’re already connected — there is nothing to do! Feel free to jump to ‘Configure your HRIS field import into Ledgy’
If you are connected, but wish to adjust your API key permissions or change HRIS provider, please ‘disconnect’ and follow the new connection instructions, or reach out to customer support.
Scenario 2: Establishing a new connection / no existing connection
1.1 Select SAP SuccessFactors from the HR system logo picker and click the Connect button
1.2 Authenticate your SAP SuccessFactors account and link it with Ledgy
To authenticate your SAP SuccessFactors account, you will need to provide the following information:
API Server URL
Username
Company ID
OAuth Credentials
1.2.1 Prerequisites
Please ensure you fulfill all the requirements to set up the integration:
You are an Administrator in your company's SAP SuccessFactors instance, or someone has shared their access with you.
1.2.2 Instructions
Step 1: Find your API Server URL at this link
In the listed API Server URLs, search for the environment that matches your subdomain
For example, if your domain was https://salesdemo4.successfactors.com, search for salesdemo4
If you are unsure what your API Server URL is, or are having trouble connecting, we recommend reaching out to your SAP Support team to obtain your API Server URL
Step 2: Enter the URL into the linking flow
Copy the entire URL. In this example, it would be: apisalesdemo4.successfactors.com
Enter your SAP SuccessFactors API Server URL into the integration authorization component as shown below
Step 3: Find your SAP Username and Company ID
To find your SAP SuccessFactors username, go to the upper right-hand side and click on your profile image to view your username.
To find your SAP SuccessFactors Company ID, in the same dropdown menu, click "Show version information." Locate Company ID in the modal that pops up:
Once you obtain your username (not email) and company ID, enter them in Merge Link as shown:
Step 4: Find your SAP SuccessFactors Client ID and Secret by generating a certificate
In your Admin Center, go to Tools, and search Manage OAuth2 Client Applications (If your page looks different, search for Manage OAuth2Client Applications in the search tool on your homepage)
Click Register Client Application
Fill out Application Name & Application URL (what actually goes in these fields is not important, except that the URL has to begin with https://)
Click Generate X.509 Certificate. Fill out Common Name (the name doesn't matter) and hit Generate
Once the certificate populates, download and save it. You will have downloaded a file called Certificate.pem
Click Register (it will have replaced the Generate button)
Back on your Manage OAuth2 Client Applications, go to the application you just created and click Edit
You will now see an API key listed - this is your Client ID. Copy and save this Key.
Open up the "Certificate.pem" file you previously downloaded in a text editor. The string between ——BEGIN ENCRYPTED PRIVATE KEY——- and —-END ENCRYPTED PRIVATE KEY——- is your Client Secret. Copy the Client Secret and save
Enter your Client ID and Secret into the integration authorization component as shown below and click on Submit:
You’ll be given the option to map additional HR field mappings from your HRIS into Ledgy. Hit ‘Skip for now’ and request additional field mappings via the in-app chat, once linking is complete.
You’ll be given the option to map additional HR field mappings from your HRIS into Ledgy. Hit ‘Skip for now’ and request additional field mappings via the in-app chat, once linking is complete.
2. Configure your HRIS field import into Ledgy
You need to configure the fields before initiating sync. Hit ‘Configure’ to open up the modal below. You are able to change the configuration later and at any future point.
Nb. please close & re-open the modal to first load the configure screen. Loading may take up to 5 minutes.
2.1. Stakeholder identifier should be a unique identifier and the value should exist for all employees in HRIS. In SAP SuccessFactors's case, the identifier can be “Work email”.
Merge field we recommend to use as "Stakeholder Identifier" (name in the HRIS) | -> Corresponding HR field that maps to recommended "Stakeholder Identifier" by Merge field (type) |
Work Email (Émail' in HRIS) | work_email (string) |
If you already have stakeholders in Ledgy, please see FAQ below.
2.2. Stakeholder email: Choose which employee field to map to Ledgy’s primary email.
2.3. Additional fields to import allow you to optionally import any of the following fields:
Manager
Mobile Phone Number
Pay Rate
2.4. Hover over the “❓ Some basic stakeholder fields” to see the default fields mapped from HRIS into Ledgy
2.5. If there are additional fields you wish to map to Ledgy from your HRIS, please click the link to reach out to support and request new HR field mappings via chat.
2.6. You can add "Sync if" conditions to specify which employees to sync in Ledgy.
⚠️ Note: filters are additive, meaning that stakeholders must match all conditions for a rule to apply to them. You can use ‘OR’ conditions to select multiple values for a given filter. For example: you may want to sync employees across multiple countries, and of multiple groups.
3. Syncing stakeholders into Ledgy
Once you have setup the configuration, you can sync stakeholders. Hit ‘sync’ to preview stakeholders that will be created or updated in Ledgy.
Nb. ‘Mobile number’ will appear as invalid if the country code is not inputted in HRIS. Please add country code to HRIS entries to successfully sync mobile number - otherwise, this will need to be manually updated in Ledgy.
Use case 2: I have already created stakeholder profiles in my Ledgy account.
1. Connect SAP SuccessFactors with Ledgy
First, go to Company Settings > Data Management > HR system integration > Connect.
Scenario 1: Existing connection
If you’re already connected — there is nothing to do! Feel free to jump to ‘Configure your HRIS field import into Ledgy’
If you are connected, but wish to adjust your API key permissions or change HRIS provider, please ‘disconnect’ and follow the new connection instructions, or reach out to customer support.
Scenario 2: Establishing a new connection / no existing connection
1.1 Select SAP SuccessFactors from the HR system logo picker and click the Connect button
1.2 Authenticate your SAP SuccessFactors account and link it with Ledgy
To authenticate your SAP SuccessFactors account, you will need to provide the following information:
API Server URL
Username
Company ID
OAuth Credentials
1.2.1 Prerequisites
Please ensure you fulfill all the requirements to set up the integration:
You are an Administrator in your company's SAP SuccessFactors instance, or someone has shared their access with you.
1.2.2 Instructions
Step 1: Find your API Server URL at this link
In the listed API Server URLs, search for the environment that matches your subdomain
For example, if your domain was https://salesdemo4.successfactors.com, search for salesdemo4
If you are unsure what your API Server URL is, or are having trouble connecting, we recommend reaching out to your SAP Support team to obtain your API Server URL
Step 2: Enter the URL into the linking flow
Copy the entire URL. In this example, it would be: apisalesdemo4.successfactors.com
Enter your SAP SuccessFactors API Server URL into the integration authorization component as shown below
Step 3: Find your SAP Username and Company ID
To find your SAP SuccessFactors username, go to the upper right-hand side and click on your profile image to view your username.
To find your SAP SuccessFactors Company ID, in the same dropdown menu, click "Show version information." Locate Company ID in the modal that pops up:
Once you obtain your username (not email) and company ID, enter them in Merge Link as shown:
Step 4: Find your SAP SuccessFactors Client ID and Secret by generating a certificate
In your Admin Center, go to Tools, and search Manage OAuth2 Client Applications (If your page looks different, search for Manage OAuth2Client Applications in the search tool on your homepage)
Click Register Client Application
Fill out Application Name & Application URL (what actually goes in these fields is not important, except that the URL has to begin with https://)
Click Generate X.509 Certificate. Fill out Common Name (the name doesn't matter) and hit Generate
Once the certificate populates, download and save it. You will have downloaded a file called Certificate.pem
Click Register (it will have replaced the Generate button)
Back on your Manage OAuth2 Client Applications, go to the application you just created and click Edit
You will now see an API key listed - this is your Client ID. Copy and save this Key.
Open up the "Certificate.pem" file you previously downloaded in a text editor. The string between ——BEGIN ENCRYPTED PRIVATE KEY——- and —-END ENCRYPTED PRIVATE KEY——- is your Client Secret. Copy the Client Secret and save
Enter your Client ID and Secret into the integration authorization component as shown below and click on Submit:
You’ll be given the option to map additional HR field mappings from your HRIS into Ledgy. Hit ‘Skip for now’ and request additional field mappings via the in-app chat, once linking is complete.
You’ll be given the option to map additional HR field mappings from your HRIS into Ledgy. Hit ‘Skip for now’ and request additional field mappings via the in-app chat, once linking is complete.
2. Configure your HRIS field import into Ledgy
You need to configure the fields before initiating sync. Hit ‘Configure’ to open up the modal below. You are able to change the configuration later and at any future point.
Nb. please close & re-open the modal to first load the configure screen. Loading may take up to 5 minutes.
2.1. Stakeholder identifier should be a unique identifier and the value should exist for all employees in HRIS. In SAP SuccessFactors's case, the identifier can be “Work email”.
Merge field we recommend to use as "Stakeholder Identifier" (name in the HRIS) | -> Corresponding HR field that maps to recommended "Stakeholder Identifier" by Merge field (type) |
Work Email (Émail' in HRIS) | work_email (string) |
2.2. Stakeholder email: Choose which employee field to map to Ledgy’s primary email.
2.3. Additional fields to import allow you to optionally import any of the following fields:
Manager
Mobile Phone Number
Pay Rate
2.4. Hover over the “❓ Some basic stakeholder fields” to see the default fields mapped from HRIS into Ledgy
2.5. If there are additional fields you wish to map to Ledgy from your HRIS, please click the link to reach out to support and request new HR field mappings via chat.
2.6. You can add "Sync if" conditions to specify which employees to sync in Ledgy.
⚠️ Note: filters are additive, meaning that stakeholders must match all conditions for a rule to apply to them. You can use ‘OR’ conditions to select multiple values for a given filter. For example: you may want to sync employees across multiple countries, and of multiple groups.
2.7. Update your stakeholders:
To edit your stakeholder in bulk, go to Stakeholders > click the "Bulk" button
Select "Natural person" > Click on the "Stakeholders" button to download your stakeholder list
Add the unique identifier (Employee ID or Work email) for each stakeholder from your HRIS Platform in the Identifier column in the Excel file
Upload the Excel file back to your account
3. Syncing stakeholders into Ledgy
Once you have setup the configuration, you can sync stakeholders. Hit ‘sync’ to preview stakeholders that will be created or updated in Ledgy.
Nb. ‘Mobile number’ will appear as invalid if the country code is not inputted in HRIS. Please add country code to HRIS entries to successfully sync mobile number - otherwise, this will need to be manually updated in Ledgy.
FAQ
Which HRIS fields are mapped into Ledgy?
By default, we now map more data from your HRIS into Ledgy, and you can select from optional fields to also map into Ledgy.
Fields mapped by default (Simple)
Fields mapped by default (Simple)
Identifier
Name
Email (i.e work email)
Personal Email
Address Line 1
Address Line 2
ZIP Code
City
Country
Birthdate
Group Name
Start Date (not visible on stakeholder modal)
Termination Date (not visible on stakeholder modal)
Employment Status (not visible on stakeholder modal)
Pay Rate (not visible on stakeholder modal)
Pay Period (not visible on stakeholder modal)
Pay Currency (not visible on stakeholder modal)
Employment Type (not visible on stakeholder modal)
Team (not visible on stakeholder modal)
For fields that are not supported by default by your HRIS, please follow FAQ for “How do I setup HR field mappings from my HRIS into Ledgy?”, to request the field mapping via support chat. You can then map the field mapping into a Ledgy custom field.
How do I setup HR field mappings from my HRIS into Ledgy?
Customer support via in-app chat - after linking flow
Customer support via in-app chat - after linking flow
Simply skip the step in the linking process, and reach out to support via the in-app chat bubble to request more HR field mappings. Once added, you will see the HR field mapping appear in the configure screen - ready to be mapped to the Ledgy custom fields created.
HRIS Fields Not Accepted by Ledgy
HRIS Fields Not Accepted by Ledgy
• Racial or ethnic origin
• Political affiliation
• Religious affiliation (including tax elections)
• Trade union membership
• Genetic or health data (including medical records)
• Biometric data
• Data on sex activity or sexual orientation (does not include gender)
• Criminal records or background check information
• Banking or payment information (including credit card, IBAN)
• Credit rating
• License or passport numbers
• US social security number
For data protection reasons, we want to avoid storing this information in Ledgy. But if you need the information in your Ledgy account, we can make an exception. Please reach out to [email protected] and explain your reasons.
What are Ledgy custom fields?
Ledgy stakeholder custom fields are company-wide fields that you create in Ledgy. They exist on each stakeholder. Now, you can create your own HR field mappings (see above) and sync them into Ledgy custom fields.
They can be used as variables for document templating and in reports, as grid columns, and as “group by” options for your stakeholders in Ledgy, and more.
What if I already have stakeholders in Ledgy, and now want to sync with HRIS?
Ledgy requires a Stakeholder identifier to match existing stakeholders in Ledgy with employees in HRIS. If no identifiers exist in Ledgy and the names do not match 100% between your HRIS platform and Ledgy, then duplicates may be created in Ledgy in the syncing process.
If you have created your stakeholders without your HRIS platform in your Ledgy account and now wish to connect your HRIS platform, please follow the steps to ensure that the sync doesn't create duplicate stakeholders.
Update your stakeholders:
To edit your stakeholder in bulk, go to Stakeholders > click the "Bulk" button
Select "Natural person" > Click on the "Stakeholders" button to download your stakeholder list
Add the unique identifier (Employee ID or Work email) for each stakeholder from your HRIS Platform in the Identifier column in the Excel file
Upload the Excel file back to your account
Correct mapping:
Follow the step 1 and step 2 in the integration process
Go to Company Settings > Data Management > HR System Integration > Click the "Configure" button
Map the name of the identifier that you added in the Excel file with the Ledgy field "Stakeholder identifier"
Click the "Save" button to save the mapping
Now you can sync Ledgy with your HRIS platform, and we will not create any duplicates!
Can I still use this page without connecting my HRIS?
You can still use the Data Management page to manage your stakeholder’s custom fields.
What happens when an employee is terminated on the HRIS?
When syncing Ledgy with your HRIS, terminated employees are not automatically recognised as terminated by Ledgy. Thus, if not specified otherwise, Ledgy will prompt you to create or update them.
There are different options for managing the terminated employees:
Add a "Sync if" condition such as sync if "status" = "active" → this will exclude the inactive/terminated employees from the sync. However, this will not automatically delete the terminated stakeholders from Ledgy if they had already been previously created (learn more about deleting stakeholders or revoking portfolio access)
Sync the terminated employees to Ledgy, and assign them to a stakeholder group such as "Ex-employee" or "Alumni"
Delete the terminated employees from your HR management platform → this will prevent the terminated stakeholders from being created or synced in the future. However, this will not automatically delete the stakeholders from Ledgy if they had already been previously created (learn more about deleting stakeholders or revoking portfolio access