# 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. |
