User Guide Introduction - SIP Lync Interface User... · 1 Algo Lync Interface for 8180 SIP Audio...

1

Algo Lync Interface for 8180 SIP Audio Alerter

User Guide

Introduction The Algo Lync Interface uses the Microsoft UCMA 4.0 framework to enable Algo 8180 SIP Audio Alerter

devices to register indirectly to the Lync 2010 Server by registering on behalf of them. The Interface uses

the same extension as those assigned to the Algo device(s) and needs the same credentials in its

configuration file as the Algo device(s). When a call is made to an Algo extension, the Interface first

receives the call, and then translates it to a pure SIP call for the Algo device(s). The Interface is able to

support the ring and strobe light alert via the Algo 8180 SIP Audio Alerter, 8188 SIP Ceiling Speaker,

8186 SIP Horn Speaker, and 8128 SIP Strobe Light.

*Please note, the Algo Lync Interface is not compatible with Skype for Business. We recommend using

third party gateways by Sonus or Audiocodes to register the Algo devices with Skype for Business.

Quick Guide Before installing the Algo Lync Interface, please ensure the machine has the following:

Microsoft UCMA Runtime (specifically UCMA 4.0) (page 3-4) Microsoft .NET Framework 4.5.1 (page 4) If using a non-domain-joined machine, a Lync certificate may need to be imported:

http://<full computer name/Lync server>/certsrv (page 4-7).

Uninstall any previous versions of the Interface, and install the service as an Administrator (page 8). The

default location will be: C:\Program Files (x86)\Algo\Algo Lync Interface

Once installed, the Interface should be Running/Started in Windows Services viewer (page 8).

Depending on the machine’s security settings, the Interface may need to be allowed to communicate

through the Windows Firewall (page 9-10) or the Windows Server Firewall (page 11-12).

User information can be updated, as an Administrator, in the AlgoLyncService.exe.config file from the

Algo Lync Interface folder (page 13-15). Stop the service in the Services viewer before updating the

configuration file, and Start the services once the file has been saved. As the service is running, logs will

be generated in algo-logs.txt file in the Algo Lync Interface folder. Once the IP address(es) of the target

Algo SIP device(s) are known, they can be configured from the web interface (page 16).

http://www.microsoft.com/en-ca/download/details.aspx?id=34992

http://www.microsoft.com/en-us/download/details.aspx?id=40779

Algo Lync Interface Version 1.4

2 Algo Communication Products Ltd.

Contents

Pre-Requisites ....................................................................................................................................3

Microsoft UCMA Runtime ........................................................................................................................................ 3

Microsoft .NET Framework ...................................................................................................................................... 4

Lync Certificate ........................................................................................................................................................ 4

Algo Lync Interface Installation ..........................................................................................................8

Communicating through the Firewall ..................................................................................................9

Windows Firewall ..................................................................................................................................................... 9

Windows Server Firewall ....................................................................................................................................... 11

Updating Configurations .................................................................................................................. 13

File Configurations ................................................................................................................................................. 13

File Configuration Examples................................................................................................................................... 14

Example 1: One Device ....................................................................................................................................................... 14

Example 2: Two or More Devices ....................................................................................................................................... 15

Configuring the Algo SIP 8180 Audio Alerter ......................................................................................................... 16

Frequently Asked Questions ............................................................................................................. 17



Pre-requisites

The Interface is a background Windows service with no GUI that will need to be installed on a separate

machine from the Lync Server. Before installing the Algo Lync Interface, ensure that the machine has the

following prerequisites: Microsoft UCMA Runtime (specifically UCMA 4.0), Microsoft .NET Framework

4.5.1, and a Lync certificate, if a non-domain-joined machine is used.

1. Microsoft UCMA Runtime

Microsoft UCMA Runtime (specifically UCMA 4.0) can be downloaded directly from the Microsoft

website. It is compatible with Windows 2012 Server, Windows Server 2008 R2 Service Pack 1, Windows

8, Windows 7 Service Pack 1 (SP1) (64-bit) with .Net 4.5. The machine running this application should be

connected to the Lync domain.

If downloading on a Windows Server with GUI, Media Foundation may be required. The following steps

outline the process of installing the Media Foundation:

1. Open Server Manager and click on Add roles and features

http://www.microsoft.com/en-ca/download/details.aspx?id=34992



2. In the Add Roles and Features Wizard, click Next until you arrive at Features on the left pane

3. Select Media Foundation in the Features list and click Install

4. The server may need to be rebooted for the feature to be activated

2. Microsoft .NET Framework 4.5.1

The Microsoft .NET Framework 4.5.1 can be downloaded directly from the Microsoft website. It is

compatible with Windows Vista SP2, Windows 7 SP1, Windows 8, Windows Server 2008 SP2 Windows

Server 2008 R2 SP1 and Windows Server 2012.

3. Lync Certificate

If a non-domain-joined machine is being used, a Lync certificate may need to be imported. The

certificate could be downloaded at: http://<full computer name/Lync server>/certsrv

Note: the Full computer name can be found in the System viewer, by going to the Windows Start menu,

right-clicking Computer, and going to Properties

Once the certificate is downloaded, activation should be done via Microsoft Management Console

(MMC):

http://www.microsoft.com/en-us/download/details.aspx?id=40779

http://full/



i. In MMC, click on File and go to Add/Remove Snap-in...

ii. On the left, in Available snap-ins, choose Certificates and Add to Root Console on the right



iii. In the Certificate span-in, choose Computer account, and click Next

iv. Then choose Local computer and click Finish

v. Once back to the Add or Remove Snap-ins, click OK

vi. In the MMC Console, in the left hand pane, choose Trusted Root Certification Authorities and

then Certificate

vii. In the right hand pane, click on More Actions, go to All Tasks, and Import



viii. In the Certificate Import Wizard, ensure that the Store Location is a Local Machine and click Next

ix. Enter the location of the certnew certificate in the Browse field and click Next

x. Choose Place all certificates in the following store, make sure "Trusted Root Certification Authorities" is entered in the Certificate store field and press Next



Algo Lync Interface Installation

The Algo Lync Interface application is available on the Algo website. If there are any previous versions of

the Interface on the machine, they should be uninstalled via the Control Panel, prior to the installation

of the new version.

To install the Algo Lync Interface:

1) Install the Algo Lync Interface as an Administrator by right-clicking on the installer icon.

2) By default, the service will be installed at: C:\Program Files (x86)\Algo\Algo Lync Interface

a) Binary name: AlgoLyncService.exe

b) Configuration file: AlgoLyncService.exe.config (or AlgoLyncService.exe XML file)

c) Service logs will be generated in algo-logs.txt file

3) Once installed, verify that the Algo Lync Interface is running in the Windows Services viewer

http://www.algosolutions.com/



Communicating through the Firewall

Depending on the machine’s Firewall and security settings, the Algo Lync Interface may be blocked when

it is first installed. The following two sections will cover the steps of allowing the Interface to

communicate through the Windows Firewall or the Windows Server Firewall.

Windows Firewall 1. In the left pane of Windows Firewall, click Allow a program or feature through Windows Firewall

2. If Algo Lync Interface doesn't appear in the Allowed programs and features, click Change settings button above the programs list and Allow another program... below the program list



3. In the Add a Program window, select Algo Lync Interface and click Add

4. Algo Lync Interface should now appear in the Allowed programs and features list. Select the check box next to Algo Lync Interface, select the network locations you permit access to, and click OK



Windows Server Firewall

1. Changes in the Windows Firewall with Advanced Security can only be changed by an Administrator

2. In the left pane navigation, right-click Inbound Rules and select New rule in the right pane once on the Inbound Rules page

3. In the New Inbound Rule Wizard configure:

i. Rule Type: choose Program and click Next

ii. Program: browse C:\Program Files (x86)\Algo\Algo Lync Interface and choose AlgoLyncService

iii. Action: choose Allow the connection

iv. Profile: select the network locations you permit access to

v. Name: enter Algo Lync Interface and Finish



4. The Algo Lync Interface should now be able to communicate through the Firewall and appear in the

Inbound Rules list.



Updating Configurations The Algo Lync Interface uses the same extension as those assigned to the Algo device(s) and needs the

same credentials in its configuration file as the Algo device(s). The user information/credentials can be

updated in the XML configuration file in the main service folder.

File Configurations

The Interface should be restarted every time the credentials are changed in the service configuration

file.

1. Stop the service (in Windows Services viewer, right click on the service name, and select Stop)

2. As an Administrator, change the configuration file, AlgoLyncService.exe.config, to provide the

necessary account credentials as seen below in the examples below. The configuration file can be

edited by running Windows Notepad as an Administrator

3. Start the service again from Services (right click and select Start)

4. Check the algo-logs.txt to make sure the program has been restarted



File Configuration Examples

The Algo Lync Interface allows connections to be established with multiple Algo 8180 SIP Audio Alerter

devices. The following are sample contents of AlgoLyncService.exe.config for one or more devices.

In the following examples, the following information is needed for correct registration:

ServerFQDN is the Microsoft Lync Server that will be used (e.g. lync_server_name.domain_name)

UserDomain is the AD domain the user is logging into

UserName and UserPWD1 should be from a user enabled with Microsoft Lync Server and associated

with the URI that will be used for the UserURI” field

The UserURI is the SIP address that is enabled with Lync and configured with the target

phone/extension that you will be using. (The interface only supports users with an AD account that

have a Lync License. Contracts registered as Common Area Phones are not be supported).

NumUser specifies the number of users that will be configured via the interface. Suffixes 1-n will be

used in the configuration details for each subsequent user. For instance, UserURI1 will be used for

the first user, and UserURI2 for the second.

Example 1: One Device

<?xml version="1.0" encoding="utf-8"?>

<configuration>

<startup>

<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />

</startup>

<appSettings>

<add key="Service Port" value="5070" />

<add key="LogLevel" value="1" />

<add key="NumUser" value="1" />

<add key="ServerFQDN1" value="lync.algolab2.local" />

<add key="UserDomain1" value="algolab2.local" />

<add key="UserName1" value="u1106" />

<add key="UserPWD1" value="0000" />

<add key="UserURI1" value="[email protected]" />

</appSettings>

</configuration>



Example 2: Two or More Devices

<?xml version="1.0" encoding="utf-8"?>

<configuration>

<startup>

<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />

</startup>

<appSettings>

<add key="Service Port" value="5070" />

<add key="LogLevel" value="1" />

<add key="NumUser" value="2" />











</appSettings>

</configuration>



Configuring the Algo 8180 SIP Audio Alerter

Once the IP address of the target SIP device(s) is known, the device can be configured from the web

interface. Directions to obtain the IP address of the SIP device can be found in Algo 8180 SIP Audio

Alerter User Guide pages 8-9.

1. Open an empty web browser and enter the device’s IP address in the address field

2. In the web interface, enter the password to log in. The default password is algo. 3. In the tabs section, proceed to the Basic Settings tab and the SIP sub-tab 4. The 8180 SIP Audio Alerter treats the machine running the Interface as its server. Therefore, once

the service is running, check the algo-logs.txt file in the Algo Lync Interface folder to obtain the address and port number. Enter the information in the SIP Domain field

5. Choose Disabled for the Page Function 6. Enter your target user name in the Ring Extension field and click Save. (The Authentification ID and

Authentification Password are not necessary as they are read from the configuration file)

http://www.algosolutions.com/8180




Frequently Asked Questions

Refer to the frequently asked questions (FAQs) to help answer questions you may have about the Algo

Lync Interface. For further assistance, please contact [email protected] and send the

algo-logs.txt file from the Algo Lync Interface folder capturing the scenario in question along with the

Algo device logs, that can be found in the System > System Log tab of the Algo web interface.

Why do I need the Algo Lync Interface?

The Algo Lync Interface provides a pathway for the Algo SIP 8180 Audio Alerter devices to register to the

Microsoft Lync Server.

Where should the application be installed?

The application should be installed on a machine running Windows 2012 Server, Windows Server 2008

R2 Service Pack 1, Windows 8, or Windows 7 Service Pack 1 (SP1) (64-bit) with .Net 4.5.

What other Algo SIP devices will work with the Algo Lync Interface?

The Algo Lync Interface is compatible with Algo SIP 8180 Audio Alerter, Algo 8128 SIP Strobe Light, and

Algo 8188 SIP Ceiling Speaker. Note that only alerting is supported by the Algo Lync Application – voice

paging typically uses Polycom Group Page instead.

How can I troubleshoot if the Algo 8180 SIP Audio Alerter doesn’t ring when the phone rings?

All of the connection and registration information will be available in the algo-logs.txt file of the service

folder when the Interface is running. Please check the logs to see if the problem has been recorded in

the logs.

Some common reasons may include: restrictive Firewall settings, running the Interface on a non-domain

joined machine with no Lync certificate, errors in the configuration file, and errors in web interface

configurations.

How do I obtain the IP address of the 8180 SIP Audio Alerter?

Directions to obtain the IP address of the SIP device, can be found in Algo 8180 SIP Audio Alerter User

Guide pages 8-9.

Does the Algo Lync Interface support common area phones?

No, the interface only supports users with Active Directory accounts.

mailto:[email protected]








Does the Algo Lync Interface support “Subscribe/Notify” events (RFC 4235 and RFC 3856/3863 PIDF)?

No, the Interface is only a SIP server simulator and not a real server, therefore, not all real SIP server functions will apply. A Hunt Group can be used instead.



Troubleshooting

The logs below outline some of the errors that can be identified when configuring the Algo Lync

Interface. For further assistance, please contact [email protected] and send the algo-logs.txt

file from the Algo Lync Interface folder capturing the scenario in question along with the Algo device

logs, that can be found in the System > System Log tab of the Algo web interface.

FAILED TO VERIFY CERTIFICATE

8/4/2015 3:14:20 PM : AlgoLyncService.exe started from: C:\Program Files

(x86)\Algo\Algo Lync Interface\, log file: C:\Program Files (x86)\Algo\Algo Lync

Interface\algo-logs.txt

8/4/2015 3:14:20 PM : Connecting to interface...

8/4/2015 3:14:20 PM : Algo Lync Interface is running at 10.30.10.39:5070

8/4/2015 3:14:20 PM : Interface is running ...

8/4/2015 3:14:41 PM : Device registered: u1102

8/4/2015 3:14:47 PM : ERROR: Failed to verify certificate.

8/4/2015 3:14:47 PM : Please import necessary certificate to establish a connection

to the server.

8/4/2015 3:14:47 PM : Lync endpoint created for : u1102

If a non-domain-joined machine is being used for the Algo Lync Interface, a Lync certificate may need to

be imported. See page 4 for details. The certificate error may also appear if the IP address of the Front

End server (FQDN) is being used instead of the full name.

THE ALGO LYNC INTERFACE CANNOT CONNECT TO THE LYNC SERVER








8/4/2015 1:06:31 PM : ERROR: connection failure, endpoint cannot connect to the

server.

8/4/2015 1:06:31 PM : Transport error occurred while sending.


The Interface is having problems connecting to the Lync Server. Check that the correct ServerFQDN is

used in the configuration file. If the problem persists, please contact your Lync Server Administrator.

mailto:[email protected]



THE ALGO LYNC INTERFACE DOES NOT RECEIVE A REGISTER REQUEST FROM THE ALGO DEVICE







See pages 9-12 to allow the Algo Lync Interface to communicate through the firewall. If the Firewall

settings have been configured, check that the Algo Device is configured properly and is on the same LAN

as the machine running the Algo Lync Interface.

NON-EXISTENT EXTENSION ERROR







8/4/2015 4:17:57 PM : REGISTER from a NON-EXISTENT extension u1105

8/4/2015 4:17:57 PM : REGISTER from a NON-EXISTENT extension u1105

Check that the UserName value matches that entered in the Ring Extension field of the Algo Web

Interface. The Interface is case sensitive and allows characters and alphanumeric usernames with no

spaces.

UNABLE TO AUTHENTICATE THE CREDENTIALS








8/4/2015 4:45:08 PM : ERROR: authentication failure, invalid credentials. Please

review the configuration file and try again.

8/4/2015 4:45:08 PM : Unable to perform authentication of credentials.


Domain information provided in the configuration file is not accepted by the Lync server. Double check

that the user (UserURI) is associated with the Active Directory (AD) domain (UserDomain) provided in

the configuration file. If problems persist, contact your Lync Server Administrator.



LOG ON DENIED








8/4/2015 4:47:08 PM : ERROR: authentication failure, invalid credentials. Please

review the configuration file and try again.

8/4/2015 4:47:08 PM : The log on was denied. Check that the proper credentials

are being used and the account is active.


Check that the correct UserURI and UserPDW was configured. If the problem persists, contact your Lync

Server Administrator in regards to the user account information.

CALLS NOT GOING THROUGH








8/4/2015 5:01:19 PM : Lync endpoint created for: u1102

The Algo device was able to successfully register with the Lync server, however the SIP calls are not

reaching the device. Double check UserURI credentials used for registration purposes. If the problem

persists, contact your Lync Server Administrator in regards to the user account information.

User Guide Introduction - SIP Lync Interface User... · 1 Algo Lync Interface for 8180 SIP Audio...

Documents

Transcript of User Guide Introduction - SIP Lync Interface User... · 1 Algo Lync Interface for 8180 SIP Audio...