Skip to main content

Overview

This document outlines the procedure for configuring a third-party assessment vendor within SAP SuccessFactors and integrating it with StackOne. The guide details adding a vendor, uploading assessment packages, and customising job requisition templates to include assessment fields. Finally, it explains how to set up external event notifications to trigger assessments and utilise the StackOne Unified API to return the results to SAP SuccessFactors.

Partner Requirements

There are no formal partnership requirements for assessment vendor integration with SAP SuccessFactors. You must have access to the Provisioning Account to create an integration user and grant the necessary permissions.

Required Permissions for Vendor Assessment in SAP SuccessFactors

You may not have access to the Provisioning Account. If this is the case, please contact your SAP SuccessFactors customer and ask them to follow the instructions below to grant you the necessary permissions.
In the Provisioning Account, create an Integration User and assign the following permissions to enable effective collaboration with third-party assessment vendors and SAP SuccessFactors.
  • SFAPI Retrieve Assessment Order Permission
  • SFAPI Update Assessment Report Permission
  • Ensure recruiting users are granted the Manage Assessment Vendors permission.
  • In Provisioning > Company Settings, enable the following options:
    • Enable Assessment Integration
    • SFAPI
    • Enable SFAPI Web Services
  • Grant the following permissions to the SFAPI integration user:
    • Access to Event Notification Subscription
    • Retrieve Assessment Order
    • Update Assessment Report
  • Enable Assessment Integration (which requires Candidate Workbench) from the Provisioning Account.

Provider Side Setup

Add the integration user to the SAP SuccessFactors API login exceptions list

Navigate to Admin Tools > Password & Login Policy Settings > Set API Login Exceptions, then Add the following information:
  • Username: Select the SFAPI integration user.
  • Maximum Password Age (days): Set to -1.
  • IP Address Restrictions: Specify the designated IP addresses or address range for the integration.

Add your vendor and upload the assessment vendor packages

1

Add a Vendor for Assessment

Go to Manage Assessment Vendors, Click Export to download the CSV file. Add your vendor with a unique clientId and mark it as active by entering Y in the active column.
Add a Vendor
Select an updated file to import the Assessment Vendor List into SAP SuccessFactors.
Upload a file of vendor
2

Upload the assessment vendor packages

You may not have access to the Provisioning Account. If this is the case, please contact your SAP SuccessFactors customer. Provide them with the CSV file of the assessment vendor package and ask them to upload it, or ask them to follow the instructions below to upload the file.
Assessment vendor packages will be uploaded from Provisioning Account > Managing Recruiting > Import/Export Assessment Vendor Packages. Prepare a CSV file with the required columns and values, as illustrated in the image.
  • vendorId: Identifies the assessment vendor (must be the same as the clientId).
  • packageCode: Identifies an assessment package for the order.
  • shortName: A shortened name for the package, for use on the candidate summary page.
  • Label: The language in which the assessment is displayed.
Import/Export Assessment Vendor Packages
Choose the file to import the assessment vendor packages list into SAP SuccessFactors.

Create a subscriber and set up an external event

1

Create a subscriber

Go to the Event Notification Subscription page. Under the Subscriber tab, add a subscriber using your Subscriber Id and Client Id. Note that your clientId must match the one uploaded with your vendor’s name in the previous step.
Create a Subscriber
2

Set up an external event to receive notifications

Navigate to the External Event tab and click + Add New to add a new external event.
Add New external event
Select the values for the specified fields:
  • Event Type: Select rcm_assessment_alert_v2.
  • Subscriber: Select the subscriber you created in the previous step.
  • Protocol: Select SOAP_OVER_HTTP_HTTPS.
  • Endpoint URL: Enter the endpoint URL, including the externalTriggerToken query parameter, which will be used to receive assessment order requests.
https://api.stackone.com/external-trigger/sapsuccessfactors_ats?externalTriggerToken=<external-trigger-token>
The endpoint URL must include the query parameter externalTriggerToken, which you will receive from the StackOne Connection Hub. This token verifies requests from SAP SuccessFactors for that specific vendor.
To obtain the External Trigger Token, please follow these steps:
  • Authentication: Select NO.
Setup external event
Click Save to save the configuration for the external event.

Manage fields for the Job Requisition template

1

Go to Manage Templates

Navigate to Admin Center and search for Manage Templates.
Navigate to Job Requisition template
Navigate to the Recruiting Management tab, select Job Requisition, and choose the template in use for the specific job requisition, such as Standard Job Requisition.
Go to Recruiting and select any specific job requisition.
Specific Job Requistion
Click on the i icon to view the Job Requisition Template.
JR Info
Standard Job Requisition
2

Add assessment field in template

Add the following field, which will be visible within the Job Requisition and allow users to select an assessment.
  • assessment: This field enables the user to select a specific assessment to associate with the job requisition.
This approach should only be used if you have permission to upload the Job Requisition template via an XML file; otherwise, you can add the fields manually and click Publish.
  <field-definition id="assessment" type="derived" required="true" custom="false">
    <field-label><![CDATA[Assessment assocication]]></field-label>
    <field-description><![CDATA\[Assessmentasso]]></field-description>
  </field-definition>
  <field-permission type="write">
    <description><![CDATA[job code permissions]]></description>
    <role-name><![CDATA[R]]></role-name>
    <status><![CDATA[pre-approved]]></status>
    <field refid="assessment"/>
  </field-permission>
Add a field from JR field template

Manage the permissions for the assessment feature

1

Go to Manage Templates

To add or update feature permissions, navigate to the specific Job Requisition Template > Application Status Configuration, select Feature Permissions Defined, and then click Add Feature Permission.
  • Feature Permission Description: Enter a relevant description.
  • Feature Permission Type: Select assessmentIntegration.
  • Feature Permission Role Name: Select All.
  • Feature Permission Status: Select the talent pipeline stage at which you want to initiate the assessment.
You can add multiple feature permissions for assessmentIntegration for a specific talent pipeline stage.
This approach should only be used if you have permission to upload the Job Requisition template via an XML file; otherwise, you can add the permissions manually and click Publish.
  <feature-permission type="assessmentIntegration">
    <description><\!\[CDATA\[Operators with below roles can see Assessment detail report for the applicant when the application is in Scheduled Status\]\]></description>
    <role-name><\!\[CDATA\[S\]\]></role-name>
    <role-name><\!\[CDATA\[T\]\]></role-name>
    <role-name><\!\[CDATA\[O\]\]></role-name>
    <role-name><\!\[CDATA\[R\]\]></role-name>
    <role-name><\!\[CDATA\[G\]\]></role-name>
    <status><\!\[CDATA\[Scheduled\]\]></status>  // You can choose any stage from the options provided; for this document, we have selected "Scheduled."
  </feature-permission>
  <feature-permission type="assessmentIntegration">
    <description><\!\[CDATA\[Operators with below roles can see Assessment detail report for the applicant when the application is in New Application Status \]\]></description>
    <role-name><\!\[CDATA\[S\]\]></role-name>
    <role-name><\!\[CDATA\[T\]\]></role-name>
    <role-name><\!\[CDATA\[O\]\]></role-name>
    <role-name><\!\[CDATA\[R\]\]></role-name>
    <role-name><\!\[CDATA\[G\]\]></role-name>
    <status><\!\[CDATA\[Default\]\]></status>
  </feature-permission>
After adding the feature permissions, click Publish to save your changes.
Add feature permission from the JR template
When an assessment is configured in Default or New Applicant, it is triggered when the candidate applies for the job. Immediately after applying and passing any prescreening questions, the candidate will be redirected to an assessment vendor site. After completing the assessment, the candidate is redirected back to the career site.

Assessment fields under Job Requisition

1

Go to Job Requisition

Access the specific Job Requisition that uses the template where you configured the Assessment in the previous steps. Hover over the job requisition title to open the Actions menu, then select View or Edit Requisition.
Go to Actions menu
To add an Assessment association row, click the Add More Assessments link and select the details below.
add a row of fields
The following fields will be visible on the job requisition:
  • Status: Select the stage where you have set up the assessment integration feature, as described in the previous step.
  • Vendor: Select the vendor, for example, STACK_ASSESSMENT_TEST.
  • Assessment: Select the specific assessment package to be sent to the candidate.
  • Email Template: Select the email template to be sent to the candidate once the assessment is triggered.
Navigate to Admin Center and search for OData API Metadata Refresh and Export.
OData API Metadata Refresh and Export
Click the Refresh button next to Cache.
Refresh button

StackOne Configuration

1

Enable SAP SuccessFactors in StackOne

Go to the ATS category on the Integrations page and enable SAP SuccessFactors.
Activate SAP SuccessFactors
2

Complete the configuration form

Fill out the required fields in the SAP SuccessFactors - Configuration modal:
  • Authentication Type - Select Client Application.
  • Integration Category - Select Assessments.
Activate SAP SuccessFactors
Click Confirm or Save Changes to enable the SAP SuccessFactors integration, allowing end-users to link their accounts via the StackOne Connector Hub.
3

Add a Webhook

Navigate to the Webhooks page, click Add webhook, and complete the form:
  • Name: Enter a recognisable name for your webhook.
  • URL: Enter the URL where the webhook will send notifications of enable events.
Add Webhook form
Enable the webhook event from the Events tab for Assessment, such as Assessment Order.
Select webhook events

ATS User Enablement

Users can obtain an External Trigger Token if they wish to use a different token from another StackOne project. Users can then update the externalTriggerToken in the query parameter of the endpoint URL. Please refer to these steps.
Navigate to the Accounts page or the StackOne Connector Hub to link your SAP SuccessFactors account with StackOne.
Link SAP SuccessFactors account
You will receive the External Trigger Token, which must be passed as a query parameter with the endpoint URL when setting up the external event in SAP SuccessFactors, as outlined in the previous steps.
External Trigger Token

ATS User Experience

1

Go to Job Requisition

Navigate to the relevant Job Requisition, hover over the requisition title to open the Actions menu, and then select View or Edit Requisition.
Go to Actions menu
Users will see the option to add an Assessment association row. By clicking Add More Assessments, users can select the details.
add a row of fields
The following fields will be visible to users on the job requisition to associate an assessment with it:
  • Status: Select the stage where you have set up the assessment integration feature, as described in the previous step.
  • Vendor: Select the vendor, for example, STACK_ASSESSMENT_TEST.
  • Assessment: Select the specific assessment package to be sent to the candidate.
  • Email Template: Select the email template to be sent to the candidate once the assessment is triggered.
Navigate to Admin Center and search for OData API Metadata Refresh and Export.
OData API Metadata Refresh and Export
Click the Refresh button next to Cache.
Refresh button
2

Visibility of the Initiate Assessment option

If you see the message below in the candidate’s application, the assessment will not be sent.
⚠️ Non Applicant
This candidate has been forwarded to this job by [recruiter] and added to this job but has not yet applied for it.
The assessment will only be sent to the candidate when they apply for the job.
The assessment will be sent to the candidate automatically when they are moved to the assessment-configured stage in the talent pipeline. The Initiate Assessment option under the Take Actions menu will only be visible if the assessment fails to send, allowing it to be re-initiated.
Take Actions menu
The Initiate Assessment option will not be visible if the assessment is sent successfully.

Send the test to the candidate from SAP SuccessFactors

Test your integration with StackOne using your SAP SuccessFactors Sandbox

Follow the SAP SuccessFactors Assessment guide for instructions on how to send the test from SAP SuccessFactors.

User experience after the assessment has been sent

When an assessment is sent to the candidate, the user will see the Initiated status along with the Assessments portlet in the candidate’s application.
Job Requisition Fields

ATS User Experience Customisation

1

Update the result via Unified API

Utilise the following endpoints to update the results:Utilise the following endpoint to get metadata to update the result of the assessment:

Users see the updated results with different conditions of the assessment in SAP SuccessFactors

When the result is completed with all details
completed with all details
When the result is completed without other details
completed without score
When the result does not include a Result URL
completed without result url

Testing Checklist

Provider Setup:
  • You have all the necessary permissions mentioned in the Partner Requirements section.
  • A vendor for Assessment with a unique clientId has been added with an active Y status.
  • The vendor’s assessment packages have been uploaded with a valid vendorId.
  • A subscriber has been created with a unique Subscriber Id and a valid Client Id (same as vendorId).
  • An external event has been created with the correct and valid endpoint URL, including a valid externaltriggerToken in the query parameter.
  • The assessment field has been added to the Job Requisition template with the necessary permissions.
  • The feature permission for assessmentIntegration has been granted to the job requisition template.
  • The Add More Assessments link and Assessment fields are visible to users during the creation/editing of the Job Requisition, as mentioned in this step.
  • The Initiate Assessment option is visible to users under the Take Actions menu within the candidate’s application, as mentioned in this step.
StackOne Configuration:
  • The integration category Assessments is selected.
ATS User Activation:
  • A valid externalTriggerToken is provided in the query parameter along with the endpoint URL.
Create a Webhook:
  • A webhook for SAP SuccessFactors has been added and enabled with the Assessment Order event.
  • A valid webhook URL has been added to receive assessment notifications.
ATS User Experience:
  • The Assessment stage is visible in the talent pipeline for the job requisition.
  • The Add More Assessments link and Assessment fields are visible to users during the creation/editing of the Job Requisition, as mentioned in this step.
  • The Initiate Assessment option is visible to users under the Take Actions menu within the candidate’s application, as mentioned in this step.
  • After sending the assessment to a candidate, the user can see the Initiated status along with the Assessment portlet in the candidate’s application.
Update Result:
  • A success response is received from the update result endpoint.
  • The updated result details are visible in the SAP SuccessFactors UI.

Troubleshooting

SymptomLikely CauseFix
Unable to access some of the navigations necessary for configuration. Insufficient permissions.

The logged-in account is not an Admin account.
Ensure the account has the necessary permissions.

Log in with an Admin account.
The Add More Assessments link and Assessment fields are not visible when creating/editing the Job Requisition. Fields are not configured in the Job Requisition template.

Fields do not have the necessary permissions in the Job Requisition template.

The OData API cache has not been refreshed after adding fields and permissions.
Add the assessment field and its permissions in the Job Requisition template.
Please refer to the following sections:
- Manage fields for the Job Requisition template.
- Manage permissions for the assessment feature.
- Refresh the OData API cache.
Packages are not available to select from the Assessment field when creating/editing the Job Requisition. The assessment vendor package list has not been uploaded.

Invalid clientId or vendorId.
Upload the assessment vendor packages list from the Provisioning Account.

Ensure the clientId and vendorId are valid.
The Initiate Assessment option is not visible under the Take Actions menu within the candidate’s application. The user does not have the necessary permissions to initiate assessments. Add the Assessment feature permission to the Job Requisition template. Please refer to this section.
Error when sending the assessment.

Test notification not received.
Invalid Endpoint URL or other configurations under External Event.

Invalid External Trigger Token.
Verify the Endpoint URL with all other valid configurations, as mentioned here.

The External Trigger Token must be valid.
Unable to update the result.Invalid payload format.Check the Connector Meta Information endpoint for the correct payload format.
The result URL shows an error when opened.The result URL may have expired or is private.Ensure you add public or signed URLs; verify CORS and expiry.
For persistent issues, contact StackOne support with detailed error logs and configuration information.
I