User synchronization datasource field descriptions

Last Updated : Apr 22, 2025 |

Directory Parameters

Name

Example values

Description

Datasource Name

Win2K8ADA

The name to identify the directory server. You might require the name later to create a synchronization job.

Host

111.140.111.126

The IP address or the host name of the directory server that you synchronize users with.

Principal

CN=Administrator,CN=Users,DC=pansv8,DC=platform,DC=avaya,DC=com

The user name of the directory server that has permissions to create or update users.

Password

<password>

The password to connect to the directory server.

From Release 8.1.3, you can enter up to 256 characters for the directory server.

Port

389, 636

The port number of the directory used for an LDAP connection.

It is recommended to use a secure SSL connection. Typically on LDAP servers, port 389 is for a non-SSL connection and port 636 is for a secure SSL connection.

Base Distinguished Name

CN=Users,DC=pansv8,DC=platform,DC=avaya,DC=com

An element that works with the search scope or the hierarchy from where you synchronize the users.

LDAP User Schema

inetOrgPerson

The schema that defines object classes by a list of attributes where the values are mandatory or optional. The schema might differ depending on your directory server. The default value is inetOrgPerson.

Search Filter

(cn=Alex*)

The field that provides a mechanism to define the criteria for matching entries in an LDAP search operation.

For more information about Search filter, see http://msdn.microsoft.com/en-us/library/windows/desktop/aa746475(v=vs.85).aspx.

Use SSL

False when you clear the check box

The option to use SSL to connect to directory server. The default port for an SSL connection is 636.

Important:

When you add the certificate, you must select the Import using TLS option.

For more information about setting up the SSL connection, see Adding trusted certificates.

Allow Deletions

False when you clear the check box

The option to delete a synchronized user that is already removed from the directory server.

Allow Null values in LDAP

False when you clear the check box

The option to allow null values to be inserted by System Manager in LDAP.

Test Connection

-

The option to verify your LDAP connection.

Test the connection before you map attributes.

Attribute Parameters

When you click Test Connection and after the test is complete, the system displays the LDAP attributes that you can administer.

When you remove the following attributes from the mapping page, the system does not remove the communication profile handle of the user:

  • email

  • otherEmail

  • Microsoft Exchange Handle

  • Microsoft SIP Handle

  • IBM Sametime Handle

LDAP Attribute

System Manager Attribute

Description

objectGUID

sourceUserKey

The attribute that uniquely defines a user.

userPrincipalName

loginName

Note:

If you are using Microsoft Active Directory for external authentication with System Manager, the attribute userPrincipalName of the user in the external server must contain a valid value.

The attribute that defines the login name in System Manager.

sn

surname

The attribute that defines the last name of the user.

givenName

givenName

The attribute that defines the given name.

displayName

displayName

The attribute that defines the display name.

middleName

middleName

The attribute that defines the middle name.

mail

email

The attribute that defines the communication profile handle.

postalCode

postalCode

The attribute that defines the postal code of the user. The system creates the address of the user, Registered_User_Address.

streetAddress

streetAddress

The attribute that defines the postal code of the user. The system creates the address for the user with a name.

preferredLanguage

preferredLanguage

The preferred language of the user.

Mapping of the LDAP attribute to preferredLanguage must be in the LanguageCode_CountryCode format.

For the format that the preferredLanguage attribute supports, see Preferred languages.

mail

otherEmail

The attribute for the secondary email of the user.

roomNumber

room

The room number of the user. The system creates the address of the user, Registered_User_Address.

co

country

The country of the user. The system creates the address of the user, Registered_User_Address.

otherTelephone

otherBusinessPhone

The secondary business telephone number of the user, Registered_User_Address address.

facsimileTelephoneNumber

fax

The fax number of the user, Registered_User_Address address.

homePhone

homePhone

The residential phone number of the user, Registered_User_Address.

otherHomePhone

otherHomePhone

The secondary residential phone number of the user, Registered_User_Address.

mobile

mobilePhone

The mobile phone number of the user, Registered_User_Address.

otherMobilePhone

otherMobilePhone

The secondary mobile phone number of the user, Registered_User_Address.

pager

pager

The pager number of the user, Registered_User_Address address.

otherPager

otherPager

The secondary pager number of the user, Registered_User_Address.

givenName

preferredGivenName

The preferred given name of the user.

organization

organization

The organization to which the user belongs.

department

department

The department to which the user belongs.

employeeID

employeeNo

The employee ID of the user.

st

stateOrProvince

The state or the province of the user. The system creates the address of the user, Registered_User_Address.

l

localityName

The locality of the user. The system creates the address for the user, Registered_User_Address.

displayName

localizedName

The localized name of the user in different languages.

Note:

Map the LDAP attribute to localizedName in the format:Locale.Name. For example, if the locale is English and the user name is Alex, the value for displayName must be en.Alex.

displayNamePrintable

endpointDisplayName

The full text name of the user represented in ASCII. The attribute supports displays that cannot handle localized text, for example, some endpoints.

msExchHouseIdentifier

Microsoft Exchange Handle

The Microsoft Exchange communication address of the user for communication with Microsoft SMTP Server.

o

Microsoft SIP Handle

The Microsoft SIP communication address of the user that supports SIP-based communication.

manager

IBM Sametime Handle

The IBM Sametime communication address of the user that supports IBM Sametime. The format must be of type DN=IBMHandle.

I

User Provisioning Rule

Note:

If you map the telephone number (Avaya E164 handle) and UPR in datasource and the LDAP attribute values change in LDAP, during next synchronization, the system updates only the Avaya E164 handle. The system does not update the Communication Manager extension or SIP handle that is configured in UPR.

The user provisioning rule.

You can map the user provisioning rule to more than one LDAP attribute. The system joins the value of multiple LDAP attributes by an underscore (_) to map the value in System Manager. You cannot map the same LDAP attribute more than once.

The user provisioning rule data synchronizes from the LDAP directory server to System Manager only.

telephoneNumber

Phone Number

The attribute that the system maps to the Avaya E164 handle. The value for the extension is the last N digit value that is set in the Use Phone Number last ..... digits for Extension field on the User Provisioning Rule page.

The synchronization is bidirectional.

extensionName

Mailbox Number

The Messaging mailbox number.

The synchronization is bidirectional.

telexNumber

CS 1000 Extension

The extension on CS 1000, if CS 1000 is supported.

The data synchronizes from System Manager to the LDAP directory server.

primaryTelexNumber

Communication Manager Extension

The extension on Communication Manager.

The data synchronizes from System Manager to the LDAP directory server.

msDS-PhoneticLastName

surnameascii

The last name of the user in ASCII.

msDS-PhoneticFirstName

givennameascii

The first name of the user in ASCII.

msDS-PhoneticDisplayName

endPointDisplayName

The display name of the user in ASCII as displayed on the endpoint.

memberOf

userRoles

When synchronized with Enterprise Directory, the roles, rights, and restrictions for administrators are automatically configured for the correct role and inherit the capability of roles.

You can map the userRoles attribute to one of the following:

  • Groups in LDAP. For example in Active Directory, the attribute memberOf contains the fully qualified group name, such as CN=DnsAdmin,CN=Users,DC=avaya,DC=com. The system searches for DnsAdmin role name.

  • Other LDAP attribute: System searches for the exact name with the value in LDAP attribute that matches with the role in System Manager.

Button

Description

Save

Adds a new datasource or saves the changes that you made on the page.

Cancel

Cancels your action and displays the previous page.
Related information
Editing the synchronization datasource
Preferred languages