Configure Address Book for Active Directory plugin

Introduction

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.

 

Property configuration

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>.

GUI fields

First fields are used by the GUI to say what is shown for a search and titles.

<Title>DisplayName</Title>

<Subtitle>title</Subtitle>

<TabHeaderProperty></TabHeaderProperty>

<TabhHeaderDefaultText>Employee</TabhHeaderDefaultText>

<DefaulSip>mail</DefaulSip>

Searchable fields

Next part are the searchable fields. These fields are used if no filter is selected in the attendant.

<DefaultSearch>

<Value>DisplayName</Value>

<Value>FirstName</Value>

<Value>LastName</Value>

</DefaultSearch>

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.

Field specification

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:

<Item>

<DatabaseName>DisplayName</DatabaseName>

<GuiName>Naam</GuiName>

<Type>None</Type>

<Order>1</Order>

<FilterOption>False</FilterOption>

</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.