Profile source field mapping
Overview
The tables below map fields from your source system into Interact when you use a General Profile Source (UMI) to import data. Use this page as the practical reference for what to send — which element or attribute holds each field, whether it is required, and the values it accepts. For the formal definition to validate your generated XML against, see the General Profile Sources schema; for a complete worked example, see the sample XML file.
Sync options
These options sit in the syncoptions element and the option elements within it. They control how the file is processed.
| Field label | Field name | Required | Description | Possible values |
|---|---|---|---|---|
| Domain | domain (attribute of syncoptions) |
Yes | Name of the sync in Control Panel > Profile Sources. Must match the Name of the configured profile source. | |
| LDAP ID | ldapid (attribute of syncoptions) |
Yes | The unique ID of the source created in Interact. Must match on all synchronisations once a user is in Interact. | Integer |
| Sync Companies | option name="syncCompanies" |
No | Whether company values should be taken from the file data. | true, false |
| Sync Locations | option name="syncLocations" |
No | Whether location values should be taken from the file data. | true, false |
| Sync Departments | option name="syncDepartments" |
No | Whether department values should be taken from the file data. | true, false |
| Sync Managers | option name="syncManagers" |
No | Whether manager values should be taken from the file data. | true, false |
| Action Disabled Users | option name="actionDisabledUsers" |
No | Action taken for disabled user accounts. | d (disable only), a (archive), x (do nothing) |
| Action Missing/Deleted Users | option name="actionMissingDeletedUsers" |
No | Action taken for missing user accounts. | d (disable only), a (archive), x (do nothing) |
| Login Type | option name="loginType" |
Yes | Login type to apply to new users. | 0 (Interact User), 1 (Windows User), 2 (SAML) |
| Default Culture | option name="defaultCulture" |
Yes | Culture to apply to new users. Integer referencing an ID in the Interact CULTURE table. | Integer |
| Default Company | option name="defaultCompany" |
No | Default company to apply. Integer referencing an ID in the Interact ORGANISATION table. | Integer |
| Default Department | option name="defaultDepartment" |
No | Default department to apply. Integer referencing an ID in the Interact ORGANISATION table. | Integer |
| Default Location | option name="defaultLocation" |
No | Default location to apply. Integer referencing an ID in the Interact ORGANISATION table. | Integer |
| New User Password Behaviour | option name="newUserPasswordBehaviour" |
No | How the password is set for a new profile. | strict (use supplied password and apply strength checks), random (generate a random password), blank (save a blank password; default if not supplied) |
User fields
These fields apply to each user element. When importing a user, the Processor attempts to match an existing user using four pieces of data in this order: uid, dn, username, email. If a value is not available, set it to an empty string.
| Field label | Field name | Required | Description | Possible values |
|---|---|---|---|---|
| UID | uid (attribute of user) |
Yes | A unique, unchanging ID for the user. | |
| Distinguished Name | dn (attribute of user) |
Yes | The distinguished name from Active Directory if used. Can be an empty string. | |
| Username | username (attribute of user) |
Yes | The Interact username. | |
email (attribute of user) |
Yes | The email address including the domain suffix. Can be an empty string. | ||
| First Name | person > firstname |
Yes | ||
| Surname | person > surname |
Yes | ||
| Title | person > title |
No | Supports applyBlank. |
|
| Initials | person > initials |
No | Supports applyBlank. |
|
| Job Title | person > jobtitle |
No | Supports applyBlank. |
|
| Phone | person > phone |
No | Supports applyBlank. |
|
| Mobile | person > mobile |
No | Supports applyBlank. |
|
| Fax | person > fax |
No | Supports applyBlank. |
|
| Extension | person > extension |
No | Supports applyBlank. |
|
| Address | person > address |
No | Supports applyBlank. |
|
| Status Enabled | statusenabled |
Yes | Whether the user is active. | true, false |
| Password | password |
Yes | A string value when a user is local. | |
| Job Start Date | jobstartdate |
No | Date | |
| Date of Birth | dateofbirth |
No | Date | |
| Culture | culture |
Yes | Integer from the CULTURE table. Typically 1 for English UK and 2 for English US. |
Integer |
| Language | language (attribute id) |
Yes | Integer from the INTERACTLANGUAGE table. Typically 0 for English and 1 for English US. |
Integer |
| Timezone | timezone |
No | See Valid timezone entries. | |
| Bio | bio |
No | Supports applyBlank. |
|
| Additional Fields | additionalfields > field (attribute name) |
No | The field name matches the field created in Interact, in snake case (for example Employee ID becomes employee_id). Supports applyBlank. |
String, boolean (True/False), or date (0\|mm/dd/yyyy\|\|\|\|\|\|\|\|) |
Manager fields
The manager element holds the manager for a user. The Processor matches an existing manager using uid, dn, username, email, in that order. Set unavailable values to empty strings.
| Field label | Field name | Required | Description |
|---|---|---|---|
| UID | uid (attribute of manager) |
Yes | A unique, unchanging ID for the manager (Guid). Can be an empty string. |
| Distinguished Name | dn (attribute of manager) |
Yes | The distinguished name from Active Directory if used. Can be an empty string. |
| Username | username (attribute of manager) |
No | The Interact username. Can be an empty string. |
email (attribute of manager) |
No | The email address including the domain suffix. Can be an empty string. |
Organisation fields
The organisations element holds a sequence of organisation elements.
| Field label | Field name | Required | Description | Possible values |
|---|---|---|---|---|
| Organisation Type | type (attribute of organisation) |
Yes | The type of organisation. | department, location, company |
| Primary | primary (attribute of organisation) |
No | Whether this is the primary organisation. If false, the user is assigned this as an additional department, location or company. |
true, false |
| Value | organisation (element value) |
Yes | The name (or ID) of the organisation. |
Group fields
The groups element holds a sequence of group elements. Each group holds a users element listing its members.
| Field label | Field name | Required | Description |
|---|---|---|---|
| User Count | UserCount (attribute of group) |
Yes | Count of user elements in the group. Informational. |
| UID | uid (attribute of group) |
Yes | A unique, unchanging ID for the group (Guid). |
| Distinguished Name | dn (attribute of group) |
Yes | The distinguished name from Active Directory. |
| Name | name (attribute of group) |
Yes | The Interact group name. |
Note: If a user is not included in any group and does not exist in Interact, they are not imported. If a user is not included in any group but already exists in Interact, they are treated as missing and handled per the sync options.