AC Voca Installation Manual - AudioCodes · Notice ACVoca|InstallationManual Notice...

Installation Manual

AudioCodes Speech-Driven Dialing Solution for Enterprises

AC Voca

Version 7.8

Notice AC Voca | Installation Manual

Notice

Information contained in this document is believed to be accurate and reliable at the time ofprinting. However, due to ongoing product improvements and revisions, AudioCodes can-not guarantee accuracy of printed material after the Date Published nor can it acceptresponsibility for errors or omissions. Updates to this document can be downloaded fromhttps://www.audiocodes.com/library/technical-documents.

This document is subject to change without notice.Date Published: May-26-2020

WEEE EU DirectivePursuant to the WEEE EU Directive, electronic and electrical waste must not be disposed of withunsorted waste. Please contact your local recycling authority for disposal of this product.

Customer SupportCustomer technical support and services are provided by AudioCodes or by an authorizedAudioCodes Service Partner. For more information on how to buy technical support for AudioCodesproducts and for contact information, please visit our website athttps://www.audiocodes.com/services-support/maintenance-and-support.

Documentation FeedbackAudioCodes continually strives to produce high quality documentation. If you have any comments(suggestions or errors) regarding this document, please fill out the Documentation Feedback formon our website at https://online.audiocodes.com/documentation-feedback.

Stay in the Loop with AudioCodes

Related Documentation

Document Name

AC Voca Release Notes

AC Voca Administrator's Guide

Document Revision Record

LTRT Description

23722 Updated document for Version 7.8.0

- ii -

https://www.audiocodes.com/library/technical-documents

https://www.audiocodes.com/services-support/maintenance-and-support

https://online.audiocodes.com/documentation-feedback

http://www.twitter.com/audiocodes

http://www.facebook.com/audiocodes

http://www.linkedin.com/companies/audiocodes

http://www.youtube.com/user/audioserge

http://blog.audiocodes.com/

https://techdocs.audiocodes.com/ac-voca/release-notes/version-780/Default.htm

https://techdocs.audiocodes.com/ac-voca/administrators-guide/version-780/Default.htm

Notice AC Voca | Installation Manual

LTRT Description

23723 Updated document for Version 7.8.1.■ New sections: Hardware Requirements; System Capacity; AC Voca

Scheduler Tasks; Configuring AC Voca DNN Speech RecognitionMode■ Updated sections: Using CleanWindows Installation; Configuring the OSN

IP Address; Configuring the OSN IP Address; Installing AC Voca;Configuring Enghouse Interactive’s Communication Portal (CP); ConfiguringEnghouse CP Additional Language Support; Installing the AC Voca License;Installing CT Connect Media Gateway License; Acapela non-Hebrew Text toSpeech; Running the LDAP Client Setup in AC Voca CloudMode; Runningthe LDAP Client Setup in AC VocaOn-premises Mode; Entering Fields underLDAP Connection Tab; Setting up LDAP Client Synchronization;Troubleshooting LDAP Client Connectivity; Installing LDAP Client Service;Configuring the LDAP Client File (removed)

23724 Updated document for Version 7.8.2.■ Updated sections: Getting Started; Installing AC Voca; Configuring Enghouse

CP Additional Language Support (Optional); Installing Text to Speech Engine;Updated screens for LDAP synchronization

- iii -

Content AC Voca | Installation Manual

Table of Contents

1 Introduction 12 Getting Started 2

Hardware Requirements 2SystemCapacity 2Entries Support 2Using CleanWindows Installation 3

Additional Software Installation 3Disabling Virtual Memory Paging File 3

Using AudioCodesMediant 800 Installation 4InstallingWindows Security Updates 4Configuring the OSN IP Address 4Configuring the Server System Time Settings 9

3 Installing AC Voca 114 Configuring AC Voca System 14

AC Voca Scheduler Tasks 14Configuring Enghouse Interactive Communication Portal (CP) 19Configuring Enghouse CP Additional Language Support (Optional) 29

5 Installing the AC Voca License 366 Installing Third-Party Licenses 40

Installing Enghouse Interactive License 40Installing Control Panel License 40Installing CTConnect Media Gateway License 42

Installing Text-to-Speech Engine 42Acapela non-Hebrew Text to Speech 42

7 Configuring AC Voca DNN Speech Recognition Mode 478 Configuring AC Voca LDAP Synchronization 48

LDAP Client Requirements 48Hardware andOperating System Requirements 48Network Requirements 48LDAP Synchronization Requirements 48

Running the LDAP Client Setup 48Running the LDAP Client Setup in AC Voca CloudMode 49Running the LDAP Client Setup in AC VocaOn-premises Mode 49

Configuring the LDAP Client 50Setting up LDAP Client Synchronization 50

Entering Fields under LDAP Connection Tab 51Entering Fields under LDAP User Attributes Tab 52Entering Fields Under VocaNOMConnection Tab 53

Configuring Files in LDAP Client On-premises Mode 54Configuring the Hosts File 55

Testing LDAP Client Connectivity 55

- iv -

Content AC Voca | Installation Manual

LDAP Server Connectivity Testing 55VocaNOM Server Connectivity Testing 56

Troubleshooting LDAP Client Connectivity 57Troubleshooting Customer’s LDAP Server 57LDAP Client Does not Connect to the VocaNOM Server 59

Error [Run] [LDAP import] edmws exception:Value Cannot be Null 60Installing LDAP Client Service 61

9 Improving LDAP Synchronization 62Basic LDAP Filters 62Advanced LDAP Filters 62LDAP User Attributes 63

10 Configuring SBC Settings for AC Voca 64Coder Settings 64DelayedOffer SDP Settings 64Terminating SIP OPTIONS Requests 64Alternative Routing Settings 64

11 Installing Signed Certificates on the IIS 65Managing Certificates in theMMC Snap-in 65Adding a Certificate 68Selecting a Certificate in IIS Manager 68

12 Enabling .NET Framework 3.5 on Windows 7013 Useful Topics 74

- v -

CHAPTER 1 Introduction AC Voca | Installation Manual

1 IntroductionAC Voca provides a state-of-the-art voice recognition service for enterprises, enhancing day-to-daycustomer interface and employee productivity by making organizational contacts easily accessiblefrommultiple user environments by voice.Combining powerful speech recognition engine with a simple-to-use conversational interface, ACVoca introduces a reliable, 24x7 call routing solution that reduces costs, increases the employee'sproductivity and enhances caller experience and satisfaction.AC Voca easily integrates with any standard PBX based on analog, digital and IP networkprotocols and can be deployed as a secured cloud service or On-premises.

- 1 -

CHAPTER 2 Getting Started AC Voca | Installation Manual

2 Getting StartedThere are a number of ways to install the AC Voca system:■ Clean Windows Installation:A customer provides a clean-installedWindows 2016 (or

Windows 2012 R2) system with the latest security updates. The installation will be provided byAudioCodes as a downloadable URL.

■ AudioCodes Mediant 800 Installation: AudioCodes provides aMediant 800 with a pre-installedWindows 2016. The installation package will be located at C:\ACVoca_Installer.

■ Pre-installed:AudioCodes offers Voca Software as a Service (SaaS) as a cloud deployment.Please contact your AudioCodes representative for more information on this option.

The default Administrator's password is "pass123". It is highly recommended to changethe password according to the Enterprise's policy. The updated password must bestored in a secure location, so that it is accessible to those that need to it.

Hardware RequirementsThe AC Voca server requires the followingminimal hardware configuration for On-premises install-ation:■ CPU: Intel Core i7-5th Gen@ 2.7GHz with 4 cores or higher - dedicate all cores; enable hyper-

threading.■ RAM: 32GB■ SSD: 256GB■ NIC: 1GB Ethernet card■ Operating System:Windows Server 2016For private cloud installations, theminimal hardware configuration is:■ For AWS:Use c5.2xlarge instances or higher■ For other configurations:Contact your AudioCodes representativeSelf-installation is designed to support single tenant deployments. For multi-tenant deployments,please contact your AudioCodes Sales or Technical Support representative.

System CapacityThe system supports the following channels capacity:■ For Hebrew andGerman, up to 6 concurrent channels are supported■ For English, up to 2 concurrent channels are supported■ For Spanish (United States, Spain, Central and South America), up to 30 concurrent channels

are supported

In cases of mixed languages under a single tenant, the service is limited to the lowestnumber of supported channels per language.

Entries Support■ Up to 17,000 entries

- 2 -


Using Clean Windows InstallationIt is the customer’s responsibility to provide a clean-installed licensed Windows 2016 (or Windows2012 R2) system with the following requirements:■ .NET Framework Features 3.5

If the server has Internet connectivity during installation, the framework will be installedautomatically. Otherwise.NET 3.5 should be pre- installed (see Enabling .NETFramework 3.5 onWindows on page 70).

■ Disabled Virtual Memory paging file■ Latest security updates■ Static IP address

Additional Software InstallationThe user must not install any additional software on the server, including anti-virus or any real timescanner. Installation of any third-party software may lead to performance issues, stability problemsandmay cause unpredictable results.

Disabling Virtual Memory Paging FileThe procedure below describes how to disable the Virtual Memory Paging file.

➢ To disable Virtual Memory Paging File on a Windows System1. Press theWindows key and openControl Panel.2. Navigate toSystem and Security > System, and then click Advanced system settings in

the left pane.

3. In theSystem Properties dialog box, click theAdvanced tab, and then click Settings…under the 'Performance' group.

4. Click theAdvanced tab, and then click the Change… button.

- 3 -


5. Select the drive that it is on, and then click theNo paging file option.6. Clear the 'Automatically manage paging file size for all drives' check box.7. Click Set, and then click OK.8. Select Restart Now to apply the changes, and then disable virtual memory.

Using AudioCodes Mediant 800 InstallationBefore installing the AC Voca system on AudioCodes Mediant 800, do the following:■ Install Windows 2012 R2 Security Updates■ Configure the OSN IP address■ Configure the Server System Time Settings

Installing Windows Security UpdatesInstall Windows Security Updates to run the latest service patches and install all missing updates.

Configuring the OSN IP AddressThe AC Voca system must have a static IP address. You can configure a static IP address for theOSN server on theMediant 800.

If you are connected remotely, performing this step will disconnect you from thesystem. After performing this step, you can re-connect the system with its new locationand IP address.

➢ To configure a static IP address for OSN:1. Press theWindows key.2. In the 'Search' text box, enter "View Network connections", and then press Enter.

3. Right-click the Intel(R) Ethernet Connection I217-LM network connection, and then from theshortcut menu, select Rename.

- 4 -


4. Assign the new alias name as Internal.

5. Right-click the Internal network connection, and then from the shortcut menu, chooseProperties.

6. Double-click Internet Protocol Version 4 (TCP/IPv4).

- 5 -


7. Enter the IP address and DNS server addresses.8. Click Advanced.

9. Clear the 'Automatic Metric' check box, and then in the 'InterfaceMetric' field enter "1".

- 6 -


A low metric number indicates higher priority. A high metric number indicates lowpriority.

10. Click OK to apply the configuration.

- 7 -


- 8 -


11. Click OK to close the Internal Properties window.12. Close theNetwork Connectionswindow.

Configuring the Server System Time SettingsFor AC Voca system multi-time zone support, Windows 2012 R2 must be configured in the UTC system time zone. The procedure below describes how to configure your server system timesettings.

Verify that your server time is correctly set to UTC time. Otherwise, perform thefollowing procedure.

➢ To configure the server system time settings:1. Right-click the server time and select Adjust date/time.

2. Assign the correct UTC time zone, date and time and then save the settings.

- 9 -


- 10 -

CHAPTER 3 Installing AC Voca AC Voca | Installation Manual

3 Installing AC VocaThe procedure below describes how to install AC Voca. As noted in Getting Started on page 2,there are a number of ways to install the AC Voca system.

A restart may be required during installation. After the restart has completed, log in tothe server and the installation process will continue automatically.

➢ To install AC Voca:1. Double-click the AC Voca file to start the installation.

2. After launching the installer, the AudioCodes logo appears:

3. The AC Voca EULA information page appears. Youmust accept the conditions to continue.

- 11 -


4. The AudioLogs directory window appears. The AC Voca system records and saves the speechrequest in an audio logs directory. Assign theAudioLogs directory and click Next.

5. A window appears displaying the components that are to be installed. Click Install.

6. Prerequisites and required third-party applications are being installed.

- 12 -


7. When completed, the installer displays the following screen. Click Close to restart the server.

- 13 -

CHAPTER 4 Configuring AC Voca System AC Voca | Installation Manual

4 Configuring AC Voca SystemThe following describes how to configure the AC Voca system. This configuration procedure shouldbe performed after completing the AC Voca Installation procedure.

AC Voca Scheduler TasksThe following describes how to configure the AC Voca system Scheduler tasks:■ Voca cleanup scheduler task■ Voca backup scheduler task

➢ To configure Voca Task Scheduler:

1. Press theWindows key, and then openAdministrative Tools.2. Open the Task Scheduler.3. Right-click Task Schedule Library, and then chooseNew Folder.

4. In the 'Name' field, enter "Voca", and then click OK.

➢ To configure Voca cleanup scheduler task:1. Right-click Voca Task Scheduler library > Import Task.

- 14 -


2. Browse to the cleanup task configuration file location -C:\NSC\VOCA_Scripts\Cleanup_script\Files Cleanup.xml, and then click OK.

3. Click Change User or Group.

4. In the 'Enter the object name to select' field, enter "Voca", and then click Check Names.

- 15 -


5. Click OK.6. In the Task Scheduler, enter your credentials (To obtain your credentials, contact your

AudioCodes representative).

➢ To configure Voca backup scheduler task:1. Right-click on theVoca Task Scheduler library, and then click Import Task.

- 16 -


2. Browse to the backup task configuration file location at C:\NSC\VOCA_Scripts\BackupScheduler/, and then select your system dialect file.

3. Click Open.

4. Click Change User or Group.

- 17 -


5. In the 'Enter the object name to select' field, enter "Voca", and then click Check Names.6. Click OK.

7. In the Task Scheduler, enter your credentials (To obtain your credentials, contact yourAudioCodes representative).

- 18 -


Configuring Enghouse Interactive CommunicationPortal (CP)Enghouse Interactive (CP) is a third-party application responsible for SIP connectivity between acustomer's PBX and the AC Voca speech recognition agent.

➢ To configure Enghouse Interactive’s CP:1. Launch the CP Console 10.3.

2. When prompted to set a password, select the 'I don’t want to use…' check box, and then clickOK.

3. When the configuration wizard starts, click Next.

- 19 -


4. When prompted, enter the passwordAC123456.

5. Click Finish when the configuration completes.

- 20 -


6. On theECS view tab, select Engine Settings > Dispatcher.

- 21 -


7. UnderDispatchers, on the right pane, right-click IP channels, and then click Set Dispatcher.

8. Select Voca_ 3.0.xxMT.9. Select the 'Restart script after error' check box, and then click Set Dispatcher.10. If the following Information window appears, click OK.11. If the channel is not active, right-click IP Channels, and then select Activate Dispatcher.

12. On the ECS view tab, select Engine Settings > Speech > Interface Configurations > ASRDirect APIs >MRCP_ASR.

- 22 -


13. Make sure all the parameters appear as shown below.

14. In the 'MRCPv2 server address' field, assign the AC Voca local static IP address and port.15. On the ECS view tab, select Engine Settings > Speech > Interface Configurations >

MRCP Local SIP Track.

- 23 -


16. Make sure all the parameters appear as shown below.

17. In the 'SIP stack address' field, assign the AC Voca local static IP address and port.18. In the ECS view, right-click the computer name, and then select Restart CP Engine(s).

- 24 -


19. Click theRestart immediately option, and then and click OK.

20. Configure the service account of Enghouse Interactive Enterprise Communications Serverservice.a. OpenAdministrative Tools > Services.b. Open theEnghouse Interactive Enterprise Communications Server service.

- 25 -


c. Select the Log On tab, and then click the This account option.

- 26 -


d. Enter the .\Voca account name.e. Enter and confirm your password. To get the credentials, please contact your AudioCodes

representative.f. Click OK.

- 27 -


g. Click OK when the following screen appears.21. Configure theMedia Gateway IP address settings.

a. Edit theMedia Gateway configurator fileC:\Program Files\Enghouse Interactive\MediaGateway\conf\vars.xml, using Notepad++.

b. Add the following line with the AC Voca system IP address.

<X-PRE-PROCESS cmd="set" data="local_ip_v4=10.31.5.250"/>

- 28 -


This line should be added before ...data=”domain$$… line.

22. Restart the server.23. Refer to Installing the AC Voca License.htmI and Installing Third Party Licenses.htmI.

Configuring Enghouse CP Additional LanguageSupport (Optional)This section describes how to add additional languages to Enghouse Control Panel. By default,Enghouse CP supports English (US) and German (Germany) languages. If Hebrew or Spanishlanguages are required, you need to run the Enghouse CP installation. If there is no need to addadditional languages, skip this section.

➢ To add additional language support:1. Run the Enghouse CP installation fileC:\ACVoca_Install\Enghouse_Interactive_

CP\Enghouse_Interactive_CP_103_GA.exe.2. The Communications Portal installation begins. ChooseModify, and then click Next.

3. In the components window, select the required languages:● English (US)● German (Germany)● Spanish (Spain)● Spain (Mexico)● Hebrew

4. Click Next.

- 29 -


5. Click Install.

6. Click Finish.

- 30 -


7. Run the Enghouse CP Service Pack installation file, C:\ACVoca_Install\Enghouse_Interactive_CP\ Enghouse_Interactive_CP_103_SPX.exe., and then click Next.

8. Click I accept.

- 31 -


9. Click Finish.

10. Activate (load) the language support and LaunchCP Console 10.3.

- 32 -


11. If the engine has not started, right-click the server name, and then clickStart CP Engine(s).

12. Click ECS View, on the lower part of the screen, and then browse theLanguage Modules.

- 33 -


13. Right-click on the Languagemodule name, and then click Load Language.

14. Restart the CP Engine by right-clicking the server name >Restart CP Engine(s).

- 34 -


- 35 -

CHAPTER 5 Installing the AC Voca License AC Voca | Installation Manual

5 Installing the AC Voca LicenseAudioCodes provides a license to use AC Voca. You can obtain a "finger print" file from the serverthat you want to install AC Voca on. This file is sent to AudioCodes so that a license file can becreated and sent back to the customer.

➢ To install the AC Voca License:1. Log in to AC Voca by navigating to https://<IP Address> in your Chrome browser.2. To get the Administrator credentials, please contact your AudioCodes representative.

The default Administrator credentials should bemodified after installation.

3. On the Licensing page (Configuration > Licensing), click Get finger print. A finger print fileis created on your server.

- 36 -


This is a sample Finger print file:

4. Send the Finger print file to AudioCodes.5. When you have received your License file from AudioCodes, copy it to your server.6. Click Choose File to select your license.

7. Select the license file name, and then click Open.

- 37 -


8. In the Set License window, click Set license to activate your AC Voca license.

9. After you have set the license, the total number of licenses should be displayed on the screen.

This is an example of what a license file looks like.

- 38 -


- 39 -

CHAPTER 6 Installing Third-Party Licenses AC Voca | Installation Manual

6 Installing Third-Party LicensesIn addition to the previous section that explains how to install the AC Voca license, you must alsoinstall the Enghouse Interactive license and a relevant Text to Speech license. This section firstdescribes how to install Enghouse Interactive licenses. Once you have completed this installation,youmust then install and configure an appropriate Text to Speech license.

Installing Enghouse Interactive LicenseYou can install the Enghouse Interactive license. Once this has been installed, you must alsoinstall the Control Panel and CTConnect Media Gateway licenses.

➢ To install the Enghouse Interactive License:1. Run the Envox License Utility application from C:\Program Files (x86)\Enghouse Inter-

active\CP\CPLicensingUtility.exe.2. Verify your System ID number and send it to AudioCodes.

Enghouse Interactive has two licenses that you need to install:■ Control Panel License■ CTConnect Media Gateway License

Installing Control Panel License

Once you have received your Control Panel license back from AudioCodes, seeInstalling Enghouse Interactive License above Paragraph Verify your System IDnumber and send it to AudioCodes. above,and continue with the following procedure.

➢ To install the Control Panel License:1. Run the Envox License Utility application from C:\Program Files (x86) \Enghouse Inter-

active\CP\CPLicensingUtility.exe.2. On the Enghouse Interactive CP Licensing Utility screen, click Load license.

- 40 -


3. Browse to the license file location, and then select theCP_import.XML license file.

4. Click Open.5. On the Enghouse Interactive System Information screen, click Apply License; a confirmation

message box appears informing you that the license has been applied successfully.

6. Click OK.

- 41 -


Installing CTConnect Media Gateway LicenseOnce you have received your CTConnect Media Gateway license back from AudioCodes (seeInstalling Enghouse Interactive License ), verify your System ID number, and then send it to yourAudioCodes representative. Continue with the following procedure.

➢ To install the CTConnect Media Gateway License:1. Copy theEnghouse CTConnect Media Gateway License XML file toC:\Program Files

(x86)\Enghouse Interactive\CTI Connect\Licenses.

The filenamemust be named import.xml.

2. Restart the server to complete the license installation.

Installing Text-to-Speech EngineThe following describes how to install the Acapela Text to Speech engine.

Acapela non-Hebrew Text to Speech

● This installation is only applicable for non-Hebrew text to speech.● The license key is dependent on your server's MAC address.

➢ To install the Acapela Text-to-Speech license:1. Verify the server MAC address.

a. Enter "cmd" in the Run dialog box, and then click OK.

b. Enter "ipconfig/all".

- 42 -


2. Find the Intel<R> 82579LM Gigabit Network Adapter, and then send theMAC address(“Physical Address”) to AudioCodes.

3. AudioCodes will send you the license key.4. Clickÿ, and then in the 'Search' field, enter "Acapela TTS Server Control Center”.5. Select it in the Search results.

6. On the Acapela TTS Server Control Center screen, click Server configuration.

- 43 -


7. Under the License System/Key Device group, selectMACIDKEY.8. Copy the received license key into the key string field.9. Click Apply, and thenOK.10. Configure theAcapela Telecom TTS Service:

a. Open Administrative Tools > Services.b. OpenAcapela Telecom TTS Service Properties.c. From the 'Startup type' drop-down list, select Automatic.d. Click Start.e. Click OK.

- 44 -


11. Enable the TTS connector on the database:a. In theRun dialog box, enter "cmd", and then click OK.

b. Run the following command:

C:\NSC\MYSQLServer\bin\mysql.exe -h localhost -u seda -p -e"UPDATE `seda`.`main_configuration` SET `Category`='TTS_Conn'WHERE `Value` = 'Acapela' AND `Name` = 'EN-US'

- 45 -


Make sure you assign the correct dialect name in the command:English USA: EN-USGerman: DE-DESpanish Spain: ES-ESSpanish USA: ES-USSpanish Mexico: ES-MX

c. Enter the password for the "seda" username (Contact your AudioCodes representative ifyou don't have the password).

- 46 -

CHAPTER 7 Configuring AC Voca DNN Speech Recognition Mode AC Voca | Installation Manual

7 Configuring AC Voca DNN SpeechRecognition ModeThis section describes how to configure and enable AC Voca Deep Neural Networks (DNN)Speech Recognition Mode, which supports English, German and Hebrew dialects only. AC VocaDNN Speech Recognition service runs on a licensed system only (see Installing AC Voca.htm).During configuration, you will be asked to enter your database credentials.

➢ To obtain your credentials:1. Contact your AudioCodes representative.2. Run theC:\NSC\VOCA_Scripts\DNN_Conf_Script\dnn.bat file.3. Enter the password for the "seda" username (Contact your AudioCodes representative if you

don't have the password).

DNN Speech RecognitionMode is enabled.

- 47 -

CHAPTER 8 Configuring AC Voca LDAP Synchronization AC Voca | Installation Manual

8 Configuring AC Voca LDAP SynchronizationThis section describes how to configure Lightweight Directory Access Protocol (LDAP)synchronization for AC VocaOn-premises and AC Voca Cloud installations.

LDAP Client RequirementsThis section describes the system requirements for the AC Voca LDAP Client.

Hardware and Operating System Requirements■ AC Voca On-premises mode: The client is running on an AC VocaOn-premises server.■ AC Voca Cloud mode: The client is running on a customer-provided server with theWindows

operating system.

Network Requirements■ The customer LDAP server should be reachable by network for AC Voca LDAP Client

The following requirements are only applicable to AC Voca Cloudmode.

■ The AC Voca Cloud server should be reachable by the network for the AC Voca LDAP Client.■ Confirm that you can access the following link: https://admin.vocanom.com

LDAP Synchronization RequirementsCustomers need to provide the following information:■ LDAP server address or FQDN name■ LDAP Base Distinguished Name (DN)■ LDAP user with “Password never expired” enabled settings

Running the LDAP Client SetupThe procedure below describes how to run the LDAP client setup in the followingmodes:■ AC Voca Cloud■ AC VocaOn-premises

- 48 -

https://admin.vocanom.com/


Running the LDAP Client Setup in AC Voca Cloud ModeThe procedure below describes how you can run the LDAP client in AC Voca Cloudmode.

➢ To run the LDAP client in AC Voca Cloud mode1. Create the C:\LDAP\VocaLdapService directory.2. Copy the LDAP client files to this directory.3. Create shortcut on the Desktop by doing the following:

a. Right-click Desktop > New > Shortcut.b. Browse toC:\LDAP\VocaLdapService\VocaLdapSetup.exe.c. Click Next, and then click Finish.

Running the LDAP Client Setup in AC Voca On-premises ModeThe procedure below describes how you can run the LDAP client in AC VocaOn-premises mode.

➢ To run the LDAP client in AC Voca On-premises mode:1. Create a shortcut on the Desktop by doing the following:

a. Right-click Desktop > New > Shortcut.b. Browse to C:\LDAP\VocaLdapService\VocaLdapSetup.exe.c. Click Next, and then click Finish.

- 49 -


2. Right-click on theVocaLdapSetup icon ; the following screen appears:

3. Select Run as administrator.

Configuring the LDAP ClientThe procedure below describes how to configure the LDAP client.

Setting up LDAP Client Synchronization

➢ To run the LDAP Client Synchronization Setup1. On the Configurator/Monitor screen, click Configure.

The following screen appears.

- 50 -


2. Click Add.3. Select the 'Enable' check box.4. In the 'Configuration Name' field, enter the appropriate name.

Entering Fields under LDAP Connection Tab

Enter the following fields under the LDAP Connection tab:

Server: Defines the LDAP server IP address or FQDN name.User: Defines the LDAP user name.Password: Defines the LDAP user password.

Ask the customer to enable the 'Password never expires' property for the LDAP user inthe Active Directory.

BaseDN: Defines the Base DNFilter: SeeUseful Topics on page 74 regarding filter configurationFilterUsage: "2"Encoding: Default

- 51 -


If you are using a secure LDAP connection, use Port 636 instead of the non-securePort 389 (default).

Entering Fields under LDAP User Attributes Tab

Enter the following fields under the LDAP User Attributes tab:

UniqueID: "objectGUID"FirstName: "givenName"LastName: "sn"Extension: "telephoneNumber"Mobile: "mobile"

Dect: If your organization is using a DECT orWLAN phone, then assignthe LDAP field of this phone type.

The DECT orWLAN phone should be enabled on the AC Voca system.

Department: "department"Email: "mail"

- 52 -


Entering Fields Under VocaNOM Connection Tab

1. Enter the following fields under theVocaNOM Connection tab:● User:Defines the Service Administrator Name● Password:Defines the Service Administrator Password● Organization ID: Defines the Service ID (ask your system integrator for the System ID)● Language: Defines the service dialect● Incremental mode:

◆ When Incremental mode is enabled, the LDAP sync disables all contacts NOT in thelist.

◆ When incremental mode is not enabled, the LDAP sync adds the contacts to thesystem (without disabling the contacts that do not appear in the updated list)

- 53 -


2. Click OK; the following screen appears:

3. Click OK.4. Click Close.

Configuring Files in LDAP Client On-premises ModeThe following files need to be configured only in On-premises mode:■ Host file■ LDAP Client file

- 54 -


Configuring the Hosts File

The procedure below describes how to configure the hosts file.

➢ To configure the hosts file:1. Using a text editor (for example, Notepad++), open the C:\Win-

dows\System32\drivers\etc\host file.2. Add a line that includes the VocaNOM System IP Address and admin.vocanom.com.

Testing LDAP Client ConnectivityThe procedure below describes how to test LDAP connectivity

LDAP Server Connectivity TestingThe procedure below describes how to test the LDAP server connection.

➢ To test the LDAP server connection:1. On the VocaNOMDirectory Client Configuration screen, select the LDAP User Attributes

tab.2. Click Test LDAP.

● If the Connection OK!!! dialog box appears, then the LDAP server is reachable by thenetwork.

- 55 -


● If theConnection ERR!!! dialog box appears, see Troubleshooting Customer’s LDAPServer on the next page.

VocaNOM Server Connectivity TestingThe procedure below describes how to test the VocaNOM server connection.

- 56 -


➢ To test the VocaNOM server connection:1. On theDirectory Import Configurations screen, click Import Now.

2. Confirm that contacts have been successfully created in the VocaNOM system.3. If the VocaNOMCloud system is not synchronized with the customer’s LDAP and some errors

appear in theC:\LDAP\VocaLdapService\logs\ log file, see LDAP Client Does not Connect tothe VocaNOM Server on page 59.

Troubleshooting LDAP Client ConnectivityThe procedure below describes how to troubleshoot LDAP client connectivity.

Troubleshooting Customer’s LDAP ServerThe procedure below describes how to troubleshoot the customer's LDAP server.

➢ To troubleshoot the customer's LDAP server:1. If you click on Test LDAP, the "Connection ERR!!!" dialog box appears.

- 57 -


2. Check theC:\LDAP\VocaLdapService\logs\ log file. If an 'LDAP error' appears, then the LDAPserver is not operational.● You can also test the Telnet connectivity to the LDAP server by running the following

command in theCommand Line console:

telnet <LDAP server name or IP> 389

For example:

telnet ldap.audiocodes.com 389telnet 10.10.10.10 389

Figure 8-1: Command Prompt

● If the LDAP server is not reachable by Telnet, check the network connectivity (firewall,routing and DNS).

3. Check if the following error appears in theC:\LDAP\VocaLdapService\logs\ log file:

Error LDAP error ……The user name or password

If so:● Verify the customer user name and password of the LDAP user

- 58 -


● Re-enter them under the LDAP Connection tab, as shown in the figure below.

LDAP Client Does not Connect to the VocaNOM ServerCheck if the following error appears in theC:\LDAP\VocaLdapService\logs\ log file.

Server was unable to process request. ---> Authentication error!!!

If so, check the User and Password under the VocaNOM Connection tab, and then re-enter thesefields if necessary.

- 59 -


Error [Run] [LDAP import] edmws exception:Value Cannot be Null

Check If the following error appears.

Error [Run] [LDAP import] edmws exception:Value cannot be null

If so, check connectivity to the VocaNOM server.For LDAP Client On-premises mode, check that the settings described in Configuring Files inLDAP Client On-premises Mode on page 54 have been applied.For LDAP Client Cloudmode, check if the VocaNOM cloud server is reachable by network and dothe following:1. Run the following command in the Command Line console.

telnet admin.vocanom.com 443

2. Check access using the following link: https://admin.vocanom.com.

- 60 -

https://admin.vocanom.com/


3. If the VocaNOM server is not reachable by Telnet or by the provided link, ask the customer tocheck network connectivity (Firewall, Routing and DNS).

Installing LDAP Client ServiceThe procedure below describes how to install the LDAP client service to enable automaticsynchronization procedures.

➢ To install the LDAP client service:1. On the Directory Import Configuration screen, click Install Service.

The LDAP client service is installed.

2. By default, the VocaNOM LDAP service runs the synchronization procedure each day at23:00.

- 61 -

CHAPTER 9 Improving LDAP Synchronization AC Voca | Installation Manual

9 Improving LDAP SynchronizationThis appendix describes how to improve LDAP synchronization by using the following filters.■ Basic LDAP■ Advanced LDAP■ LDAP User Attributes

Basic LDAP Filters■ The following LDAP filter receives active (not disabled) contacts with first and last name and

office or mobile phones.

(&(givenName=*)(sn=*)(!(|(userAccountControl=514)(userAccountControl=546)))(|(telephoneNumber=*)(mobile=*)))

■ The following filter is the same as the above, but receives only active contacts i.e., contactswithout phones.

(&(givenName=*)(sn=*)(!(|(userAccountControl=514)(userAccountControl=546))))

Advanced LDAP FiltersSometimes, after LDAP synchronization, VocaNOM contains irrelevant contacts or objects. Youneed to understand the LDAP structure and improve the filter. VocaNOM contains the non-userscontacts (printers, computers etc.).Add the following user’s object to the filter:■ objectCategory=person■ objectClass=userFor example:■ Filter without phones:

(&(objectCategory=person)(objectClass=user)(givenName=*)(sn=*)(!(|(userAccountControl=514)(userAccountControl=546))))

■ Filter with phones:

(&(objectCategory=person)(objectClass=user)(givenName=*)(sn=*)(|(telephoneNumber=*)(mobile=*))(!(|(userAccountControl=514)(userAccountControl=546))))

VocaNOM contains the following contacts:■ Dismissed employees■ Employees who have resignedThese contacts are usually disabled by the System Administrator in the Active Directory.The filters provided by AudioCodes don’t receive contacts with userAccountControl=514 anduserAccountControl=546 (i.e., disabled contacts). Sometimes the disabled contacts have otheruserAccountControl values which need to be added to the filters.

- 62 -

CHAPTER 9 Improving LDAP Synchronization AC Voca | Installation Manual

For more information on how to use the UserAccountControl flags, refer tohttps://support.microsoft.com/en- us/help/305144/how- to- use- the- useraccountcontrol- flags- to-manipulate-user-account-pro.

LDAP User AttributesThe Active Directory sometimes contains relevant information in another attribute, which needs tobe changed on the VocaNOM LDAP Client. For example, the LDAP telephoneNumber attribute isempty, but themsRTCSIP attribute contains the phone number. See the default settings below:

The figure below displays how to change the attribute in the VocaNOM LDAP client.

- 63 -

https://support.microsoft.com/en-us/help/305144/how-to-use-the-useraccountcontrol-flags-to-manipulate-user-account-pro


CHAPTER 10 Configuring SBC Settings for AC Voca AC Voca | Installation Manual

10 Configuring SBC Settings for AC VocaThis section describes how to configure the AC Voca, on the SBC side.■ Coder settings■ Delayed offer SDP settings■ Terminate OPTIONS request■ Alternate routing settings

Coder SettingsAC Voca only supports G.711U-law andG.711A-law coders.These coders should be configured in theAllowed Audio Coder Group in the IP Profile of the ACVoca SIP entity on the SBC.If the PBX system doesn’t support G.711U-law and/or G.711A-law coders, i.e., the coders do notexist in the SDP offer of the incoming SIP message, the coders should be configured in ExtensionCoders Group in the IP Profile of the AC Voca SIP entity.

Delayed Offer SDP SettingsAC Voca doesn’t support incoming SIP messages without the SDP offer.If an incoming SIP message doesn’t have the SDP offer, the 'Remote Delayed Offer Support' fieldshould be set as Not Supported in the IP Profile of the AC Voca SIP entity.

For the Remote Delayed Offer Support function, you need to assign extension coders inthe IP Profile of the AC Voca SIP entity as discussed above.

Terminating SIP OPTIONS RequestsTo terminate SIP OPTIONS messages at the SBC device (i.e., to handle them locally), create arouting rule with the following settings:

Source IP Group: ANYRequest Type: OPTIONSDestination Type: Dest AddressDestination Address: Internal

Alternative Routing SettingsWhen AC Voca does not respond, or responds with a SIP error, create the alternative routingsetting and redirect the call to customer’s extension.

- 64 -

CHAPTER 11 Installing Signed Certificates on the IIS AC Voca | Installation Manual

11 Installing Signed Certificates on the IISTo configure AC Voca to work with HTTPS, youmust first install a valid signed certificate.Use the following procedures to install the certificate on the Internet Information Server (IIS).

Managing Certificates in the MMC Snap-inYou canmanage certificates in theMMC Snap-in.

➢ To manage certificates in the MMC Snap-in:1. Open the Command Prompt window.2. EnterMMC and then press ENTER.

To view certificates in the local machine store, youmust be set up as an Administrator.

3. On the Console Root, click File > Add/Remove Snap.

- 65 -


4. From the File menu, chooseAdd/Remove Snap In.5. In the 'Available snap-ins', select Certificates.

6. Click Add > to add snap-ins.

- 66 -


7. In the Certificates snap-in group, click theComputer Account option, and then click Next.

You can select either My user account or Service account options. If you are not anAdministrator of the computer, you canmanage certificates only for your user account.

8. Click the Local computer option.

9. In the Select Computer dialog box, click Finish.10. In the Add/Remove Snap-in dialog box, click OK.11. In the Console Root window, click Certificates (Local Computer) to view the certificate

stores for the computer.

- 67 -


12. To view certificates for your account, repeat steps 3 to 6. In step 7, instead of selectingComputer account, click My User account and repeat steps 8 to 10 (Optional step).

13. From the Filemenu, chooseSave orSave As. Save the console file for later reuse (Optionalstep).

Adding a Certificate1. Navigate toConsole Root > Certificates (Local Computer) > Personal > Certificates.2. On right pane, select All Tasks > Import.3. Follow the dialog to install the certificate.

Selecting a Certificate in IIS ManagerYou can select a certificate in the Internet Information Services (IIS) Manager.

➢ To select a certificate in IIS Manager:1. Open the IIS Manager.

- 68 -


2. Right-click the default site, and then chooseEdit Site – Bindings.3. Select HTTPS binding (Port 443), and then click Edit.

4. From the 'SSL certificate' drop-down list, select the new certificate, and then click OK.

- 69 -

CHAPTER 12 Enabling .NET Framework 3.5 on Windows AC Voca | Installation Manual

12 Enabling .NET Framework 3.5 on WindowsYou can use Server Manager to enable .NET Framework 3.5. For more information, seeMicrosoft’sguidelines here.Before enabling .NET Framework 3.5, ensure that you have the following:■ Windows Server 2012 R2 or 2016■ Administrator user rights. The current user must be amember of the local Administrators group

to add or removeWindows features.■ Target computers might need network access and rights to use either alternate sources or an

Internet connection to useWindows Update.■ Installationmedia (only if you have no Internet connection to useWindows Update)

➢ To enable .NET Framework 3.5 on a Windows System:1. On the Server Manager page, click Manage, and then select Add Roles and Features to start

the Add Roles and Features Wizard.

2. On theBefore you Begin page, click Next.

3. On theSelect Installation Type page, click theRole-based or feature-based installationoption, and then click Next.

- 70 -

https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/enable-net-framework-35-by-using-the-add-roles-and-features-wizard


4. On theSelection Destination Server page, select the target server, and then click Next.

5. On theSelect Server Roles page, click Next.

- 71 -


6. On the Select Features page, select the '.Net Framework 3.5 Features' check box, and thenclick Next.

7. On the Confirm Installation Selections page, click Install.

- 72 -


On the Confirm Installation Selections page, a warning is displayed askingDo you needto specify an alternate source path?. If the target computer does not have access toWindows Update, click theSpecify an alternate source path link to specify the pathto the \sources\sxs folder on the installationmedia and then click OK. After you havespecified the alternate source, or if the target computer has access toWindowsUpdate, click theX next to the warning, and then click Install.

- 73 -

CHAPTER 13 Useful Topics AC Voca | Installation Manual

13 Useful TopicsThe following are some useful links to refer to for additional information:■ For Active Directory - LDAP Syntax Filters, go to

https://social.technet.microsoft.com/wiki/contents/articles/5392.active-directory-ldap-syntax-filters.aspx

■ For using the UserAccountControl Flags, go to https://support.microsoft.com/en-us/help/305144/how-to-use-the-useraccountcontrol-flags-to-manipulate-user-account-pro

■ For LDAP Filter Syntax, go to http://www.ldapexplorer.com/en/manual/109010000-ldap-filter-syntax.htm

- 74 -





http://www.ldapexplorer.com/en/manual/109010000-ldap-filter-syntax.htm

http://www.ldapexplorer.com/en/manual/109010000-ldap-filter-syntax.htm

This page is intentionally left blank.

CHAPTER 13 Useful Topics AC Voca | Installation Manual

- 75 -

International Headquarters1 Hayarden Street,Airport CityLod 7019900, IsraelTel: +972-3-976-4000Fax: +972-3-976-4040

AudioCodes Inc.200 Cottontail LaneSuite A101ESomerset NJ 08873Tel: +1-732-469-0880Fax: +1-732-469-2298

Contact us: https://www.audiocodes.com/corporate/offices-worldwideWebsite: https://www.audiocodes.com/

©2020 AudioCodes Ltd. All rights reserved. AudioCodes, AC, HD VoIP, HD VoIP Sounds Better,IPmedia, Mediant, MediaPack, What’s Inside Matters, OSN, SmartTAP, User Management Pack,VMAS, VoIPerfect, VoIPerfectHD, Your Gateway To VoIP, 3GX, VocaNom, AudioCodes OneVoice, AudioCodes Meeting Insights, AudioCodes Room Experience and CloudBond are trade-marks or registered trademarks of AudioCodes Limited. All other products or trademarks are prop-erty of their respective owners. Product specifications are subject to change without notice.

Document #: LTRT-23724

http://https//www.audiocodes.com/corporate/offices-worldwide

http://https//www.audiocodes.com/

AC Voca Installation Manual - AudioCodes · Notice ACVoca|InstallationManual Notice...

Documents

Transcript of AC Voca Installation Manual - AudioCodes · Notice ACVoca|InstallationManual Notice...