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 SAP Integrated Business Planning 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 for more information.
When you first create the SAP Integrated Business Planning SaaS source, the default correlation mapping is:
| Account Attribute | Operation | Identity Attribute |
|---|---|---|
| ID | Equals | Username |
| 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 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 |
|---|---|
| ID | Account |
| ID | Group |
| ID | Role |
| ID | uwAuthorityProfile |
Default Account Attributes
The SAP Integrated Business Planning 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 |
|---|---|
| ID | ID of the business partner. |
| Active | The user's active status. |
| User Name | The user's user name. |
| User ID | User ID. |
| Person UUID | Unique ID of the business partner. |
| Global User ID | Global User ID. |
| Person External ID | Employee ID of the business partner. |
| First Name | The user's first name. |
| Last Name | The user's last name. |
| Middle Name | The user's middle name. |
| Department | Department of employee. |
| Function | Functional title name. |
| Full Name | The user's full name. This is an Account Name. |
| Last Name Prefix | The user's last name prefix. |
| Initials | The user's initials. |
| Name Supplement | Name supplement. |
| The user's email address. | |
| User Start Date | Validity start date of user. |
| User End Date | Validity end date of user. |
| Employee Start Date | Start date of employee. |
| Employee End Date | End date of employee. |
| Timezone | User's timezone. |
| Logon Language Code | Logon language code. |
| Time Format Code | Time format code. |
| Date Format Code | Date format code. |
| Decimal Format Code | Decimal format code. |
| Groups | Business roles assigned to user. Type: group. Properties: Entitlement, Multi-Valued |
| Locked | Indicates the user's locked status |
| Permission Filters | Permission filters assigned to business users. Properties: Entitlement, Multi-Valued |
| User Groups | User Groups assigned to business users. Type: userGroups. Properties: Entitlement, Multi-Valued |
Additional Account Attributes
The following lists the additional supported account attributes that you can configure as per your requirement:
Note
Use the attribute name as indicated for aggregation.
| Attribute Name | Description |
|---|---|
| birthName | The user's birth name. |
| nickName | The user's nick name. |
| lastNameSecondPrefix | The user's last name second prefix. |
| additionalLastName | The user's additional last name, if any. |
| academicSecondTitle | The user's academic second title. |
| academicTitle | The user's academic title. |
| building | Building name. |
| roomNumber | Room number. |
| phoneNumberExtension | Phone Number Extension. |
| phoneNumber | Phone number. |
| countryDialingCode | Country dialing code. |
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.
Default Group Attributes
The SAP Integrated Business Planning SaaS 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 |
|---|---|
| ID | The ID of the group. This is an Entitlement ID which must not be changed. |
| Group Name | The name of the group. This is an Entitlement Name. |
| Members | The members of the group. |
| Description | The group's description. |
| Catalogs | The catalogs assigned to business role. |
Permission Filters
The following lists the permission filters attributes.
Object Type: permissionFilters
| Attribute Name | Description |
|---|---|
| Permission Filter | The unique identifier of the Permission Filter. |
| Planning Area | The unique identifier of the associated Planning Area. |
| Planning Area Description | The description of the Permission Filter's planning area. |
| Description | The user-defined text description of the Permission Filter. |
| RfcRestrType | Indicates whether read access to attributes is (R)estricted or (U)nrestricted. |
| WfcRestrType | Indicates the level of write access to attributes: (N)o Access, (R)estricted, or (U)nrestricted. |
| WkfRestrType | Indicates whether write access to key figures is (R)estricted or (U)nrestricted. |
Additional Supported Permission Filter attributes list includes:
| Attribute Name | Description |
|---|---|
| ChangedAt | Timestamp indicating when the Permission Filter was last modified. |
| ChangedBy | Username of the user who last modified the Permission Filter. |
| CreatedAt | Timestamp indicating when the Permission Filter was originally created. |
| CreatedBy | Username of the user who originally created the Permission Filter. |
| NumUsers | The number of users assigned to the Permission Filter. |
| NumGroups | The number of user groups associated with the Permission Filter. |
| NumRoles | The number of business roles assigned to the Permission Filter. |
| Autocomplete | Flag indicating whether missing filter criteria from the planning level should be automatically added to the Permission Filter. |
| CreatedByEmailAddress | Email address of the user who originally created the Permission Filter. |
| CreatedByPhoneNumber | Phone number of the user who originally created the Permission Filter. |
| ChangedByEmailAddress | Email address of the user who last modified the Permission Filter. |
| ChangedByPhoneNumber | Phone number of the user who last modified the Permission Filter. |
User Groups
The following lists the User Groups attributes.
| Attribute Name | Description |
|---|---|
| GroupID | The unique identifier of the User Group. |
| Group Description | The description of the User Group. |
| CategoryID | The Category ID of the User Group. |
| UserCount | The number of users associated with the User Group. |
Additional Supported User Groups attributes
The following is a list of additional supported attributes for the User Group:
| Attribute Name | Description |
|---|---|
| CreatedBy | UserID of the user who last modified the User Group. |
| CreatedAt | Timestamp indicating when the User Group was originally created. |
| ChangedBy | UserID of the user who last modified the User Group. |
| ChangedAt | Timestamp indicating when the User Group was last modified. |
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.