[Advanced] Addressbook Providers (Conf)¶
Using this section users can configure an external addressbook provider as LDAP or an Active Directory system.
First of all, users must create a new address book provider. To add a new address book, click on New LDAP Provider or New Exchange Provider, enter the name of the provider, press the Save Changes button and then Back.
To fill in fields in an easier and quicker way, press the Preset button and select one provider from the arrow icon (LDAP or Microsoft Active Directory).
Note
The Connection INFO should fit the company domain, and the Attribute Mapping represents the default configuration and can be changed only if LDAP scheme has been changed or the user is searching for another field.
LDAP Providers¶
This section explains the settings when clicking on New LDAP Provider. To assist you in filling out the fields, you can select a preset on the top right. Possible presets are LDAP and Active Directory.
Hint
Important note: if an OU with a symbol is used, (e.g., OU=+1) it needs to be encoded to work in LDAP providers. Addressbook providers offer only one possibility to do this: Leave the base path field empty. Instead configure the base path in the ldap URL field and encode the OU. In our example the "+1" would translate to 2B1. The URL should look like this: ldap://hostname.local:389/OU=\2B1,DC=GeniusBytes,DC=local.
Connection INFO¶
This part contains settings to connect to the provider.
URL: the address of the address book provider.
UserDN: the user who performs queries on the provider.
Password: the password of the user specified in userDN.
Confirm password: the password entered in the upper field.
Authentication Type: authentication mechanism used by the LDAP protocol. Possible values are SIMPLE or GSSAPI.
Realm (only GSSAPI): the GSSAPI/Kerberos authentication realm.
Kerberos KDC (only GSSAPI): the KDC (Key Distribution Center) for GSSAPI/Kerberos. Usually the Domain Controller.
Base path: the starting path used to build the search path for queries.
Connection timeout: the time in milliseconds after which a connection attempt is aborted and the server is deemed unreachable.
Read timeout: the time in milliseconds to wait for a reply from th server.
Dereference aliases: specifies how the aliases are dereferenced - for further details, refer to the Aliases and Dereferencing Aliases appendix.
Context pooled: if checked, it enables the provider to use an already existing connection for users.
Target nodes: check the nodes that should have this feature.
Note
Special characters must be protected in LDAP/AD query strings. For further details, refer to Special Characters.
Attribute Mapping¶
Mapping is necessary to perform searches for queries in the external address book. Assign attribute values according to the provider configuration.
First name attribute: the attribute value for user's first name.
Last name attribute: the attribute value for user's surname.
Full name attribute: the attribute value for user's full name.
Company attribute: the attribute value for user's company.
Description attribute: the attribute value for the description.
Email attribute: the attribute value for user's email.
Telephone attribute: the attribute value for user's telephone.
Address attribute: the attribute value for user's address.
Search¶
Additional search filter: add additional search filters here.
Max count: the maximum number of results.
Testing¶
To test the connection click on Test and enter a name to search for. Click on Test.
If the search is successful, the corresponding information is displayed.
Note
An error message usually appears after a misconfiguration in the Connection INFO section. Review these settings first.
Exchange Providers¶
Connection INFO¶
Exchange version: the exchange version that is to be used. Select the correct option from the drop down menu.
Exchange EWS URL: the URL of the Exchange Web Service (EWS).
Username: the account username used to access Exchange.
Password: the password for the account specified above.
Confirm Password: confirm the password that you entered above by typing it again.
Target nodes: check the nodes that should have this feature.
UPN for impersonation: the UPN for impersonation.
Azure Provider¶
Please note that for this addressbook provider an additional Azure configuration is needed. The necessary permissions are listed below. For more information on the topic, please refer to MS Azure Configuration. Please configure the Azure Server application.
Required API Permissions¶
Please configure your Azure Provider in such a way that it allows for:
OrgContact.Read.All (Application)
User.Read (Delegated)
User.Read.All (Application)
Note that some of those will require admin consent!
Note
Please note that currently only "STARTS_WITH" search options are available due to Microsoft Graph limitations.
Connection INFO¶
Tenant name: the tenant name of the Microsoft domain. Usually this is the domain name.
Web/API Client ID: the client ID of the Microsoft Web/API that you created. Refer to MS Azure Configuration for details.
Web/API Secret: the secret of the above mentioned Microsoft Web/API.
Confirm Web/API Secret: confirm the secret here.
Target nodes: check the nodes that should have this feature.
Attribute Mapping¶
Mapping is necessary to perform searches for queries in the external address book. Assign attribute values according to the provider configuration.
First name attribute: the attribute value for user's first name.
Last name attribute: the attribute value for user's surname.
Full name attribute: the attribute value for user's full name.
Company attribute: the attribute value for user's company.
Description attribute: the attribute value for the description.
Email attribute: the attribute value for user's email.
Telephone attribute: the attribute value for user's telephone.
Address attribute: the attribute value for user's address.
Fax attribute: the attribute value for user's fax number.
Search¶
Max count: the maximum number of results.
Testing¶
Click on Test resolve name to test the connection. Enter an Impersonate username and a search filter. Then click on Test
To save changes press the Save Changes button, then Back.
To edit a provider, select the provider to edit, and press the Edit button. To save changes press the Save changes button, then Back.
To delete a provider, select the provider to delete, press the Trash button, and then Confirm.