diff --git a/integration-configuration-concepts/ats/sapsuccessfactors-background-check.mdx b/integration-configuration-concepts/ats/sapsuccessfactors-background-check.mdx index b621c26f..1de48445 100644 --- a/integration-configuration-concepts/ats/sapsuccessfactors-background-check.mdx +++ b/integration-configuration-concepts/ats/sapsuccessfactors-background-check.mdx @@ -5,435 +5,8 @@ description: "To successfully send webhook notifications from SAP SuccessFactors import IntegrationFooter from "/snippets/integration-footer.mdx"; - - This guidance assumes that you have administrative privileges for your SAP SuccessFactors account. - -## Enable the Other Background Check Vendor option - - - - Go to the _Admin Center_ and search for _Background Check Central_ - - Search for BC Central - - - Enable Background Check in Recruiting and Choose `Other Background Check Vendor` - - Enable Background Check in Recruiting - - - - -## Select the type of integration template for the external background check - - - Recruiters do not need the mandatory permissions to initiate background checks using the Integration Center. However, to use the Integration Center for modeling and executing the integration, you do need the following mandatory permissions: - - - **Admin access to MDF OData API** - - **Access to Integration Center** - - **Access to non-Secured Objects** - - - - - Navigate to _Admin Center_ and search for _Integration Center_ - - Go to Integration Center - - - To view the list of available integrations, click on `My Integrations`. - - My Integrations - - - - - Click the `+ Create` button and select _More Integration Types_ to access the list of available integration types. - - Select More Integration Types - - - Select the following values from the modal - - **Application/UI**, for **Trigger Type** - - **SuccessFactors**, for **Source Type** - - **REST**, for **Destination Type** - - **JSON**, for **Format** - - Click on the `Create` button - - Select correct values from the Modal - - - Use the search box to find the entity called `JobApplicationBackgroundCheckRequest`, and then select it from the search results. - - Search for JobApplicationBackgroundCheckRequest - - - - -## Create and configure an integration template for background checks - - - - Enter the name of the integration, then click the `Next` button to proceed with further configuration steps. You can also click the `Save` button to save the current step's configuration. - - Select More Integration Types - - - - - Click on the `+` button > _Insert Sibling Element_, then click on the inserted element to open a prompt where you can enter the name of the element. - - Please refer the mapping listed here. - - - Select option to map fields - - - Click the `+` button > _Add Child Element_ for the added element and then click on the inserted element to open a prompt where you can enter the name of the child element. - - Select option to map child fields - - - To set the association for added element. Click on the `Set as Associated Field` icon. - - Open Modal to select association - - - Choose the specific fields to map that can be found in the _Entity Tree View_. - - Open Modal to select association - - - Select the field and Click on the `Change Association` button. - - Click on the change association - - - You will notice that the Association has been updated for the data field. - - Updated data field association - - - Map the properties of the data fields to their corresponding properties in the OData API. - - - | Expected properties of data fields | To | Corresponding properties in the OData API entity | - | ------------------------------------------------- | ---- | ------------------------------------------------------------------ | - | backgroundCheckInfo/requestId | -> | requestId | - | backgroundCheckInfo/bgiAccountId | -> | jobApplication/jobRequisition/bgiAccountId/id | - | backgroundCheckInfo/packageId | -> | jobApplication/jobRequisition/packageId/id | - | backgroundCheckInfo/packageExternalCode | -> | jobApplication/jobRequisition/packageId/externalCode | - | backgroundCheckInfo/packageLocaleLabel | -> | jobApplication/jobRequisition/packageId/localeLabel | - | createdByUserInfo/userId | -> | createdByUserNav/userId | - | createdByUserInfo/firstName | -> | createdByUserNav/firstName | - | createdByUserInfo/lastName | -> | createdByUserNav/lastName | - | createdByUserInfo/email | -> | createdByUserNav/email | - | createdByUserInfo/jobRole | -> | createdByUserNav/jobRole | - | createdDateTime | -> | createdDateTime | - | lastModifiedDateTime | -> | lastModifiedDateTime | - | orderStatus | -> | orderStatus | - | responseCode | -> | responseCode | - | responseDetail | -> | responseDetail | - | vendorCode | -> | vendorCode | - | vendorOrderNo | -> | vendorOrderNo | - | applicationInfo/applicationId | -> | jobApplication/applicationId | - | applicationInfo/appStatusName | -> | jobApplication/jobAppStatus/appStatusName | - | jobRequisitionInfo/jobReqId | -> | jobApplication/jobReqId | - | jobRequisitionInfo/externalTitle | -> | jobApplication/jobRequisition/jobReqLocale/externalTitle | - | jobRequisitionInfo/hiringManager/usersSysId | -> | jobApplication/jobRequisition/hiringManager/usersSysId | - | jobRequisitionInfo/hiringManager/firstName | -> | jobApplication/jobRequisition/hiringManager/userNav/firstName | - | jobRequisitionInfo/hiringManager/lastName | -> | jobApplication/jobRequisition/hiringManager/userNav/lastName | - | jobRequisitionInfo/hiringManager/email | -> | jobApplication/jobRequisition/hiringManager/userNav/email | - | jobRequisitionInfo/hiringManager/operatorRole | -> | jobApplication/jobRequisition/hiringManager/operatorRole | - | jobRequisitionInfo/hiringManagerTeam/usersSysId | -> | jobApplication/jobRequisition/hiringManagerTeam/usersSysId | - | jobRequisitionInfo/hiringManagerTeam/firstName | -> | jobApplication/jobRequisition/hiringManagerTeam/userNav/firstName | - | jobRequisitionInfo/hiringManagerTeam/lastName | -> | jobApplication/jobRequisition/hiringManagerTeam/userNav/lastName | - | jobRequisitionInfo/hiringManagerTeam/email | -> | jobApplication/jobRequisition/hiringManagerTeam/userNav/email | - | jobRequisitionInfo/hiringManagerTeam/operatorRole | -> | jobApplication/jobRequisition/hiringManagerTeam/operatorRole | - | candidateInfo/candidateId | -> | jobApplication/candidate/candidateId | - | candidateInfo/firstName | -> | jobApplication/candidate/firstName | - | candidateInfo/lastName | -> | jobApplication/candidate/lastName | - | candidateInfo/primaryEmail | -> | jobApplication/candidate/primaryEmail | - | candidateInfo/contactEmail | -> | jobApplication/candidate/contactEmail | - - - - - After mapping will look like - - - - - Click on the `Switch to Field Mapping View` option, - - Change the mapping view - - - Click on the `+` button and select the `JobApplicationBackgroundCheckRequest` entity. Then click `Add` and proceed by clicking the `Next` button. - - After adding will look like this response mapping - - - - - You do not need to set anything on the Filter and Sort step. Simply click the `Next` button. - - Change the mapping view - - - - - Select the option for `REST Server Settings` and input the following details: - - **Connection Name:** You can choose any name you prefer. - - **REST API URL:** This is the endpoint URL provided by StackOne, which will be used to receive background check order requests. - - **Authentication Type:** Select `Basic Authentication` from the dropdown menu. - - **Username:** Enter the `External Trigger Token` that you receive from the `StackOne Integration Hub` during the connection setup. - - **Password:** This field can be left empty. - - **HTTP Method:** Choose the `POST` method under REST Operation Settings. - - Click on the `Next` button to proceed. - - Change the mapping view - - - - - Review the template structure in the _Review and Run_ step. To save it, select the `Save` option. After creation, the template will run in the background, eliminating the need to click `Run Now`. - - Review and Run - - - - You can access the logs by clicking on the `Last Run Time` link. - - You can confirm the integration by returning to _Integration Center_ > _My Integrations_. - - - -## Create Vendor from Recruiting External Vendor - - - - Navigate to _Manage Data_ and select `Recruiting External Vendor` from _Create New_ dropdown - - Recruiting External Vendor - - - Enter the External Code, Vendor Name, and select `Background Check` as the Integration Type from the dropdown menu. Click on `Save` to create the vendor. - - `External Code` refers to a text string that serves as a code for the background check vendor. The OData API entities use this value to facilitate communication between the third-party vendor and SAP SuccessFactors. If this information is not entered correctly, certain integration scenarios may fail to function properly. - - - - Enter all required details of Recruiting External Vendor - - - - -## Create Recruiting Vendor Integration Mapping - - - - Navigate to _Manage Data_ and select `Recruiting Vendor Integration Mapping` from _Create New_ dropdown - - Recruiting Vendor Integration Mapping - - - Enter the External Code, select your Vendor Name, choose your Integration Name from the dropdown, and set the Default integration value to `Yes`. - - Enter a numeric value in the _Hours Before User Can Reinitiate_ field. This field currently has no functionality in SAP SF. - - Enter all required details of Recruiting Vendor Integration Mapping - - - Click `Save` to save the mapping between the vendor and integration. - - Only one `Recruiting Vendor Integration Mapping` can be active at a time. To set the selected vendor integration as active for the instance, select `Yes` in the **Default Integration** field. - - - - -## Manage fields for the Job Requisition template - - - - 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 that is in use for the specific job requisition, such as `Standard Job Requisition`. - - Go to the _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 - - - - - Please add the following fields that you will receive in the order request: - - - **bgiAccountId:** You can create multiple accounts with a single third-party background check vendor. This field enables recruiters to select which account to use. - - **packageId:** Recruiters can choose the package they want to apply to a specific job requisition. - - - - This approach will only be used if you have permission to upload the Job Requisition template via an XML file; otherwise, you can manually add the fields and click the `Publish` button. - - - ```XML - - - - accountId - - - - - - packageId - - ``` - - - - Add two fields from JR field template - - - In the next step, Update the permissions to ensure the fields are visible during Job Requisition creation or updates. - - - -## Manage the permissions for the fields added to the Job Requisition template - - - - To add or update field permissions, navigate to the specific Job Requisition Template, select `Field Permissions Defined`, and then click on `Add Field Permission` from the modal. - - - **Field Permission description:** Enter any description - - **Field Permission Type:** Select `Write Permission` - - **Field Permission Role Name:** Select `Recruiter` - - **Field Reference ID:** Select `bgiAccountId` & `packageId` fields - - **Field Permission Status:** Select `All` or `pre-approved` from dropdown - - After adding the fields, Click on the `Publish` to save your changes. - - Add field permissions from the JR template - - - After successfully updating the permissions, the fields will be visible in the Job Requisition during create/edit. - - - -## To add background check accounts from the PickList Center. - - - - Go to _Admin Center_ and search for `PickList Center` - - Navigate to PickList Center - - - Search for `bgiAccountId` - - Search for bgiAccountId - - - - - Click on `bgiAccountId`. This will direct you to the Picklist Values page where you can add different `Background Check Accounts`. - - Add new accounts for background check - - - - You can create multiple accounts with a single third-party background check vendor. All accounts added in this picklist will be available for recruiters to choose as the Background Check Account under the Job Requisition details. - - - - -## To add background check packages from PickList Center - - - - Go to _Admin Center_ and search for `PickList Center` - - naviaget to Picklist center - - - Search for `packageId` - - Search for packageId - - - - - Click on `packageId` to go to the Picklist Values page, where you can add different `Background Check Packages`. - - Add new Packages - - - - All packages added in this picklist will be available for recruiters to choose as the Background Check Package to apply on the Job Requisitions. - - - - - -## To include a Background Check stage in the Talent Pipeline - - - You can skip this step if you already have a separate `Background Check` stage in the talent pipeline for the Job Requisition. - - - - - Go to _Admin Center_ and search for `Edit Applicant Status Configuration`.Select the specific Applicant Status Set currently in use for the job requisition, such as the `Standard Status Set`. - - Navigate to Applicant Status Configuration - - - It will take you to the page for the `Standard Status Set`, - - Direct to status set page - - - - - Find `Background Check` stage, edit and select `none` from the `Status Group` dropdown. This will make the Background Check visible as a separate stage in the Job Requisition's Talent Pipeline. - - Edit Applicant Status Set configurations - - - Click the `Save and Finish` button to save your changes. - - Save and finish - - - - - Navigate to the _Job Requisiton_ > _Candidates_. Above, you will see the updated talent pipeline, - - Where can you verify the added stage - - - You can now proceed to move the candidates to the Background Check stage. - - - -## Edit Job Requisition to Select Background Check +## Associate background check to the Job Requisition @@ -443,29 +16,14 @@ import IntegrationFooter from "/snippets/integration-footer.mdx"; Select the correct values for the _Account ID_ and _Package ID_ fields. Click on the `Save Changes` button. - - Navigate to _Admin Center_ and search for `OData API Metadata Refresh and Export` - - OData API Metadata Refresh and Export - - - Click on the `Refresh` button next to Cache. - - Refresh button - - - Both fields are visible -## To Send Background Check to the Candidate - - If you are not seeing the `Background Check` as a separate step in the current Job Requisition, please visit this step. - +## To Send the background check to the Candidate @@ -482,59 +40,26 @@ import IntegrationFooter from "/snippets/integration-footer.mdx"; Navigate to _Background Check_, click on the `Initiate Background Check` option in the Take Action menu. - - - - - - Users involved in recruiting must have the necessary permissions to initiate background checks. - - Go to the specific _Job Requisition Template_ > _Template Settings_ > _Application Status Configuration_ and Add the feature permission block for background check to the job requisition template. - - - Apply Updates - - - Or you can add permissions via Job Requisition template XML file. - ```XML - - <\!\[CDATA[R can launch BackGround Check during statuses with screening category.]\]> - <\!\[CDATA[T]\]> - <\!\[CDATA[O]\]> - <\!\[CDATA[R]\]> - <\!\[CDATA[S]\]> - <\!\[CDATA[Background Check]\]> - - ``` - - - - Assign `Background Check Initiate Permission` and Allow users to execute "Application/UI" or "Event-based" Integrations role-based permissions from Admin Center. - - - - - Initiate Background Check Click on the `Confirm` to send the Background Check. You'll get the success on the same modal. - - The Background Check request will appear in the candidate's application under the Background Check portlet. + The initiated background check request will appear in the candidate's application under the Background Check portlet. Background Check Request portlet + ## To Check Result of the Background Check - Go to the `Background Check` stage, The results will be available in the Background Check portlet within the candidate application. + Go to the `Background Check` stage, The results will be available in the Background Check portlet within the candidate's application. Check Result of the Background Check @@ -543,6 +68,7 @@ import IntegrationFooter from "/snippets/integration-footer.mdx"; + ## Useful Links https://api.sap.com/products/SAPSuccessFactors/apis/all