# SailPoint SuccessFactors LMS SaaS Connector Documentation

> SuccessFactors LMS SaaS Connector Documentation

# Documentation

# Connecting SailPoint and SuccessFactors LMS SaaS

To connect SailPoint with SuccessFactors LMS, perform the following tasks:

## Adding the Source in SailPoint

To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs.

> [!IMPORTANT]
>
> By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration.

**To configure a new source:**

1. Sign in to SailPoint.
2. Go to **Admin \> Connections \> Sources**.
3. Select **Create New**.
4. Search for the connector by entering the name in the search box, and then select **Actions**.
5. In the **Actions** dropdown list, select the setup method:

   - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started.

     > **Note**
     >
     > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>). For more information, contact your SailPoint Customer Service Manager.
   - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup.

### Configuring a Source Using Express Setup

Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data.

1. Review the directions and select **Start Express Setup**.
2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**.

   > **Note**
   >
   > The source name must be unique. You can change these settings later in the source configuration.
3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider.

   > **Note**
   >
   > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section.
5. Select **Finish**.

   After a successful test connection, the system creates your source and prompts you to run an aggregation.

   - If you want to aggregate now, select **Aggregate**.

     - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**.
     - To see the list of aggregated source accounts, go to **Account Management \> Accounts**.
   - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet.

### Configuring a Source Using Standard Setup

Use Standard Setup to configure the connector for full feature support.

1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters.
2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters.
3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
4. (Optional) Select a governance group to grant its members [source](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
5. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there.

## Base Configuration

Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary.

1. Enter a unique name and description for the source.
2. In the **Source Owner** dropdown list, select the identity that owns this source.

   - To find a source owner, begin entering their name.
3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider.

   > **Note**
   >
   > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information.
5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-with-a-source>).
6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default.

   - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system.
   - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source.
7. Select **Save**.

## Connection Settings

Provide the information required for SailPoint to connect and authenticate with the SuccessFactors LMS managed system.

1. Go to **Connection Settings**.
2. Enter the **Base URL** used to connect to the SuccessFactors LMS managed system.
3. Select the **Grant Type** as SAML Bearer Assertion or OAuth 2.0 Client credentials authentication.
4. Enter the **User ID** used to connect to the SuccessFactors LMS managed system with the appropriate permissions.
5. Enter the **Company ID** used to connect to access the SuccessFactors LMS API.

   > **Note**
   >
   > To obtain Company ID and Client ID, go to **System Administration \> Configuration \> OAuth Token Server** in the SuccessFactors LMS managed system.
6. Enter the **Client ID** issued by the authorization server to your client application during the registration process.

   > **Note**
   >
   > To create a Client ID and Client Secret for the test connection, refer to [To Create a Client Secret Key for Test Connection](<#to-create-a-client-secret-key-for-test-connection>).
7. Enter the **Client Secret** of the SuccessFactors LMS system.
8. Enter the **Token URL** (SailPoint recommends using HTTPS for a secured connection).
9. Enter the **Private key**.
10. Select **Save**.

### To Create a Client Secret Key for Test Connection

Go to **SAP SuccessFactors Learning Administration**, then go to **System Administration \> Security \> Administrators**.

1. Find and open the account of the administrator (Minimum Permission User) in edit mode.
2. Choose **Generate a New Client Secret** in Summary.
3. Copy the newly generated Client Secret.

## Aggregation Settings

Configure the following settings related to account aggregation processes.

> [!NOTE]
>
> **Screenshot**
>
> [![Aggregation Settings](<https://documentation.sailpoint.com/connectors/successfactors_lms/saas/help/img/aggregation_settings.png>)](<https://documentation.sailpoint.com/connectors/successfactors_lms/saas/help/img/aggregation_settings.png>)

1. Select **Aggregate Inactive Users** to aggregate the inactive users.
2. Enter the number of records in **Page Size** to aggregate in a single page. The default value is 200.
3. Enter the **Aggregation Timeout (in seconds)**. The aggregation fails when the connector receives no response from the managed system for the configured duration. The default value is 180.
4. Select **Save**.

## Review and Test

Perform a test to confirm the connection to SailPoint.

1. Go to **Review and Test**.
2. Confirm that the entries in each field are correct.

   If you note any mistakes, return to the section and make corrections.
3. Select **Test Connection**.

## SailPoint Application Onboarding

SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface.

For more information, refer to [Application Onboarding](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Integrating SailPoint with SuccessFactors LMS SaaS

> [!NOTE]
>
> **Integration**
>
> This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager.

The SAP SuccessFactors Learning Management Solution (LMS) helps prepare people for the future with innovative capabilities to drive skills management, learning, and development. The LMS is a software tool that allows you to create, deliver, and report on training courses and programs.

Integrating SuccessFactors LMS with SailPoint connector facilitates aggregation and assignment of user training information. The integration assists in aggregating the courses users are actively engaging with or have completed in the past. It also enables aggregating all active courses within SuccessFactors LMS, making them easily assignable to users through SailPoint.

This document is designed to give specific information about the requirements and field definitions needed to get a working instance of a SuccessFactors LMS SaaS.

For a comprehensive list of supported features and use cases, refer the [Supported Features](<#supported-features>) section.

> [!NOTE]
>
> To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes](<https://community.sailpoint.com/release-notes/saas>) page.

## Supported Features

The SuccessFactors LMS SaaS connector supports the following features:

- Manage SuccessFactors LMS Users as Accounts
- Account Aggregation
- Account Provisioning (Assign/Unassigned groups to User)
- Add/Remove Entitlements
- Manage Items, Curricula, and Programs as Entitlements

## Prerequisites

- Identify or create a service account on the SuccessFactors LMS managed system.

## Required Permissions

Following are the steps to create and assign a role on the SuccessFactors LMS managed system:

1. Go to **System Administrators \> Security \> Administrators \> Add New**.
2. Create a New Admin.
3. Go to **System Administrators \> Security \> Role Management \> Add New**.
4. Create a New Role.

   > **Note**
   >
   > Ensure to assign the required permissions to the created New Role mentioned in [Minimum Permissions](<#minimum-permissions>).
5. Assign the created role to the created admin.

### Minimum Permissions

To perform specific operations, you must assign the following required minimum permissions for the SuccessFactors LMS SaaS connector:

| Operations | Required Permissions |
| --- | --- |
| Test Connection | [Required Permissions for Test-Connection](<#required-permissions-for-test-connection>) |
| Aggregation | [Required Permissions for Aggregation](<#required-permissions-for-aggregation>) |
| Provisioning | [Required Permissions for Provisioning](<#required-permissions-for-provisioning>) |

#### Required Permissions for Test-Connection

| Permission ID | Permissions |
| --- | --- |
| Search | Search User |
| People Management | View User |

#### Required Permissions for Aggregation

| Permission ID | Permissions |
| --- | --- |
| Search | Search Item, Search Program, Search Curriculum, Search User |
| People Management | View Item Assigned to User, View Programs Assigned to User on User Entity, View Curriculum Assigned to User, View User, View User Learning History |

#### Required Permissions for Provisioning

| Permission ID | Permissions |
| --- | --- |
| People Management | Assign Item to User, Assign Program to User, Assign Curriculum to User, Unassign Item from User, Unassign Program from User, Unassign Curriculum from User, View Item Assigned to User |
| Search | Search Item, Search User, Search Program, Search Curriculum |

# Schema Reference

The application schema is used to configure the objects returned from a connector.

> [!NOTE]
>
> - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.
> - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified.

The SuccessFactors LMS SaaS connector uses the following default correlation and object configurations.

## Default Correlation Configuration

Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements.

You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities](<https://documentation.sailpoint.com/saas/help/accounts/correlation.html>) for more information.

When you first create the SuccessFactors LMS SaaS source, the default correlation mapping is:

| Account Attribute | Operation | Identity Attribute |
| --- | --- | --- |
| StudentID | Equals | Employee Number |
| Email Address | Equals | Work Email |

## Default Account Schema

Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.

The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.

### Default Account ID

SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*.

> [!CAUTION]
>
> Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
>
> To resolve issues caused by changing account IDs, reconfigure them to their default values.

The following table lists the default account IDs for this connector:

| Account ID | Schema Object Type |
| --- | --- |
| StudentID | account |
| Item ID | Item |
| Curricula ID | Curricula |
| Program ID | Program |

### Default Account Attributes

The SuccessFactors LMS SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

| Attribute Name | Description |
| --- | --- |
| First Name | The given name of a user. |
| Last Name | The family name of a user. |
| Middle Name | The middle initial of a user. |
| Email Address | The user's email address. |
| Address | The street address of a user. |
| City | The city of the user. |
| State | The state or province of the user. |
| Country | The country of the user. |
| Active | Active can be (Y or N) or (Yes or No). The value N and the value No mean that the user is inactive. The value Y and the value Yes mean that the user is active. |
| Postal | The postal code of the user. |
| StudentID | The unique ID of a user in the Learning Management System (LMS). |
| PersonGUID | This is an internally generated, immutable identifier for one person. |
| ExternalID | This is a mutable identifier for one person across all of SAP SuccessFactors HXM Suite. |
| Is Fulltime | Is the user a full time employee? |
| Job Location | The unique ID of the user's physical location. |
| Job Title | The unique job CODE of the user. |
| Security Domain | Security domain ID of the entity. |
| Organization | The unique ID of the organization that the entity belongs to. |
| Primary Manager | The user ID of the user's supervisor. |
| Has Access | Does the user have access to the Learning Management System (LMS)? |
| Hire Date | The user's hire date. |
| Termination Date | The date that the user separated from the company. |
| Self Registered | Is the user self registered? |
| IsContigentWorker | Represent whether Employee is Contingent Worker or not. |
| Locked | Is the user locked out of the system? |
| Region | Region associated with user. |
| Role | The security role ID of the user. |
| Profile Status | The status indicating if the student is an active employee. |
| Native Deep Link User | Depending on how you set Native Deeplink User, you mark the user as either coming in from Human Experience Management (HXM) through the connector or a user who is native to learning. |
| Employee Type | Employee Type(salaried/contractor/full time). |
| Employee Status | You can associate employees with a status that identifies their standing in the company (for example, full-time, on leave, or suspended). |
| Regular/Temporary ID | Companies use the regular temp ID to search and report on users in categories of their regular and temporary work. |
| Position Number ID | The position number ID. |
| Assigned Items | Items assigned to user. |
| Assigned Curricula | Curricula assigned to user. |
| Assigned Programs | Programs assigned to user. |
| Scheduled classes | Scheduled classes of user. |
| Completed items | Completed items of user. |
| Completed Programs | Completed Programs of user. |

> [!NOTE]
>
> Completed Items shows all items completed by the user. Items completed as part of Curricula and Programs are also shown here. Format is `Item ID#completion date`. Completed Programs shows all programs completed by the user. Format is `Program ID#Completion date of Program`.

## Default Entitlement Attributes

Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) for more information.

> [!CAUTION]
>
> Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.

### Default Group Attributes

The SuccessFactors LMS SaaS connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

#### Object Type: Item

| Attribute Name | Description |
| --- | --- |
| Item title | Title of the learning item. |
| Item Type ID | Determine how users are marked complete for a learning item. One item type can have completion statuses of pass and fail while another might have completion statuses of pass, fail and incomplete. |
| Revision date | The revision date of this entity. Learning items often have revision dates that correspond to a regulator's revision of compliance measures. |
| Item ID | The unique ID of a learning item. |
| Classification ID | The unique ID of the classification for a learning item. It can be one of the following values: BLENDED, CONTINUOUS ONLINE ACCESS, EXTERNAL-COURSE, PHYSICAL GOOD, or TIME-BASED. |
| Source ID | The source is the developer of the learning item or the organization or regulatory body that requires it. |
| Domain ID | The security domain ID of the entity. |
| Is Active | Is item active? |
| Delivery Method ID | The unique ID of a delivery method. A delivery method describes how a learning item will be delivered (for example, a book, PDF file, or online course). |

#### Object Type: Curricula

| Attribute Name | Description |
| --- | --- |
| Curricula Title | The title of a curriculum in the system. |
| Curricula ID | The Unique ID of a curriculum in the system. |
| Domain ID | The security domain ID of the entity. |
| Is Active | If curricula is active. |
| Curricula Type ID | The unique ID of the curriculum type. Curricula types are ways to categorize curricula. |
| Basis date | When the curriculum is calendar based, basis date is used to calculate the period. It is the starting line for retraining intervals. For example, if the user must retrain every year, and the basis date is January 1, the user must retrain every year by January 1. |
| ForceIncomp | If Y, the system calculates whether the status of the curriculum should be Complete or Incomplete based on a users most recent attempt at completing any one item in the curriculum. |
| Curricula Desc | The plain text description of the curriculum that the system returns. |

#### Configurable Account Attributes

The following is a list of attributes that are not provided out of the box. You can add them to your schema to view various SuccessFactors LMS managed system group information.

| Attribute Name | Description |
| --- | --- |
| Items | Items inside curricula. |
| Subcurricula | Subcurricula inside Curricula. |

> [!NOTE]
>
> Items inside curricula and subcurricula inside Curricula are displayed only if Curricula is assigned to the user.

#### Object Type: Program

| Attribute Name | Description |
| --- | --- |
| Program Title | The title of a program. |
| Program ID | The unique ID of a program in SAP SuccessFactors Learning. |
| Program Type | Learning program types describe how the user goes about completing a program. |
| Domain ID | The security domain ID of the entity. |
| Is Active | Is active? |
| Assignment Type ID | The assignment type of the entity. |
| Duration | The length of the program. |
| Description | A description of the program. |
| Start Date | The start date of the program. It applies only when the program type is SCHEDULE\_BASED. |
| End date | The end date of the program. It applies only when the program type is SCHEDULE\_BASED. |

# Troubleshooting

If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support.

For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information:

- [SailPoint Identity Services Documentation](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

## Debug Logs

For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](<https://documentation.sailpoint.com/saas/help/sources/managing_additional_settings.html>).

## Entitlement aggregation fails due to a timeout error after adding an additional attribute in the group schema

**Resolution**: Go to [Aggregation Settings](<https://documentation.sailpoint.com/connectors/successfactors_lms/saas/help/connecting.html#aggregation-settings>) and increase the value in the **Aggregation Timeout** field. The default value is 180 seconds.

## Aggregation is taking a long time to complete

**Resolution**: To improve the performance of the aggregation, the connector uses 4 threads in parallel out of the box. The value of the thread needs to be determined and can be changed as per the VA configuration.

```text
POST https://{orgName}.api.identitynow.com/cc/api/source/update/{SuccessFactorsLMSSourceID}
Form-Data: key:connector_threadSize  value: <Number of aggregation Threads/>
```