AudioCodes cX-UM Installation Manual
Installation Manual
AudioCodes One Voice for Microsoft® Skype for Business
cX-UM Connector
Installation Manual
Version 0.1.4
Installation Manual Contents
Table of Contents
1 Introduction ......................................................................................................... 9
2 cX-UM Data Flow ............................................................................................... 11
3 Azure Notification Handler App Service and Service Bus ............................. 13
4 SIP Interface ...................................................................................................... 15
4.1 Unsolicited MWI ..................................................................................................... 15
4.1.1 Backup SIP Hosts .................................................................................................... 15
4.2 Subscribe-Based MWI ........................................................................................... 15
5 cX-UM Connector System Requirements ........................................................ 17
6 Users Configuration .......................................................................................... 19
6.1 CSV File ................................................................................................................. 19
6.2 Users Modification .................................................................................................. 19
6.3 CSV file Location .................................................................................................... 19
6.3.1 Local Storage ........................................................................................................... 19
6.3.2 Azure Blob Storage .................................................................................................. 19
7 High Availability ................................................................................................ 21
7.1 Enabling High Availability ....................................................................................... 21
7.2 High Availability Operation ..................................................................................... 21
7.2.1 Azure Users Blob Change ....................................................................................... 21
7.2.2 Server Up/Down ...................................................................................................... 21
7.2.3 Users Distribution .................................................................................................... 21
8 License ............................................................................................................... 23
8.1 License Generation ................................................................................................ 23
8.2 Trial License ........................................................................................................... 23
9 Installation and Configuration ......................................................................... 25
9.1 Prerequisites .......................................................................................................... 25
9.1.1 UCMA 5 Runtime ..................................................................................................... 25
9.1.2 Azure CLI on Windows ............................................................................................ 26
10 Azure Setup ....................................................................................................... 27
10.1 Resource Group ..................................................................................................... 27
10.2 Service Bus ............................................................................................................ 27
10.3 Notification Handler Web App ................................................................................ 27
10.4 Azure Application ................................................................................................... 28
11 cX-UM ....................................................................... Error! Bookmark not defined.
12 cX-UM Configuration ......................................................................................... 33
12.1 Start cX-UM ............................................................................................................ 33
12.2 Configure cX-UM .................................................................................................... 33
12.2.1 cX-UM config-only Mode ......................................................................................... 33
12.2.2 cX-UM Swagger Configuration ................................................................................ 33
12.3 Testing cX-UM Configuration ................................................................................. 34
12.4 Run cX-UM as Windows Service ........................................................................... 34
Version 0.1.4 3 cX-UM Connector
cX-UM Connector
12.4.1 Syslog Viewer Configuration ................................................................................... 34
12.4.2 Start cX-UM Windows Service ................................................................................ 35
13 Users Configuration .......................................................................................... 37
13.1 CSV File ................................................................................................................. 37
13.2 Users Modification .................................................................................................. 37
13.3 CSV File Download and Upload ............................................................................. 37
14 License ............................................................................................................... 39
14.1 Trial License ........................................................................................................... 39
14.2 Production License ................................................................................................. 39
15 cX-UM High Availability Configuration ............................................................ 41
15.1 Azure Blobs Storage .............................................................................................. 41
15.1.1 Users Blob File ........................................................................................................ 41
15.1.2 User Blob Change Event ......................................................................................... 41
15.1.2.1 Service Bus Topic ....................................................................................42
15.1.2.2 Storage Change Event .............................................................................42
15.2 cX-UM Configuration .............................................................................................. 42
15.3 HA Verification ....................................................................................................... 43
A HA – SIP Message Redirection ........................................................................ 47
A.1.1 Incoming Messages Redirection ............................................................................. 47
B XUM Limitations ................................................................................................ 49
C Known Issues .................................................................................................... 51
C.1 Working with Internet Explorer ............................................................................... 51
D Sample Messages ............................................................................................. 53
D.1 Unsolicited MWI ..................................................................................................... 53
D.2 Subscribe Based MWI ............................................................................................ 53
Installation Manual 4 Document #: LTRT-40732
Installation Manual Contents
List of Figures
Figure 9-1: UCMA 5.0 Setup .................................................................................................................. 25
Figure 9-2:Installation Complete ............................................................................................................ 26
Version 0.1.4 5 cX-UM Connector
cX-UM Connector
List of Tables
Table 5-1: cX-UM Connector System Requirements ............................................................................. 17
Table 6-1: CSV File ................................................................................................................................ 19
Table 7-1: Server Up/Down .................................................................................................................... 21
Table 12-1: Swagger Configuration ........................................................................................................ 34
Table 13-1: Mandatory User Configuration ............................................................................................ 37
Table 15-1: All cX-UM Configuration Parameters .................................................................................. 43
Installation Manual 6 Document #: LTRT-40732
Installation Manual Notices
Notice
Information contained in this document is believed to be accurate and reliable at the time of
printing. However, due to ongoing product improvements and revisions, AudioCodes cannot
guarantee accuracy of printed material after the Date Published nor can it accept responsibility
for errors or omissions. Updates to this document can be downloaded from
https://www.audiocodes.com/library/technical-documents.
This document is subject to change without notice.
Date Published: July-15-2020
WEEE EU Directive
Pursuant to the WEEE EU Directive, electronic and electrical waste must not be disposed of
with unsorted waste. Please contact your local recycling authority for disposal of this product.
Customer Support
Customer technical support and services are provided by AudioCodes or by an authorized
AudioCodes Service Partner. For more information on how to buy technical support for
AudioCodes products and for contact information, please visit our Web site at
https://www.audiocodes.com/services-support/maintenance-and-support
.
Software Download
https://downloads-audiocodes.s3.eu-central-1.amazonaws.com/Download/AC_cX-UM_IW.html
Stay in the Loop with AudioCodes
Abbreviations and Terminology
Each abbreviation, unless widely used, is spelled out in full when first used.
Version 0.1.4 7 cX-UM Connector
cX-UM Connector
Related Documentation
Document Name
Document Revision Record
LTRT Description
40732 Initial document release for Version 0.1.4
Documentation Feedback
AudioCodes continually strives to produce high quality documentation. If you have any
comments (suggestions or errors) regarding this document, please fill out the
Documentation Feedback form on our Web site at
http://online.audiocodes.com/documentation-feedback
.
Software Revision Record
The following table lists the software versions released in Version 0.1.4.
Table 1-1: Software Revision Record
Software Version Date
0.1.4 Mar 2020
Note: The latest software versions can be downloaded from:
https://downloads-audiocodes.s3.eu-central-1.amazonaws.com/Download/AC_cXUM_IW.html
Pay attention to download the cX-UM platform version (SfB Online/Teams)
Unzip the file to a temporary directory.
Installation Manual 8 Document #: LTRT-40732
Installation Manual 1. Introduction
1 Introduction
Office 365™ Microsoft Exchange Online Unified Messaging (UM) has reached End-ofSupport as of February 28, 2020.
cX-UM (Cloud X-UM) provides MWI notifications for Cloud VoiceMails. The application is
useful for users using non-MS telephony systems (e.g. Cisco), and at the same time using
Microsoft Cloud Voicemail as their voicemail systems. These users can use cX-UM to receive
standard SIP MWI notifications for any change in their voicemail status (new voicemail
deposited, voicemail read or voicemail deleted).
To allow telephony (PBX) equipment to communicate securely with the Office 365 network,
customers are required to deploy AudioCodes' Mediant Session Border Controllers (SBCs)
with CCE for SfB Online or SBCs with Direct Routing for Teams Users.
This document details the installation procedure for cX-UM Connector as a standalone
server. For Skype for Business 2015 and Skype for Business 2019 for X-UM Standard
based on CloudBond Standard Plus, refer to LTRT-26791 AudioCodes X-UM
Configuration Ver.0.1) or for X-UM Connector Installation, refer to LTRT-40729 AudioCodes
X-UM Standard Installation Ver. 0.1.
Note: This document describes MWI notifications for Cloud VoiceMails; however, it does
not describe Microsoft Direct Routing functionality which is handled by AudioCodes SBC
devices.
Version 0.1.4 9 cX-UM Connector
cX-UM Connector
This page is intentionally left blank.
Installation Manual 10 Document #: LTRT-40732
Installation Manual 2. cX-UM Data Flow
2 cX-UM Data Flow
This section summarizes the steps for the cX-UM Data Flow:
1. cX-UM uses Graph API change notifications
voicemail folder.
2. The subscription requires a publicly open https webhook, that is called upon a change.
3. Since the cX-UM application is located on the customer premises behind a firewall, and
cannot be reached from outside, a dedicated Azure App Service notification handler is
configured as the notification webhook.
4. Cloud Voicemail sends notifications to the notification handler.
5. The notification handler pushes the notification to an Azure Service Bus queue.
6. The cX-UM application listens to the Azure Service Bus queue and recieves the
notifications.
7. cX-UM sends a corresponding SIP MWI notification.
to subscribe changes to each user’s
Version 0.1.4 11 cX-UM Connector
cX-UM Connector
This page is intentionally left blank.
Installation Manual 12 Document #: LTRT-40732
Installation Manual 3. Azure Notification Handler App Service and Service Bus
3 Azure Notification Handler App Service
and Service Bus
Graph API change notifications can only be sent to publically open HTTPS servers. Since
the cX-UM application is located on customer premises behind a firewall and cannot be
reached from outside, a dedicated Azure App Service receives the notifications and forwards
them to cX-UM. The notification handler is a very basic application that simply receives the
HTTPS notification and pushes it to an Azure Service Bus queue. Each cX-UM server listens
to a single service bus queue with the hostname of the cX-UM server. The queue is
automatically created by cX-UM upon startup, if required. While there may be multiple cXUM servers per customer, only a single App service is required per customer.The App service
pushes the notification to the correct queue, based on the URL which called it.
For example:
1. cX-UM server1 registers for change notification with webhook:
https://notif-handler.azurewebsites.net/api/ExchNotif/server1
2. App service listens to:
https://notif-handler.azurewebsites.net/api/ExchNotif/{serverName}
3. A notification is sent to:
https://notif-handler.azurewebsites.net/api/ExchNotif/server1
4. App service pushes the notification to queue ‘server1’ based on URL suffix.
5. cX-UM server1 receives the notification.
Version 0.1.4 13 cX-UM Connector
cX-UM Connector
This page is intentionally left blank.
Installation Manual 14 Document #: LTRT-40732
Installation Manual 4. SIP Interface
4 SIP Interface
cX-UM provides SIP interfaces only for receiving message-waiting indicators (MWI)
notifications. It does not support phone registration and calling. cX-UM provides two
methods for sending MWI:
unsolicited MWI
subscribe-based MWI
Note: cX-UM SIP interface supports TCP transport only. It does not support UDP.
4.1 Unsolicited MWI
cX-UM sends unsolicited MWI for all users who do not subscribe for MWI events. All
unsolicited MWIs for all these users are sent to the same SIP host. See an example for
Unsolicited MWI in Section D.1.
4.1.1 Backup SIP Hosts
cX-UM supports an optional configuration for multiple backup hosts, where notifications are
sent to the first available backup host. Once the primary host is up again, cX-UM resumes
sending the notifications. Availability is determined by periodically sending SIP Options
messages.
4.2 Subscribe-Based MWI
cX-UM supports subscribe-based MWI to which phones subscribe for MWI events. When cXUM needs to send an MWI, it sends it directly to the phone within the subscription session.
See example Subscribe-Based MWI message in Section D.2.
Version 0.1.4 15 cX-UM Connector
cX-UM Connector
This page is intentionally left blank.
Installation Manual 16 Document #: LTRT-40732
Installation Manual 5. cX-UM Connector System Requirements
5 cX-UM Connector System Requirements
The X-UM Connector's minimum requirements are described in the table below:
Table 5-1: cX-UM Connector System Requirements
System Requirements
Operation System Windows 2012 R2/2016 standard
Processor 4 Core
Memory 6 GB
Disk size Minimum 50 Gb. We recommend 80 Gb.
Version 0.1.4 17 cX-UM Connector
Loading...