Extract Employee Data from SuccessFactors Task
About Extract Employee Data from SuccessFactors
The Extract Employee Data from SuccessFactors task automates an employee data export from SuccessFactors. You can import core employee data (name, email, unique identifier), employee metadata (gender, role, department, etc), and org hierarchy data (manager, location) on a recurring schedule that you set. After your data is imported into Qualtrics, it needs to be saved using a data loader task, usually the load users into EX directory task.
Setting Up an Extract Employee Data from SuccessFactors Task
- Create an ETL workflow.
- Select Data source (ETL extractor).
- Select Extract employee data from SuccessFactors.
- Choose a SuccessFactors account to use.
- If you want to add a new SuccessFactors account to use, click Add new user account.
Qtip: After clicking Add new user account, you will be directed to enter your SuccessFactors account information. See finding your SuccessFactors account information for help finding the required fields.
- Click Next.
- Four fields will be automatically mapped for you. These fields correspond to core employee data fields and are commonly imported into Qualtrics. These fields are your employee’s first name, last name, email address, and unique identifier. If needed, you can remove these fields from your mapping.
- To add additional fields to import, click Add Field.
Qtip: The Qualtrics platform does not support multiple employments for an individual participant from SuccessFactors. If a field has multiple values, the extractor will pull the value that has been the most recently modified. We currently do not support selecting any other values. Additionally, if you have multiple records for the same employee in SuccessFactors, the Basic Transform task must be used to filter out any values that are not the primary employment.
- Select a SuccessFactors field by clicking the field box and choosing from the list. You can also type in the field name to find it more quickly. You can search by either field name (if available, e.g., “Gender”) or by field path within SuccessFactors (e.g. personal_information/birth_name).
Qtip: Custom fields can be imported by entering the appropriate SuccessFactors fieldname (e.g., personal_information/custom_fieldname). Custom fields will not appear in search results as you type. Custom fields must have a “lastModifiedDateTime” subfield to be imported.
- To remove a field, click the minus sign ( – ) to the right of the field.
- Click Next.
- A preview will appear, showing you an example of what will be imported for each field you selected.
- If the preview looks OK, click Save. If you need to make changes to your fields, click the Back button instead.
After setting up your SuccessFactors task, you must tell Qualtrics where to save your data with a data loader task. Usually, this is the load users to EX directory task.
Finding Your SuccessFactors Account Information
After clicking Add new user account, you will see a screen for you to enter the OAuth credentials from SuccessFactors. Visit our Configuring SuccessFactors Tasks with OAuth Credentials page for prerequisite information necessary for set-up.
- Name: This is the label you give your account. This field isn’t used for authentication.
- Username: Your SAP User ID.
Warning: Your username and your SAP User ID may be different. The User ID is case sensitive.
- API key, X.509 certificate private key: X.509 certificate authentication adds an additional layer of protection to your data. When you register an Oauth Client using this certificate, an API key will also be generated.
Qtip: There are 2 options for generating the certificate and private key. You can generate your own certificate and private key, or SAP has an option to generate while registering the OAuth2 Client Application, which you can download from SuccessFactors. If you generate a private key, it must be in the PKCS8 format. For more information, please see SAP’s documentation.
For more details on this process, please see the following SAP documentation:
-
- Registering Your OAuth2 Client Application
- Creating an X.509 Certificate in SAP SuccessFactors
- Generating a SAML Assertion
- Requesting an Access Token
- Viewing the Validity of an Access Token
Qtip: The last 3 documents in this list are intended for SuccessFactors admin users, or any other user with permission to create OAuth integrations. For additional help with certificate authentication, please contact SuccessFactors support.
- Datacenter domain: Your SuccessFactors domain.
Qtip: Do not include the http:// in the URL.
- Company ID: Your SuccessFactors company ID.
You can find a few of these fields on your SuccessFactors login page:
- Your Username is entered in the username field.
Warning: Your username and your SAP User ID may be different. The User ID is case sensitive.
- Your Company ID will appear above the login fields.
Example: An example company ID is BenefitsSB.
- Your Datacenter domain can be found in your URL once logged into SuccessFactors.
Qtip: Do not include the http:// in the URL.Example: An example datacenter domain is apisalesdemo4.successfactors.com.
If you need help accessing your SuccessFactors information, please see our Configuring SuccessFactors Tasks with OAuth Credentials page, or contact SuccessFactors support.
Troubleshooting SuccessFactors Tasks
To troubleshoot your workflow, head to workflows reporting and view the output of your workflow. If your workflow failed, this will contain information into why it failed.
Incorrect Account Credentials
See Configuring SuccessFactors Tasks with OAuth Credentials.
Imported Fields are Blank
The extract employee data from SuccessFactors task displays all non-custom fields associated with a SuccessFactors account, but it’s possible that the field selected in the task does not have information associated with it in SuccessFactors. Ensure that the field’s path you’ve selected matches a filled field in SuccessFactors. Note that some field names might be associated with multiple locations within SuccessFactors. For example, “/personal_information/created_by” and “address_information/created_by” are different fields!
Common Field Errors
This table lists common errors and their resolutions. These errors appear when previewing your imported data in the extract employee data from SuccessFactors task.
Error Message | Resolution |
Preview record request was successful, but zero results were received. | Contact SuccessFactors support about why zero records are being returned. |
Unable to parse field path {{Field Path Here}} from response. Field path must be of type boolean or string. | This is a warning message indicating that the field path was not a Boolean or String in the preview record.
Check the field type in the ODATA Dictionary in SuccessFactors. |
Error encountered while fetching OAuth token from SuccessFactors: {{Error from SuccessFactors}}. | Credential error when requesting OAuth Token. The specific reason will be in the message from SuccessFactors.
Known reasons:
To resolve this error, update your credentials so that they are correct. See Configuring SuccessFactors Tasks with OAuth Credentials for more information. |
Error encountered from SuccessFactors while fetching preview record: {{Error from SuccessFactors}}. | Error on OData API call from SuccessFactors. The specific reason will be in the message from SuccessFactors. This error happens because the Property cannot not found.
See the “Property not found” subsection below for more information on resolving this error. |
Unexpected internal error encountered while fetching preview record from SuccessFactors. | Internal error on Qualtrics’ side. Please contact Qualtrics Support. |
Property Not Found
If you are trying to import custom SuccessFactors fields, the format cannot be validated in our field dropdown. If you get an unexpected error in when previewing your import, such as “Invalid property names”, please check in SuccessFactors that the field path is correct.
To look up a field, go to the Admin Center in SuccessFactors and then navigate to your OData API Data Dictionary.
From here, go to the Entity tab, and look up the field you want to add. Confirm the field exists and that the field path matches what you’ve added in the Qualtrics Extract Employee Data from SuccessFactors task. In general, “PerPerson” is the base entity to start with to find the correct field path. If the field path is correct, and you are still running into the error, please reach out to SuccessFactors support for assistance.