Difference between revisions of "Unify Assist"

Latest revision as of 14:41, 16 April 2024

Introduction

Unify Assist can help you in your daily workflow. It is the perfect addition to your OpenScape Desk Phone CP device connected to Unify Office. It allows you to intiate and control calls made via your desk phone.

• Click to dial
• Hotkey dialling
• LDAP search and lookup
• Call control via your desk phone

Installation

Unify Assist can be installed from the Unify Software Download server. The Installation file is signed by an official Atos CA certificate. You have to install it before installing Unify Assist to allow the operating system to validate the digital signature. Execute the following commands in a Powershell window with admin privileges to import the certificate into your local machines truststore.

Invoke-WebRequest "https://pki-crl.atos.net/certificates/AtosRootCA2015.cer" -OutFile ".\test.cer"; Import-Certificate -FilePath ".\test.cer" -CertStoreLocation Cert:\LocalMachine\Root; rm .\test.cer

LDAP

The LDAP configuration must be done via environment variables. The following configuration items are available

• CTI_LDAP_SERVERURI (required)
• CTI_LDAP_USERNAME
• CTI_LDAP_PASSWORD
• CTI_LDAP_SEARCHBASE (required)
• CTI_LDAP_FIRSTNAME_ATTR
• CTI_LDAP_LASTNAME_ATTR
• CTI_LDAP_NUMBER_ATTR
• CTI_LDAP_FILTER_ATTR

Example configuration file

CTI_LDAP_SERVERURI

The server address of the LDAP server. This item is required and must be provided in URI form: e.g. "ldap://1.2.3.4:389"

CTI_LDAP_USERNAME

The username used for login on the LDAP server. Leave blank if anonymous login should be used.

CTI_LDAP_PASSWORD

The password used for login on the LDAP server. Leave blank if anonymous login should be used.

CTI_LDAP_SEARCHBASE

The search base to use for searching. This item is required. Example: "ou=users,dc=atos,dc=net"

CTI_LDAP_FIRSTNAME_ATTR

The LDAP server attribute used as first name. Default value is: "givenName"

CTI_LDAP_LASTNAME_ATTR

The LDAP server attribute used as last name. Default value is: "sn"

CTI_LDAP_NUMBER_ATTR

The LDAP server attributes used for phone numbers. Can be a comma seperated list, e.g. "telephoneNumber,mobile,home". Default value: "telephoneNumber". Provide all attributes for the search result, that may contain numbers to dial.

CTI_LDAP_MAIL_ATTR

The LDAP server attribute used for E-mail address. If set, will be used to receive the E-mail address from the user via the LDAP server on a manual search. The E-mail address will be used to retrive the presence state of the user on Unify Office.

CTI_LDAP_FILTER_ATTR

The LDAP server attributes used for filtering users on a search. Can be a comma seperated list, e.g. "givenName,sn". Default values are provided by CTI_LDAP_FIRSTNAME_ATTR and CTI_LDAP_LASTNAME_ATTR. Every search string provided by the user will be used to filter by the attributes provided (combined with the OR operator and a wildcard at the end).

If you need to enable search on multiple specific attributes like department names, building names or job functions, just add the attribute to the CTI_LDAP_FILTER_ATTR environment variable.

CTI_LDAP_CA_CERT

When providing the LDAP server address as ldaps:// in order to establish a trusted TLS connection, a certificate needs to be provided to verify the secure connection. A path to a CA certificate needs to be provided via the environment variable.

CTI_LDAP_2ND_LINE

The LDAP server attributes used to show additional information related to the user. Can be a comma seperated list, e.g. "department,jobFunction".

If set and LDAP server returns a matching (as per the search string) value for the user, this information will be shown in the user interface on a manual search. All matching attribute values will be shown

CTI_MAX_NUMBER_RESULTS

The maximum number of results to be returned from the LDAP server. The default number is 25.

CSV file as local phonebook

Without an LDAP server, you can provide the phonebook data via a CSV file available via Windows Explorer. The format to be used for the CSV file is as follows.

• The first line of the file describes the column names and has to have the following names: FirstName;LastName;phone1;phone2;phone3
• Every entry in the file must at least have a first name or last name and one of phone1, phone2 or phone3
• Every record can have a maximum of 3 phone numbers

The file will be read on every start of Unify Assist. The path to the file has to be provided via environment variable CTI_PHONEBOOK_CSV. If changes are made to the file, Unify Assist has to be restarted.

Disable Auto-Update

The app will automatically check for a newer version on start. When a new version is available, it will notify the user and download it from the server. The digital signature of the update file is verified and afterwards the new version can be installed.

If you want to disable the automatic update, simply set an environment variable named CTI_DISABLE_AUTOUPDATE. It can have any value, as long as it is set, the automatic update functionality will be disabled.

MSI Installation

The Unify Assist is provided as MSI file to allow for centralized installation on client PCs. If you intend to use the click to dial and Hotkey dialling function, you need to set a few registry entries when installing. Below is an example registry file that can be used to set the required registry keys on your windows system.

Windows Registry Editor Version 5.00

[HKEY_CURRENT_USER\SOFTWARE\RegisteredApplications]
"UnifyOfficeCTI"="Software\\UnifyOfficeCTI\\Capabilities"

[HKEY_CURRENT_USER\SOFTWARE\UnifyOfficeCTI]

[HKEY_CURRENT_USER\SOFTWARE\UnifyOfficeCTI\Capabilities]
"ApplicationName"="Unify Assist"
"ApplicationDescription"="Unify Assist"

[HKEY_CURRENT_USER\SOFTWARE\UnifyOfficeCTI\Capabilities\URLAssociations]
"callto"="uocti"
"tel"="uocti"

[HKEY_CURRENT_USER\SOFTWARE\Classes\callto]
@="URL:callto"
"URL Protocol"=""

[HKEY_CURRENT_USER\SOFTWARE\Classes\tel]
@="URL:tel"
"URL Protocol"=""