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 Workday connector uses the following default correlation and object configurations.
Identity Profile Mapping
The Workday connector supports the following attributes in Identity Profile Mapping by default:
| Identity Attribute | Schema Attribute |
|---|---|
| SailPoint User Name | FILENUMBER |
| Display Name | WORKER_NAME |
| Work Email | EMAIL_ADDRESS_WORK |
| Family Name | LAST_NAME |
| Given Name | FIRST_NAME |
| Middle Name | MIDDLE_NAME |
| Alternate Email | EMAIL_ADDRESS_HOME |
| Work Phone Number | WORK_TELEPHONE |
| Alternate Phone Number | WORK_MOBILE |
| City | CITY |
| Cost Center | COST_CENTER |
| Country | COUNTRY (Transform ISO3166 Country Format) |
| Department | DEPARTMENT |
| Employee Number | FILENUMBER |
| End Date | TERMINATION_DATE |
| Start Date | HIREDATE |
| Manager Name | MANAGER_ID |
| Organization | ORGANIZATION_NAME |
| Postal Code | POSTAL_CODE |
| Preferred Name | PREFERRED_FIRST_NAME |
| State | STATE |
| Street Address | ADDRESS_WORK |
| Time Zone | Time_Profile_ID |
| Title | JOBTITLE |
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 |
|---|---|
| FILENUMBER | Account |
Default Account Attributes
The Workday 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 |
|---|---|
| USERID | The Worker ID associated with the worker. |
| FILENUMBER | The user's unique ID. This is an Account ID which must not be changed. |
| MANAGER | The worker's current manager. |
| MANAGER_ID | The worker's manager's Employee ID. |
| JOBTITLE | The worker's business title. |
| JOBCODE | The worker's job profile. |
| EMPLOYEE_TYPE | The user's classification type within the organization. |
| FIRST_NAME | The worker's legal first name. |
| LAST_NAME | The worker's legal last name. |
| MIDDLE_NAME | The worker's preferred middle name. |
| LEGAL_MIDDLE_NAME | The worker's legal middle name. |
| PREFIX | The user's prefix. For example, Mr. or Mrs. |
| SUFFIX | The user's suffix. For example, Jr. or Sr. |
| PREFERRED_FIRST_NAME | The worker's preferred first name. |
| WORKER_NAME | The worker's name. |
| CLASS | A concatenation of the worker's position, time type, and employment type. |
| DEPARTMENT | The worker's cost center. |
| COST_CENTER | The cost center's name in the worker's organization data. |
| COST_CENTER_HIERARCHY | The worker's cost center hierarchy. |
| COST_CENTER_REFERENCE_ID | The cost center's reference ID in the worker's organization data. |
| COMPANY_NAME | The company to which the worker belongs. |
| ORGANIZATION_NAME (Not applicable for Workday API version 30.1) |
The worker's business unit's name. |
| DIVISION | The sales channel in the worker's organization data. |
| TEAM (Not applicable for Workday API version 30.1) |
The team in the worker's organization data. |
| LOCATION | The worker's business site. |
| HIREDATE | The worker's hire date. |
| TERMINATION_DATE | The date the worker was terminated. |
| LAST_DAY_OF_WORK | The worker's last working day. |
| CONTRACT_END_DATE | The worker's contract end date. |
| FULLPARTTIME | Indicates whether the worker is full time or part time. |
| ON_LEAVE | Indicates if the worker is on leave. |
| FUTURE_DATE | Represents the worker's next future milestone date. For example, future date of hire, termination date, onboarding date, or end of their contingent worker contract. |
| FUTURE_ACTION | Represents the worker's next future action. For example, Hire, Terminate, Onboarding, or End Contingent Worker Contract (Hire Employee). |
| POSTAL_CODE | The worker's business site's postal code. |
| COUNTRY | The worker's business site's country. |
| CITY | The worker's business site's city. |
| STATE | The worker's business site's state. |
| ADDRESS_LINE_1 | The worker's business site's street address. |
| ADDRESS_HOME | The worker's home address. |
| ADDRESS_WORK | The worker's work address. |
| EMAIL_ADDRESS_HOME | The worker's home email address. |
| EMAIL_ADDRESS_WORK | The worker's email address. |
| ADDITIONAL_EMAIL_ADDRESS_HOME | The worker's additional home email address. |
| ADDITIONAL_EMAIL_ADDRESS_WORK | The worker's additional work email address. |
| WORK_MOBILE | The worker's work mobile number. |
| WORK_TELEPHONE | The worker's work telephone number. |
| HOME_MOBILE | The worker's home mobile number. |
| HOME_TELEPHONE | The worker's home telephone number. |
| ADDITIONAL_PHONE_WORK | Additional business phone number of the worker. |
| ADDITIONAL_PHONE_HOME | Additional home phone number of a worker. |
| LOCALE_ID | The ID for the user's locale. |
| Time_Profile_ID | The ID of the user's timezone. |
Note
For more information on Rescinded/Corrected Event for Hired and Terminated Workers, refer to Rescinded and Corrected User Records. The Workday connector can aggregate fields in addition to the fields present in the default account schema - for more information, refer to XPath to Support Additional Standard Attributes in Schema.
Optional Attributes
If you require the image attribute to be a String attribute type, add the following attributes:
| Attributes | Description | Source Data Element WD Object /Field Web Service Element File field |
|---|---|---|
| IMAGE_NAME (type as String) | Image file name | Worker_Data/Photo_Data/File name |
| IMAGE (type as String) | Image value as string | Worker_Data/Photo_Data/Image |
| EMAIL_ADDRESS_WORK | Email address of the worker | Worker_Data/Personal_Data/Contact_Data/Email_Address_Data[Usage_Data[@Public='true']/Type_Data[@Primary='true']/Type_Reference/ID[@type='Communication_Usage_Type_ID'] ='WORK']/Email_Address |
| EMAIL_ADDRESS_HOME | Home email address of the worker | Worker_Data/Personal_Data/Contact_Data/Email_Address_Data[Usage_Data[@Public='true']/Type_Data[@Primary='true']/Type_Reference/ID[@type='Communication_Usage_Type_ID'] ='HOME']/Email_Address |
| ADDRESS_HOME | Home address of the worker | Worker_Data/Personal_Data/Contact_Data/Address_Data[Usage_Data/Type_Data/Type_Reference/ID[@type='Communication_Usage_Type_ID'] ='HOME']/@Formatted_Address |
| ADDRESS_WORK | Work address of the worker | Worker_Data/Personal_Data/Contact_Data/Address_Data[Usage_Data/Type_Data/Type_Reference/ID[@type='Communication_Usage_Type_ID'] ='WORK']/@Formatted_Address |
| ADDITIONAL_PHONE_WORK | Additional business phone number of the worker | Worker_Data/Personal_Data/Contact_Data/Phone_Data[Usage_Data[@Public='true']/Type_Data[@Primary='false']/Type_Reference/ID[@type='Communication_Usage_Type_ID'] ='WORK']/@Formatted_Phone |
| ADDITIONAL_PHONE_HOME | Additional home phone number of a worker | Worker_Data/Personal_Data/Contact_Data/Phone_Data[Usage_Data[@Public='true']/Type_Data[@Primary='false']/Type_Reference/ID[@type='Communication_Usage_Type_ID'] ='HOME']/@Formatted_Phone |
| ADDITIONAL_EMAIL_ADDRESS_WORK | Additional Email address of the worker | Worker_Data/Personal_Data/Contact_Data/Email_Address_Data[Usage_Data[@Public='true']/Type_Data[@Primary='false']/Type_Reference/ID[@type='Communication_Usage_Type_ID'] ='WORK']/Email_Address |
| ADDITIONAL_EMAIL_ADDRESS_HOME | Additional Home email address of the worker | Worker_Data/Personal_Data/Contact_Data/Email_Address_Data[Usage_Data[@Public='true']/Type_Data[@Primary='false']/Type_Reference/ID[@type='Communication_Usage_Type_ID'] ='HOME']/Email_Address |
| ORGANIZATION_NAME (Not applicable for Workday API version 30.1) | Represent organization name whose type is BUSINESS_UNIT | Worker_Data/Organization_Data/Worker_Organization_Data/Organization_Data[Organization_Type_Reference[@Descriptor ='Business Unit']]/Organization_Name |
| CONTRACT_END_DATE | Represent the contract end date of worker | Worker_Data/Employment_Data/Worker_Contract_Data/Contract_End_Date |
| ADDRESS_LINE_1 | Represent business site's Address_line_1 of worker | Worker_Data/Employment_Data/Position_Data/Business_Site_Summary_Data/Address_Data/Address_Line_Data[@Type ='ADDRESS_LINE_1'] |
| STATE | Represent business site's country region | Worker_Data/Employment_Data/Position_Data/Business_Site_Summary_Data/Address_Data/Country_Region_Reference/@Descriptor |
| LAST_DAY_OF_WORK | Represents the last day of work of the worker | Worker_Data/Employment_Data/Worker_Status_Data/Termination_Last_Day_of_Work |
| COST_CENTER_REFERENCE_ID | Represent reference ID of organization type COST CENTER | Worker_Data/Organization_Data/Worker_Organization_Data/Organization_Data[Organization_Type_Reference[@Descriptor ='Cost Center']]/Organization_Reference_ID |
| COMPANY_NAME | Represent organization name whose type is COMPANY | Worker_Data/Organization_Data/Worker_Organization_Data/Organization_Data[Organization_Type_Reference/ID [@type='Organization_Type_ID']='COMPANY']/Organization_Name |
Note
Adding the image attribute to the schema may increase the time taken to fetch a response from the Workday source.
Additional Schema Attributes for Pre-Hire Functionality
Note
These attributes are available out of the box for new sources. For existing sources, additional schema attributes need to be added manually in order to use the Pre-Hire functionality.
| Schema Attribute | Description |
|---|---|
| PRE_HIRE_ID | Pre Hire ID for the person. |
| DATE_PRE_HIRE_ADDED_TO_SYSTEM | The date when pre-hire is added in Workday. |
| ELIGIBLE_FOR_HIRE | Specify whether Prehire is eligible for hire or not. |
| REFFERED_BY | Pre-Hires is referred by. |
| SOURCE | Pre-Hire Source. |
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.