Integrate SuccessFactors

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

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.

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

Review prerequisites

After you set up this integration in 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 a SuccessFactors HCM integration:

  • API URL
  • Company ID
  • User ID
  • Client ID
  • Client Private Key

For a 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, and store it for later use.
  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. 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 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.

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.

    SuccessFactors connector parameters, Existing Employee module, Learning module, API URL, Company ID, User ID, Client ID, Client Private Key, and all the same for Learning module

  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.
      • 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 and Set data synchronization in the Configure the integration article.

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.

SuccessFactors Microapps

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

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

Notification or Page Use-case workflows
New Teammate notification When a new teammate joins, all subscribers receive a notification highlighting the new teammate and their position.
Position Changed notification When the title of an employee changes, all subscribers receive a notification highlighting the teammate and their new position.
My Detail page Provides a form for viewing personal details and provides a link to manager subdetails.
My Team page Provides a table view of an employee’s teammates and links to user details.
User Detail page Provides a form for viewing a user’s details, and provides a link to their manager’s and any direct reports’ subdetails.
User SubDetail page Provides a form for viewing a user’s subdetails, and provides a link to their details.
Users page Provides a table view of users with search functionality and a link to user details.

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

Notification or Page Use-case workflows
Popular Course notification When a learning course is defined as popular based on its rating, all subscribers receive a notification.
Courses page Provides a list of available courses with a link to learning item details.
Learning Item Detail page Provides a table view of learning items with a link to scheduled offering details and an option to share by email.
Scheduled Offering Detail page Provides a detailed view of a scheduled offering with a list of instructors and an option to register for the offering.