ATS to Entra ID Profile Map
You can define ATS attributes to Entra ID profile mapping on this step. Simply type text or drag drop ATS attributes and map to each attribute.
Data Mapping and Transformation¶
Data mapping and transformation is at the heart of the workflow design. Data transformation allows you to map and transform data elements from the incoming ATS data to the outgoing Entra ID that makes an API call or performs an operation.
As you see in the picture below, there are two sections highlighted by red and green color:
-
The area highlighted in red is the "Trigger data" available for you to drag and drop to your conditionals. These are the ATS attributes you defined in "ATS Data Definition" step.
-
The area highlighted in green has the Entra ID attribute fields to which data needs to be mapped. It also has the data "Mapping and Transformation" capabilities to manipulate trigger data as well as your own input data to generate the final value for the corresponding Entra ID attributes.
-
Hire2Retire being targeted at business users or citizen integrators provides hundreds of "Excel Style Functions" for data mapping and transformations on the toolbar starting with "fx".
Choose the extention attribute from the dropdown "Choose the extension attribute to store the Unique ID" to store the hash of the personal email. This hash is used as the identifier to determine the user profile created by the ATS flow. If any applicant applies for multiple roles, the system combines the hashed value with the job title attribute as an identifier, which helps in storing multiple applications from a single applicant.
Note - Hire2Retire auto-generates mail, UPN and mail nickname using UPN prefix and UPN suffix. As mail nickname is a required attribute of an employee profile in Entra ID, By default mail nickname is auto-generated using UPN prefix by Hire2Retire. If user provides mapping in mail nickname field, then Hire2Retire will take the user-provided value and map to employee profile.
| # | AttributeName | Description |
|---|---|---|
| 1 | Name | Display name of the user |
| 2 | UPN prefix or user name | The part before @ in UPN is upn prefix. |
| 3 | UPN suffix or domain name | The part after @ in UPN is upn prefix. |
| 4 | jobTitle | The jobTitle attribute is used for mapping the Job title of the Applicant in the Entra ID. |
Manage HCM to Entra ID flow in Hire2Retire¶
Enable this checkbox "Check if you have configured any HCM to Entra ID flow" if you have configured any HCM to GD flow in Hire2Retire. This helps Hire2Retire in checking if the user is already created before through ATS flow in the Entra ID using the hash value stored in the extension attribute. If so, then the HCM workflow will update that employee profile created from ATS flow after employee gets onboarded.
Other Entra ID Attributes¶
| # | Attribute Name | Description |
|---|---|---|
| 1 | aboutMe | Information about current user |
| 2 | ageGroup | The user's age group. Possible values: null, Undefined, Minor, Adult, NotAdult. |
| 3 | businessPhones | The list of business phone number. |
| 4 | companyName | The name of the company in which user works |
| 5 | consentProvidedForMinor | Whether the consent has been provided for a minor. Allowed values: null, granted, denied, or notRequired. |
| 6 | country | The name of the country in which the user resides |
| 7 | creationType | If the user account was created as a local account for an Entra Active Directory B2C tenant, the value is LocalAccount or nameCoexistence. |
| 8 | department | It contains the name for the department in which the user works. |
| 9 | employeeHireDate | Date on which employee was hired. |
| 10 | employeeType | This attribute specifies an employee's job category |
| 11 | externalUserState | This represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. |
| 12 | faxNumber | The fax number of the user |
| 13 | First Name | First name of the user |
| 14 | interests | Other interests of the user |
| 15 | isResourceAccount | It is of boolean type and reserved for future use. |
| 16 | legalAgeGroupClassification | It is calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, minorWithOutParentalConsent, minorWithParentalConsent, minorNoParentalConsentRequired, notAdult, and adult. |
| 17 | mobilePhone | The primary mobile phone number. |
| 18 | mySite | The user's personal site |
| 19 | officeLocation | office location of the user |
| 20 | OtherMails | A list of secondary email addresses for the user. Example: ["bob@contoso.com", "Robert@fabrikam.com"]. |
| 21 | pastProjects | Projects undertaken by the user |
| 22 | postalCode | The postal code for the user's postal address. The postal code is specific to the user's country/region. |
| 23 | preferredDataLocation | The preferred data location for the group |
| 24 | preferredLanguage | Language preferred by the user |
| 25 | preferredName | Name preferred by the user. |
| 26 | proxyAddresses | Email addresses for the group that direct to the same group mailbox |
| 27 | responsibilities | Responsibilities undertaken by the user |
| 28 | schools | A list for the user to enumerate the schools they have attended |
| 29 | streetAddress | An address description with street name and house number/description |
| 30 | Last Name | Last name of the user |
| 31 | usageLocation | Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries/regions. Not nullable. A two letter country/region code (ISO standard 3166). Examples: "US", "JP", and "GB". |
| 32 | userType | A string value that can be used to classify user types in your directory. Value can be Member or Guest |
Other than the attributes mentioned above, we have 15 "extensionAttributes". Each object in the Entra ID has Extension attributes that are ready to be used for whatever purposes admins might come up with, such as storing additional information on user accounts during automated processing.
Clear Attribute(s)¶
You can clear the values of attribute(s) from the Entra Active Directory by selecting them in the Clear Attributes multi-select. If you provide empty values for selected attributes in the mapped data, those attributes will be cleared. The values of unselected attribute(s) will be preserved as it is.
