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 for more information.
-
The schema attributes that are not present by default must be defined as strings if not specified.
The SuccessFactors connector uses the following default correlation and object configurations.
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 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 |
|---|---|
| PersonID | Account |
| GroupID | Group |
| RoleID | Role |
Default Account Attributes
The SuccessFactors 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 |
|---|---|
| PersonID | The person's unique identifier. This is an Account ID which must not be changed. |
| Username | The person's username |
| Userid | The person's user ID |
| Salutation | The person's salutation |
| FormalName | The person's formal name |
| FirstName | The person's first name |
| MiddleName | The person's middle name |
| LastName | The person's last name |
| PreferredName | The person's preferred name |
| Department | The person's department name |
| Division | Represents the division name in the organization data |
| Company | The company under which the Employee belongs |
| Location | The person's work location name |
| Country | Name of the person's country |
| PositionNumber | The position number associated with the Employee |
| JobTitle | The job title associated with the Employee |
| EmployeeType | The Employee type |
| EmployeeStatus | The Employee's active Status |
| PrimaryEmailAddress | The person's primary email address |
| Job Classification | The person's job classification |
| CostCenterID | Cost center ID associated with the Employee |
| IsContigentWorker | Indicates whether the Employee is Contingent Worker or not |
| FLSA | FLSA status code |
| AssignmentType | The person's assignment type |
| ManagerID | The person's manager's unique identifier |
| CostCenter | The cost center associated with the Employee |
| EmployeeClass | The Employee's class designation |
| IsFullTime | Indicates whether the Employee is Full Time or Part Time |
| ServiceDate | The person's service start date |
| JobInfoLastModified | Date when Job Information was last modified |
| Position Entry Date | Position start date for Employee |
| LastDateWorked | Last date the Employee worked |
| BusinessPhone | The person's business phone number |
| BusinessPhoneCountryCode | The person's business phone country code |
| BusinessExtension | The person's business extension |
| Cell | The person's primary cell |
| CellCountryCode | The person's primary cell code |
| Fax | The person's fax number |
| FutureActions | Stores Information about Future Actions in the following JSON format: {"Actions": [{"ActionType" : "\<ActionCode>","ActionReason" : "\<Action Reason value>","ActionStartDate" : "\<Start date>","ActionEndDate" : "\<End date>"}]}. For example, {"Actions": [{"ActionType" : "SCWK","ActionReason" : "Start CWK","ActionStartDate" : "2018-08-26","ActionEndDate" : "2018-09-08"}]}. This attribute aggregates the ManagerID value along with existing future employment details. |
| Person ID External | The person's External ID |
| BusinessUnit | The person's business unit name |
| Termination Date | Populates the Termination Date for Employees and WorkOrder End Date for Contingent Workers. |
| Groups | Groups associated with the person. |
| Roles | Roles associated with the person. |
Users-Only Attributes
| Attribute Name | Description |
|---|---|
| User.Status | Status of the user |
| User.FirstName | First name of the user |
| User.LastName | Last name of the user |
| User.Email | Email address of the user |
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 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.
The attributes listed on this page define Group and Role type objects.
Default Group Attributes
The SuccessFactors connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.
| Attribute Name | Description |
|---|---|
| GroupName | Name of the group |
| GroupID | ID of the group. This is an Account ID which must not be changed. |
| GroupType | The group's type |
| CreatedBy | User ID of the group's creator |
| LastModifiedDate | Date the group was last modified |
| IsStaticGroup | Indicates if the group is static or dynamic |
| Roles | Roles associated to the access group |
Default Role Attributes
The SuccessFactors connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles.
| Attribute Name | Description |
|---|---|
| RoleName | Name of the role |
| RoleID | Internal ID of the role |
| Groups | Access groups associated to the role |
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.