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 Direct 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 |
|---|---|
| User Name | Account |
| Name | Group |
| ID | Profile |
Default Account Attributes
The SAP Direct 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 |
|---|---|
| Academic Title (Address) | Academic title of the user. |
| Academic Title 2 (Address) | Second Academic title of the user. |
| Addr Number (Address) | Address number of the user. |
| Alias (Logon Data) | Alias name. |
| Birth Name (Address) | Name at birth. |
| Building (Address) | Name of the building. |
| Building 2 (Address) | Second name of the building. |
| Building Long (Address) | Long name of the building. |
| Care of (Address) | Care of name. |
| Check Status (Address) | Check status for the user. |
| City (Address) | Name of the city. |
| City Number (Address) | Number of the city. |
| Code (Address) | Signature initials. |
| Communication Language (Address) | Communication language of the user. The different values to be set for this attribute are mentioned in Logon and Communication Language Attributes. |
| Communication type (Address) | Communication method for the user. |
| Company (Address) | Name of the company. |
| Company Address (Address) | Address of the company. |
| Company Address 2 (Address) | Second address of the company. |
| Company Address 3 (Address) | Third address of the company. |
| Company Address 4 (Address) | Fourth address of the company. |
| Contractual User Type ID | Contractual user types associated with user. |
| Country (Address) | Name of the country. |
| Country ISO (Address) | ISO name of the country. |
| Date Format | Date format must be in MM-DD-YYYY. |
| Decimal Notation | Decimal format should be similar to 1,234,567.89. |
| Delete After Printing | Delete spool requests immediately after printing. |
| Delivery District (Address) | Delivery district name. |
| Department (Address) | Department name. |
| District (Address) | District name. |
| District Number (Address) | District number for the user. |
| Documentation Description | Description of the documentation. |
| E-Mail (Address) | Email address. |
| E-Mail List (Address) | Email address list. |
| Employee Number (Address) | Employee number of the user. |
| Fax (Address) | Fax number. |
| Fax Extension (Address) | Fax extension number. |
| Fax List (Address) | Fax number list. |
| First name (Address) | First name of the user. |
| Floor (Address) | Floor number. |
| Floor 2 (Address) | A second floor number. |
| Format (Address) | Format name. |
| Full Name (Address) | Full name of the user. |
| Full Name 2 (Address) | Full name 2 of the user. |
| Function (Address) | Function of the user. |
| GUI Flag | Unsecured communication permitted. |
| House Number 2 (Address) | House number 2 of the user. |
| House Number (Address) | House number of the user. |
| House Number 3 (Address) | House number 3 of the user. |
| Inhouse ML (Address) | Inhouse mail of the user. |
| Initials (Address) | Initials of the user. |
| Language CR P (Address) | CR P language of the user. |
| Language ISO (Address) | ISO language of the user. |
| Language UCP ISO (Address) | CP ISO language of the user. |
| Language UP ISO (Address) | P ISO language of the user. |
| Last Name (Address) | Last name of the user. |
| Location (Address) | Location name. |
| Logon Language (Defaults) | Logon language for the user. The different values to be set for this attribute are mentioned in Logon and Communication Language Attributes. |
| Middle Name (Address) | Middle name of the user. |
| Mobile Number | Mobile number of the user. Only one mobile number is supported. For example, US:9999999999 |
| Name Country (Address) | Name of the country. |
| Nickname (Address) | Nickname of the user. |
| Notes (Address) | Notes for the user. |
| Other City (Address) | Name of the other city. |
| Other City Number (Address) | Number of the other city. |
| Output Device | Printer name assigned to the user. |
| Pager SMS List (Address) | Pager or SMS number list in the format: pager_type#pager_number |
| Parameters | Parameter list in the format: parameter_ID=parameter_value |
| Pboxcity Number (Address) | Pbox number of the city. |
| PCODE 1 Ext (Address) | Postal code 1 extension. |
| PCODE 2 Ext (Address) | Postal code 2 extension. |
| PCODE 3 Ext (Address) | Postal code 3 extension. |
| Person Responsible | Person responsible for documentation. |
| PO Box (Address) | PO box number. |
| PO Box City (Address) | PO box number of the city. |
| PO Box City ISO (Address) | PO box number of the ISO city. |
| PO Box Country (Address) | PO box number of the country. |
| PO Box Region (Address) | PO box number of the region. |
| PO Box Without Number (Address) | PO box without number. |
| Postal Code (Address) | Postal code of the user. |
| Postal Code 2 (Address) | 2nd postal code of the user. |
| Postal Code 3 (Address) | 3rd postal code of the user. |
| Prefix 1 (Address) | First prefix. |
| Prefix 2 (Address) | Second prefix. |
| Print Immediately (Defaults) | Print immediately flag for the user. |
| Printer List (Address) | Print destination list. |
| Profiles | Profiles for the user. |
| Region (Address) | Name of the region. |
| Region Group (Address) | Group name of the region. |
| Remote Communication List (Address) | Communication notes list. |
| Remote Function Call List (Address) | Remote function call destination list. |
| Remote Mail List (Address) | Remote mail list of the user. |
| Room Number (Address) | Room number of the user. |
| Room Number 2 (Address) | Second room number of the user. |
| Reference User | Reference user name. |
| Roles | Roles for user. The Account Aggregation fetches the active roles (composite /simple) assigned directly to the user. |
| Role Details | Role Details of the user. |
| Search Term 2 P (Address) | Second search term P for the user. |
| Search Term P (Address) | Search term P for the user. |
| Search Term 1 (Address) | First search term for the user. |
| Search Term 2 (Address) | Second search term for the user. |
| Second Name (Address) | Second name of the user. |
| Street Abbreviation (Address) | Street abbreviation for the user. |
| Street Address (Address) | Street address of the user. |
| Street Address 2 (Address) | Street address 2 of the user. |
| Street Address 3 (Address) | Street address 3 of the user. |
| Street Address 4 (Address) | Street address 4 of the user. |
| Street Number (Address) | Street number of the user. |
| SNC Name | SNC name. |
| Systems | Systems list. |
| Tax Jurisdiction Code (Address) | Tax jurisdiction code of the user. |
| Telephone (Address) | Telephone number. |
| Telephone Extension (Address) | Telephone extension number. |
| Telephone List (Address) | Telephone number list. |
| Teletex List (Address) | Teletex number list. |
| Telex List (Address) | Telex number list. |
| Time Format (Defaults) | Time format of the user. |
| Time Zone (Address) | System time zone. |
| Title (Address) | Title of the user. |
| Title SPPL (Address) | Title SPPL of the user. |
| Transportation Zone (Address) | Transportation zone of the user. |
| TZone (Defaults) | Personal time zone. |
| URL (Homepage) List (Address) | URL (Homepage) address list in the format: URI_type#URI_name |
| User Last Logon Time | User last log in time. |
| User Last Logon Date | User last log in date. |
| Logon Data Time Zone | User last log time zone. |
| Productive Password | User password set in permanent mode. |
| Password Deactivated | Password Deactivated Flag. |
| User Name | User Name. |
| User Title (Address) | Title of the user. |
| User Type (Logon Data) | Type of the user. |
| User Valid From (Logon Data) | Valid from date for the user. |
| User Valid To (Logon Data) | Valid to date for the user. |
| User Group (Groups) | User Group Assignments of the user. |
| X.400 List (Address) | Organization name list. |
| User Group | User Group Auth assignment. |
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 Role Attributes
The SAP Direct 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 |
|---|---|
| Name | Role name |
| Type | Role type |
| Description | A description of the role. If the description field contains a null character, the connector will remove that character and then trim any leading or trailing whitespace. |
| Child Roles | Child Role list The child roles list displays the child roles of composite roles in the Group object properties of Entitlement Catalog. When upgrading existing applications, mark Entitlement as true to display the child roles in the Group object properties Entitlement grid. |
| Long Description | A long description of the role. If the long description field contains a null character, the connector will remove that character and then trim any leading or trailing whitespace. |
| Subsystem | System name for CUA System Aggregation |
| Generated Profile | System generated profile associated to Role that has authorizations. |
| TCodes assigned through Menu | Transaction Codes added through Role Menu. |
| TCodes assigned directly | Transaction Codes assigned directly and not through the Role menu. |
| Other Menu Items | Non transactional items added through the Role menu. |
| Authorization Objects | Authorization objects associated with role. |
Note
When performing group aggregation in a SAP Central User Administration (CUA) environment, the connector does not fetch child roles or child profiles of any composite role or profile. This is due to the fact that the CUA system does not maintain child level roles or profile details for child subsystems. This works in a similar way, where the attribute ID does not fetch attributes like TCodes assigned through Menus, TCodes assigned directly and Other Menu Items or Generated Profiles for the group object type.
To fetch the TCodes assigned through menu, TCodes assigned directly, and Other Menu Items attributes, add the following attribute definitions to the account schema:
{
"name": "TCodes assigned through menu",
"type": "STRING",
"schema": null,
"description": "Transaction Codes added through Role Menu",
"isMulti": true,
"isEntitlement": true,
"isGroup": false
},
{
"name": "TCodes assigned directly",
"type": "STRING",
"schema": null,
"description": "TCodes assigned directly, and not through the Role menu",
"isMulti": true,
"isEntitlement": true,
"isGroup": false
},
{
"name": "Other Menu Items",
"type": "STRING",
"schema": null,
"description": "Non transactional items added through the Role menu",
"isMulti": true,
"isEntitlement": true,
"isGroup": false
},
Default ContractualUserType Attributes
| Attribute Name | Description |
|---|---|
| User Type ID | The type of ID or license ID. |
| Name | The license description. |
Default Profile Attributes
| Attribute Name | Description |
|---|---|
| ID | Profile name along with the description. |
| Name | Profile name |
| Type | Profile type |
| Description | Profile description |
| Subsystem | System name for CUA System Aggregation |
| Child Profiles | Sub profile list |
Default Usergroup Attributes
| Attribute Name | Description |
|---|---|
| User Group Auth | User Group Id |
| Language | Language of the group |
| Description | Description of the user group auth |
Default Usergroups Attributes
| Attribute Name | Description |
|---|---|
| User Group | User Group Id |
| Language | Language of the group |
| Description | Description of the user group assigned |
Schema Extension
The schema can extend to include the fields within the structures provisioned by the SAP standard BAPI. The fields in the following structures are provisioned:
- ADDRESS
- ALIAS
- COMPANY
- DEFAULTS
- LOGONDATA
- PASSWORD
Note
No custom attributes are supported during provisioning.
Additional Attributes
The SAP Direct connector supports updating the following SAP attributes (variables) as per their names in the schema:
- Telephone List
- EMail List
- X.400 List
- Teletex List
- Fax List
-
Pager SMS List
Note
The Pager SMS List value must be in the
<Pagerservice>#<PagerNumber>format. -
Printer List
- Remote Function Call List
- Remote Mail List
-
URL Homepage List
Note
The URL Homepage List value must be in the
<URl Type> #<urlvalue>format.
Logon and Communication Language Attributes
To set logon and communication Language in SAP Direct, use the required string literal as shown in the following table:
| Language | String Literal |
|---|---|
| Afrikaans | a |
| Arabic | A |
| Bulgarian | W |
| Catalan | c |
| Chinese | 1 |
| Chinese traditional | M |
| Croatian | 6 |
| Customer reserve | Z |
| Czech | C |
| Danish | K |
| Dutch | N |
| English | E |
| Estonian | 9 |
| Finnish | U |
| French | F |
| German | D |
| Greek | G |
| Hebrew | B |
| Hungarian | H |
| Icelandic | b |
| Indonesian | i |
| Italian | I |
| Japanese | J |
| Korean | 3 |
| Latvian | Y |
| Lithuanian | X |
| Malay | 7 |
| Norwegian | O |
| Polish | L |
| Portuguese | P |
| Romanian | 4 |
| Russian | R |
| Serbian | 0 |
| Serbian (Latin) | d |
| Slovak | Q |
| Slovenian | 5 |
| Spanish | S |
| Swedish | V |
| Thai | 2 |
| Turkish | T |
| Ukrainian | 8 |
Entitlement Data
The aggregated entitlement data consists of the following:
- SAP Roles (Simple and Composite)
- SAP Profiles (Simple and Composite)
- SAP Contractual User Type (Active SAP Licenses)
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.