# Set Default IDS Attribute Mappings

The IDS Attribute Mappings page defines the default attributes that will be used for an IDS connection between the directory server user data fields, for instance Active Directory, and the MiCollab server user data fields. It allows you to map the corporate directory service user data fields to the MiCollab data fields. MiCollab uses the connection and attribute mappings to

- write user data and corporate contacts from Active Directory into the MiCollab database,

- write corporate contacts from Active Directory, MiVoice 5000 LDAP directory service, or MiVoice 5000 Manager (AM7450) directory service into the MiCollab Client corporate directory, or

- support access to an external LDAP directory database for directory searches from MiCollab Clients.

## Conditions

### General

- You can apply the default set of attribute mappings to a connection by leaving the Use default attribute mappings box checked, or you can clear the box and assign custom mapping attributes to a connection.

- At minimum, directory server attributes must be set for the User ID, Distinguished Name, First Name, and Last Name fields. All other fields can have blank directory server attributes, which allows the fields to remain blank or to be populated from a template.

- Customized attribute fields are validated when the connection runs. If you enter an attribute incorrectly, the operations will likely fail. The failed operations are listed as errors in the summary and are sent to in the detained updates queue.

- If you change an attribute mapping on MiCollab after the initial full synchronization, another full synchronization is required because regular scheduled synchronizations only detect and apply deltas from the directory service. The directory service is unaware of the change on MiCollab until you perform a full synchronization. A warning message is displayed if you change an attribute on MiCollab after the initial sync. The warning indicates that another full synchronization is required apply the change to the directory server.

- MiCollab supports UTF-8 format for the directory service attributes with the following exceptions: Email address, Department, and Location. These field attributes do not support UTF-8 format. This limitation applies to the MiVoice Business system also. If one of these fields receives UTF-8 data, the operation fails and is sent to the deferred updates queue.

- If First Name, Last Name, or Department attributes are updated for a user, the updated values will get reflected after 15 minutes in the client call window. It is recommended for users to wait for 15 minutes or restart the system to display the updated values.

### Specific Conditions Relating to Users

Directory service attributes that are mapped to user service data must

- be unique

- belong to the user object class - different objects cannot be described by the same set of attributes; otherwise, updates will fail.

- programmable from a user interface such as the Active Directory Users and Computers console.

- be single-valued (not a list of comma-separated values)

- be available (when you select an LDAP attribute to map to user service data, ensure that the attribute in use for some other purpose).

### Specific Conditions Relating to Contacts

The attribute mappings of the IDS connection must be set to match the MiVoice 5000 directory schema. The MiVoice 5000 can have different attributes for internal (people) and external (contact) records. Therefore, to support the synchronization of both types of records, the internal and external record attribute tables on the MiVoice 5000 LDAP directory service must match each other for the MiCollab IDS connection to retrieve both types of records.

The MiVoice 5000 and MiVoice 5000 Manager (AM7450) allow you to configure custom attributes in the directory schema in order to provide additional custom information for external records. On the MiVoice 5000 you perform the configuration from the Telephony Service -> Subscribers -> Directory-> Parameters ->Customization menu. On the AM7450 you perform the configuration from the Telephony-> Directory Management-> Customization menu. The custom attributes are named attr1, attr2, attr3, and so forth. MiCollab IDS support mappings to these custom attributes.

### Specific Conditions Relating to Mobile Phones

If the Mobile Phone Directory Number field is mapped in the Attribute Mappings table, when a new user is created with a mobile number in Active Directory, the mobile number is populated into the External Hot Desk User (EHDU) number in MiVoice Business. It is also sent to MiCollab Client server (UCA) and added to the user's phones list. The user will see this number when they manage their dynamic status and other users will see that number in the corporate directory. The EHDU number is added to the following interfaces:

- User and Services application in MiCollab.

- Phone service in MiVoice Business.

- User's phone service list as presented in the UCA management pages

- End user's account information.

- MiCollab Client corporate directory as presented to other users.

When the mobile number for an existing user is updated in Active Directory, then on the next scheduled IDS synchronization cycle, the mobile number change is detected and the new mobile number is shown in bold in the detained queue. If the IDS connection is configured to apply updates immediately (defer all updates is not checked) then the EHDU number will be updated immediately in the interfaces listed above; if not, the EHDU is updated after you save the update in the 'Manage Detained Queue' tool.

Note the following:

- DID numbers and Directory numbers are not updated. Only mobile numbers are updated.

- Whenever you update an Active Directory user (any attribute) if there is a mobile number programmed in Active Directory the number will be synchronized into MiCollab, possibly over-writing end user's provided EHDU number. To avoid overwriting a user's EHDU number, review the change in 'Manage detained queue' and if necessary choose not to apply the change.

- If you do not want mobile numbers that are provisioned in Active Directory to be applied to the MiCollab solution, remove the mobile number mapping from the IDS connection.

- If the EHDU was published, it remains published. If it was not published, it remains unpublished.

- If other fields are also updated in Active Directory at the same time (such as the user's first or last name) these updates are also applied.

- It is not necessary to perform a PBX sync in order for an update to be sent to the MiVoice Business or MiCollab Client.

- The same number format supported in the initial create is supported in the subsequent update.

- To synchronize existing users mobile numbers with Active Directory, check the 'Re-initialize on next cycle' option in the IDS connection and re-run the sync.

- The correct MiVoice Business system username and password must be provisioned in the Network Elements tab in the User and Services application.

## Attribute Mapping Descriptions

The following LDAP attributes are mapped from an external Active Directory or LDAP source through the MiCollab IDS integration for

- Users (including Teamwork mode users)

- Contacts

for the following communication platform integrations:

- MiVoice Business

- MiVoice MX-ONE

- MiVoice 5000

and for

- access to an external directory such as Mitel MetaDirectory or Mitel InAttend.

Note: The default attribute mappings are applied to a new connection. To use custom mappings, clear the Use default attribute mappings box and enter the required attributes.

Note: In the Attribute Mapping table, not all the attributes are applicable in case of ForgeRock Directory Services. See the table below for reference.

MiCollab Attribute | Description | Attribute Mappings
Default Active Directory mappings for user data and MiCollab Client Contacts | Default Active Directory mappings MiCollab Client Contacts only | Sample MiVoice 5000/ MiVoice 5000 Manager LDAP Directory Service mappings for MiCollab Client Contacts only | ForgeRock Directory Services Default attributes
City | Enter the directory server attribute for the city. | l | l | l | (unmapped)
Company Name | Enter the directory server attribute for the company name. | company | company | company | (unmapped)
Country | Enter the directory server attribute for the country. | co | co | co | co
DID Number | Enter the directory server attribute for the Direct Inward Dial Number. N ote: If you change a DID number on the directory server, it is NOT updated on MiCollab. | (unmapped) | (unmapped) | (unmapped) | (unmapped)
Department | Enter the directory server attribute for the department. | department | department | department | (unmapped)
Distinguished Name | Enter the directory server attribute for the distinguished name. The distinguished name attribute is used by MiCollab Client to group contacts via their organizational unit information. | distinguishedName | distinguishedName | distinguishedName | cn
Email | Enter the directory server attribute for the e-mail address. | mail | mail | mail | mail
Fax | Enter the directory server attribute for the business fax. | facsimileTelephoneNumber | facsimileTelephoneNumber | facsimileTelephoneNumber | facsimileTelephoneNumber
First Name | Enter the directory server attribute for the user first name. This field is mandatory. On the MiVoice 5000 and MiVoice 5000 Manager (AM7450) the first name is typically identified by the displayGn field if UTF8 is supported. Otherwise, use the givenName field. | givenName | givenName | givenName | givenName
Home Element | Specify the directory server attribute for the MiVoice Business system that supports the phone services. You must enter the IP address or hostname of the MiVoice Business system in the specified attribute on the directory server. After you synchronize the directory server database with MiCollab, the user's phone services are assigned to the specified MiVoice Business system. Note: You can also apply a role (see below) with an associated template that assigns the MiVoice Business system. Note: This field does not apply to MiCollab Client contacts. Note: The values entered in the Home Element and the System Administrator > Manage Network Elements > IP Address/FQDN fields must be the same. Note: The value entered in the Home Element field will supersede the pre-defined value in the IP Address/FQDN field, when you select the desired PBX from the MiCollab template. | ipPhone | ipPhone | ipPhone | (unmapped)
Info | Enter a directory server attribute that represents some data that will be searchable in MiCollab Clients. | (unmapped) | (unmapped) | (unmapped) | (unmapped)
Info 2 | Enter a directory serve r attribute that represents some data that will be searchable in MiCollab Clients. | (unmapped) | (unmapped) | (unmapped) | (unmapped)
Language | Enter the directory server attribute for the preferred language. Note: This field does not apply to MiCollab Client contacts. | preferredLanguage | preferredLanguage | preferredLanguage | preferredLanguage
Last Name | Enter the directory server attribute for the user's last name. This field is mandatory. For MiVoice 5000 and MiVoice MX-ONE integrations, use the "displayName" attribute if UTF8 character support is required. Set the field to "sn" if UTF8 support is not required. | sn | sn | sn | sn
Location | Enter the directory server attribute for the location. This field does not apply to corporate contact records. | physicalDeliveryOfficeName | physicalDeliveryOfficeName | physicalDeliveryOfficeName | physicalDeliveryOfficeName
Login | Enter the directory server attribute for the Login ID field. This field is mandatory. This attribute has a maximum length of 20 characters in the directory service. | samAccountName | not applicable | samAccountName | uid
Mobile Phone Number | Enter the directory server attribute for the mobile phone. Note: If you change a mobile number on the directory server, it is updated on MiCollab during the next synchronization. | (unmapped) | (unmapped) | mobile | mobile
Mobile Phone Number 2 | Enter the LDAP attribute for the second mobile phone. | (unmapped) | (unmapped) | (unmapped) | (unmapped)
Object Class | Displays the directory server attribute that is used to import users, or contacts, or both, from the directory server using IDS. This field is read-only. | objectClass | objectClass | objectClass | objectClass
Photograph | Enter the directory server attribute for the photograph/picture. Default entry is thumbnailPhoto. It also supports jpegPhoto. Note: Photograph/picture added using the Client or Server Manager will over-ride the AD sync photo/picture. | thumbnailPhoto | thumbnailPhoto | thumbnailPhoto | (unmapped)
Position | Enter the directory server attribute for the position. | (unmapped) | (unmapped) | (unmapped) | (unmapped)
Postal/ZIP Code | Enter the directory server attribute for the postal code or ZIP code. | postalCode | postalCode | postalCode | postalCode
Primary Phone Directory Number | Enter the LDAP attribute for the prime directory number. | telephoneNumber | telephoneNumber | telephoneNumber | telephoneNumber
Role | Enter the directory server attribute for the role. The role field for a contact record is not mandatory. For Active Directory contact synchronization, the role is automatically set to "contact" after a contactRecord is identified or in the case of Active Directory if the objectClass is set to "contact". If the role is present in the directory server, users whose roles are set to ‘Contact’ will be created as contacts in MiCollab. | employeeType | employeeType | employeeType | description
Secondary Phone Directory Number | Enter the secondary phone directory number. | (unmapped) | otherTelephone | otherTelephone | (unmapped)
Street | Enter the directory server attribute for the street. | streetAddress | streetAddress | streetAddress | streetAddress
Title | Enter the directory server attribute for the title. | title | title | title | title
User Id | Enter the directory server attribute for the Globally Unique Identifier (GUID). For integrations that use Active Directory set this field to "objectGUID". For MiVoice 5000 or MiVoice 5000 Manager, set to "cleUid". | objectGUID | objectGUID | objectGUID | uid

## Level of Attribute Support