Configure Address Book for Active Directory plugin
This document is created to help people with configuring their address book plugins.
The improvements make it possible to configure what values from the database are shown, which values can be called, mailed or edited and. Also you can choose which values are shown in the list of search results. If no filter is selected it is possible to define a set of fields in the database that are searched.
Installation & folders
The installation folder is default set to “C:\Program Files (x86)\Anywhere365 Attendant\” but can be changed on installation. All the plugins will be installed in the folder called plugins, if this is not present when you install a plugin it will be created.
For all our samples we will use the AD Addressbook as sample. Default Ad Addressbook installation location should be: “C:\Program Files (x86)\Anywhere365 Attendant\plugins\Wsp.Anywhere365.AdAddressbook”. After installation this folder will be present.
In the installer are some options that will create an XML with settings that are used to contact a server. There are more options available when you open the file AddressbookConfig.xml in the plugin installation folder.
If you open the file AddressbookConfig.xml you will see the next structure:
<?xml version="1.0" encoding="utf-8"?>
In the future it will probably be possible to add more Credentials by copying the <credentials></credentials> part.
Here is an explanation for the fields:
- Host - location of the server.
- Base - If a server is not configured to forward to the right folder this value can be set to add a base folder to the connection.
- Port - If another port is specified then the default port for LDAP, you can configure it by setting this property.
- User - The username that is configured to be authenticated on the server for LDAP.
- Password - Password of the user above, which is hashed. At this point it can only be set on installation.
Besides the information of the Server(s) you can also set some other settings for all servers.
- MaxEmptyResultsPerServer - Maximum number of results when there are no search and filters are defined. To disable set to 0.
- MaxSearchResultsPerServer - Maximum number of results when there is a search defined. To disable set to 0.
- DataInformationFile - Name of file with specification of fields that are retrieved from the database.
The file named “DataInformation.xml” by default contains an XML structure with values that are retrieved from a database. Also is configured which label is used before a value in the Graphical interface of the attendant and if a value is searchable at start or if it is possible to filter for a field.
The Data Information XML is a big file and I will try to split it in some pieces below and explain the values.
All items of the XML are beneath the main node called <DatabaseInfo></DatabaseInfo>.
First fields are used by the GUI to say what is shown for a search and titles.
- Title - This is a field from the database that is shown in the search results and above a search result with the details.
- SubTitle - Shown as value next to the Title in the search results. Also the name of a field in the database is used.
- TabHeaderProperty - In some addressbooks it is possible to configure tabs for items beneath items. This is nog available in any LDAP addressbooks yet.
- TabhHeaderDefaultText - Same as TabHeaderProperty.
- DefaulSip - This field from the database is used as standard SIPThe Session Initiation Protocol (SIP) is a protocol to make multimedia communication (audio, video and other data communication) possible and it is also used for Voice over IP (VoIP). SIP has similarities with other Internet protocols such as HTTP and SMTP. address. You set this mostly for the default mail address for users.
Next part are the searchable fields. These fields are used if no filter is selected in the attendant.
The trick is just to add or remove <Value></Value> Items. The value in these nodes is a field from the database. When nog filter is selected and you enter something in the searchbox the values specified will be searched. So with current values if displayname, firstname or lastname of an item matches the value entered in the search it will show in the search results.
Last part of the XML are specified items. All <Item></Item> nodes have the same values, they are saying how an item is shown in the database and what it label looks like. The items are shown in the detail part for a selected contact.
The XML for an item:
- DatabaseName - The field in the database of which the value will be displayed if it is available.
- GuiName - The label shown in front of the value in the Graphical interface. In the screenshot it is shown bold.
- Type - Some values can be of a type, think of mail addresses or phone numbers. Default you show set this value to None for just text values. Possibilities are:
- Mail: for a mail address, it is possible to mail this person from within the attendant.
- Phone: A phone number, an option will be added in the attendant to call this number.
- DateTime: the value is a date in the database, it wil be formatted to the current culture.
- Editable: The value is editable, used for notes in our Exchange addressbook.
- Order - The lowest value of order will be shown first in the list and the highest will be at the bottom.
- FilterOption - If set to true a filter icon will be added after the value and the GuiName will be added in the list of filters.
Did you find this page helpful?
Sorry about that
Why wasn't this helpful? (check all that apply)
Thank you for your feedback.
Want to tell us more?
Email your feedback to our documentation team.
Thanks for taking the time to give us some feedback.