Configure Address Book for SQL plugin

Introduction

This document is created to help people with configuring the Sql Addressbook plugin. The plugin allows you to search through your contacts in an addressbook made in SQL.

In it’s current form it uses a predefined database. You are able to rename or add columns to this structure, but several key columns are expected to be present, which will be discussed in the documentation. The exception is the note table which is expected to be in the format as specified by Anywhere365, at least in the addressbook’s current iteration.

 

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.

The default installation location should be: “C:\Program Files (x86)\Anywhere365 Attendant\plugins\Wsp.Anywhere365.SqlAddressbook”. After installation this folder will be present.

 

Position in the attendant

The SQL Addressbook makes use of two parts of the attendant, the contact card on the right side and the red circled icon on the right bar. It is important to know that only one of this type op plugin can be active on these spots. So if you have the contact card extension plugin or a different address book plugin installed then they will take precedence over the SQL Addressbook plugin and therefore the SQL Addresbook plugin will not be shown. So make certain these type of plugins are de-installed if present if you wish to use the SQL Addressbook Plugin

 

Settings in the attendant

When opening the attendant click on the bottom right circle to open the settings tab. Then click on plugins in the right bar. Then select the SQL Addressbook plugin to open the settings page where you can configure the settings for the SQL Addressbook plugin. If you click on advanced settings more settings will be available. Assuming you are using the predefined database you do not need to touch these settings unless you wish to change something. By pressing basic settings the advanced settings are closed again.

 

Basic Settings

These five settings are shown without pressing advanced settings and are the only settings that need to be specified when using the predefined database.

  • SQL Server: Name of the SQL Server to which to connect

  • Database: Name of the database. Assuming you are using the predefined database the name is contactnotesdatabase. Otherwise use the name your system administrator has given the database.

  • Username: Name of the user that can login on the database

  • Password: The user’s password. This value is ignored if integrated security is set to true

  • Integrated security: True or false. Integrated security is active if the database user is identical to the windows user and therefore they share the same password. This value is basically only applicable if you run the database locally so it is unlikely this value will be used. If set to true it will ignore the password value.

 

Advanced Settings

The advanced settings focus on changing the database layout or queries. If you are using the predefined database these should not have to be changed but if the need arises they can be changed.

  • Contact Table: This is the name of the table where the contacts are stored. The data from this table is shown in the address book. If you change this value all SQL queries that use the contact table will use this value instead. So for instance if we change the value to Test, it will go from select * from Contact to select * from Test

  • Phone Number Table: A reference table between the phonetype and contact table that stores the phonenumbers of the contacts.

  • Phone Type Table: Table that stores the different type of phonenumbers that can be used, for instance Workphone and Homephone

  • Note Table: Table that stores the notes of each contact

  • 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. Field: Name of the column in the contact table that is used for sip recognition. The default is set to email This value then gets sip: set in front of it to make it an actual sip address and this is used to retrieve the contact data from Skype for this contact, assuming the address can be found in Skype for businessSkype for Business (formerly Microsoft Office Communicator and Microsoft Lync) is an instant-messaging client used by Anywhere365. In order to use SFB, a Microsoft Skype for Business Server is required. Skype for Business is enterprise software; compared to Skype, it has different features that target businesses..

  • Private Contact: Name of the column in contact that is used to determine that the user is a private contact. If true the contact be edited, if false only the note can be edited.

  • Contact Primary Key: Primary key of the contact table. Expected to be of type string

  • Phone Type Primary Key: Primary key of the phone type table. Expected to be of type integer

  • Phone Type Name Field: Field name of the phone type name in the phone type table

  • Phone Number Field: Field name of the phone number field in the phone number table

  • Query Format: The select query that is executed to retrieve the contacts in the address book. [TABLENAME] = Contact table. [SEARCHANDFILTER] = the value of the Search Query Part. [LIMIT] = the amount of contacts to retrieve

  • Search Query Part: The where clause of the query and the value of [SEARCHANDFILTER] in the Query Format setting. The [FIELD] is defined in the next setting, Fields in search. The remainder show how it should search for the value specified in the search bar on the address book tab.

  • Fields in search: ; separated list that consists of all values to search through in the where clause. The default is Firstname;Lastname, meaning the where clause goes like where firstname or lastname like ‘%VALUE%’

  • Order query part: How to order the fields. This is also a ; list so you can decide to order on multiple fields.

  • Order ascending: Whether it should sort ascending or descending, for instance Ascending means it starts at A or 0, where Descending means it starts at Z or the highest number.

  • Use Search Query Part string on Note table as well: This means that the value of the setting Search Query Part will also be used to search through notes if set to true. [FIELD] will be replaced with the name of the column that the notes reside in and the rest of the query will be performed as it is set in that setting.

  • Amount of contacts to retrieve: The maximum amount of contacts that will be shown on the right side of the address book