Integrate SAP SuccessFactors 编辑

Integrate with SAP SuccessFactors for anywhere access to employee, skills, and course information.

Note:

We provide two SuccessFactors integration templates for your use. We recommend using the newer SuccessFactors EC HTTP integration for SAP SuccessFactors Employee Central use-cases. The HTTP integration provides more power to configure the cached data structure.

For a comprehensive list of out-of-the-box SuccessFactors microapps, see Use SuccessFactors microapps.

Review prerequisites

After you set up this integration in SAP SuccessFactors, you will need these artifacts to add the integration in Citrix Workspace Microapps based on the type of integration you need to enable. After you complete this process, your existing level of audit logging persists, including any actions carried out by the use of Citrix Microapps.

• The required configuration information to connect with SAP SuccessFactors depends on whether you use the Learning module.
• Create an Admin user in the Provisioning instance. Typically a SuccessFactors Certified Consultant performs all activities in Provisioning. Give the user a distinguishable name.
• Configure Citrix Gateway to support single sign-on for SuccessFactors so that once users log in they are automatically logged in again without having to enter their credentials a second time. For more information about configuring SSO, see Citrix Gateway Service.

Note:

Rate limits apply for SuccessFactors integrations to the number of requests per minute. This can impact testing instances. To avoid issues, set rate limits to 8 calls per second. For more information, consult your SuccessFactors consultant to find out the correct maximum request rate value.

For the SuccessFactors EC integration:

• Base URL: Your base URL follows this model: https://{tenant}.successfactors.{region}/odata/v2
• Username: Your unique user ID.
• Client ID: The client ID is the string representing client registration information unique to the authorization server. See Collect your Company ID and Client ID.
• Company ID: The company ID is a short string of characters that identifies each SAP SuccessFactors system, like a username for your organization. See Collect your Company ID and Client ID.
• Private Key: This is the API key from registering the OAuth2 Client. See Register the OAuth2 Client.
• OAuth URL: This is the Application URL generated in the template, and follows this model: https://{tenant}.successfactors.{region}/oauth. You need this to Register the OAuth2 Client.

For the SuccessFactors HCM integration:

• API URL
• Company ID
• User ID (Username)
• Client ID (API Key)
• Client Private Key (Encrypted Private Key)

For the SuccessFactors Learning integration:

• Learning URL
• Learning Company ID
• Learning User ID
• Learning Client ID
• Learning Client Secret

Set up SuccessFactors HCM integration

Follow this process if you need to set up the basic SuccessFactors HCM integration or the basic integration with Learning Module. Using your admin user, you create a permission role, create a permission group, and assign the permission group to the permission role.

Create a permission role

To create a permission role, follow these steps:

1. Log in to SAP SuccessFactors Admin Center with your Admin user.
2. Search for and select Manage Permission Roles, and select Create New.
3. Enter a meaningful Role Name and select Permission….
4. Scroll to Manage Integration Tools, click Select All, and select Done.
5. Select Save Changes.

Create a permission group

To create a permission group, follow these steps:

1. In the SAP SuccessFactors Admin Center, search for and select Manage Permission Groups, and select Create New.
2. Enter a meaningful Group Name.
3. Under Choose Group Members: People Pool, select category Username.
4. Enter the username of the dedicated user, select the check box next to the name, and select Done.
5. Select Done again.

Assign the new permission group to the permission role

To assign the new permission group to the permission role, follow these steps:

1. In the SAP SuccessFactors Admin Center, search for and select Manage Permission Roles, and select the previously created permission role.
2. Scroll down to Grant this role to… and select Add….
3. Under Grant this role to: Permission Group…, click Select….
4. Search for the previously created group, select the check box next to the name, and select Done.

5. Select Done again, and select Save Changes.

   You assigned the user permission group to the permission role.

Register the OAuth2 Client

To register the OAuth2 Client, follow these steps:

1. In the SAP SuccessFactors Admin Center, search for and select Manage OAuth2 Client Applications, and select Register Client Application.

2. Enter the following details:

   Application Name

   Application URL

3. Select Generate X.509 Certificate.
4. Enter a Common Name (CN), and select Generate.
5. Select Download to download a copy of the X.509 Certificate. The Client Private Key is located within the certificate file as Encrypted Private Key. Copy and save this key. You use these details when configuring the integration.

6. Select Register.

   The new application is listed on the Manage Oauth2 Client Applications page.

7. Under Actions, select View.
8. Copy the API Key and store it for later use.

Set up SuccessFactors Learning integration

Follow this process if you need to set up the basic SuccessFactors integration with Learning Module or just the Learning module. Using your admin user, you collect the Company ID and Client ID, and generate a new Client Secret.

Collect your Company ID and Client ID

To collect your company ID and client ID, follow these steps:

1. Log in to SAP SuccessFactors Learning administration environment for your tenant.
2. Navigate to System Admin > Configuration > OAuth Token Server.
3. On the Application Administration screen, copy the Company ID and Client ID and store it for later use.

Generate a new client secret

To generate a new client secret, follow these steps:

1. On the Application Administration screen, select Generate a new Client Secret and confirm by selecting OK.

   The Newly Generated Client Secret populates below the Client ID.

2. Copy the client secret and store it for later use.

   The secret is not stored. When you leave the OAuth Token Server page, the secret disappears.

Add callback URLs

Add a custom URL to your instance configuration to grant access to private data and enable OAuth authenticated user actions. The first callback that is listed does not change. The second callback depends on the target application, and can be found in your URL address bar when creating the integration. The section {yourmicroappserverurl} is composed of a tenant part, a region part, and an environment part: https://{tenantID}.{region(us/eu/ap-s)}.iws.cloud.com.

Log in to SuccessFactors as an admin and add the following authorized redirect URLs for this integration:

• https://{yourmicroappserverurl}/admin/api/external-services/com.sapho.services.successfactors.SuccessFactorsService/auth/serverContext
• https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback

Add the SuccessFactors EC integration

Follow these steps to set up the SuccessFactors EC integration. The authentication options are preselected. Ensure that these options are selected as you complete the process. We recommend using this newer HTTP integration for most use-cases. The HTTP integration provides more power to configure the cached data structure.

Follow these steps:

1. From the Microapp Integrations page, select Add New Integration, and Add a new integration from Citrix-provided templates.
2. Choose the SuccessFactors EC tile under Integrations.
3. Enter an Integration name for the integration.
4. Enter Connector parameters.
   • Enter the instance Base URL: https://{tenant}.successfactors.{region}/odata/v2
   • Select an Icon for the integration from the Icon Library, or leave this as the default icon.

5. Under Service authentication, select OAuth 2.0 from the Authentication method menu and complete the authentication details. The authentication options are preselected. Ensure that these options are selected as you complete the process. Use the OAuth 2.0 security protocol to generate request/authorization tokens for delegated access. It is recommended that you always use OAuth 2.0 as your service authentication method where available. OAuth 2.0 ensures that your integration meets the maximum security compliance with your configured microapp.

   1. Select SAML 2.0 Success Factors from the Grant type flow menu.
   2. Leave Scope empty.
   3. Enter your Username.
   4. Enter your Client ID. The client ID is the string representing client registration information unique to the authorization server. See Collect your Company ID and Client ID.
   5. Enter your Company ID. The company ID is a short string of characters that identifies each SAP SuccessFactors system, like a username for your organization. See Collect your Company ID and Client ID.
   6. Enter your Private Key. This is the API key from registering the OAuth2 Client. See Register the OAuth2 Client.
   7. Your OAuth URL is automatically generated. This is the Application URL generated in the template, and follows this model: https://{tenant}.successfactors.{region}/oauth. You need this to Register the OAuth2 Client.
6. Leave Service Action Authentication disabled.
7. The Enable request rate limiting toggle is enabled. Leave 1 for Number of requests and 1 second for Time interval. 1.. Request timeout is set to 120 by default.
8. (Optional) Enable Logging toggle to keep 24 hours of logging for support purposes.
9. Select Save to proceed.

You are now ready to set and run your first data synchronization. For complete information about synchronization rules, synchronization that does not meet its schedule and veto rules, see Synchronize data.

Use SuccessFactors EC microapps

Existing application integrations come with out-of-the-box microapps. Start with these microapps and customize them for your needs. Our SuccessFactors ECintegration comes with the following preconfigured out-of-the-box microapps:

Directory: Search for employees and preview their details including skill set.

Skills: Search for skills and preview employees with corresponding skill set.

Add the SuccessFactors integration to Citrix Workspace Microapps

Add the SuccessFactors integration to Citrix Workspace Microapps to connect to your application. This delivers out-of-the-box microapps with pre-configured notifications and actions which are ready to use within your Workspace.

Use the following process to enable the SuccessFactors Integration. Ensure you meet the prerequisites, and decide which integration you need to set up:

• the basic SuccessFactors HCM integration,
• the basic integration with Learning Module,
• just the Learning module.

Follow these steps:

1. From the overview page, select Get Started.

   The Manage Integrations page opens.

2. Select Add New Integration, and Add a new integration from Citrix-provided templates.
3. Choose the SuccessFactors tile.

4. Enter a name for the integration.

   

5. Enter the Connector parameters that you collected as prerequisites.
   • Select Yes/No from the Are you using the Employee central module?
     • Enter the API URL. For example, https://api12preview.sapsf.eu/odata/v2v.
     • Enter the Company ID.
     • Enter the User ID.
     • Enter the Client ID.
     • Enter the Client Private Key.
   • Select Yes/No from the Are you using the Learning module?
     • Enter the Learning URL.
     • Enter the Learning Company ID.
     • Enter the Learning User ID.
     • Enter the Learning Client ID.
     • Enter the Learning Client Secret.
6. Select Add.

The Microapp Integrations page opens with your added integration and its microapps. From here you can add another integration, continue setting up your out-of-the-box microapps, or create a new microapp for this integration.

You are now ready to set and run your first data synchronization. As a large quantity of data can be pulled from your integrated application to the Microapps platform, we recommend you use the Table page to filter entities for your first data synchronization to speed up synchronization. For more information, see Verify needed entities. For complete information about synchronization rules, synchronization that does not meet its schedule and veto rules, see Synchronize data.

For more details of API endpoints and table entities, see SuccessFactors connector specifications.

Use SuccessFactors microapps

Existing application integrations come with out-of-the-box microapps. Start with these microapps and customize them for your needs.

Our SuccessFactors integration comes with the following preconfigured out-of-the-box microapps:

Directory: Search, view, and edit employees with corresponding details.

Learning: Search, view, share, and register available learning courses.