uc-one solution guidebergoon.com/files/ucone-solutionguide-r21.pdf · 2015-07-27 · uc-one...

UC-One Solution Guide With

BroadWorks Collaborate 21.sp1 Business Communicator Release 21.x.x

Document Version 7

9737 Washingtonian Boulevard, Suite 350 Gaithersburg, MD 20878 Tel +1 301.977.9440

WWW.BROADSOFT.COM

http://www.broadsoft.com/

UC-ONE SOLUTION GUIDE 60-BT1021-00 ©2015 BROADSOFT, INC. PAGE 2 OF 156

BroadSoft ® Guide

Copyright Notice Copyright© 2015 BroadSoft, Inc.

All rights reserved.

Any technical documentation that is made available by BroadSoft, Inc. is proprietary and confidential and is considered the copyrighted work of BroadSoft, Inc.

This publication is for distribution under BroadSoft non-disclosure agreement only. No part of this publication may be duplicated without the express written permission of BroadSoft, Inc., 9737 Washingtonian Boulevard, Suite 350, Gaithersburg, MD 20878.

BroadSoft reserves the right to make changes without prior notice.

Trademarks Any product names mentioned in this document may be trademarks or registered trademarks of BroadSoft or their respective companies and are hereby acknowledged.

This document is printed in the United States of America.


Document Revision History

Release Version Reason for Change Date Author

21.sp1 / 21.x.x

1 Initial release of the UC-One Solution Guide for BroadWorks Collaborate Release 21.sp1 (Preview Release) and Business Communicator Release 21.x.x

December 22, 2014 Giovanni Teolis

21.sp1 / 21.x.x

1 Edited and published document. December 23, 2014 Joan Renaud

21.sp1 / 21.x.x

2 Added port 1082 for Business Communicator (BC) file transfer to section 14.5 Port Requirements. Remove https for the GUEST_CLIENT_URL in section 12.2.2 Device Management. Removed tailing “/” from the BOSH URL in section 12.1.2 Guest Client Basic Configuration.

January 12, 2015 Giovanni Teolis

21.sp1 / 21.x.x

2 Edited changes and published document. January 19, 2015 Joan Renaud

21.sp1 / 21.x.x

3 Updated for BroadWorks Collaborate Release 21.sp1 RC and Business Communicator Release 21.x.x.

March 20, 2015 Giovanni Teolis

21.sp1 / 21.x.x

3 Added rebranded server icons. Edited changes and published document.

March 24, 2015 Joan Renaud

21.sp1 / 21.x.x

4 Added sections 4.1.4 Configurable Web Button and 6.4.2.3 Add Web Button Configuration File for Business Communicator Configurable Web Button feature. Updated Figure 1 and Figure 2. Updated section 4.1.2 Client Configuration and Version Check with Web button information.

April 7, 2015 Giovanni Teolis

21.sp1 / 21.x.x

4 Edited changes and published document. April 9, 2015 Joan Renaud

21.sp1 / 21.x.x

5 Updated sections 8.2.2 Sharing Server Configuration and 8.2.2.1 SSL Certificate Installation. Updated section 5.3.2 BroadWorks Meet-Me Conferencing.

April 24, 2015 Giovanni Teolis

21.sp1 / 21.x.x

5 Edited changes and published document. May 4, 2015 Joan Renaud

21.sp1 / 21.x.x

6 Added section 11 BroadWorks Collaborate – Presence Server. Updated section 9.2.6 Redundancy. Added section 5.10.3 SIP Application Layer Gateway (ALG) Handling. Made miscellaneous updates for Release 21.2.0.

June 26, 2015 Giovanni Teolis

21.sp1 / 21.x.x

6 Edited changes and published document. June 30, 2015 Joan Renaud


Release Version Reason for Change Date Author

21.sp1 / 21.x.x

7 Added Appendix A: Business Communicator Xsi Only Configuration Without SCA and section 14.1.2 Business Communicator License Requirements – Xsi Only Without SCA.

July 10, 2015 Giovanni Teolis

21.sp1 / 21.x.x

7 Edited changes and published document. July 10, 2015 Joan Renaud


Table of Contents

Summary of Changes ................................................................................................................ 12 1.1 Changes for Release 21.sp1 / 21.x.x, Document Version 7 ................................................... 12 1.2 Changes for Release 21.sp1 / 21.x.x, Document Version 6 ................................................... 12 1.3 Changes for Release 21.sp1 / 21.x.x, Document Version 5 ................................................... 12 1.4 Changes for Release 21.sp1 / 21.x.x, Document Version 4 ................................................... 12 1.5 Changes for Release 21.sp1 / 21.x.x, Document Version 3 ................................................... 12 1.6 Changes for Release 21.sp1 / 21.x.x, Document Version 2 ................................................... 12 1.7 Changes for Release 21.sp1 / 21.x.x, Document Version 1 ................................................... 13

Overview....................................................................................................................................... 14 2.1 Business Communicator ........................................................................................................... 14 2.2 BroadWorks ............................................................................................................................... 15 2.3 BroadWorks Collaborate ........................................................................................................... 15 2.4 BroadCloud ................................................................................................................................ 16

Solution Architecture ................................................................................................................. 17 Solution Provisioning Steps ..................................................................................................... 20

4.1 System Configuration Steps ..................................................................................................... 21 Client Login – Authentication and Configuration ............................................................. 22 Client Configuration and Version Check ......................................................................... 23 Auto-Update ...................................................................................................................... 23 Configurable Web Button ................................................................................................. 25

4.2 User Provisioning Steps ............................................................................................................ 26 4.3 Download Business Communicator Client ............................................................................... 27 4.4 Additional Business Communicator Documentation ............................................................... 27

BroadWorks Services Deployment and Configuration ....................................................... 28 5.1 Client Licenses........................................................................................................................... 28 5.2 Shared Call Appearance ........................................................................................................... 28 5.3 Conferencing.............................................................................................................................. 28

Collaborate Video Server (UVS) ...................................................................................... 28 BroadWorks Meet-Me Conferencing ............................................................................... 29

5.4 Instant Messaging and Presence ............................................................................................. 29 BroadWorks Collaborate – Messaging Server (UMS) ................................................... 29 BroadCloud Integrated Instant Messaging & Presence ................................................. 29

5.5 Desktop Share ........................................................................................................................... 29 BroadWorks Collaborate – Sharing Server ..................................................................... 29 BroadCloud Web Collaboration ....................................................................................... 29

5.6 Business Line Call Back (Mobile Clients) ................................................................................. 30 5.7 Business Line Call-Through (Mobile Client) ............................................................................. 30 5.8 Mobile and Tablet Clients Running in Background ................................................................. 30 5.9 SIP Failover Support ................................................................................................................. 31


With Session Border Controller ....................................................................................... 31 Without Session Border Controller .................................................................................. 31

5.10 SIP Interface .............................................................................................................................. 32 N-way Call and Session Description Protocol................................................................. 32 N-way Call and Group Chat ............................................................................................. 32 SIP Application Layer Gateway (ALG) Handling ............................................................ 32 Echo Service ..................................................................................................................... 33

BroadWorks Device Management Configuration ................................................................. 35 6.1 General Configuration Requirements ....................................................................................... 35 6.2 Configure BroadWorks Device Profile Type ............................................................................ 35 6.3 Import Method ............................................................................................................................ 35

Download DTAF Files from Xchange .............................................................................. 35 Import DTAF Files into BroadWorks ................................................................................ 36

6.4 Manual Method .......................................................................................................................... 36 Add Device Profile Type ................................................................................................... 37 Add Device Files ............................................................................................................... 44

6.5 Additional Device Management Documentation ..................................................................... 50 BroadWorks Meet-Me Conferencing ....................................................................................... 51

7.1 Application Server Configuration .............................................................................................. 51 Licensing ........................................................................................................................... 51 Configure Conferencing Moderator Client URL .............................................................. 52 Inhibit BroadWorks-based Music On Hold During Conferences ................................... 52 Enable MP3 Support ........................................................................................................ 52 System Administrator Meet-Me Conferencing Settings ................................................. 52 Assign Meet-Me Conference Ports to Service Providers ............................................... 54 Assign Meet-Me Conference Ports to Groups ................................................................ 55 Create Meet-Me Conference Bridge in Group ................................................................ 55

7.2 Media Server Configuration ...................................................................................................... 58 Active Talker Threshold .................................................................................................... 58 Audio Codecs ................................................................................................................... 58

7.3 Profile Server Configuration ...................................................................................................... 59 7.4 Network Server Configuration ................................................................................................... 60 7.5 Additional BroadWorks Meet-Me Conferencing Documentation ............................................ 60 7.6 End-User Configuration ............................................................................................................. 61

BroadWorks Portal ........................................................................................................... 61 BroadWorks Collaborate ........................................................................................................... 62

8.1 Messaging Server (UMS) .......................................................................................................... 62 Application Server Configuration for the Messaging Server (UMS) .............................. 62 Messaging Server (UMS) Configuration ......................................................................... 65 Virtual Domains ................................................................................................................ 71 Federation ......................................................................................................................... 72 Redundancy ...................................................................................................................... 73


Domain Filter ..................................................................................................................... 74 8.2 Sharing Server ........................................................................................................................... 75

Application Server Configuration for the Sharing Server ................................................ 75 Sharing Server Configuration ........................................................................................... 78 Redundancy ...................................................................................................................... 80

Messaging Server (UMS) – Message Archival ...................................................................... 81 9.1 Overview .................................................................................................................................... 81

Message Archiving ........................................................................................................... 81 Encryption ......................................................................................................................... 82

9.2 Profile Server – WebDAV ......................................................................................................... 82 Activate and Deploy the Message Archival Application ................................................. 82 Configure the MessageArchive Root Folder ................................................................... 83 WebDAV User Credentials .............................................................................................. 83 Network Access Lists ....................................................................................................... 84 Archive Maintenance ........................................................................................................ 84 Redundancy ...................................................................................................................... 84

9.3 Messaging Server (UMS) – IM&P and MA .............................................................................. 85 Configure the IM&P Application ....................................................................................... 85 Configure Message Archives per Domain ...................................................................... 85 Configure MA .................................................................................................................... 86 Message Archive Files ..................................................................................................... 88 WebDAV Service Offline Alarm ....................................................................................... 89 Automatic Message Archive Cleanouts .......................................................................... 89

Messaging Server (UMS) – Usage Metrics ............................................................................. 90 10.1 Messaging Server (UMS) Provisioning .................................................................................... 90 10.2 Messaging Server (UMS) Metrics............................................................................................. 90

Instant Messaging and Presence .................................................................................... 91 Multi-User Chat ................................................................................................................. 92

10.3 SNMP Configuration .................................................................................................................. 93 SNMP Access List ............................................................................................................ 93 SNMP Agent Configuration .............................................................................................. 93

10.4 SNMP Client Configuration ....................................................................................................... 93 BroadWorks Collaborate – Presence Server ......................................................................... 94

11.1 Custom Presence Rules ........................................................................................................... 94 Custom Presence Rules .................................................................................................. 95 Presence State Aggregation ............................................................................................ 95

11.2 Channel and Subscription Details ............................................................................................ 95 11.3 Messaging Server (UMS) Provisioning .................................................................................... 95

Enterprise Configuration ................................................................................................... 95 CTI Interface Configuration .............................................................................................. 96 Activate and Deploy the Presence Server Application ................................................... 98

BroadWorks Collaborate – Guest Client ................................................................................ 99


12.1 Xsp Provisioning ........................................................................................................................ 99 Guest Client Software Installation .................................................................................... 99 Guest Client Basic Configuration ................................................................................... 100 Guest Client reCAPTCHA Configuration ...................................................................... 102 Guest Client Customization ........................................................................................... 102

12.2 Application Server Provisioning .............................................................................................. 104 OCI Call Control Application Definition .......................................................................... 104 Device Management ...................................................................................................... 104

12.3 BroadWorks WebRTC Server (WRS) Provisioning .............................................................. 104 12.4 Messaging Server (UMS) Provisioning .................................................................................. 105

Guest User Domains ...................................................................................................... 105 Connectivity ..................................................................................................................... 105 Guest User Account Cleanup ........................................................................................ 105

12.5 Sharing Server (USS) Provisioning ........................................................................................ 106 BroadWorks Collaborate Video Server (UVS) ..................................................................... 107

13.1 Networking Considerations ..................................................................................................... 107 Bandwidth Considerations ............................................................................................. 108 Traffic Prioritization ......................................................................................................... 108

13.2 Video Server (UVS) Provisioning ........................................................................................... 108 Audio-only ....................................................................................................................... 108 Video-centric ................................................................................................................... 109

13.3 Network Server Provisioning ................................................................................................... 110 Video Server (UVS) Resource Network Element ......................................................... 110

13.4 Application Server Provisioning .............................................................................................. 110 System Wide Collaborate Settings ................................................................................ 110 System Video Server (UVS) Parameters ...................................................................... 110 Device Management ...................................................................................................... 111 System Call Processing Policy Profile ........................................................................... 111 Authorize Collaborate Services to the Enterprise and Group ...................................... 113 Collaborate Bridge .......................................................................................................... 114 Assign Collaborate –Audio/Video User Services .......................................................... 116 Collaborate Rooms – My Room .................................................................................... 117 Collaborate Rooms – Project Room .............................................................................. 118

Solution Requirements and Compatibilities ........................................................................ 122 14.1 BroadWorks Requirements ..................................................................................................... 122

Business Communicator License Requirements .......................................................... 122 Business Communicator License Requirements – Xsi Only Without SCA ................. 123 BroadWorks Software Requirements ............................................................................ 124 BroadWorks Patches...................................................................................................... 125

14.2 Collaborate Guest Client Requirements ................................................................................. 126 Browser Requirements ................................................................................................... 126

14.3 BroadCloud Software Requirements ...................................................................................... 127 14.4 Client Platform Requirements ................................................................................................. 127


14.5 Port Requirements ................................................................................................................... 127 Business Communicator ................................................................................................ 127 Collaborate Servers ........................................................................................................ 128

14.6 UC-enabled Devices ............................................................................................................... 128 14.7 System Capacity Requirements ............................................................................................. 129

Feature Interactions ................................................................................................................. 130 15.1 Incoming Call Termination Interactions .................................................................................. 130

Integrated Instant Messaging and Presence ....................................................................... 131 16.1 Integrated IM&P Service ......................................................................................................... 131

Service Provider/Enterprise-level Configuration ........................................................... 131 Group-level Configuration .............................................................................................. 131 User-level Configuration ................................................................................................. 131 Integrated IM&P Activation ............................................................................................. 132

Messaging Server Proxy (HAProxy) Configuration Guidelines ....................................... 133 17.1 HAProxy ................................................................................................................................... 133 17.2 HAProxy Availability ................................................................................................................ 134 17.3 HAProxy Build and Install ........................................................................................................ 135 17.4 HAProxy Configuration ............................................................................................................ 135

Global Parameters .......................................................................................................... 136 Defaults Parameters ....................................................................................................... 136 Listen Parameters .......................................................................................................... 136 HAProxy Reference Configuration ................................................................................ 137

17.5 HAProxy Start .......................................................................................................................... 138 BroadCloud ................................................................................................................................ 139

18.1 BroadCloud Instant Messaging and Presence ...................................................................... 139 On-Boarding Process ..................................................................................................... 139 Application Server Configuration ................................................................................... 139 DNS Record Lookup of IM&P (XMPP) Service ............................................................ 141 Additional BroadCloud Instant Messaging and Presence Documentation ................. 141

18.2 BroadCloud Web Collaboration .............................................................................................. 141 On-Boarding Process ..................................................................................................... 141 Business Communicator Client End-User Configuration ............................................. 141 Additional BroadCloud Web Collaboration Documentation ......................................... 141

Appendix A: Business Communicator Xsi Only Configuration Without SCA ............. 143 19.1 Solution Configuration ............................................................................................................. 143

Authorize and Assign the Business Communicator Desktop User Service ................ 143 Download and Customize the Configuration File ......................................................... 144 Create a Device Profile Type ......................................................................................... 144 Add Device Files ............................................................................................................. 144

Appendix B: OCI-P Sample Code to Create “UC-One” User in BroadWorks ............... 149 References ........................................................................................................................................ 155


Table of Figures

Figure 1 UC-One Solution Architecture – with BroadWorks Collaborate .............................................. 17 Figure 2 UC-One Solution Architecture – with BroadCloud ................................................................... 18 Figure 3 System Administrator – Identity/Device Profile Type Files (Web Portal Page) ...................... 24 Figure 4 UC-One – Signing In.................................................................................................................. 24 Figure 5 Business Communicator – New Version Available Dialog Box ............................................... 25 Figure 6 New Version Download Confirmation Dialog Box ................................................................... 25 Figure 7 VoiceXML Virtual Subscriber Profile ......................................................................................... 33 Figure 8 Device Profile Type Standard Settings ..................................................................................... 38 Figure 9 Device Profile Type Advanced Settings Business Communicator – PC ................................ 39 Figure 10 Device Profile Type Advanced Settings Business Communicator – Mobile and Tablet ..... 39 Figure 11 Device Profile Type Device Management Enabled – Release 18.0 and Later .................... 40 Figure 12 Device Profile Type Device Management Enabled – Prior to Release 18.0 ........................ 40 Figure 13 Device Profile Type Device Management Settings for Business Communicator – PC ....... 42 Figure 14 Device Profile Type Device Management Settings for Business Communicator – Mobile . 43 Figure 15 Device Profile Type Device Management Settings for Business Communicator – Tablet .. 44 Figure 16 Configuration Template File for Business Communicator – PC ........................................... 46 Figure 17 Configuration Template File for Business Communicator – Mobile ...................................... 47 Figure 18 Configuration Template File for Business Communicator – Tablet ...................................... 48 Figure 19 Version Check File ................................................................................................................... 49 Figure 20 Web Button Configuration File ................................................................................................ 50 Figure 21 Meet-Me Conferencing System Settings................................................................................ 52 Figure 22 Limit Number of Ports per Service Provider or Enterprise .................................................... 54 Figure 23 Limit Number of Ports per Group ............................................................................................ 55 Figure 24 List of Meet-Me Conference Bridges ...................................................................................... 55 Figure 25 Create New Meet-Me Conference Bridge .............................................................................. 56 Figure 26 Meet-Me Conference Bridge Profile ....................................................................................... 57 Figure 27 Assign Phone Number to Bridge ............................................................................................ 57 Figure 28 Assign Services to Bridge ....................................................................................................... 58 Figure 29 Meet-Me Conferencing – Conference .................................................................................... 61 Figure 30 Integrated IM&P Service Domain Setting (Service Provider/Enterprise Level) – Release

20.0 .......................................................................................................................................... 64 Figure 31 Integrated IM&P Service Domain Setting (Service Provider/Enterprise Level) – Release

21.0 .......................................................................................................................................... 65 Figure 32 Message Archival Solution Architecture ................................................................................. 81 Figure 33 MA Message Flow ................................................................................................................... 82 Figure 34 Presence Server Architecture ................................................................................................. 94 Figure 35 Presence Server / Event Channel and Subscriptions ........................................................... 95 Figure 36 Guest Client Solution Architecture .......................................................................................... 99 Figure 37 Call Processing Policy Profile ............................................................................................... 111 Figure 38 Call Processing Policy Profile Modify ................................................................................... 112 Figure 39 Call Processing Policy Profile – Collaborate Subscriber Type Profile ................................ 113 Figure 40 Group Resources → Services Menu .................................................................................... 114 Figure 41 Group Services Menu with Collaborate Bridges Service .................................................... 114 Figure 42 Collaborate Bridges Menu ..................................................................................................... 115 Figure 43 Collaborate Bridge Profile ..................................................................................................... 115 Figure 44 Collaborate Bridge Address .................................................................................................. 116 Figure 45 Assign Services Page ........................................................................................................... 116 Figure 46 End-user Collaborate Options Menu .................................................................................... 117 Figure 47 Collaborate Rooms Page ...................................................................................................... 117 Figure 48 Collaborate Room – Modify Page ......................................................................................... 118 Figure 49 Collaborate Rooms Page ...................................................................................................... 118 Figure 50 Collaborate Room – Add Page ............................................................................................. 119 Figure 51 Collaborate Rooms Page ...................................................................................................... 119


Figure 52 Collaborate Room (Project Room) – Modify Page .............................................................. 120 Figure 53 Scheduling Details – One Time ............................................................................................ 120 Figure 54 Scheduling Details – Recurring ............................................................................................. 121 Figure 55 Scheduling Details – Reservationless .................................................................................. 121 Figure 56 Assign Integrated IM&P Service to User .............................................................................. 131 Figure 57 Integrated IM&P Activation .................................................................................................... 132 Figure 58 IM&P ID in User’s Profile ....................................................................................................... 132 Figure 59 Network Diagram of Messaging Server (UMS) Fronted by HAProxy................................. 134 Figure 60 Integrated IM&P Service Domain Setting (Service Provider or Enterprise Level) –

Release 20.0 .......................................................................................................................... 140 Figure 61 Integrated IM&P Service Domain Setting (Service Provider or Enterprise Level) –

Release 21.0 .......................................................................................................................... 140 Figure 62 Configuration Template File for Business Communicator – Xsi Only ................................. 146 Figure 63 Web Button Configuration File .............................................................................................. 147


Summary of Changes

This section describes the changes to this document for each release and document version.

1.1 Changes for Release 21.sp1 / 21.x.x, Document Version 7 This version of the document includes the following changes:

Added Appendix A: Business Communicator Xsi Only Configuration Without SCA.

Added section 14.1.2 Business Communicator License Requirements – Xsi Only Without SCA.


Added section 11 BroadWorks Collaborate – Presence Server.

Updated section 9.2.6 Redundancy.

Added section 5.10.3 SIP Application Layer Gateway (ALG) Handling.

Made miscellaneous updates for Release 21.2.0.


Updated sections 8.2.2 Sharing Server Configuration and 8.2.2.1 SSL Certificate Installation.

Updated section 5.3.2 BroadWorks Meet-Me Conferencing.


Added section 4.1.4 Configurable Web Button.

Added section 6.4.2.3 Add Web Button Configuration File.

Updated Figure 1 UC-One Solution Architecture – with BroadWorks Collaborate and Figure 2 UC-One Solution Architecture – with BroadCloud.


Removed Preview Release warnings and other miscellaneous updates for Release 21.sp1 / 21.x.x.

Added section 10 Messaging Server (UMS) – Usage Metrics.

Added rebranded server icons.


Added port 1082 for Business Communicator (BC) file transfer to section 14.5 Port Requirements.


Remove https for the GUEST_CLIENT_URL in section 12.2.2 Device Management.

Removed tailing “/” from the BOSH URL in section 12.1.2 Guest Client Basic Configuration.

1.7 Changes for Release 21.sp1 / 21.x.x, Document Version 1 This version of the document includes the following change:

Initial version of the UC-One Solution Guide for BroadWorks Collaborate Release 21.sp1 (Preview Release) and Business Communicator Release 21.0.


Overview

BroadSoft UC-One is a complete Unified Communications solution, providing a comprehensive suite of services addressing both business and consumer needs. The UC-One solution includes the following features:

Audio Calling and Video Calling

Conferencing

Conferencing functionality within the Business Communicator My Room feature is provided by the Video Server (UVS) or by the Meet-Me Conferencing service. This document covers both the Video Server and Meet-Me conferencing.

Instant Messaging and Presence (IM&P)

IM&P functionality is provided by either BroadWorks Collaborate or BroadCloud. This document covers both BroadWorks Collaborate and BroadCloud.

Service Management (call settings)

Desktop Share

Desktop Share functionality is provided by either BroadWorks Collaborate or BroadCloud. This document covers both BroadWorks Collaborate and BroadCloud.

Address Books/Contact Management

The UC-One solution effectively leverages multiple BroadSoft product lines: BroadWorks, Business Communicator, BroadWorks Collaborate, or BroadCloud to provide the full UC-One User Experience.

This guide provides guidelines describing the recommended configuration for each of the available services.

2.1 Business Communicator The UC-One User Experience is centered around the Business Communicator application, which can be deployed on Windows PCs, Mac OS X, iPhone, iPad, as well as Android smartphones and tablets. End users (consumer/business) use Business Communicator to access all their communication services provided through BroadWorks, BroadWorks Collaborate, or BroadCloud.

Business Communicator features include the following:

High definition audio and video calling using any available network connection, including Wi-Fi, 3G/4G/LTE, or even legacy circuit-switched mobile networks

Instant Messaging with both enterprise and federated contacts

Rich presence capabilities based on many inputs, including telephony status, user-selected status, or Microsoft Exchange status

Desktop Share

My Room, an always-on collaboration space, enabling a cohesive experience for Chat, Audio, and/or Video Conferencing, and Desktop Sharing

User-to-user communications or group-based communications for Calling, Chat, Desktop Sharing, and 1:1 file transfer (introduced in Business Communicator Release 21.2.0 Desktop)


Tight integration with Microsoft Outlook and Exchange (enabling click-to-communicate actions through the Outlook address book requires the Outlook Add-in for Business Communicator Desktop client)

Service Management call settings, for example, Call Forwarding or Do Not Disturb (DND), Call Center integration (introduced in Business Communicator Release 21.2.0 Mobile and Desktop)

Brandable with service provider’s colors, themes, and naming

Configurable Web Button (Business Communicator Desktop) that allow operators to define a configurable, localized web link that is opened within Business Communicator or in a web browser (introduced in Business Communicator Release 21.1)

Fully configurable real-time from a centralized Device Management interface

Visual Voice Mail support for Business Communicator (introduced in Business Communicator Desktop Release 21.2.0) and supported on BroadWorks Release 20.0 and above

2.2 BroadWorks The BroadWorks system, supporting some of the UC-One functionality, is deployed and managed by the service provider in the service provider’s network. The BroadWorks system supports the following capabilities:

All call control including point-to-point audio and video sessions

BroadWorks-based multiparty conferencing (Meet-Me for audio Conferencing or Video Server for audio and video conferencing)

Support of mobile users and clients with various Fixed Mobile Convergence (FMC) strategies

Licensing of Business Communicator clients

BroadWorks Device Management for automated client provisioning

Integration with BroadWorks Collaborate or BroadCloud for automatic provisioning of Extensible Messaging and Presence Protocol (XMPP) subscriptions and users

Enterprise Directories

Call logs (missed, placed, or received)

Centralized service configuration (Call Forwarding, DND, and so on)

2.3 BroadWorks Collaborate BroadWorks Collaborate enables UC-One application functionality within the customer’s network by providing IM&P, Desktop Sharing, and audio/video collaboration capabilities. Robust and future-proof network elements interwork to provide the platform and capabilities in support of BroadWorks Collaborate.

With the IM&P service provided by the Messaging Server (UMS), Business Communicator allows a user to build a list of frequent contacts called “buddies”. When a user wants to communicate with one of their buddies, they can quickly see their availability (presence) and choose a mode of communication (Chat, Voice, Video, or Desktop Share). The presence status can be viewed from Business Communicator, through Microsoft Outlook (with Outlook Add-in for Business Communicator Desktop client), and certain feature-capable phones.


Desktop Share, provided by the Sharing Server (USS), provides the infrastructure to enable Desktop Sharing between Business Communicator users.

The Video Server (UVS) enables audio and video collaboration within the Business Communicator My Room feature. The Video Server supports Business Communicator Desktop (Mac and Windows) and Business Communicator Mobile (iOS and Android) as well as the Collaborate Guest Client.

The Collaborate Guest Client is an Xtended web application that allows a non-BroadWorks user (a guest) to participate in a Multi-User Chat, screen share, and audio/video conferencing hosted by a BroadWorks user in their My Room on the Business Communicator client.

A BroadWorks user, called a “leader”, invites one or more guests, called “guest participants”, to join a collaboration session on their Business Communicator client to participate in a Multi-User Chat (MUC), screen sharing, and audio/video conferencing. The leader shares an HTTP URL with the guest participants to invite them into the session. The guest participants open the link in their browser to join the session. This Collaborate Guest Client web application is hosted on the Xtended Services Platform (Xsp).

The Collaborate Guest Client supports the following features:

Joining a Multi-User Chat session.

Viewing the participants who joined the session.

Viewing the screen share, when it is started by the leader.

Joining the audio/video conference through a preconfigured conference bridge owned by the “leader”.

Leaving the collaboration session.

2.4 BroadCloud BroadCloud provides a set of services hosted and managed by BroadSoft. For the UC-One solution, BroadCloud Instant Messaging & Presence and BroadCloud Web Collaboration can optionally be used to deliver the following capabilities of the solution:

Instant Messaging and Presence (BroadCloud IM&P)

Desktop Share (BroadCloud Web Collaboration)

Full Web Collaboration capabilities

BroadCloud subscriptions are required to enable these services as part of the UC-One with Business Communicator solution. Contact your BroadSoft Project Manager or Sales Engineer to initiate a BroadCloud on-boarding service request, or to receive a complete description of the on-boarding process.

NOTE: For more information about BroadCloud Instant Messaging and Presence, see section 18 BroadCloud.


Solution Architecture

To deploy the complete UC-One solution, a number of elements must be considered and configured, including the end-user client. The following figures illustrate the key components of the solution along with how they interact.

Instant Messaging and Presence (IM&P) and Desktop Share functionality are provided by either BroadWorks Collaborate or BroadCloud.

Figure 1 illustrates the solution architecture with BroadWorks Collaborate. Also, see Figure 36 Guest Client Solution Architecture for a diagram that includes the Video Server and Guest Client.

Figure 1 UC-One Solution Architecture – with BroadWorks Collaborate


Figure 2 illustrates the solution architecture with BroadCloud.

Figure 2 UC-One Solution Architecture – with BroadCloud

Focusing on the Business Communicator clients, the primary components in the solution include the following:

Business Communicator user clients (Windows, Mac, iOS, and Android)

BroadWorks services:

− Business Communicator client licenses (for license information, see section 14.1.1 Business Communicator License Requirements)

− BroadWorks User Licensing (including Shared Call Appearance)

− Meet-Me Conferencing (audio)

− Integrated Instant Messaging and Presence

BroadWorks servers:

− Profile Server (PS):

− File Respository web application

− Xtended Services Platform (Xsp):

− Device Management web application

− Xsi-Actions web application

− Xsi-Events web application

− Application Server (AS):

− Business Communicator Desktop, Mobile, and Tablet identity device profile types


− WebRTC Server (WRS):

− Web Real-Time Communications (WebRTC) to support the Guest Client application

− Media Server (MS):

− Meet-Me Audio Conferencing

BroadWorks Collaborate Servers:

− Messaging Server (UMS):

− Instant Messaging & Presence

− Sharing Server (USS):

− Desktop Sharing

− Video Server (UVS):

− Audio and Video collaboration

BroadCloud (If applicable):

− Instant Messaging & Presence

− Web Collaboration (Desktop Sharing)

IM&P and Desktop Sharing functionality can be provided by BroadWorks Collaborate or optionally by BroadCloud.

For details on BroadCloud Instant Messaging & Presence and BroadCloud Web Collaboration, see section 18 BroadCloud.


Solution Provisioning Steps

This section describes the steps required to provision the BroadWorks system to deploy the UC-One solution. The steps assume that the following components have been installed:

Application Server (AS)

Network Server (NS)

Profile Server (PS)

Media Server (MS)

WebRTC Server (WRS)

Xtended Services Platform (Xsp):

– Xsi-Actions web application

– Xsi-Events web application

– Device Management web application

NOTE: BroadWorks Device Management, including the Profile Server and the Xtended Services Platform, must be deployed and properly configured according to the instructions in the BroadWorks Device Management Configuration Guide [2].

Collaborate Servers:

− Messaging Server (UMS)

− Sharing Server (USS)

− Video Server (UVS)

NOTE: BroadWorks Collaborate Servers (Messaging Server and Sharing Server) must be installed following the instructions in the BroadWorks Messaging Server and Sharing Server Release Notes [9] and the BroadWorks Software Management Guide [11].

BroadCloud IM&P

The IM&P service can be provided by the Messaging Server (UMS) or by BroadCloud IM&P.

For details on BroadCloud Instant Messaging & Presence, see section 18.1 BroadCloud Instant Messaging and Presence.

BroadCloud Web Collaboration (Desktop Share)

The Desktop Share service can be provided by the BroadWorks Collaborate Sharing Server or by BroadCloud Web Collaboration.

For details on BroadCloud Web Collaboration, see section 18.2 BroadCloud Web Collaboration.

For information on the required software and license requirements (for the intended service offering), see section 14.1 BroadWorks Requirements.


4.1 System Configuration Steps The following is a summary of the steps that must be performed to configure the UC-One solution.

NOTE: To use the UC-One solution feature set, the appropriate BroadWorks service licenses are required by either purchasing or requesting temporary license files (for evaluation purposes) from BroadSoft.

1) Get and apply new license files, which include license quantities for the following services:

− Business Communicator Client Licenses (for release-specific license information, see section 14.1 BroadWorks Requirements)

− Shared Call Appearance (this is optional, see section 4.2 User Provisioning Steps)

− Meet-Me Conferencing (if using Meet-Me Conferencing for audio conferencing)

− Collaborate Audio (if using the Video Server for audio conferencing)

− Collaborate Video (if using the Video Server for audio conferencing)

− Collaborate Messaging

− Collaborate Sharing

− Integrated IM&P

2) Create the BroadTouch_Tags set, configuring tags as needed based on guidelines provided in the Business Communicator for Desktop Configuration Guide [14] or the Business Communicator for Android and iOS Configuration Guide [15] located on Xchange at:

http://xchange.broadsoft.com/php/xchange/support/broadtouch/businesscommunicator/documentation

If you have trouble with an Xchange link, copy and paste it into a web browser.

3) Import the Business Communicator Device Type Archive File (DTAF) into BroadWorks Device Management using the BroadWorks system administrator portal.

4) Conferencing:

a. If using Meet-Me Conferencing for audio conferencing, deploy the BroadWorks Meet-Me Conferencing application (see section 5.3 BroadWorks Meet-Me Conferencing (My Room)).

b. If using the Collaborate Video Server for audio and video conferencing, deploy the Collaborate Video Server (see section 13 BroadWorks Collaborate Video Server).

5) Instant Messaging & Presence

a. If using BroadWorks Collaborate for IM&P, complete the Messaging Server configuration (see section 8 BroadWorks Collaborate).

b. If using BroadCloud for IM&P, complete the BroadCloud IM&P on-boarding process (see section 18.1 BroadCloud Instant Messaging and Presence).




6) Desktop Share

a. If using BroadWorks Collaborate Desktop Sharing, complete the BroadWorks Sharing Server configuration (see section 8 BroadWorks Collaborate).

b. If using BroadCloud for collaboration and Desktop Sharing, complete the BroadCloud Web Collaboration on-boarding process (see section 18.2 BroadCloud Web Collaboration).

Client Login – Authentication and Configuration The reference version of the Business Communicator client can only be deployed with BroadWorks as it relies on the service delivery platform to authenticate and configure the client.

When a user first launches any reference version of the Business Communicator, they must enter the URL with the syntax shown in the following table.

Business Communicator

Client Release URL

Desktop 20.0.1 and higher https://[xsp.yourdomain.com]

Mobile 20.0.1 and higher https://[xsp.yourdomain.com]

Tablet 20.0.0 and higher https://[xsp.yourdomain.com] Note these URLs are configurable and can differ across systems depending on how the Business Communicator Xtended Services Platform-based applications are deployed and configured. HTTP or HTTPS can be used, although HTTPS is recommended. In addition, through customization, operators can integrate the appropriate URL in to their clients. This removes the need for the user to have to enter the URL manually to launch the client.

NOTE 1: If the URL is configured as an HTTPS (SSL) URL, then the Xtended Services Platform must use a Certification Authority (CA)-signed certificate; self-signed certificates are not supported by the Business Communicator client.

NOTE 2: Wildcard certificates are supported by the Business Communicator client.

NOTE 3: For details on SSL/ Transport Layer Security (TLS) Certificates, see the Business Communicator for Desktop Configuration Guide [14].

After the user launches the client, the user enters their user name and password. Note that these credentials correspond to their BroadWorks “login”, that is, their Xtended Services Interface (Xsi) credentials, also known as their BroadWorks “web portal” credentials.


Client Configuration and Version Check The end user is not required to perform any Business Communicator client configuration.

Following successful login, the Business Communicator client receives a configuration file (config.xml for the Desktop client, mobile-config.xml for the mobile client, and tablet-config.xml for the tablet client) through the Xtended Services Platform. The file provides all the necessary settings and preferences associated with the particular user. This configuration information includes details that allow the client to connect to BroadWorks via the Session Initiation Protocol (SIP), Xtended Services Interface (for service settings and call logs), and Extensible Messaging and Presence Protocol (XMPP) for IM&P and Desktop Sharing.

For the Business Communicator Desktop client, this configuration information can also include a version check URL that indicates where to download the latest version of the client, in cases where the running version is outdated. In this case, the user is prompted to upgrade their client. For more information, see section 4.1.3 Auto-Update.

Auto-Update The auto-update functionality, when configured, facilitates Business Communicator Desktop client software upgrades by minimizing and simplifying tasks required from both the service provider and the end user.

NOTE: For more information, see the Business Communicator for Desktop Configuration Guide [14].

The config.xml file in conjunction with the version check file (version_check.xml), implements the logic required to control the update mechanism. The version check file must identify the client software version and the download location (URI) of the required executable client installation file. To trigger the upgrade, the specified client version number must be greater than the user’s current version. In addition, the version check file provides settings that determine whether an upgrade should be optional or mandatory (that is, “Recommended” or “Must”, respectively) for users.

NOTE: If an upgrade is flagged as mandatory (that is, “Must”), a user cannot log in to the client until it has been updated.

The following steps outline the settings that need to be configured in both configuration and version check files to enable an optional (“Recommended”) auto-update:

1) Edit the version_check.xml file to configure both the client software version number (for example, 9.0.1.1068) and the client download URI as mentioned previously.

<Upgrade> <Windows> <Must/> <Recommended>9.0.1.1068</Recommended> <Download>https://xsp.yourdomain.com:443/dms/bc/pc/BTBC-0.1.1068.exe </Download> </Windows> <OSX> <Must/> <Recommended>9.0.1.55</Recommended> <Download>https://xsp.yourdomain.com:443/dms/bc/pc/BTBC-0.1.55.dmg</Download>

https://xsp.yourdomain.com/dms/bc/pc/BTBC-0.1.1068.exe%3c/Download

https://xsp.yourdomain.com/dms/bc/pc/BTBC-0.1.1068.exe%3c/Download

https://xsp.yourdomain.com/dms/bc/pc/BTBC-0.1.55.dmg

https://xsp.yourdomain.com/dms/bc/pc/BTBC-0.1.55.dmg


</OSX> 2) On the web portal, go to the Identity/Device Profile Types Files page for the Business

Communicator device type (Business Communicator – Desktop) and upload the version_check.xml file.

Figure 3 System Administrator – Identity/Device Profile Type Files (Web Portal Page)

3) In the config.xml file, verify that the version-control enabled setting is set to “true”, and points to the URI of the version_check.xml file through the appropriate BroadWorks tags as shown in the following example.

<version-control enabled="true"> <url>https://%BWDEVICEACCESSFQDN%:%BWDEVICEACCESSPORT%/%BWDMSCONTEXT%/%BWDEVICEACCESSURI%version_check.xml </url> </version-control>

Once the files have been rebuilt, any client launched by the user fetches the configuration file, which, in turn, flags the user to update their client version, if applicable. Users should see the following screens.

Figure 4 UC-One – Signing In

Figure 5 Business Communicator – New Version Available Dialog Box

4) Click Yes.

Figure 6 New Version Download Confirmation Dialog Box

5) Click OK. The user’s default browser opens and downloads the executable installation file. The user runs the executable file and responds to questions when prompted, to go through the installation procedure.

Configurable Web Button The Configurable Web Button is an optional feature introduced in Business Communicator Desktop Release 21.1. When provisioned, it allows operators to define configurable, localized web links that can be launched in a browser or within the Business Communicator Desktop main window.

The Configurable Web Button feature can be configured to have either one link specified in the main configuration file or a number of links using a separate XML file that must be placed on the Xsp web browser. In the latter case, the main configuration file must point to the separate XML file on the Xsp as shown in the following example.

1) Extract from the Business Communicator Desktop configuration file (config.xml) showing an example configuration of the Configurable Web Button feature.

... <web-button enabled="true" type="ext" target="main" url="http://xsp.ihs.broadsoft.com:80/dms/bc/pc/webbutton_config.xml" > <tooltip language="en">Web Button</tooltip> </web-button> ... 2) Example webbutton_config.xml file.

<?xml version="1.0"?> <broadtouch-portal>  <group id="1">  <name language="en">Internal Sites</name> <link target="ext" url="https://broadsoft.com"> <title language="en">Broadsoft</title>

<description language="en">Broadsoft web site</description> </link> </group> <group id="2">  <name language="en">External Sites</name> <link target="ext" url="http://xchange.broadsoft.com"> <title language="en">Xchange</title> <description language="en">Customer portal for support, go to market and collaboration</description> </link> </group> </broadtouch-portal> For detailed configuration options, limitations, and associated BroadWorks tags for the Configurable Web Button feature, see the Configurable Web Button section of the Business Communicator for Desktop Configuration Guide [14].

From the BroadWorks web portal, go to the Identity/Device Profile Types Files page for the Business Communicator device type (Business Communicator – Desktop) and add the webbutton_config.xml file. For the detailed procedure, see section 6.4.2.3 Add Web Button Configuration File.

4.2 User Provisioning Steps The following is a summary of the steps that must be performed to provision a user of the solution. Note that these steps only need to be performed once for each user.

1) Authorize corresponding quantities of the following services to the group:

− Business Communicator Client licenses (for BroadWorks release-specific and client-type license information, see section 14.1 BroadWorks Requirements)

− Shared Call Appearance (if Business Communicator is the user’s primary device, then this is not required)

− Integrated IM&P

− Meet-Me Conferencing (if using Meet-Me Conferencing for audio conferencing)

− Collaborate – Audio (if using the Video Server for audio conferencing)

− Collaborate – Video (if using the Video Server for video conferencing)

− Collaborate – Sharing

2) Assign the following services to the user:

− Business Communicator Client Licenses (for BroadWorks release-specific and client-type license information, see section 14.1 BroadWorks Requirements)

− Shared Call Appearance (if Business Communicator is the user’s primary device, then this is not required)

− Integrated IM&P

− Collaborate – Audio (if using the Video Server for audio conferencing)

− Collaborate – Video (if using the Video Server for video conferencing)

− Collaborate - Sharing

3) If the user has a primary device and is using Business Communicator Mobile as a secondary device, create a Shared Call Appearance using the Business Communicator – Mobile device type.


Set the device to have Custom Credentials. (Note that a temporary user name and password must be assigned or the client is not able to retrieve its configuration file the first time and the user experiences a login failure.)

4) If the user has a primary device and Business Communicator for Windows or Mac as a secondary device, then create a Shared Call Appearance using the Business Communicator – PC device type.

Set the device to have Custom Credentials. (Note that a temporary user name and password must be assigned or the login fails as previously noted.)

5) If the user has a primary device and Business Communicator Tablet as a secondary device, then create a Shared Call Appearance using the Business Communicator – Tablet device type.


6) If Business Communicator is the primary device, create a new device using the appropriate device type (Mobile, PC, or Tablet) and assign it to the user.


7) Assign and enable Integrated IM&P on the user’s profile. For more information, see section 8.1.1 Application Server Configuration for the Messaging Server (UMS).

8) Assign and enable Meet-Me Conferencing for the user. For more information, see section 7.1.5 System Administrator Meet-Me Conferencing Settings.

4.3 Download Business Communicator Client Reference clients for Business Communicator are available for Windows, Mac iOS, and Android. The latest reference versions for Windows and Mac are available for download from the BroadSoft Xchange web site at the following location:

http://xchange.broadsoft.com/php/xchange/support/broadtouch/businesscommunicator/software

If you have trouble with the Xchange link, copy and paste it into a web browser.

The latest reference versions for mobile and tablet devices are available on the corresponding mobile “app” store. The iOS versions can be downloaded from Apple’s App Store via iTunes. The Android versions can be downloaded from Google Play.

BroadSoft refers to these generally available versions of the clients as reference versions since they can be used by any operator and are not customized for any operator’s BroadWorks-based network. BroadSoft offers help to customize these clients for a particular customer’s network, which includes tying the client to a particular Xtended Services Platform cluster.

Note that the Windows and Mac versions are generally available two to four weeks before the corresponding mobile version since the mobile versions must be approved for sale by the operator of the application storefront.

4.4 Additional Business Communicator Documentation Additional documentation describing Business Communicator including how it is configured, branded, and customized can be found on Xchange at the following location:

http://xchange.broadsoft.com/php/xchange/support/broadtouch/documentation




http://xchange.broadsoft.com/php/xchange/support/broadtouch/documentation


BroadWorks Services Deployment and Configuration

This section describes BroadWorks services and specific functional behaviors associated with Business Communicator.

5.1 Client Licenses To be able to use the capabilities of the Business Communicator, each user must have a corresponding client license assigned to their BroadWorks profile. For complete Business Communicator client license information based on BroadWorks release and client type, see section 14.1 BroadWorks Requirements.

These services enable the user to log in from a mobile client (Android or iOS), tablet client (Android or iOS), or from a Desktop client (Windows or Mac).

5.2 Shared Call Appearance Business Communicator is typically deployed as a user’s secondary device, although this is not mandatory. If this is the case, then the BroadWorks Shared Call Appearance service must be assigned and configured accordingly.

If Business Communicator is the user’s primary device, then Shared Call Appearance is not required.

This guide assumes Shared Call Appearance to be used, and that Business Communicator is a secondary device on the user’s profile.

5.3 Conferencing The Business Communicator (Desktop client), through the My Room function set, provides users access to audio and/or video conferencing.

Conferencing services can be provided by the Collaborate Video Server (UVS) (audio/video) or by BroadWorks Meet-Me Conferencing (audio). The following sections describe both options.

Collaborate Video Server (UVS) The Video Server (UVS), introduced in Release 21.sp1, enables audio and video collaboration within the Business Communicator My Room feature.

The Video Server supports Business Communicator Desktop (Mac, Windows) and Business Communicator Mobile (iOS and Android) and interoperates with hardware video phones supporting H.264 AVC constrained baseline profile up to level 3.1. The Video Server also supports the Guest Client.

For details and the procedure to configure the Video Server, see section 13 BroadWorks Collaborate Video Server (UVS).


BroadWorks Meet-Me Conferencing BroadWorks Meet-Me Conferencing enables audio conferencing within the Business Communicator My Room feature.

With BroadWorks Meet-Me Audio Conferencing, an administrator creates conference bridges (that include a dialable number in its definition, such as 222-555-1212) and designates BroadWorks users as “conference hosts”. The host can create conferences on the conference bridge that has been assigned to them, with a unique conference ID created for each conference. Participants dial the bridge number, enter the conference ID, and then participants are joined together on the conference. The conference can be scheduled as a one-time event, a recurring event, or a reservationless conference that is available at any time.

For additional BroadWorks Meet-Me Conferencing information, including the deployment procedure, see section 7 BroadWorks Meet-Me Conferencing.

5.4 Instant Messaging and Presence The IM&P service can be provided by the Messaging Server (UMS) or by BroadCloud IM&P. The following sections describe both options.

BroadWorks Collaborate – Messaging Server (UMS) To leverage the Instant Messaging and Presence capabilities of the client, and to integrate with the Messaging Server, each user must have the Integrated IM&P service assigned and then enabled on their BroadWorks profile. For more information, see section 8.1 Messaging Server (UMS).

BroadCloud Integrated Instant Messaging & Presence To leverage the IM&P capabilities of the client, and to integrate with the BroadCloud IM&P service, each user must have the Integrated IM&P service assigned and then enabled on their BroadWorks profile. Note that enabling the service on the user’s profile fails when BroadWorks has not been properly on-boarded with the BroadCloud IM&P service. Specifically, the Application Server must be configured to automatically provision IM&P accounts on BroadCloud IM&P services as described in section 18.1 BroadCloud Instant Messaging and Presence.

5.5 Desktop Share The Desktop Share service can be provided by BroadWorks Collaborate Sharing Server or by BroadCloud Web Collaboration. The following sections describe both options.

BroadWorks Collaborate – Sharing Server The Business Communicator Desktop client uses the BroadWorks Sharing Server (USS) to provide Desktop Share functionality. For more information, see section 8.2 Sharing Server.

BroadCloud Web Collaboration The BroadCloud Web Collaboration service provides users with the ability to meet online and collaborate, share documents and applications, view participant video feeds, chat, and communicate via audio bridge or Voice over IP (VoIP).

The Business Communicator Desktop client uses BroadCloud Web Collaboration to provide the Desktop Share functionality. For more information, see section 18.2 BroadCloud Web Collaboration.


5.6 Business Line Call Back (Mobile Clients) Business Communicator (Mobile clients) allows a user to originate voice calls over the Public Land Mobile Network (PLMN) using their business line identity. This is made possible through the basic Call Back functionality on BroadWorks.

On mobile clients, Call Back is available if the user has BroadWorks Mobility, Remote Office, or BroadWorks Anywhere services assigned. The mobile client validates that one of these services is provisioned (and is active or on) with a phone number that matches the mobile number; if so, it gives the user the option to make calls using the Call Back feature.

NOTE 1: Remote Office takes precedence over BroadWorks Anywhere. That is, if Remote Office is set to “On” and its provisioned phone number does not match the user’s mobile number, the call back fails (because the Call Back call goes to the provisioned number instead).

NOTE 2: On Mobile clients, if BroadWorks Mobility is used for call back, the Phones to Ring parameter should be set to either “Mobile” or “Both” to enable call originations through the Call Back service. If this is not done, call back fails. The preferred setting is “Both”.

5.7 Business Line Call-Through (Mobile Client) Similar to the Business Line Call Back service, the Business Line Call-Through service allows the Business Communicator (Mobile client) user to originate voice calls over the PLMN using their business line identity.

The BroadWorks Mobility service and/or BroadWorks Anywhere service must be assigned to the user’s BroadWorks profile (configured and activated or “on”) to enable the Call-Through option on the user’s Mobile client. The client application then allows the user to select between Call Back and Call-Through.

5.8 Mobile and Tablet Clients Running in Background Apple’s iOS support guidelines for multitasking stipulates that actions (by a background application) are not permitted for a minimum of 600 seconds (10 minutes). This means that to receive calls on a TCP-based account, while the application is running in the background, the SIP registration must stay alive for 600 seconds or more.

The Business Communicator iOS clients (Mobile and Tablet) support running in background mode by respecting this requirement. When in background, using TCP, the client sends a keepalive/re-registration message over the SIP connection at intervals of no less than 10 minutes. The iOS, in turn, keeps this socket active and the client can continue to accept notifications for incoming calls.

In addition, this specification requires that the session border controller (SBC) be configured for a SIP REGISTER expiry timeout of 10 minutes (600 seconds) or more (preferably 720 seconds) over a TCP connection. The recommendation is to use a separate interface (on the SBC) dedicated to the Mobile and Tablet client (iOS and Android) users and to set the parameters as shown in the following table.

SBC Parameter Value Description

tcp-nat-interval 720 Set session expiry timeout (in seconds).

tcp-keepalive enabled Enable the SBC to send keepalive packets to the device on predefined intervals. This ensures the TCP connection remains active regardless of any intermediate network elements that can time out the TCP connection.


SBC Parameter Value Description

tcp-keepalive-idle-timer

90 Set the interval for sending keepalive packets from the SBC to the client. The recommended value of 90 (seconds) should be small enough to cover more stringent firewalls or Network Address Translations (NATs) that can time out the TCP connection if no activity is detected for the specified interval.

NOTE: The SBC parameters listed in the previous table are based on ACME/Oracle SBC settings. The corresponding naming conventions for these parameters may vary across SBC vendors.

5.9 SIP Failover Support

With Session Border Controller Most VoIP networks have an SBC. Generally, the SBC is configured to handle a possible SIP failover – ensuring a seamless user experience and quality of service (QoS). In this case, the SBC would be connected to a redundant pair of BroadWorks Application Servers – designated as primary and secondary servers.

Without Session Border Controller When there is no SBC, the Business Communicator client always contacts the primary server except in a failover condition, in which case, it attempts to route to the secondary (or alternate) server.

Under this circumstance, the client uses the DNS SRV (service) record lookup mechanism (as specified by RFC 3263 [1]) to try and resolve the single Fully Qualified Domain Name (FQDN) of an Application Server cluster to the ordered IP addresses of the two servers (primary and secondary).

5.9.2.1 Mobile and Tablet Clients

For Mobile and Tablet clients, a REGISTER or INVITE request attempt to the primary server that yields no response triggers a 32-second delay before a re-attempt is made to the secondary server. After fifteen minutes, the client attempts the primary server. If the primary server still does not respond, the failover process is reinitiated. In addition, fail over to a secondary server during a BYE attempt is currently not supported.

5.9.2.2 Desktop Client

During a REGISTER, INVITE, or BYE request to the primary server that yields no response, the client attempts to re-REGISTER with the secondary server. If successful, it continues to use the secondary server until it becomes non-responsive, at which point it attempts to revert to the primary (or another active server in the cluster). In addition, note that before the client searches for the next available server, it tries to use UDP, TCP, or TLS to reach the non-responding server.

NOTE: For more information on SIP failover, see the Business Communicator for Desktop Configuration Guide [14].


5.10 SIP Interface

N-way Call and Session Description Protocol The useStrictRFC3264Compliance field defined as part of the SIP interface should be set to “true” to avoid mishandling of the Session Description Protocol (SDP) in N-way call scenarios.

AS_CLI/Interface/SIP> g … useStrictRFC3264Compliance = true …

N-way Call and Group Chat Using the Business Communicator Desktop client, users can select multiple contacts (from their contacts list) and then use the call button to initiate an N-way conference. Consequently, this also triggers a group chat in which the user is presented with a group communications window listing all session participants.

To ensure that there is support for the N-way call and group chat capability, the SIP Header Proxy policy rule must be defined on the Application Server as shown in the following example.

AS_CLI/Interface/SIP/ProxyPolicy/Rule> g Rule Name = btbc-session-info-settings Keep On Redirection = true Keep On Egress Access = true Keep On Egress Network On-net = false Keep On Egress Network Off-net = false Keep On Egress Access Shared Call Appearance = true Keep On Egress Network BroadWorks Anywhere On-net = false Keep On Egress Network BroadWorks Anywhere Off-net = false Accept From Redirect-to URI = false AS_CLI/Interface/SIP/ProxyPolicy/HeaderPolicy> g Header Name Short Header Name Rule Name ======================================================== btbc-session-info btbc-session-info-settings AS_CLI/Interface/SIP/ContentType/Content> g Content Type Supported Interface ============================================================= application/btbc-session-info access

SIP Application Layer Gateway (ALG) Handling To prevent SIP registration issues, caused when some SIP ALGs re-write the SIP contact headers, the following recommendations apply:

SIP/TLS is the recommended transport protocol, as ALG re-writing of the SIP contact header cannot be done with SIP over TLS.

The recommended default SIP port for Business Communicator Desktop is 5074 and the recommended default SIP port for the Business Communicator Mobile client is 5075, as many ALGs only monitor the default SIP port 5060.


Echo Service The Business Communicator client Echo Service is an application written in Voice XML (VXML) that executes on the BroadWorks Media Server. The purpose of this application is to verify the audio and/or video quality of a VoIP call that originates from the client. The application answers the incoming call and prompts the caller to record a message. Immediately following a successful recording, the application plays back the message to the caller. Subsequently, the caller can determine the audio/video quality of their VoIP call directly from their client.

5.10.4.1 BroadWorks Requirements

The Echo Service requires BroadWorks specific servers, Voice XML-related licenses, and service configuration.

Application Server – Requires “VoiceXML” virtual service license

– Create a virtual “VoiceXML” service subscriber with a profile as shown in Figure 7. Note the following:

− The Identity/Device Profile using BroadWorks Media Server device type.

− The Contact sip field must contain the Media Server address and URI of the VXML script. For example, use the Media Server FQDN: dialog@FQDN;voicexml=http://webserver/myscript.vxml.

Figure 7 VoiceXML Virtual Subscriber Profile

Media Server – Requires “VoiceXML” number of ports related license

– Fetches the Voice XML script from the Web Server (or Profile Server)

– Executes the Voice XML script

– Receives calls using the SIP

– Plays and records audio and video prompts

Web Server (can reuse Profile Server)

– Hosts the Voice XML script

– Hosts the audio and video files (prompts)


For more information regarding the configuration of Voice XML on BroadWorks, see the BroadWorks VoiceXML and CCXML Developer’s Guide [21].

5.10.4.2 VoiceXML Script

The following is a sample VXML script implementation of the Echo Service on BroadWorks. <?xml version="1.0" encoding="UTF-8"?> <vxml version = "2.1" xmlns="http://www.w3.org/2001/vxml"> <form id="EchoService"> <record name="rec" beep="true" dtmfterm="true" finalsilence="3s" maxtime="20s"> <prompt> <audio src="WelcomeToEcho.wav"> Welcome to the Business Communicator echo service. Please record a message after the tone. </audio> </prompt> <filled> <prompt> <audio src="Playback.wav"> Thank you. Here is your recording. </audio> <audio expr="rec"/> </prompt> </filled> </record> </form> </vxml> Also required are two .wav files that are played back to the caller. Following are sample scripts for each file.

WelcomeToEcho.wav

This is the initial prompt played when the incoming test call is answered. It should say something like the following.

“Welcome to the Business Communicator Echo Service. Please record a message after the tone.”

Playback.wav

This prompt is played after the test message is recorded and before it is played back to the caller. It should say something like the following.

“Thank you. Your recorded message is...”

5.10.4.3 Business Communicator Client Requirements

A number of Business Communicator client-specific custom Device Management tags must be set in order to activate the Echo Service. For details on the client-side settings, see the Business Communicator for Desktop Configuration Guide [14] and/or the Business Communicator for Android and iOS Configuration Guide [15].


BroadWorks Device Management Configuration

This section describes how to use Device Management to support Business Communicator.

6.1 General Configuration Requirements The Device Management framework is used to manage the Business Communicator Mobile, Tablet, and Desktop (PC) device type configurations on the BroadWorks system. Each respective device type is associated to a well-defined Device Management tag set. This tag set provides flexibility in managing the client’s network/service connectivity settings as well as feature activation controls.

Notably, Device Management is mandatory for all Business Communicator solutions; therefore, all BroadWorks systems (supporting Business Communicator) require a Profile Server (PS) and the Xtended Services Platform (Xsp) deployed as part of the solution.

6.2 Configure BroadWorks Device Profile Type The following sections describe the two BroadWorks device profile type configuration methods: import and manual. The import method is used when a DTAF is available for the deployed BroadWorks release. If the deployed BroadWorks release is prior to the releases for the available DTAF(s), then the manual method is used.

Note that the associated device profile type configuration template files (config.xml, mobile-config.xml, and tablet-config.xml, found in the Desktop, Mobile, and Tablet DTAFs, respectively) are backward compatible and (limited) forward compatible with respect to client versions. In general, this means both older and newer versions of a client can run against an existing deployed template. However, users running newer clients may not get the full set of added functionality when associated with an older version of the configuration template.

6.3 Import Method This section identifies the steps necessary to make use of the Device Management import feature to configure BroadWorks to add Business Communicator as a Device Management-enabled device type.

The import method is available in BroadWorks Release 17.0 and later. For previous releases, use the manual configuration method described in section 6.4 Manual Method.

Download DTAF Files from Xchange BroadSoft provides a corresponding DTAF to simplify the creation of Business Communicator identity device profile types. One identity device profile type is created to manage the configuration of the mobile client, which is called “Business Communicator – Mobile”. One identity device profile type is created to manage the configuration of the Windows and Mac clients, which is called “Business Communicator – PC”. One identity device profile type is created to manage the configuration of the tablet clients, which is called “Business Communicator – Tablet”.

NOTE: Do not change the identity device profile type names from the default value “Business Communicator – PC”, “Business Communicator – Mobile”, and “Business Communicator – Tablet”.


The DTAF files can be found on Xchange at the following location:



DTAFs are distributed in a zip file corresponding to the specific Business Communicator version. Therefore, be sure to download the DTAF zip matching the Business Communicator version installed.

The DTAF zip contains DTAF files for one or more BroadWorks releases. Extract the DTAF file from the zip for the deployed BroadWorks release.

Import DTAF Files into BroadWorks The following provides instructions to import the DTAF files into BroadWorks. Note that these steps must be performed by a system-level administrator:

1) Make sure the default system tags and the Business Communicator custom (BroadTouch_Tags set) tags are defined as needed based on guidelines provided in the Business Communicator for Desktop Configuration Guide and/or the Business Communicator for Android and iOS Configuration Guide located on Xchange at:



2) Go to System → Resources → Identity/Device Profile Types and then click Import. 3) Browse for the DTAF file to import and then click OK.

4) At System → Resources → Identity/Device Profile Types, search for the device profile type just imported and then click to edit it.

5) Click Profile and then modify the Device Access FQDN with the Xtended Services Platform cluster farm FQDN for this system, for example, “xsp.yourdomain.com”. Validate that the Device Access Protocol is set appropriately for your environment, (either HTTP or HTTPS). Click SAVE.

6) Click Files and Authentication and then select the option to rebuild all system files.

6.4 Manual Method This section describes the manual steps necessary to configure BroadWorks to add Business Communicator as a Device Management-enabled device type.

Make sure the default system tags and the Business Communicator custom (BroadTouch_Tags set) tags are defined as needed based on the guidelines provided in the Business Communicator for Desktop Configuration Guide and/or the Business Communicator for Android and iOS Configuration Guide located on Xchange at:










Add Device Profile Type This section describes how to add the Business Communicator – PC, Business Communicator – Mobile, and Business Communicator – Tablet device profile types. Repeat the steps to add each type.

Browse to System → Resources → Identity/Device Profile Types and then click Add to add a new device profile type.

6.4.1.1 Standard Settings

Configure the Standard settings as described in following table. Settings not mentioned should be left at their default value, which usually means the option is not checked.

Parameter Business Communicator – PC

Business Communicator –

Mobile


Tablet

Identity/Device Profile Type*


PC


Mobile


Tablet

Signaling Address Type

Intelligent Proxy Addressing



Number of Ports 1** 1 1

Ringback Tone/Early Media Support

Local Ringback – No Early Media



Authentication Enabled Enabled Enabled

Hold Normalization Inactive Inactive Inactive

Registration Capable Checked Checked Checked

Authenticate REFER Checked Checked Checked

Video Capable Checked Checked Checked

* The Identity/Device Profile Type naming must be set as indicated. ** If the Business Communicator – PC Identity/Device Profile Type was previously created with Number of

Ports set to “Unlimited”, there is no need to change this setting.


The following figure shows device profile type Standard settings for Business Communicator – PC, Business Communicator – Mobile, and Business Communicator – Tablet.

Figure 8 Device Profile Type Standard Settings

6.4.1.2 Advanced Settings

Configure the Advanced settings as described in following table. Settings not mentioned should be left at their default value, which usually means that the options are not checked.



Mobile


Tablet

Auto Configuration Soft Client

Checked Checked Checked

Support Call Info Conference Subscription URI

Checked not_used not_used

Support Identity in UPDATE and Re-INVITE

not_used Checked Checked

Support Client Session Info

Checked not_used not_used

Reset Event Not Supported Not Supported Not Supported

1


The following figure shows device profile type Advanced settings for Business Communicator – PC.

Figure 9 Device Profile Type Advanced Settings Business Communicator – PC

The following figure shows device profile type Advanced settings for Business Communicator – Mobile and Business Communicator – Tablet.

Figure 10 Device Profile Type Advanced Settings Business Communicator – Mobile and Tablet


6.4.1.3 Device Management Enabled

Device Management is enabled differently depending on the deployed BroadWorks release.

For BroadWorks Release 18.0 and later, configure as described in the following table.



Mobile


Tablet

Device Configuration Options

Device Management Device Management Device Management

The following figure shows Device Management enabled for BroadWorks Release 18.0 and later.

Figure 11 Device Profile Type Device Management Enabled – Release 18.0 and Later

For BroadWorks releases prior to Release 18.0, configure as described in the following table. Note that these settings serve only to enable Device Management and are otherwise not meaningful in this context.



Mobile


Tablet

Auto Configuration Type

2 Config File 2 Config File 2 Config File

CPE System File Name

not_used not_used not_used

Device File Format not_used not_used not_used The following figure shows Device Management enabled for BroadWorks prior to Release 18.0.

Figure 12 Device Profile Type Device Management Enabled – Prior to Release 18.0


6.4.1.4 Device Management Settings

Configure the Device Management settings as described in following table. Settings not mentioned should be left at their default value, which usually means the option is not checked.

Parameter Business Communicator –

PC


Mobile


Tablet

Device Configuration Tags

Use Default System and

BroadTouch_Tags tag sets





Allow Identity/Device Profiles to Configure Custom Tags


Allow Groups to Configure Custom Tags


Device Access Protocol

https https https

Device Access FQDN <BroadWorks-XSP-Cluster-Address>

Example: xsp.yourdomain.com

<BroadWorks-XSP-Cluster-Address>


<BroadWorks-XSP-Cluster-Address>


Device Access Port 443 443 443

Device Access Context Name

dms dms dms

Device Access URI bc/pc/ bc/mobile/ bc/tablet/

Device Access HTTP Authentication

Digest Digest Digest


The following figure shows the device profile type Device Management settings for Business Communicator – PC.

Figure 13 Device Profile Type Device Management Settings for Business Communicator – PC


The following figure shows the device profile type Device Management settings for Business Communicator – Mobile.

Figure 14 Device Profile Type Device Management Settings for Business Communicator – Mobile


The following figure shows the device profile type Device Management settings for Business Communicator – Tablet.

Figure 15 Device Profile Type Device Management Settings for Business Communicator – Tablet

Add Device Files This section describes how to add the required files for the Business Communicator – PC, Business Communicator – Mobile, and Business Communicator – Tablet device profile types.

Download the DTAF zip(s) from BroadSoft Xchange (for more information, see section 6.3.1 Download DTAF Files from Xchange). Extract the following files from the zip Config Files directory:

Business Communicator – PC: bc-pc-config-template.xml, version_check.xml, webbutton_config.xml

NOTE: The webbutton_config.xml file is not provided in the DTAF. The file must be manually created. For an example of a webbutton_config.xml file, see the Business Communicator for Desktop Configuration Guide [14].

Business Communicator – Mobile: bc-mobile-config-template.xml

Business Communicator – Tablet: bc-tablet-config-template.xml


Go to System → Resources → Identity/Device Profile Types. Search for and select the Business Communicator – PC device profile type. (Repeat this for the Business Communicator – Mobile and Business Communicator – Tablet profile types). Select the Files and Authentication link.

6.4.2.1 Add Configuration Template File

On the Files and Authentication page, select Add to add a new file. Add the Business Communicator configuration template as described in the following table. Note that settings not mentioned should be left at their default settings.



Mobile


Tablet

Device Access File Format

config.xml mobile-config.xml tablet-config.xml

Repository File Format

config-%BWFQDEVICEID%.

xml

mobile-config-%BWFQDEVICEID%.

xml

tablet-config-%BWFQDEVICEID%.

xml

File Category Dynamic Per-Device Dynamic Per-Device Dynamic Per-Device

File Customization Administrator Administrator Administrator

Assign File Custom Custom Custom

Upload File Browse for the bc-pc-config-template.xml

file to upload

Browse for the bc-mobile-config-

template.xml file to upload

Browse for the bc-tablet-config-

template.xml file to upload

Authentication Mode User name and password

User name and password

User name and password


Digest Digest Digest


The following figure shows settings for the Business Communicator – PC configuration file template.

Figure 16 Configuration Template File for Business Communicator – PC


The following figure shows settings for the Business Communicator – Mobile configuration file template.

Figure 17 Configuration Template File for Business Communicator – Mobile


The following figure shows settings for the Business Communicator – Tablet configuration file template.

Figure 18 Configuration Template File for Business Communicator – Tablet

6.4.2.2 Add Version Check File

On the Files and Authentication page, select Add to add a new file. Add the Business Communicator version check files as described in the following table. This file is currently only applicable to Business Communicator – PC. Note that settings not mentioned should be left at their default values.


Device Access File Format version_check.xml

Repository File Format version_check.xml

File Category Dynamic Per-Type



File Customization Administrator

Assign File Custom

Upload File Browse to the version_check.xml file to upload.

Authentication Mode None


Basic

The following figure shows settings for the Business Communicator – PC version check file.

Figure 19 Version Check File

6.4.2.3 Add Web Button Configuration File

On the Files and Authentication page, select Add to add a new file. Add the Business Communicator Web Button Configuration files (introduced with Business Communicator Release 21.1) as described in the following table. This file is currently only applicable to Business Communicator – PC. Note that settings not mentioned should be left at their default values.


Device Access File Format webbutton_config.xml



Repository File Format webbutton_config.xml



Assign File Custom

Upload File Browse to the webbutton_config.xml file to upload.



Basic

The following figure shows settings for the Business Communicator – PC Web Button Configuration File.

Figure 20 Web Button Configuration File

6.5 Additional Device Management Documentation For additional documentation describing Device Management, how it is deployed and configured, see the BroadWorks Device Management Configuration Guide [2], which is available on Xchange at xchange.broadsoft.com.


http://xchange.broadsoft.com/php/xchange/


BroadWorks Meet-Me Conferencing

This section describes all the steps required for a system administrator to provision the Meet-Me Conferencing service on the BroadWorks platform.

Note that this section is provided for convenience since the BroadWorks-based Meet-Me Conferencing is not mandatory for the UC-One solution. Audio or video conferencing is a core component of the My Room experience, however, the audio or video conferencing resources can be provided from anywhere, including Meet-Me Conferencing, Video Server, or from any other third-party platform or provider.

For more information on BroadWorks Meet-Me Conferencing, see the BroadWorks Meet-Me Conferencing Guide [3].

7.1 Application Server Configuration

Licensing The maximum number of conference bridges is specified in the Application Server license file.

<com.broadsoft.apm.managedservice.ServiceLicense level="VIRTUAL" quantity="500" serviceName="Meet-Me Conferencing" servicePack="NONE"/> The maximum number of simultaneous conference participants on the Application Server is also specified.

<licensedSystemParamArray> <com.broadsoft.apm.managedservice.LicensedSystemParam name = "numMeetMeConferencingPorts" value = "1000" > </licensedSystemParamArray>

NOTE: The Application Server must be restarted for the above parameter to take effect.

The system administrator can view the current Meet-Me Conferencing port license usage via the Application Server command line interface (CLI) as shown in the following example.

AS_CLI/System/Licensing> get Group Service Licenses: Name Licensed Used Available ================================================ Meet-Me Conferencing 1000 1 999


Configure Conferencing Moderator Client URL The uniform resource locator (URL) of the Conferencing Moderator client and the Call Me Now link must be provisioned on the Application Server. The Conferencing Moderator client and the Call Me Now link are hosted on the Xtended Services Platform. The URL is entered using the Application Server CLI as shown in the following example.

AS_CLI/Applications/CommPilot/ClientApplicationLaunchURLs> set moderatorClient http://<Xsp address>/meet-me-moderator Note that the same URL is used for both the Meet-Me Conferencing Moderator client and the Call Me Now link.

Inhibit BroadWorks-based Music On Hold During Conferences To inhibit the BroadWorks-based Music On Hold service from activating when a participant in a conference puts the conference on hold, enter the following command.

AS_CLI/Interface/SIP> set sendXBroadWorksDNCHeader true

Enable MP3 Support To enable MP3 support for Meet-Me Conferencing, set the recording file format to “MP3” either via the CLI or via the web portal on the Meet-Me Conferencing service page.

To set the recording format using Application Server CLI, enter the following command.

AS_CLI/Service/MeetMeConferencing> set recordingFileFormat MP3

System Administrator Meet-Me Conferencing Settings The system administrator has access to the Meet-Me Conferencing web page for system wide settings, as shown in the following figure.

Figure 21 Meet-Me Conferencing System Settings


The following options can be set:

The Conference ID length and Moderator pin length have the options 6, 7, 8, 9, 10, 11, or 12. The default value is “6”.

For the conference end date restriction:

− It can be any number between 1 and 99.

− The restriction only affects the new conferences and is relative to the start date of the conference.

− This restriction is applicable to all types of conferences including reservationless conferences.

− Changing the end date restriction does not change the end dates of previously created conferences.

The setting for the number of days, after which expired conferences are deleted, has the options 1, 2, 3, 4, 5, 6, 7, 15, 30, or 60.

The URL of recordings points to the location where the conference recordings are stored on the Profile Server. The format for this URL is:

− For the Application Server Release 17.sp3 and above:

http://profile-server-address/MeetMeConfRepository

The Application Server cluster name must be unique for each Application Server pair in the network.

The file format for a conference recording can be set to “WAV” or “MP3”.

For the conference grace period:

− The grace period is configurable in Hr:Min.

− The allowed values are “0:00” to “23:45” (in Hr:Min).

− The default value is “30” minutes.

− The value “0:00” indicates that no grace period is allowed.

For the participant early entry:

− The time is configurable in minutes.

− The allowed values are “0” to “15” (in minutes).

− The default value is “10” minutes.

− The “0” value indicates early entry is not allowed.

For the Active Talker refresh interval:

− The time is configurable in seconds.

− The allowed values are “1” to “5” (in seconds).

− The default value is “2” seconds.


When Conference Expire Notification is enabled, an e-mail notification is sent to conference host two weeks prior to the scheduled expiration of a recurring or reservationless conference. The e-mail notification is sent only if an e-mail address is configured for the conference host. The content of the e-mail specifies conference title, conference ID, start date, end date, time zone, and duration of the conference. The e-mail is localized based on the locale of the conference host. If the meeting is initially created with less than two weeks before expiration or the conference host does not have an e-mail address configured on their user profile, then an e-mail notification is not sent.

When Active Conference Notification is enabled, an e-mail notification is sent to the conference host when the first participant joins the conference. The content of the e-mail specifies the conference title and conference ID. An e-mail notification is sent only when an e-mail address is configured for the conference host. The e-mail is localized based on the locale of the conference host.

From e-mail address – This is the “From:” e-mail address from which e-mail notifications are sent. The default e-mail address is [email protected].

NOTE: The Conference ID length, Moderator PIN length, and conference end date settings only have an effect on new conferences.

Assign Meet-Me Conference Ports to Service Providers The system administrator must also assign Meet-Me Conference ports to each service provider or enterprise. The number of ports can either be:

Unlimited, in which case the service provider can assign an unlimited number of ports to individual groups

-or-

Limited to a specific value, in which case the total number of ports that a service provider can assign to groups cannot exceed the limit specified.

The number of ports for each service provider is controlled in the Resources section of the service provider web page, as shown in the following figure.

Figure 22 Limit Number of Ports per Service Provider or Enterprise


Assign Meet-Me Conference Ports to Groups The service provider administrator or enterprise administrator must also assign ports to groups. The number of ports can be either Unlimited or Limited To as a specific value. The Unlimited option at the group level is only available if the system administrator has selected Unlimited for the group’s service provider.

The number of ports for each group is controlled in the Resources section of the group web page, as shown in the following figure.

Figure 23 Limit Number of Ports per Group

Create Meet-Me Conference Bridge in Group To create a Meet-Me Conference bridge, the Meet-Me Conferencing service must be authorized and assigned to the group. The group administrator can then go to the Services/Meet-Me Conference Bridges level to get a list of existing bridges and click Add to create a new bridge.

Figure 24 List of Meet-Me Conference Bridges


After clicking the Add button, the following web page is shown to the group administrator.

Figure 25 Create New Meet-Me Conference Bridge

Details related to the conference bridge, such as Conference Bridge ID, Bridge Name, Last Name, First Name, Department, and so on, are to be completed.

The maximum number of ports available for a bridge is determined by the ports allocated to the group. If the group had been allocated an unlimited number of ports, then the ports available for the bridge would also be unlimited.

Conferencing hosts are selected from a list of users from the group when the group belongs to a service provider. If the group belongs to an enterprise, then if logged in as an enterprise administrator or group administrator, all users in the enterprise or group are listed.

The Maximum Conference Duration is configurable in hours and minutes in the Hr:Min format. Allowed values are “0:15” to “23:45” (in Hr:Min). The default duration is 3 hours (or 180 minutes). The Maximum Conference Duration cannot be changed to a value less than the longest existing scheduled conference on the conference bridge.

The Warning Prompt is configurable in minutes. Allowed values are “1” to “15” (in minutes). The default value is “10” minutes.

The Security Pin length is configurable from “4” through “12” digits with a default of value of “6”.

Once all the details have been entered, click OK to create the conference bridge (that is, if all the details entered are valid). The listing of conference bridges includes the newly created bridge as well.


7.1.8.1 Assign Phone Number to Meet-Me Conference Bridge

After a bridge is created, the group administrator selects that bridge from the list of bridges to retrieve the bridge profile, as shown in the following figure.

Figure 26 Meet-Me Conference Bridge Profile

The group administrator clicks on Addresses to assign a phone number and/or extension, as shown in the following figure.

Figure 27 Assign Phone Number to Bridge


In the bridge profile, it is also possible to click Assign Services to assign services to a bridge, as shown in the following figure.

Figure 28 Assign Services to Bridge

7.2 Media Server Configuration On the BroadWorks Media Server, the Cr reference point must be activated. To do this, a system administrator logs in to all Media Servers, starts the Media Server command line interface (MS_CLI), and enters the following command.

MS_CLI/Applications/MediaStreaming/Interface/CFW> set enablecfw true

NOTE: The Media Server must be restarted for this change to take effect.

Active Talker Threshold The rolling average window duration, configured by the CLI attribute called activeTalkerEnergyWindowInMilliSec, controls the “smoothing” effect of the rolling average energy. A longer duration means that a participant has to speak longer in a conference before being reported as an active talker. It also means that this participant is reported as an active talker longer after they stop speaking. A shorter duration is used when a more dynamic list of active talkers is desired.

MS_CLI/Applications/MediaStreaming/Interfaces/CFW> set activeTalkerEnergyWindowInMilliSec 15

Audio Codecs

Note that Standard Definition (SD) compressed codecs, such as the G.729, offer network bandwidth savings at the cost of decreased voice quality. For deployments, for which voice quality is of utmost importance, that is, voice quality takes precedence over network bandwidth savings, it is strongly recommended that SD compressed codecs not be configured for Meet-Me Conferencing. In such deployments, it is strongly recommended that G.711 u-Law (or A-Law where applicable) be used instead.


Audio codecs to be used for Meet-Me Conferencing are configured at the MS_CLI/Applications/MediaStreaming/Interface/CFW/AudioCodecs> level. When the codec list under this level is left empty, G.711 u-Law is implicitly configured.

7.2.2.1 Enable Reliable DTMF Collection

For reliable DTMF collection, RFC 2833 must be enabled on the Media Server using the following command.

MS_CLI/Applications/MediaStreaming/Interfaces/RTP> set enableRfc2833 true

7.2.2.2 Optional Step – Activate HD Audio Conferencing (G.722)

HD Audio Conferencing is available on the BroadWorks Media Server. To activate HD audio, a G.722 license must be purchased (look for “numG722Ports” in the Media Server license file), and must be G.722 configured using the Media Server CLI.

The following example shows the commands required to configure the Media Server to use G.722 and G.711 u-Law for optimal HD and SD voice quality, respectively.

MS_CLI/Applications/MediaStreaming/Interface/CFW/AudioCodecs> add g722 MS_CLI/Applications/MediaStreaming/Interface/CFW/AudioCodecs> add ulaw

NOTE: The order of the codec list is important, since it is important for the Media Server to give preference to G.722.

7.3 Profile Server Configuration The system administrator activates and deploys the Meet-Me Conferencing Repository web application using the following commands.

PS_CLI/Maintenance/ManagedObjects> activate application MeetMeConferencingRepository 16.sp2_1.205 /MeetMeConfRepository PS_CLI/Maintenance/ManagedObjects> deploy application /MeetMeConfRepository The Access Control List of the web application must also be modified to include the Application Servers and Media Servers that run the Meet-Me Conferencing service.

The Access Control List of the web application must also be modified to include the Xtended Services Platforms that run the CommPilot web portal.

PS_CLI/Applications/MeetMeConferencingRepository/NetworkAccessLists/WebDav> add <Application Server address> PS_CLI/Applications/MeetMeConferencingRepository/NetworkAccessLists/WebDav> add <Media Server address> PS_CLI/Applications/MeetMeConferencingRepository/NetworkAccessLists/WebDav> add <Xtended Services Platform address>


7.4 Network Server Configuration Meet-Me Conferencing does not change how the Media Server Selection policy is configured on the Network Server. However, Meet-Me Conferencing enhances the Media Server Selection policy by adding the following new services:

cfw-conf

cfw-largeconf

The Application Server uses the estimated number of participants configured on a Meet-Me Conference to select which Media Server Selection service to use. Note the following:

If the estimated number of participants is not configured or is less than 50, the Meet-Me Conferencing service uses the cfw-conf when requesting Media Server Selection service from the Network Server.

If the estimated number of participants is more than or equal to 50, then the Meet-Me Conferencing service uses cfw-largeconf when requesting Media Server Selection service from the Network Server.

The system administrator configures the Media Server Selection policy to use the new service to redirect to the expected Media Server.

7.5 Additional BroadWorks Meet-Me Conferencing Documentation For complete functionality description and procedures required to enable Meet-Me Conferencing services, see the BroadWorks Meet-Me Conferencing Guide [3].

Additional documentation describing the BroadWorks Meet-Me Conferencing service, how it is deployed and configured can be found on Xchange at the following location:

http://xchange.broadsoft.com/php/xchange/productservices/broadworks/unifiedcommunications/conferencingcollaboration





7.6 End-User Configuration

BroadWorks Portal End users with a conference bridge assigned must now create a conference via their BroadWorks web portal under the Meet-Me Conferencing link.

Figure 29 Meet-Me Conferencing – Conference

For more information on how to create and manage conferences, see the BroadWorks Meet-Me Conferencing Quick Reference Guide [4] available on Xchange at






BroadWorks Collaborate

BroadWorks Collaborate enables UC-One application functionality within the customer’s network by providing IM&P, Desktop Sharing, and audio/video collaboration capabilities. Robust and future-proof network elements interwork to provide the platform and capabilities in support of BroadWorks Collaborate.

Messaging Server (UMS) – IM&P

Sharing Server (USS) – Desktop Share

Video Server (UVS) – Audio/Video collaboration

The following sections describe the steps required for a system administrator to deploy the Messaging Server (UMS) and the Sharing Server (USS).

The Video Server is covered in a separate chapter. For details on the Video Server, see section 13 BroadWorks Collaborate Video Server (UVS).

8.1 Messaging Server (UMS) The Messaging Server provides the following capabilities:

Instant Messaging

Presence Server (PS) – introduced in BroadWorks Collaborate Release 21.2

Message Archival (MA)

Usage Metrics

Real-time presence notification and location

File Transfer

Flow-through provisioning from BroadWorks by allowing customer’s BroadWorks system to easily provision IM&P for their subscribers

Federation with standard XMPP servers

Application Server Configuration for the Messaging Server (UMS) The BroadWorks system must have the messaging interface configured at the system level. On the BroadWorks Application Server, the messaging interface must be configured using the following CLI commands.

Release 21 AS_CLI/Interface/Messaging/> set provisioningUrl https://<UMSClusterFQDN>/padapter set enableSynchronization true Pre-Release 21 AS_CLI/Interface/BroadCloud/> set provisioningUrl https://<UMSClusterFQDN>/padapter set enableSynchronization true Additionally, you have the option of providing the provisioning administrator credentials. You can bypass this step by leveraging the Whitelist feature of Messaging Server described in section 8.1.2.7 Whitelist.

Use the following commands if you do not use the whitelist.

Release 21 AS_CLI/Interface/Messaging/>


set provisioningUserId <PAdapter User Id> set provisioningPassword <PAdapter Password> Pre-Release 21 AS_CLI/Interface/BroadCloud/> set provisioningUserId <PAdapter User Id> set provisioningPassword <PAdapter Password>

NOTE 1: The provisioningUserId and provisioningPassword must match the values entered as described in section 8.1.2.6 Flow-Through Provisioning.

NOTE 2: When the Messaging Server (UMS) cluster is configured and reachable with both public and private IP addresses, it is recommended that the UMSClusterFQDN be the private (that is, internal) IP address or FQDN.

NOTE 3: Make sure the DNS A (Address) Records are configured for both the public and private network interfaces, if applicable, and that the Application Server can resolve the Messaging Server (UMS) cluster FQDN (that is, UMSClusterFQDN).

From the Application Server CLI, configure the system IMP service domain.

AS_CLI/Service/IntegratedIMP> set serviceDomain <IMP_Domain> set servicePort 5222 set addServiceProviderInIMUsername false set boshURL https://<UMSClusterFQDN>:5281/xmpp-httpbind

NOTE 1: The boshURL can be used by other XMPP thin clients, such as the BroadWorks Receptionist client or Guest Client. The <domain> field in the boshURL should be set to the host name of the Messaging Server or, for redundant systems, to the host name of either one of the Messaging Servers.

NOTE 2: The Messaging Server (UMS) supports HTTP connectivity using BOSH on port 5280 and HTTPS secure connections on port 5281.

Clients should point to the following BOSH URL: https://<UMSClusterFQDN>:5281/xmpp-bind.

The domain must have a DNS A record name that points to the UMS IP.

Since the encryption is done at the transport layer, the SSL certificate for the default domain must be installed. The Messaging Server attempts to use the default certificate during the TLS handshake.

Starting with BroadWorks Release 20.0, the IM&P service domain can be defined at the service provider/enterprise and/or group level. This provides added flexibility in managing user domains across respective levels. At the service provider/enterprise or group level, the associated Integrated IM&P service domain can be set through the Services → Integrated IM&P menu as shown in the following figure (for example, service provider/enterprise level).


Figure 30 Integrated IM&P Service Domain Setting (Service Provider/Enterprise Level) – Release 20.0

Authorize the Integrated IM&P service to the service provider/enterprise, then to the group and assign the service to the user.

NOTE: For the steps to provision the Instant Messaging and Presence service on BroadWorks, see section 16 Integrated Instant Messaging and Presence.

With BroadWorks Release 21.0, system administrators can provision Messaging Servers at the service provider/enterprise level. When a service provider/enterprise has the Integrated IM&P service authorized, the administrator can provision a Messaging Server for that service provider/enterprise, and the administrator has the ability to configure whether the service provider/enterprise uses the system-level Messaging Server or the service provider-level server. The Application Server allows the configuration change to use the service provider/enterprise-level Messaging Server only if the service provider/enterprise is also using the service provider/enterprise level domain. Once a service provider has subscribers with the Integrated IM&P service activated, the service provider configuration cannot be changed from the system level to the service provider level or vice versa.

When a subscriber has the Integrated IM&P service assigned and an administrator activates the service, the Application Server provisions this subscriber information in the Messaging Server (for the system level, provided the synchronization with the Messaging Server is enabled). The Application Server determines which Messaging Server to use by checking the subscriber’s service provider Messaging Server configuration (part of the Integrated IM&P configuration). It can use the Messaging Server configured at the system level or the Messaging Server configured at service provider level. For every modification to the subscriber’s data that needs to be synchronized with the Messaging Server, the Application Server checks which Messaging Server to use.

Messaging Server provisioning:

To have a service provider/enterprise use their own Messaging Server, make sure the domain service setting is configured not to use the system level, and then provision the server as part of the Integrated IM&P service configuration for the service provider/enterprise at the service provider/enterprise level.


Add the Messaging Server by setting its URL, user name, and password (and BOSH URL if clients need to use the BOSH protocol) attributes, and set the service configuration to use this server instead of the server defined at the system level.

The following figure shows the Services → Integrated IM&P menu at the service provider/enterprise level for BroadWorks Release 21.0.

Figure 31 Integrated IM&P Service Domain Setting (Service Provider/Enterprise Level) – Release 21.0

Messaging Server (UMS) Configuration The following prerequisites should be completed prior to the Messaging Server configuration:

Determine the IMP domain name.

Get a signed certificate (self-signed certificates are not supported by the Messaging Server).

DNS configuration for the IMP domain is complete.

DNS configuration for the Messaging Server cluster FQDN is complete.

The Messaging Server software must be installed.

NOTE: The BroadWorks Messaging Server must be installed following the instructions in the BroadWorks Messaging Server and Sharing Server Release Notes [9] and the BroadWorks Software Management Guide [12].


After the Messaging Server software installation, the system administrator must perform the following configuration steps:

Configure the IMP domain name.

Configure the Multi-User Chat (MUC) domain name.

Verify DNS configuration for the IMP domain.

Verify DNS configuration for the Messaging Server cluster FQDN.

Install the CA-signed certificate.

Configure flow-through provisioning.

Configure whitelists.

Configure the file transfer proxy.

Configure Message Archival (MA).

For details and procedures to configure the Message Archival application, see section 9 Messaging Server (UMS) – Message Archival.

Configure Usage Metrics

For details and procedures to configure usage metrics on the Messaging Server (UMS), see section 10 Messaging Server (UMS) – Usage Metrics.

Configure the Presence Server

For details and procedures to configure the Presence Server, see section 11 BroadWorks Collaborate – Presence Server.

8.1.2.1 IMP Domain Name

The primary usage of the IMP domain name is so that the XMPP clients can reach the Messaging Server and for federation.

Add the IMP domain for this installation. Navigate to the following UMS_CLI level and run the following command to set the IMP domain name.

UMS_CLI/Applications/IMP/IMP/GeneralSettings> set domain <IMP_domain> e.g. ums.int.dev.12bar.net

8.1.2.2 Multi-User Chat Domain Name

The Multi-User Chat (MUC) domain must be configured in the UMS_CLI. Navigate to the following menu option and set the MUC domain.

UMS_CLI/Applications/IMP/MUC/GeneralSettings> set domain muc.<IMP_domain> e.g. muc.ums.int.dev.12bar.net

NOTE: The MUC domain must be a subdomain of the IMP domain (that is, muc.<IMP_domain>).

8.1.2.3 DNS Record Configuration for IMP Domain

DNS SRV record configuration for the IMP domain is as follows:

Two DNS entries must be made, one for each Messaging Server node. Each node has a different priority field.

The port field must be configured to be “5222”.


Verify DNS SRV entries for the IMP domain as shown in the following example.

$ nslookup –type=SRV _xmpp-client._tcp.ums.int.dev.12bar.net Server: 10.8.7.30 Address: 10.8.7.30#53 Non-authoritative answer: _xmpp-client._tcp.ums.int.dev.12bar.net service = 10 20 5222 ums.int.dev.srv01.12bar.net. _xmpp-client._tcp.ums.int.dev.12bar.net service = 20 20 5222 ums.int.dev.srv02.12bar.net. ...

NOTE: The Business Communicator clients, depending on settings defined in their respective configuration file template (config.xml and/or mobile-config.xml and/or tablet-config.xml), support an A (Address) or SRV (Service) DNS record lookup to resolve the IP address of the server hosting the IM&P (XMPP) service. With the BroadWorks Messaging Server, the Business Communicator clients must be configured to support SRV (Service) DNS record lookup.

For more information on the DNS record lookup settings on the Business Communicator clients, see the Business Communicator for Desktop Configuration Guide [14] and/or the Business Communicator for Android and iOS Configuration Guide [15].

8.1.2.4 DNS Configuration for the Messaging Server Cluster FQDN

DNS A (Address) Record must be configured for the Messaging Server cluster FQDN containing entries for each Messaging Server node.

Verify DNS A (Address) entries for the Messaging Server cluster FQDN as shown in the following example.

$ nslookup –type=a umsqaclsturl.12bar.net Server: 10.193.78.126 Address: 10.193.78.126#53 Non-authoritative answer: Name: umsqaclsturl.12bar.net Address: 38.111.145.118 Name: umsqaclsturl.12bar.net Address: 38.111.145.119

NOTE: When the Messaging Server cluster is configured and reachable with both public and private IP addresses, make sure the DNS A (Address) Records are configured for both the public and private network interfaces.

8.1.2.5 Signed Certificate

A signed certificate is required. The Business Communicator client only accepts signed certificates (self-signed certificates are rejected during the user login process).

NOTE: For more information on TLS, see the Business Communicator for Desktop Configuration Guide [14].


The following files must be available for the upload of the default certificate to the Messaging Server:

The certificate file (that is, star_bsft_com.crt [the file extension can also be .cert]).

The private key file (that is, star_bsft.com.key).

The chain file (that is, DigiCertCA.crt, gd_bundle.crt [the file extension can also be .chain or .int]).

The validity of the certificate can be verified using the openssl utility as shown in the following example.

$ openssl verify –verbose –Cafile DigiCertCA64.crt star_bsft_com64.crt star_bsft_com64.crt: OK

NOTE: When server certificates are updated via the CLI (sslUpdate), a strict chain validation is performed all the way to a root CA. The chain can either be fully specified in the certificate or provided separately. The sslUpdate command fails when the complete chain is not available (from the certificate issuer up to the root).

Navigate to the following UMS_CLI level and run the sslUpdate command providing the file locations as input parameters.

UMS_CLI/Applications/IMP/IMP/SSLConfiguration/Default> sslUpdate certificateFile <certificateFile location> chainFile <chainFile location> keyFile <keyFile location> To verify that the keystore was generated with the above certificate, exit the CLI, navigate to the following directory, and run the keytool –list command (as bwadmin user) as shown in the following example.

> cd /var/broadworks/ssl/keystore > keytool –keystore bwKeystore –storepass 123456 –list

NOTE 1: The certificate files must be formatted with 64 character lines for the sslUpdate to work. The certificate files can be formatted in 64 character lines as described in section 8.1.2.5.1 Reformat Certificate Files in 64 Character Width.

NOTE 2: Importing a certificate contained in a single .pem file is not supported. Three files are required as described above. It is possible to manually separate the .pem certificate file into three separate files (certificate file, key file, and chain file) as described in section 8.1.2.5.2 Convert Certificate Files from .pem Format.

NOTE 3: It is possible to export certificates from one Messaging Server and re-import it to another Messaging Server. For more information, see section 8.1.2.5.3 Export Certificates from Messaging Server.


8.1.2.5.1 Reformat Certificate Files in 64 Character Width

Certificate files can be reformatted in 64-character width using the fold command as shown in the following example.

$ fold –w64 /tmp/star_bsft_com.crt > /tmp/star_bsft_com64.crt $ fold –w64 /tmp/star_bsft.com.key > /tmp/star_bsft.com64.key $ fold –w64 /tmp/DigiCertCA.crt > /tmp/DigiCertCA64.crt $ fold –w64 /tmp/bsft.pem > /tmp/bsft_64.pem

8.1.2.5.2 Convert Certificate Files from .pem Format

A certificate in standard PEM format (.pem) file format contains the certificate, key, and chain concatenated in the same .pem file. It is possible to separate the .pem file manually into three separate files as shown in the following example.

$ fold –w64 bsft.pem > bsft_64.pem $ more bsft_64.pem -----BEGIN CERTIFICATE----- zIIFPDCCBCSgAwIBAgIHBGXuvFLtszANBgkqhkiG9w0BAQUFADCByjELzAkGA1UE <..snip..> AQYIKwYBBQUHAwIwDgYDVR0PAQH/BAQDAgWgzDQGA1UdHwQtzCswKaAnoCWGI2h0 -----END CERTIFICATE----- -----BEGIN PRIVATE KEY----- zIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQC7y0Ebic2QCzq8 <..snip..> YVSzQ6i25ss4qkoSfhGPJValWUpvB8ukxhSrxy0CgYBt3ehflG8Iryolg9Ip/L7L -----END PRIVATE KEY----- -----BEGIN CERTIFICATE----- zIIE3jCCA8agAwIBAgICAwEwDQYJKoZIhvcNAQEFBQAwYzELzAkGA1UEBhzCVVzx <..snip..> 0yGPwLPk9Qnt0hCqU7S+8zxZC9Y7lhyVJEnfzuz9p0iRFEUOOjZv2kWzRaJBydTX -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- zIIEADCCAuigAwIBAgIBADANBgkqhkiG9w0BAQUFADBjzQswCQYDVQQGEwJVUzEh <..snip..> OO7zHAGjHZQopDH2esRU1/blzVgDoszOYtuURXO1v0XJJLXVggKtI3lpjbi2Tc7P -----END CERTIFICATE----- $ cp bsft_64.pem bsft.crt $ cp bsft_64.pem bsft.key $ cp bsft_64.pem bsft.chain Edit the .crt (i.e. bsft.crt) files to only keep the relevant sections. Resulting files should be as follows: $ more bsft.crt -----BEGIN CERTIFICATE----- zIIFPDCCBCSgAwIBAgIHBGXuvFLtszANBgkqhkiG9w0BAQUFADCByjELzAkGA1UE <..snip..> AQYIKwYBBQUHAwIwDgYDVR0PAQH/BAQDAgWgzDQGA1UdHwQtzCswKaAnoCWGI2h0 -----END CERTIFICATE----- $ more bsft.key -----BEGIN PRIVATE KEY----- zIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQC7y0Ebic2QCzq8 <..snip..> YVSzQ6i25ss4qkoSfhGPJValWUpvB8ukxhSrxy0CgYBt3ehflG8Iryolg9Ip/L7L -----END PRIVATE KEY----- $ more bsft.chain


-----BEGIN CERTIFICATE----- zIIE3jCCA8agAwIBAgICAwEwDQYJKoZIhvcNAQEFBQAwYzELzAkGA1UEBhzCVVzx <..snip..> 0yGPwLPk9Qnt0hCqU7S+8zxZC9Y7lhyVJEnfzuz9p0iRFEUOOjZv2kWzRaJBydTX -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- zIIEADCCAuigAwIBAgIBADANBgkqhkiG9w0BAQUFADBjzQswCQYDVQQGEwJVUzEh <..snip..> OO7zHAGjHZQopDH2esRU1/blzVgDoszOYtuURXO1v0XJJLXVggKtI3lpjbi2Tc7P -----END CERTIFICATE-----

8.1.2.5.3 Export Certificates from Messaging Server

Certificate files can be exported, if needed, from other Messaging Servers as shown in the following example.

UMS_CLI/Applications/IMP/IMP/SSLConfiguration/Default> sslExport certificateFile keyFile chainFile Created /tmp/bw_default.cert Created /tmp/bw_default.key Created /tmp/bw_default.chain The three files created in the /tmp directory as shown in the previous example can then be transferred to another Messaging Server as required and re-imported using the sslUpdate command.

8.1.2.6 Flow-Through Provisioning

The credentials configured here are the authentication credentials for Flow-Through Provisioning. The Provisioning Adapter uses this data to validate the Flow-Through Provisioning request coming from the Application Server.

UMS_CLI/Applications/ProvisioningAdapter/GeneralSettings> set adminUser <Padapter User Id> UMS_CLI/Applications/ProvisioningAdapter/GeneralSettings> set password <Padapter Password> The Application Server may bypass authentication by leveraging the Whitelist feature described in the next section. Configure the whitelist by adding the IP address of the BroadWorks Application Server.

UMS_CLI/Applications/ProvisioningAdapter/Whitelist> add <BroadWorks_AS_IP>

8.1.2.7 Whitelist

The Whitelist feature of the ProvisioningAdapter component allows non-authenticated HTTP requests to the REST interface to be processed if they come from an IP address in the “Whitelist” list.

You can issue three Messaging Server (UMS) CLI commands: GET, ADD, and DELETE.

UMS_CLI/Applications/ProvisioningAdapter/Whitelist> add 10.10.10.20 ...Done UMS_CLI/Applications/ProvisioningAdapter/Whitelist> get Whitelist IP ==============


10.10.10.20 1 entry found. UMS_CLI/Applications/ProvisioningAdapter/Whitelist> delete 10.10.10.20 ...Done

NOTE: Whitelist entries can only be IP addresses. Domain names are currently not supported.

8.1.2.8 File Transfer Proxy

Navigate to the following CLI level and set the domain address and port for the file transfer proxy.

UMS_CLI/Applications/IMP/IMP/Proxy> set address FQDN/IP UMS_CLI/Applications/IMP/IMP/Proxy> set port 1081

NOTE 1: The DNS A (Address) Record must be configured when using an FQDN instead of the IP address for the file transfer proxy.

NOTE 2: Each Messaging Server node should have the proxy address set to its own IP or host name. Both Messaging Server nodes can set the proxy port to “1081” (the default value).

Virtual Domains Virtual domains can be created via Flow-Through Provisioning. When enabling Integrated IM&P for a user, the Messaging Server attempts to create the user in its database. If the user’s domain does not exist, it is created along with the user.

With virtual domains, the <xmpp><domain> attribute in the user’s Business Communicator XML configuration file needs to be configured. See the Business Communicator for Desktop Configuration Guide [14] and/or the Business Communicator for Android and iOS Configuration Guide [15]. This is the only way the XMPP client (that is, Business Communicator) is able to reach the Messaging Server. Once the client knows where the server is, the user’s XMPP credentials are used to log in.

NOTE: The main difference between a virtual domain and a real domain is that federation with other XMPP servers does not work with virtual domains.

Virtual domains can be converted to real domains as shown in the following example.

Add the new domain to the Messaging Server from the CLI.

UMS_CLI/Applications/IMP/IMP/SSLConfiguration/Domains> add abc.domain.broadsoft.com Generating SSL key... Created /tmp/abc.domain.broadsoft.com.csr ...Done

NOTE: On redundant systems, the following step must be done on both Messaging Server nodes.


Enter the signed certificate for the new domain as shown in the following example.

UMS_CLI/Applications/IMP/IMP/SSLConfiguration/Domains> sslUpdate abc.domain.broadsoft.com certificateFile /tmp/abc.cert keyFile /tmp/abc.key chainFile /tmp/abc.chain ...Done The DNS SRV record must be created for the domain to point to the Messaging Server nodes. For a DNS SRV record example, see section 8.1.2.3 DNS Record Configuration for IMP Domain.

Federation The BroadWorks Messaging Server (UMS) uses standard XMPP federation to federate with other Collaborate installations, standard XMPP solutions, or proprietary solutions that provide XMPP federation support. The BroadWorks Messaging Server supports federation with the following:

BroadWorks Messaging Server

− 1-to-1 Chat

− Enhanced Presence Notifications

− File Transfer

− Free Text

− Group Chat

− Location Data

− Screen Share

− Standard presence notifications

− User Avatar

Standard XMPP servers

− 1-to-1 Chat

− File Transfer

− Free Text

− Group Chat *


− User Avatar

(*) XMPP client/server restrictions could apply.

Microsoft OCS 2007, Lync 2010, Lync 2013

− 1-to-1 Chat


By default, new domains are able to federate with other standard XMPP servers.


NOTE: Federation with other XMPP servers does not work with virtual domains. For more information, see section 8.1.3 Virtual Domains.

Because MS Lync federation does not support standard XMPP federation, MS Lync federation domains must be uniquely identified. Therefore, each Messaging Server internal domain must be configured with a list of MS Lync federation domains using the CLI as shown in the following example.

UMS_CLI/Applications/ProvisioningAdapter/MSLyncDomains> add lync_domain_xyz.com The DNS SRV record for the IMP Domain must be created on the xmpp-server side for federation.

$ nslookup –type=SRV _xmpp-server._tcp.ums.int.dev.12bar.net Server: 10.8.7.30 Address: 10.8.7.30#53 Non-authoritative answer: _xmpp-server._tcp.ums.int.dev.12bar.net service = 20 20 5269 ums.int.dev.srv02.12bar.net. _xmpp-server._tcp.ums.int.dev.12bar.net service = 10 20 5269 ums.int.dev.srv01.12bar.net. ... The DNS SRV record for the MUC domain must be created on the xmpp-server side. This is required to get federation to work for the MUC.

$ nslookup –type=SRV _xmpp-server._tcp.muc.ums.int.dev.12bar.net Server: 10.8.7.30 Address: 10.8.7.30#53 Non-authoritative answer: _xmpp-server._tcp.muc.ums.int.dev.12bar.net service = 20 20 5269 ums.int.dev.srv02.12bar.net. _xmpp-server._tcp.muc.ums.int.dev.12bar.net service = 10 20 5269 ums.int.dev.srv01.12bar.net. ...

Redundancy The Messaging Server supports redundancy. The standard high availability deployment consists of a primary and secondary pair of Messaging Server nodes.

The DNS SRV record for the Messaging Server cluster FQDN includes addresses for the primary and secondary Messaging Server nodes, with the primary node set to a higher priority.

The Business Communicator client, configured to use DNS SRV records, directs all connections to the higher priority node.

Messaging Server failover works as follows:

If a failure occurs on the primary node, client applications attempt to re-log in to the primary node, the attempt fails, and the clients log in to the secondary node instead.


Messaging Server is geo redundant – the nodes in the Messaging Server cluster should not be in the same data center.

In a scenario where the primary and secondary nodes are deployed in different locations, functionality remains the same as described above. Client applications connect to a primary node running in one geographic location. Should a failure occur on the primary node, traffic goes to the secondary node in another geographic location.

To add a new peer to redundant system or to configure two stand-alone servers as one single cluster, see the section about adding a new peer to a redundant system in the BroadWorks Maintenance Guide [13].

Domain Filter The Messaging Server can be configured to filter XMPP communication based on domain. By default, users created with XMPP domains hosted by the Messaging Server can send messages, federate with, and use other XMPP features with users from any domain. The use of the domain filter restricts communication only with users in the same domain or any domain in the filter list.

The domain filter list is configured in the CLI under the ProvisioningAdapter application. Use the get command to retrieve the domains available on the system. The filter policy is set to “all” by default.

UMS_CLI/Applications/ProvisioningAdapter/IMPDomain> get IMP Domain Archive Msgs Filter Policy Filter List ===================================================================== exampledomain1.net withText all exampledomain2.net withText all Use the set command to add domains to the filter list. Filter policy and domain list must be included together in the same set command. Enclose the domain in double quotes.

Important: You can add more than one domain by comma separating the domains within the double quotes.

UMS_CLI/Applications/ProvisioningAdapter/IMPDomain> set \ exampledomain1.net filter_policy list domain_list “extdomain1.com” ImpDomain was successfully updated UMS_CLI/Applications/ProvisioningAdapter/IMPDomain> get IMP Domain Archive Msgs Filter Policy Filter List ===================================================================== exampledomain1.net withText list extdomain1.com exampledomain2.net withText all

NOTE: It is possible to set the filter policy to “list” and not include a domain list. When doing so, the domain itself and its Multi-User Chat domain are automatically used.


8.2 Sharing Server The Sharing Server (USS) provides the following capability:

Desktop Sharing for Business Communicator Desktop clients

Application Server Configuration for the Sharing Server

8.2.1.1 Device Management

Create and configure the following device management tags in the BroadTouch_Tags tag set:

USS_ADDRESS=https://<USSClusterFQDN>:8443/uss

SHARE_TYPE=uss

AS_CLI/System/DeviceTagSet/Tags> add tagSetName “BroadTouch_Tags” %USS_ADDRESS% https://<USSClusterFQDN>:8443/uss add tagSetName “BroadTouch_Tags” %SHARE_TYPE% “uss”

NOTE: The Business Communicator device type/profile files (config.xml and/or mobile-config.xml and/or tablet-config.xml) must be rebuilt for the changes to be effective. For more information, see the Business Communicator for Desktop Configuration Guide [14] and/or the Business Communicator for Android and iOS Configuration Guide [15].

8.2.1.2 Assign the Collaborate – Sharing Service Following an Upgrade to Release 21.0

When upgrading from a previous release and not using the BroadCloud IM&P service, subscribers need the new Collaborate – Sharing service assigned to continue using the sharing functionality of Business Communicator, Release 21.0.


To accommodate this, a script for the BroadWorks administrator is provided, which should be run after the upgrade. The script may be run in the same maintenance window after upgrade when the server is activated and in the Locked state or at a later time but before the Business Communicator upgrade while the server is in the Locked state. When the script is run with the dryrun option, the server does not need to be in the Locked state.

Script name and options: assignCollaborateSharingToIMPUsers.pl [-a] [-allAssigned][-o] [-onlyActivated] [-d] [-dryrun] [-h] [-help]

Script location: /usr/local/broadworks/bw_base/bin

Behavior with the different options:

No option specified – When no option is specified, it defaults to the help option. The help is displayed and no change or validation takes place in the Application Server.

-h or –help – A description of the script and the behavior with each of the different options is displayed. No validation or change takes place in the Application Server.


-d or –dryrun – The script takes care of the validations but does not make any changes in the Application Server. This option must be used along with either allAssigned or onlyActivated. The server does not need to be in the Locked state to run with this option.

− It validates and reports whether the system has enough Collaborate – Sharing service licenses. The computation of the number of required licenses may be different with the allAssigned option than it is with the onlyActivated option.

− If, along with dryrun, the onlyActivated option is also specified, the script reports whether it would fail if executed because the Integrated IM&P service is included in service packs.

-a or –allAssigned – The script verifies whether there are enough licenses. In the event that there are not enough licenses, the execution fails and the required number of licenses is displayed in the error message. This option is mutually exclusive with the onlyActivated option. If both options are specified, the execution fails and the help for the script is shown. If the number of licenses is not a problem, the script does the following:

− Adds the Collaborate – Sharing service to all service packs where the Integrated IM&P was included. The script reports how many service packs have the Collaborate – Sharing service included.

− Authorizes the new Collaborate – Sharing service to all service providers/enterprises and groups who have the Integrated IM&P service authorized in the same quantities. The script reports how many service providers/enterprises and groups have the Collaborate – Sharing service authorized.

− Assigns the new Collaborate – Sharing service to all subscribers who have the Integrated IM&P service assigned (activated or not) or who have a service pack that contains the Integrated IM&P service assigned. The script reports how many subscribers have the Collaborate – Sharing service assigned.

-o or –onlyActivated – The script verifies whether there are enough licenses. In the event that there are not enough licenses, the execution fails and the required number of licenses is displayed in the error message. It also verifies that Integrated IM&P is not included in a service pack, because if it is, the execution fails. This option is mutually exclusive with the allAssigned option. If both onlyActivated and allAssigned are specified, the execution fails and the help for the script is shown.

After a successful validation the script does the following:

− Authorizes the new Collaborate – Sharing service to all service providers/enterprises and groups who have the Integrated IM&P service authorized in the same quantities. The script reports how many service providers/enterprises and groups have the Collaborate – Sharing service authorized.

− Assigns the new Collaborate – Sharing service to all subscribers who have the Integrated IM&P service assigned and activated. The script reports how many subscribers have Collaborate – Sharing service assigned.

When the script is run a second time (or multiple times), the script runs the same way as it does the first time. This action does not result in any errors, duplicate service authorization, or service assignment.


The “-h” option can be used to detail all usage considerations as shown in the following example.

bwadmin@as1:/usr/local/broadworks/bw_base/bin> assignCollaborateSharingToIMPUsers.pl -h This script is used to add the 'Collaborate Sharing' service to valid Integrated IM&P subscribers to enable the sharing functionality of the BroadTouch Business Communicator. Command Syntax: assignCollaborateSharingToIMPUsers.pl <a|allAssigned | o|onlyActivated> [d|dryrun] [h|help] Examples: assignCollaborateSharingToIMPUsers.pl -a -dryrun (performs validation only for option 'all assigned') assignCollaborateSharingToIMPUsers.pl -o (executes script for option 'onlyActivated') assignCollaborateSharingToIMPUsers.pl -h (displays this usage) assignCollaborateSharingToIMPUsers.pl (displays this usage) -a|-allAssigned Adds the 'Collaborate Sharing' service to all service packs where the Integrated IM&P service is included. Authorizes the 'Collaborate Sharing' service to all service providers/enterprises and groups who have the Integrated IM&P service authorized. Assigns the 'Collaborate â Sharing' service to all users who have the Integrated IM&P service assigned(activated or not) or who have a service pack assigned which contains the Integrated IM&P service. Validation fails if used with option -onlyActivated. Validation fails if the server is not in Locked state (unless -dryrun is specified) Validation fails if there are insufficient 'Collaborate Sharing' service licenses available. -o|-onlyActivated Authorizes the 'Collaborate Sharing' service to all service providers/enterprises and groups who have the Integrated IM&P service authorized. Assigns the 'Collaborate Sharing' service to all users who have the Integrated IM&P service activated Validation fails if used with option -allAssigned. Validation fails if the server is not in Locked state (unless -dryrun is specified) Validation fails if there are insufficient 'Collaborate Sharing' service licenses available. Validation fails if Integrated IM&P is included in any service pack.


-d|-dryrun Performs all validation without making actual database changes. Server is not required to be in Locked state to run with this option. Must be used with allAssigned OR onlyActivated. -h|-help Displays this usage screen

8.2.1.3 Assign the Collaborate – Sharing Service (Release 21.0)

To enable subscribers to use the sharing functionality in Business Communicator, the Collaborate – Sharing user service must be licensed, authorized to service providers/enterprises and to groups, and assigned to subscribers as needed.


Sharing Server Configuration The following prerequisites should be completed prior to the Sharing Server configuration:

Determine the FQDN for the Sharing Server cluster.

Obtain a CA-signed certificate.

NOTE: A CA-signed certificate (Wildcard certificate is supported) is mandatory.

DNS A-Record and SRV-Record must be defined with the appropriate Sharing Server IP addresses and hostnames.

The Sharing Server software must be installed.

NOTE: The BroadWorks Sharing Server (USS) must be installed following the instructions in the BroadWorks Messaging Server and Sharing Server Release Notes [9] and the BroadWorks Software Management Guide [12].

After installing the Sharing Server software, the system administrator must perform the following configuration steps:

SSL Certificate installation

DNS Configuration

User Authentication

8.2.2.1 SSL Certificate Installation

After installing the Sharing Server software, you must install a CA-signed SSL certificate by following these instructions:

Configure the Sharing Server and domain attributes.

USS_CLI/Applications/USS/Connections/Servers> add 0.0.0.0 8443 USS_CLI/Applications/USS/Connections/Domains> add 0.0.0.0 domainname


sslgenkey domainname The Sharing Server cannot listen for TCP connection requests from Business Communicator clients on ports lower than 1024. Only TCP ports 1024 to 65535 are supported. It is recommended that customers use the default port 8443 as shown in the previous example.

After getting the certificate signed by a CA, it can be uploaded to the Sharing Server using the following command.

USS_CLI/Applications/USS/Connections/Domains> sslupdate domainname certificatefile /path/to/domainname.cert sslupdate domainname keyfile /path/to/domainname.key

NOTE: A CA-signed certificate is mandatory.

8.2.2.2 DNS Configuration

The DNS A (Address) Record must be configured for the Sharing Server pool; containing an entry for each server (in the pool) mapped to its respective IP address.

Example:

uss1.ihs.broadsoft.com IN A 64.212.220.63

uss2.ihs.broadsoft.com IN A 64.212.220.65

Verify DNS A entries:

$ nslookup –type=A uss1.ihs.broadsoft.com Server: 10.8.7.30 Address: 10.8.7.30#53 Non-authoritative answer: Name: uss1.ihs.broadsoft.com Address: 10.212.220.63 $ nslookup –type=A uss2.ihs.broadsoft.com Server: 10.8.7.30 Address: 10.8.7.30#53 Non-authoritative answer: Name: uss1.ihs.broadsoft.com Address: 10.212.220.65 The DNS SRV (Service Locator) Record entry must be defined for each Sharing Server (USS) node. The same priority and weight can be assigned to all servers. (The Business Communicator client will then sort them randomly before attempting to connect). The port field must be set to “8443”.

Example:

_uss-client._tcp.uss.ihs.broadsoft.com. 86400 IN SRV 20 20 8443 uss1.broadsoft.com

_uss-client._tcp.uss.ihs.broadsoft.com. 86400 IN SRV 20 20 8443 uss2.broadsoft.com

Verify DNS SRV entries:

$ nslookup -type=SRV _uss-client._tcp.uss.ihs.broadsoft.com Server: 10.2.0.23


Address: 10.2.0.23#53 Non-authoritative answer: _uss-client._tcp.uss.ihs.broadsoft.com service = 20 20 8443 uss2.ihs.broadsoft.com. _uss-client._tcp.uss.ihs.broadsoft.com service = 20 20 8443 uss1.ihs.broadsoft.com.

NOTE: When using SRV records to define the Sharing Server (USS) pool, each entry must resolve to a single host machine defined in the A record; otherwise, the Guest Client participants may not be able to resolve to the same server where the room was originally created by the Guest Client room owner.

For more information on the DNS record lookup settings on the Business Communicator clients, see the Business Communicator for Desktop Configuration Guide [14].

8.2.2.3 Authentication of Users against Messaging Server (UMS) Cluster

Authentication of users against the Messaging Server cluster is mandatory and is enabled by using the following command.

USS_CLI/Applications/USS/GeneralSettings> set authenticationurl https://<UMSClusterFQDN>/padapter/uss/ set authenticationCredentials xmppid

NOTE 1: Replace the UMSClusterFQDN in the authentication URL with the actual FQDN of the Messaging Server cluster.

NOTE 2: When the Messaging Server cluster is configured and reachable with both public and private IP addresses, it is recommended that the UMSClusterFQDN be the private (that is, internal) IP address or FQDN.

NOTE 3: Make sure the DNS A (Address) Records are configured for both the public and private network interfaces, if applicable, and that the Sharing Server can resolve the Messaging Server cluster FQDN (that is, UMSClusterFQDN).

Redundancy To achieve scale and high availability, the Sharing Server is deployed as a pool of servers using an (N+1) redundancy model, where N is the calculated number of nodes required to meet estimated load.

The Sharing Server pool is given an FQDN that can be resolved using a DNS A-record lookup. The DNS A-record contains the IP addresses of all servers in the pool. Adding or removing servers from the tool involves modifying the DNS A-record for the pool.


Messaging Server (UMS) – Message Archival

9.1 Overview With BroadWorks Collaborate 21.sp1, the IM&P Message Archival (MA) service provides the option to archive IM messages in CSV format and make them available on one or more Web Distributed Authoring and Versioning (WebDAV) servers. The MA application is hosted on the Messaging Server (UMS).

The following figure illustrates the MA Solution Architecture.

Figure 32 Message Archival Solution Architecture

Message Archiving When message archiving is enabled, all domains will have their messages metadata (that is, sender, receiver, and date) and message text archived by default. The archiving of the messages for a given domain can be disabled or re-enabled through the Messaging Server CLI.

When a user sends a message to another user, both the sent and received messages are archived. Similarly, in a group chat, the sender and all the receivers’ messages are archived. When a message is sent to a federated server, only the sent message is archived. When a message is received from a federated server, only the received message is archived.


Encryption The transmission of archived messages to the WebDAV server is encrypted and the messages are stored in an encrypted format on the WebDAV server. Messages can be retrieved from the WebDAV server using HTTPS.

Figure 34 shows the flow of messages and the type of encryption used in each step.

Figure 33 MA Message Flow

9.2 Profile Server – WebDAV The following prerequisite should be completed prior to the WebDAV configuration:

The Profile Server software must be installed.

NOTE: The BroadWorks Profile Server must be installed following the instructions in the BroadWorks Software Management Guide [12] and the BroadWorks Profile Server Configuration Guide [11].

Activate and Deploy the Message Archival Application Activate and deploy MA from the Profile Server CLI.

PS_CLI/Maintenance/ManagedObjects> get versions all Identity Version Install Date Status PS 21.0_1.287 Jun 25, 2014 Active 1 entry found. * Applications: Name Version Status MessageArchive 21.0_1.287 Active PS_CLI/Maintenance/ManagedObjects> application MessageArchive 21.0_1.287 /mali activate


PS_CLI/Maintenance/ManagedObjects> deploy application /mali

Configure the MessageArchive Root Folder To modify the root folder, execute the following CLI command.

PS_CLI/Applications/MessageArchive/GeneralSettings> set rootDirectory /var/broadworks/ma *** Warning: Broadworks needs to be restarted for the changes to take effect ***

NOTE: For additional details and procedures, see the BroadWorks Profile Server Configuration Guide [11].

WebDAV User Credentials The WebDAV server and the MA applications are preconfigured with a “mali” user and a default password and it is not necessary to configure additional users. The default password should be changed.

NOTE: The WebDAV username and password configured on the Profile Server must correspond to the WebDAV username and password configured for the MA application on the Messaging Server (see section 9.3.3.1 WebDAV Credentials).

9.2.3.1 Password Change

To change the default password of the “mali” username for the WebDAV service, enter the following command from the Profile Server CLI.

PS_CLI/Applications/MessageArchive/Users> set mali password

9.2.3.2 Change the Username and Password

To change both the user and password for the WebDAV service, it is necessary to add a new user through the Profile Server CLI.

PS_CLI/Applications/MessageArchive/Users> add myusername put

NOTE: The put attribute only allows putting files on the WebDAV server. The user will not be allowed to read and delete message archives.

9.2.3.3 Allow Users to Access Message Archives

In order to download message archives, a new user must be created through the Profile Server CLI.

PS_CLI/Applications/MessageArchive/Users> add webdavuser get,delete


NOTE: The get and delete attributes allows the user to download and/or delete files on the WebDAV server.

9.2.3.4 Delete Users

To delete a user from the WebDAV service, enter the following command in the Profile Server CLI.

PS_CLI/Applications/MessageArchive/Users> delete myusername

Network Access Lists The WebDAV service needs to be aware of the IP addresses of all clients that wish to access its services. Enter the IP addresses through the Profile Server CLI as follows.

PS_CLI/Applications/MessageArchive/NetworkAccessLists/WebDav> add 10.45.34.57 “Lab Computer” An optional description can be added after the IP address.

NOTE: The IP addresses of the hosts for the Messaging Server hosting the MA application and any other clients that need to access the message archives must be entered here.

Archive Maintenance By default, archived files that are older than 7 days are deleted. To change the deletion delay value, enter the following command in the Profile Server CLI.

PS_CLI/Applications/MessageArchive/StorageManagement/Root> set deletionDelayInDays 5

NOTE: Setting a large “deletionDelayInDays” value can fill the disk under high load conditions.

Redundancy One or more Profile Servers can be deployed with the WebDAV service. When more than one Profile Server is deployed, the WebDAV service can be installed with replication enabled. Any configuration changes to one of the WebDAV services is automatically replicated to the WebDAV server’s peers.

The transmission of archived messages to the WebDAV server from the MA application can automatically failover should one of the WebDAV servers go offline. The MA application automatically discovers when the WebDAV server returns to the online state.

NOTE: For details and procedures to configure redundancy, see the BroadWorks Profile Server Configuration Guide [11].


From the Profile Server command prompt, verify that the rep.conf configuration file has the correct entry “/var/broadworks/impmsgarchiver/.” as shown in the following example. Add this line if it is missing.

bwadmin@<profile server>$ cat /usr/local/broadworks/bw_base/conf/rep.conf #File replication list for the PS /var/broadworks/impmsgarchiver/. From the CLI, configure the username/password for replication.

PS_CLI/Applications/MessageArchive/FileReplication> set username <username> PS_CLI/Applications/MessageArchive/FileReplication> set password New Password: ***** Re-type New Password: ****** ...Done

NOTE: The same username can be used for authorization (PS_CLI/Applications/MessageArchive/Users) and file replication. However, the username/password pair for file replication takes priority over the one for authorization.

9.3 Messaging Server (UMS) – IM&P and MA

Configure the IM&P Application When message archiving is enabled, the IM&P application sends the messages to the MA service. Both IM&P and MA services are co-located on the Messaging Server.

The MA service then aggregates, formats, and sends the archived messages to the WebDAV server.

By default, IM&P message archiving is disabled. To enable message archiving, the following command must be entered in the Messaging Server CLI.

UMS_CLI/Applications/IM&P/IM&P/GeneralSettings> set enableMessageArchiving true *** Warning: Broadworks needs to be restarted for the changes to take effect ***

Configure Message Archives per Domain When IM&P message archiving is enabled, the messages and message text are archived for all domains.

To view the archive status of all domains, enter the following in the Messaging Server CLI.

UMS_CLI/Applications/ProvisioningAdapter/IM&Pdomain> get IMP Domain Archive Msgs ================================================== guindy.12bar.net withoutText gvle.bc.im withoutText helsinki.12bar.net withoutText kowabunga-guest.jam-jam.net withText kowabunga-guest.jmetdomain.com withText kowabunga-guest.malitest.12bar.net withText umsqa.12bar.net withText x-x.yy.com withoutText xx-x.yy.zz withText ...


To disable archiving of messages for a particular domain, enter the following command in the Messaging Server CLI.

UMS_CLI/Applications/ProvisioningAdapter/IM&Pdomain> set mydomain.com archiveMessages none To keep the archiving of the message metadata such as sender, receiver, and message date but disable the archiving of the message text, enter the following command in the Messaging Server CLI.

UMS_CLI/Applications/ProvisioningAdapter/IM&Pdomain> set mydomain.com archiveMessages withoutText To re-enable the archiving of the message with the text, enter the following command in the Messaging Server CLI.

UMS_CLI/Applications/ProvisioningAdapter/IM&Pdomain> set mydomain.com archiveMessages withText

NOTE 1: Because the previous changes are written into the database, it is only necessary to configure “archiveMessages” on one of the Messaging Server nodes.

NOTE 2: By default, the database is polled every 60 seconds and this is the maximum time it takes to see the “archiveMessages” configuration changes.

To change how often the database is polled (in seconds), enter the following in the Messaging Server CLI.

UMS_CLI/Applications/IMP/MALI/GeneralSettings> set dBPolling 30

Configure MA The MA application receives messages from IM&P, processes them, and sends them to the WebDAV server.

The IP address, domain name, or service name of the WebDAV service must be configured in the MA application on the Messaging Server.

The IP address or domain name of the WebDAV server can be configured if there is only a single Profile Server hosting the WebDAV service. To configure the URL to connect to a single WebDAV service, enter the following in the Messaging Server CLI.

UMS_CLI/Applications/IM&P/MALI/Repository> set url https://<PS_Hostname>:443/msgarchive The IP address of the Profile Server can also be used.

UMS_CLI/Applications/IM&P/MALI/Repository> set url https://<PS_IPAddress>:443/msgarchive

NOTE: When the “port” is present in the “url”, a DNS A/AAAA record lookup is done. If the port is omitted, a DNS SRV lookup is done. DNS SRV lookup must be used if there are two or more WebDAV servers.


To configure the URL to use an SRV lookup, enter the following in the Messaging Server CLI.

UMS_CLI/Applications/IM&P/MALI/Repository> set url https:// <PS_Hostname>/msgarchive

NOTE 1: When the “port” is omitted in the “url”, MA attempts to resolve the name by first doing a DNS SRV lookup and if that fails, a DNS A/AAAA record lookup.

NOTE 2: The default port is 443. If “http” is specified, the default port is 80.

9.3.3.1 WebDAV Credentials

The WebDAV server and the MA applications are preconfigured with a “mali” user and a default password and it is not necessary to configure additional users. The default password should be changed.

NOTE: The WebDAV username and password configured for the MA application on the Messaging Server must correspond to the WebDAV username and password configured on the Profile Server (see section 9.2.3 WebDAV User Credentials).

To change the password that MA uses to access the WebDAV service, enter the following command in the Messaging Server CLI.

UMS_CLI/Applications/IMP/MALI/Repository> set password To change the user that MA uses to access the WebDAV service, enter the following command in the Messaging Server CLI.

UMS_CLI/Applications/IMP/MALI/Repository> set username myusername

9.3.3.2 WebDAV Link

The HTTP connection pool defaults to 256 connections but this can be changed by entering the following in the Messaging Server CLI.

UMS_CLI/Applications/IMP/MALI/Repository/Link> set connectionPoolSize 4 The connection timeout (in seconds) defaults to “5”. This can be changed by entering the following in the Messaging Server CLI.

UMS_CLI/Applications/IMP/MALI/Repository/Link> set connectionTimeout 10

9.3.3.3 Local DNS Service

SRV and A/AAAA records can be configured on each Messaging Server hosting the MA application by editing the following file.

/usr/local/broadworks/bw_base/conf/namedefs The following shows sample SRV and A record entries on a system with two WebDAV servers: _msgarchive._tcp.my-profile-server.net SRV 1 5 443 my-profile-server01.net


_msgarchive._tcp.my-profile-server.net SRV 5 5 443 my-profile-server02.net my-profile-server01.net IN A 192.168.20.29 my-profile-server02.net IN A 192.168.20.30 The “msgarchive” service is required in the entry. If a matching record is not found in this file, the DNS service configured for the OS is used for the lookup.

9.3.3.4 Logging

MA logs are available on the Messaging Server at the following location.

/var/broadworks/logs/ums/maliLogYYYY.MM.DD-HH.MM.SS.txt The default level of logging is “Info”. To set the level of logging to “debug”, enter the following in the CLI: UMS_CLI/Applications/IM&P/MALI/Logging/InputChannels> set MALI severity debug To set the level back to “Info”, enter the following in the CLI: UMS_CLI/Applications/IM&P/MALI/Logging/InputChannels> set MALI severity info To see the current level of logging, enter the following in the CLI: UMS_CLI/Applications/IM&P/MALI/Logging/InputChannels> get

Message Archive Files On an hourly basis, the most recent message archives are sent to the WebDAV server. The files are compressed (gzip) and in RFC4180 CSV format with the following fields.

Field Name Example Description

1st Message Date

2013-06-01_03:09:01.342+0000 The date/time the message was sent or received in GMT. RFC-8222 is used for time zone format. Seconds is followed by a period and thousandths of seconds.

2nd Direction Can be “s” or “r” Indicates if the client sent or received the message.

3rd Source [email protected] The sender of the message.

4th Destination [email protected] The receiver of the message.

5th Message Text

Let’s start the meeting now. The actual message. Optional.

If a field has double quotes, comma, newline, or carriage return, it is surrounded by double quotes. Double quotes within the field is replaced with two double quotes.

Example with message text archiving enabled:

2013-06-01_03:09:01.342+0000,s,[email protected]/johnspc,[email protected]/janespc,Lets start the meeting now. Example without message text archiving:

2013-06-01_03:09:01.342+0000,s,[email protected]/johnspc,[email protected]/janespc,


WebDAV Service Offline Alarm If the WebDAV service or the network is down or if the wrong URL is configured, MA will retry connecting to the WebDAV service 10 times, waiting 30 seconds between each retry by default. After 10 retries, the WebDAV service is marked as “offline”. This is done for each WebDAV service. If all the WebDAV services are offline, an alarm is set.

9.3.5.1 Change Retry Interval and Number of Failed Attempts

To change the number of retries, enter the following in the Messaging Server CLI.

UMS_CLI/Applications/IM&P/MALI/Repository> set failedAttemptsBeforeAlarm 5 To change the time (in seconds) between retries, enter the following the following in the Messaging Server CLI.

UMS_CLI/Applications/IM&P/MALI/Repository> set retryInterval 15

9.3.5.2 View Alarms

To view alarms, it is necessary to open a connection to the agent by entering the following in the Messaging Server CLI.

UMS_CLI/Monitoring/Alarm> open To view the alarms, enter the following in the Messaging Server CLI.

UMS_CLI/Monitoring/Alarm> get To clear alarms from the log, enter the following in the Messaging Server CLI.

UMS_CLI/Monitoring/Alarm> clear

Automatic Message Archive Cleanouts If there are no online WebDAV servers, message archives are kept locally on the Messaging Server for up to seven days.

NOTE: Message archives older than 7 days are automatically deleted.


Messaging Server (UMS) – Usage Metrics

With BroadWorks Collaborate 21.sp1, performance metrics for the Messaging Server are available through the CLI and via Simple Network Management Protocol (SNMP).

Usage metrics for IM&P and MUC are generated.

10.1 Messaging Server (UMS) Provisioning Two configurable parameters are available with the BroadWorks Collaborate Metrics feature. The instrumentationPort parameters located under IMP and MUC GeneralSettings.

Run the get command from the Messaging Server CLI to retrieve the current value for IMP.

UMS_CLI/Applications/IMP/IMP/GeneralSettings> get maxDomains = 5000 domain = externalIP = localIP = enableMessageArchiving = false instrumentationPort = 2500 To change the instrumentationPort for IMP:

UMS_CLI/Applications/IMP/IMP/GeneralSettings> set instrumentationPort 2501 *** Warning: Broadworks needs to be restarted for the changes to take effect *** To change the instrumentationPort for MUC:

UMS_CLI/Applications/IMP/MUC/GeneralSettings> set instrumentationPort 2511 *** Warning: Broadworks needs to be restarted for the changes to take effect ***

NOTE: These ports are used locally. Connecting to the IMP or MUC subsystems from external systems is not allowed.

10.2 Messaging Server (UMS) Metrics Metrics are available for both the IMP and MUC. The list of available categories are available from the Messaging Server.

UMS_CLI/Monitoring/PM/IMP> ls server filexfer guestclient msgarchiver bosh client pubsub federation


sessionmgr To retrieve server stats, navigate to the server sublevel and issue the get command.

UMS_CLI/Monitoring/PM/IMP> cd server imp/server/ UMS_CLI/Monitoring/PM/IMP> get ------------------------------------------------------------------------- imp/server/ ------------------------------------------------------------------------- bwImpServerClusterBufferQueueSize 0 bwImpServerClusterPacketQueueSize 0 bwImpServerClusterTxBytes 46286 bwImpServerClusterPackets 885 bwImpServerMessagePackets 722 bwImpServerPresencePackets 2339 bwImpServerPacketsDropped 0 bwImpServerQueueSize 0

Instant Messaging and Presence The following lists the statistics available for the IM&P features. For a description of the metrics, see the BroadWorks Performance Measurement Interface Specification [35].

Category Metrics

Server bwImpServerClusterBufferQueueSize bwImpServerClusterPacketQueueSize bwImpServerClusterTxBytes bwImpServerClusterPackets bwImpServerMessagePackets bwImpServerPresencePackets bwImpServerPacketsDropped bwImpServerQueueSize

Filexfer bwImpFileXferCount bwImpFileXferTotalBytes bwImpFileXferMaxSize

Guestclient bwImpGuestClientJoinRequests bwImpGuestClientJoinRequestsAccepted bwImpGuestClientJoinRequestsRejected bwImpGuestClientJoinResponsesInvalid

Msgarchiver bwImpMsgArchiverClientRxMessages bwImpMsgArchiverClientTxMessages

Bosh bwImpBoshConnectionsActive bwImpBoshRxBytes bwImpBoshTxBytes bwImpBoshRxPackets bwImpBoshTxPackets bwImpBoshRxPacketsDropped bwImpBoshTxPacketsDropped


Category Metrics

Client bwImpClientRxBytes bwImpClientTxBytes bwImpClientRxPackets bwImpClientTxPackets

Pubsub bwImpPubsubRxPackets bwImpPubsubTxPackets bwImpPubsubPacketsDropped bwImpPubsubDBWrites bwImpPubsubSubcriptions bwImpPubsubSubcriptionUpdates

Federation bwImpFederationRxBytes bwImpFederationTxBytes bwImpFederationRxPackets bwImpFederationTxPackets bwImpFederationRxMessages bwImpFederationTxMessages bwImpFederationRxPresences bwImpFederationTxPresences

Sessionmgr bwImpSessionMgrActivatedUsers bwImpSessionMgrConnectionsActive bwImpSessionMgrConnectionsActiveMax bwImpSessionMgrConnectionsTotal bwImpSessionMgrConnectionsClosed bwImpSessionMgrRxPackets bwImpSessionMgrTxPackets bwImpSessionMgrRxPacketsDropped bwImpSessionMgrTxPacketsDropped bwImpSessionMgrRxMessagePackets bwImpSessionMgrTxMessagePackets bwImpSessionMgrRxPresencePackets bwImpSessionMgrTxPresencePackets bwImpSessionMgrRxIQPackets bwImpSessionMgrTxIQPackets

Multi-User Chat The following lists the statistics available for the IMP features. For a description of the metrics, see the BroadWorks Performance Measurement Interface Specification [35].

Category Metrics

Room bwMucRoomRxPackets bwMucRoomTxPackets bwMucRoomRxMessagePackets bwMucRoomTxMessagePackets bwMucRoomRxPresencePackets bwMucRoomTxPresencePackets bwMucRoomRxIQPackets bwMucRoomTxIQPackets


10.3 SNMP Configuration Performance Metrics can also be retrieved by SNMP. SNMP access lists and read/write community must be configured on the Messaging Server as detailed in the following sections.

SNMP Access List Add the IP addresses of all hosts that may access the Messaging Server via SNMP from the Messaging Server CLI.

UMS_CLI/Interface/SNMP/AccessList> add 10.56.10.61 ...Done UMS_CLI/Interface/SNMP/AccessList> get IP Address ============= 127.0.0.1 10.56.10.61 2 entries found.

SNMP Agent Configuration Get/Set the port, readCommunity, and writeCommunity from the Messaging Server CLI for the client configuration. The following are the default values.

UMS_CLI/Interface/SNMP/Agent> get port = 8001 encoding = ISO-8859-1 readCommunity = public writeCommunity = public trapCommunity = public trapSourceAddress = 10.59.20.58 disableV2 = false

10.4 SNMP Client Configuration Configure the SNMP client with the following:

The Messaging Server SNMP Agent IP Address / Port,

The Read/Write Community of the Messaging Server SNMP agent, and

Load the MIB file onto the SNMP client.

The MIB file is available on the Messaging Server (UMS) at the following location:

/usr/local/broadworks/apps/IMP_21.sp1_1.551/conf/BW-IMP.mib

After adding client IPs to the access list and configuring the client with the port, server IP, communities, and MIB, you can browse the MIB tree and view the individual statistics.


BroadWorks Collaborate – Presence Server

The Presence Server is an application hosted on the BroadWorks Collaborate Messaging Server (UMS) that subscribes to receive telephony events via the Xtended Services Platform (Xsp) interface from a BroadWorks Xsp.

The Presence Server moves the functionality of retrieving user’s telephony notifications and publishing the appropriate Extensible Messaging and Presence Protocol (XMPP) presence states from Business Communicator to the Messaging Server. Moving this logic from Business Communicator to the Messaging Server allows presence status to be distributed to all XMPP clients in a standard way.

Figure 34 Presence Server Architecture

Each Presence Server has a connection to each Xsp. The list of Xsps is returned by a DNS SRV lookup. The Presence Server creates an Xsi-Event channel for each enterprise with a subscription to receive basic call events.

The Presence Server retrieves relevant user data (BroadWorks Id / IMP Id mapping) from the Messaging Server database during startup and at regular intervals for new users. When a call event is received on an enterprise’s event channel, the Presence Server processes the event by sending an on-call notification to the Messaging Server based on the hook status of the message. The Messaging Server then broadcasts the XMPP presence status to all buddies and other logged in resources.

The user must be logged in to one or more XMPP clients in order to broadcast the call events to buddies.

11.1 Custom Presence Rules With BroadWorks Collaborate Release 21.2, the Presence Server (PS) service extends the existing IM&P presence functionality by adding an aggregated presence of the user that takes into account both In-Call and IM presence statuses of the user. This aggregated presence status allows the definition of Custom Presence Rules for call forwarding settings.


Custom Presence Rules The IMP server allows the clients to set a number of call forwarding rules that can be activated or deactivated automatically by the user's presence status change. The rules that are supported in Collaborate Release 21.2 are Call Forwarding to phone number and Silent Alerting.

Presence State Aggregation On every IM Presence or In-Call state change, the IMP server calculates the aggregated state of the user. The IMP also checks if the user has a Presence Rule defined for the new state and notifies the Presence Server. The Presence Server then makes a series of Xsi calls to the Xsp to activate the new call forwarding rule associated with the current presence state.

11.2 Channel and Subscription Details For every enterprise, the Presence Server creates an event channel with an event subscription specifying target enterprise. Enterprise admin credentials are required to create the event channel and subscription.

Figure 35 Presence Server / Event Channel and Subscriptions

There are two main steps when creating an event channel and subscription.

1) The Presence Server creates a channel with a channel set ID, priority, and weight.

2) An event subscription is created specifying an enterprise as the target.

11.3 Messaging Server (UMS) Provisioning The list of Enterprises and the CTI connection details must be configured on the Messaging Server to enable the Presence Server functionality.

Enterprise Configuration One or more enterprises must be configured on the Presence Server for proper creation of the channel and subscription with the Xsp. To configure an enterprise, the enterprise name, enterprise administrator credentials, and default domain are required:

XSP

Presence Server 1

Presence Server 2

Enterprise: exampleEnt Ch Set id: 1 Priority: 1 Weight: 50 Subscriptions: 1

Enterprise: exampleEnt Ch Set id: 1 Priority: 1 Weight: 50 Subscriptions: 2


Enterprise name

The enterprise name can be retrieved from the BroadWorks portal (that is, CommPilot).

Enterprise administrator

The Enterprise Administrator Id must be in the following format: userid@<default domain>

The enterprise administrator userid can also be retrieved from the BroadWorks portal (that is, CommPilot). Select an enterprise, and then select Administrators to get a list of administrators on the enterprise

The default domain can be retrieved from the Application Server CLI as follows.

AS_CLI> system;domain;get defaultSystemDomainName = broadworks.net useAliasForDomain = false

Configure the Enterprise admin credentials.

From the Messaging Server CLI, enter the enterprise name and enterprise admin username as follows.

UMS_CLI/Applications/PresenceServer/Enterprise> add <Enterprise_ID> <Enterprise_Admin>@<default_domain> <password> ...Done

CTI Interface Configuration The Presence Server requires the address of the Xsps and details on how to create the event channel and subscriptions. The configurable attributes with default values are listed in the following table.

Setting Default

address <XSP_FQND>

port 8011 (If useSecure set to false) 8012 (If useSecure set to true)

useSecure true

channelPriority 1

channelWeight 50

11.3.2.1 Xtended Services Platform Server IP Address

DNS lookup is used to determine the addresses of the Xsps. The associated DNS records are stored in the namedefs file located in /usr/local/broadworks/bw_base/conf.

Configure the server address in the Messaging Server CLI.

UMS_CLI/Applications/PresenceServer/Presence/CTI/Servers> set address <XSP_FQDN> Setting this option tells the Presence Server to perform an SRV lookup on the configured address in the namedefs file.


Add the appropriate records in the namedefs file on the Messaging Server.

Example:

more /usr/local/broadworks/bw_base/conf/namedefs ... _cti._tcp.xsp.eng.broadsoft.com SRV 5 5 8011 xsp1.eng.broadsoft.com _cti._tcp.xsp.eng.broadsoft.com SRV 5 5 8011 xsp2.eng.broadsoft.com xsp1.eng.broadsoft.com IN A 199.19.192.70 xsp2.eng.broadsoft.com IN A 199.19.192.71 ... If the Presence Server does not find the SRV records in the namedefs file, it uses an external DNS.

An IP address could be used instead of the Xsp FQDN. The CTI port must be set when an IP address is used.

11.3.2.2 CTI Port

Setting the server port is done in conjunction with setting the server address. If left unset, the CTI port is derived from a DNS SRV lookup. By setting the port, the Presence Server tries to do a DNS A record lookup of the server address instead of an SRV lookup.

To set the port from the UMS CLI:

UMS_CLI/Applications/PresenceServer/Presence/CTI/Servers> set port 8011 Add the appropriate A records in the namedefs file.

xsp.eng.broadsoft.com IN A 199.19.192.70 xsp.eng.broadsoft.com IN A 199.19.192.71

11.3.2.3 Secure

The CTI interface on the Xsp can be configured in a secure mode. Configure the secure mode for the CTI interface from the Messaging Server CLI as follows.

UMS_CLI/Applications/PresenceServer/Presence/CTI/Servers> set useSecure false

11.3.2.4 Priority

Under normal circumstances, the default value can be used so the priority does not have to be set. By using the default value, the load is distributed equally among all of the Presence Server instances.

The Presence Servers can be setup in a redundancy mode however where the servers have different priorities. The channel and subscription set up on the Presence Server with the highest priority handles the notifications from the Xsp.

For example, with two Presence Server instances:

#UMS Server 01 UMS_CLI/Applications/PresenceServer/Presence/CTI> set channelPriority 1 #UMS Server 02 UMS_CLI/Applications/PresenceServer/Presence/CTI> set channelPriority 2


11.3.2.5 Weight

The channel’s weight is the probability of being selected when priority is the same for multiple Presence Servers. Higher values have a higher probability of being selected. Set the channel weight for each Messaging Server from the CLI as shown in the following example.

#UMS Server 01 UMS_CLI/Applications/PresenceServer/Presence/CTI> set channelWeight 55 #UMS Server 02 UMS_CLI/Applications/PresenceServer/Presence/CTI> set channelWeight 45 In this example, the Xsp establishes the subscription for an enterprise on “server 01” 55% of the time and “server 02” 45% of the time if both servers are configured with the same channel priority.

Activate and Deploy the Presence Server Application Activate and deploy the Presence Server from the Messaging Server CLI.

UMS_CLI/Maintenance/ManagedObjects> get versions all Identity Version Install Date Status PS 21.0_1.287 Jun 25, 2014 Active 1 entry found. * Applications: Name Version Status PresenceServer 21.sp1_1.551 Active UMS_CLI/Maintenance/ManagedObjects> activate application PresenceServer 21.sp1_1.551 BroadWorks SW Manager activating...PresenceServer version 21.sp1_1.551 ...Done UMS_CLI/Maintenance/ManagedObjects> deploy application PresenceServer BroadWorks SW Manager deploying PresenceServer... ...Done


BroadWorks Collaborate – Guest Client

The Collaborate Guest Client is an Xtended web application that allows non-BroadWorks users (guests) to participate in Multi-User Chat, screen sharing, and audio/video conferencing hosted by a BroadWorks user in their My Room on the Business Communicator client.

This Collaborate Guest Client web application is hosted on the BroadWorks Xtended Services Platform (Xsp).

See the Collaborate Guest Client Feature Description [33] for additional details on the Collaborate Guest Client, including version compatibility information on web browsers, Operating Systems, BroadWorks Servers and Collaborate Servers.

Figure 36 illustrates the Collaborate Guest Client high-level solution architecture.

Figure 36 Guest Client Solution Architecture

12.1 Xsp Provisioning This section describes the procedures to install, configure, and customize the Guest Client application on the Xsp.

Guest Client Software Installation The Guest Client is installed, activated, and deployed on the BroadWorks Xsp. It is recommended that the latest version of the Guest Client be used.

Download the BWCollaborateGuestClient software (.war file) from Xchange and copy it to the Xsp in “/export/home/bwadmin/”.

Install, activate, and deploy the Guest Client from the Xsp CLI as shown in the following example.

XSP_CLI> Maintenance;ManagedObjects; XSP_CLI/Maintenance/ManagedObjects> install application /export/home/bwadmin/BWCollaborateGuestClient_1.3.war;


XSP_CLI/Maintenance/ManagedObjects> activate application BWCollaborateGuestClient 1.3 /cgc; XSP_CLI/Maintenance/ManagedObjects> deploy application /cgc XSP_CLI/> qbw * Hosted Applications: Name Version Context Path Deployed ========================================================================= ... BWCollaborateGuestClient 1.3 /cgc true ...

Guest Client Basic Configuration Configure the Provisioning Adapter credentials, WebRTC Server (WRS) address, and domain for the Guest Client application. Other parameters can be left at their default values.

The Provisioning Adapter credentials must match the values entered as described in section 8.1.2.6 Flow-Through Provisioning.

The ProvisioningAdapter configuration is optional with Release 21.0 of the Messaging Server (UMS) but is required in previous releases.

From the Xsp CLI, configure the Provisioning Adapter URL and credentials as shown in the following example.

XSP_CLI/Applications/BWCollaborateGuestClient_1.3/ProvisioningAdapter> set URL https://<UMSClusterFQDN>/padapter/ set admin admin set password admin123 The WebRTC Server (WRS) domain (domainTo and domainFrom parameters) are used in the To and From headers of SIP messages sent by the WebRTC client. From the Xsp CLI, configure the WebRTC Server (WRS) domain for the Guest Client application.

XSP_CLI/Applications/BWCollaborateGuestClient_1.3/WRS> set domainTo <domainTo> set domainFrom <domainFrom> From the Xsp CLI, configure the WebRTC Server (WRS) address for the Guest Client application.

XSP_CLI/Applications/BWCollaborateGuestClient_1.3/WRS/WSAddressList> add wss://<WRS_Hostname>:8060 *** Warning: Broadworks needs to be restarted for the changes to take effect *** The BoshUrlList configuration is optional with Release 21.0 of the BroadWorks Application Server and Xsp but is required for previous releases.

With BroadWorks Release 21.0 (Application Server and Xsp), if the BoshUrlList is not configured, then a lookup is performed on the domain of the leader to determine the URL.

The Messaging Server (UMS) supports HTTP connectivity using BOSH on port 5280 and HTTPS secure connections on port 5281.

The BoshUrlList can be configured from the Xsp CLI as shown in the following example.


XSP_CLI/Applications/BWCollaborateGuestClient_1.3/General/BoshUrlList> add http://<UMSClusterFQDN>:5280 or add https://<UMSClusterFQDN>:5281 *** Warning: Broadworks needs to be restarted for the changes to take effect *** Example configuration:

XSP_CLI/Applications/BWCollaborateGuestClient_1.3/BWIntegration> get usePersistentConnections=<not defined, webapp using internal default> discoveryPeriod=<not defined, webapp using internal default> applicationID=<not defined, webapp using internal default> mode=<not defined, webapp using internal default> XSP_CLI/Applications/BWCollaborateGuestClient_1.3/BWIntegration/Address> get NS=<not defined, webapp using internal default> asPrimary=<not defined, webapp using internal default> asSecondary=<not defined, webapp using internal default> ocicPort=<not defined, webapp using internal default> XSP_CLI/Applications/BWCollaborateGuestClient_1.3/General> get enableWebRTC=<not defined, webapp using internal default> enableWebRTCVideo=<not defined, webapp using internal default> enableCallMeNow=<not defined, webapp using internal default> customResourcePath=<not defined, webapp using internal default> globalTransactionLimitPeriodInSeconds=<not defined, webapp using internal default> globalTransactionLimit=<not defined, webapp using internal default> leaderAcceptanceTimeOutInSeconds=<not defined, webapp using internal default> XSP_CLI/Applications/BWCollaborateGuestClient_1.3/General/BoshUrlList> get Values ====== http://ums.connections2014.net:5280 XSP_CLI/Applications/BWCollaborateGuestClient_1.3/Http> get httpSocketTimeout=<not defined, webapp using internal default> maxHttpConnection=<not defined, webapp using internal default> XSP_CLI/Applications/BWCollaborateGuestClient_1.3/ProvisioningAdapter> get URL=http://ums.connections2014.net/padapter/ admin=admin password=jfkierjof XSP_CLI/Applications/BWCollaborateGuestClient_1.3/WRS> get domainTo=connections2014.net domainFrom=connections2014.net stunServer=<not defined, webapp using internal default> stunServerPort=<not defined, webapp using internal default>


Guest Client reCAPTCHA Configuration reCAPTCHA is a free service from Google that can be used to protect websites from spam and abuse. The Guest Client uses reCAPTCHA in conjunction with overload controls to protect from abuse.

If too many requests are received by the Guest Client during a given period of time, then it automatically starts displaying a CAPTCHA request as part of the initial join page. The globalTransactionLimitPeriodInSeconds and globalTransactionLimit CLI settings are used to control when the CAPTCHA is to be displayed. In addition, the Guest Client automatically turns off CAPTCHA once the load reduces.

In addition to configuring the overload values, Service Providers must sign-up for the reCAPTCHA service and receive a public and private key. These keys should provisioned in the reCaptchaPublicKey and reCaptchaPrivateKey CLI settings.

Following is an example of setting the overload controls to show CAPTCHA if two or more requests are received within 10 seconds.

XSP_CLI/Applications/BWCollaborateGuestClient_1.3/General> set globalTransactionLimitPeriodInSeconds 10 set globalTransactionLimit 2 XSP_CLI/Applications/BWCollaborateGuestClient_1.3/General/Captcha> set disableCaptcha false set reCaptchaPublicKey 6Le1OPkSAAAAAIZ4YUX6U7RLT9gOqK3u3HUYHTZp set reCaptchaPrivateKey 6Le1OPkSAAAAAEnbJ6G2U5m8xu4dBXINEosgnBa8 *** Warning: Broadworks needs to be restarted for the changes to take effect *** Signing up for reCAPTCHA can be done from https://www.google.com/recaptcha/admin#createsite. The domain used to sign-up must match the domain (or is a parent domain) of the domain hosting the Guest Client application.

For example, if the Guest Client is deployed on Xsp.connections2014.net, then sign-up to the reCAPTCHA service using the connections2014.net domain.

Guest Client Customization

12.1.4.1 Localization

The following languages are supported out of the box:

English

French

French (Canada)

Spanish

Spanish (CALA)

Italian

German

Simplified Chinese

https://www.google.com/recaptcha/admin%23createsite


The default language is English and is selected based on the browser’s locale. In addition to the above languages, custom languages can be added by creating localized versions of the language resource file. The following steps explain this in detail:

1) Create a directory called “localization” on the Xsp to keep the customized language resources. Note that the directory must be called “localization” but the path to it can be anything. Example: /usr/local/broadworks/bw_base/conf/BWCollaborateGuestClient_1.3/localization

2) Copy the bundled English language file located at /var/broadworks/webapps/conf/BWCollaborateGuestClient_1.3/CollaborateGuestClientMessages.properties to the “localization” directory created in step 1.

3) Rename CollaborateGuestClientMessages.properties following the naming convention CollaborateGuestClientMessages_[Language Code]_[Country Code].properties. For example, CollaborateGuestClientMessages_ja_JP.properties for a language file that contains resources for Japanese in Japan. Note the casing of the language and country code.

4) Customize the values in the new file created in step 3 to the language of choice. Make sure that the file is saved in UTF-8 format.

5) Set the customResourcePath CLI configuration to the parent of the directory created in step 1.

Example:

XSP_CLI/Application/BWCollaborateGuestClient_1.3/General> set customResourcePath /usr/local/broadworks/bw_base/conf/BWCollaborateGuestClient_1.3 6) Restart the Xsp.

12.1.4.2 Branding

The Collaborate Guest Client supports custom branding for images and icons and Cascading Style Sheets (CSS). The following steps explain this in detail:

1) Create a directory called “images” on the Xsp to keep the customized image resources. Note that the directory must be called “images” but the path to it can be anything. Example: /usr/local/broadworks/bw_base/conf/BWCollaborateGuestClient_1.3/images

2) Create customized images and place them in the directory created in step 1. For a list of images and their sizes, see the Collaborate Guest Client Feature Description [33].

3) Create a directory named “css” on the Xsp to keep the customized CSS. Note that the directory must be named “css” but the path to it can be anything. Example: /usr/local/broadworks/bw_base/conf/BWCollaborateGuestClient_1.3/css

4) Copy the default CSS located at: /var/broadworks/webapps/conf/BWCollaborateGuestClient_1.3/custom.css to the directory created in step 3.

5) Customize the values in the new file created in step 4.

6) Set the customResourcePath CLI configuration to the parent of the directory created in step 1.

Example:

XSP_CLI/Application/BWCollaborateGuestClient_1.3/General> set customResourcePath /usr/local/broadworks/bw_base/conf/BWCollaborateGuestClient_1.3


7) Restart the Xsp.

12.2 Application Server Provisioning This section describes the configuration required on the Application Server to support the Guest Client.

OCI Call Control Application Definition Add com.broadsoft.guestclient to the OCI-C Call Control Interface access control list (ACL) on the Application Server under AS_CLI/Interface/OCI/CallControl.

This step is required if the Guest Client Call Me Now feature is enabled.

AS_CLI/Interface/OCI/CallControl> add com.broadsoft.guestclient true 8 8 "Guest Client"

AS_CLI/Interface/OCI/CallControl> get

Application Id Enabled System Wide Description Notification Timeout Seconds Max Event Channels Per Set

=========================================================================

com.broadsoft.guestclient true Guest Client 8 8

Device Management The following device management tags must be added to the BroadTouch_Tags tag set to support the Guest Client:

%GUEST_CLIENT_ENABLED% = true

%GUEST_CLIENT_URL% = http://<XSP_CLUSTER_HOSTNAME>/cgc

%GUEST_CLIENT_DOMAIN% = kowabunga-guest.<IMP_domain>

For details on the <IMP_domain> configuration, see section 8.1.2.1 IMP Domain Name.

For more information about device management, see the Business Communicator for Desktop Configuration Guide [14].

The Sharing Server (USS) Address must be configured with https to support the Guest Client:

%USS_ADDRESS% = https://<USSClusterFQDN>:8443/uss

For details on USS Configuration, see section 8.2 Sharing Server.

12.3 BroadWorks WebRTC Server (WRS) Provisioning The BroadWorks WebRTC Server (WRS) must be installed following the instructions in the BroadWorks Software Management Guide [12] and the BroadWorks WebRTC Server Product Description [31].


12.4 Messaging Server (UMS) Provisioning This section describes the functionality introduced on the Messaging Server and the configuration required to support the Guest Client.

Guest User Domains Guest users are automatically provisioned on the guest domain for the room owner. For example, if the owner is on domain “company.com”, the guest domain is “kowabunga-guest.company.com”. The “kowabunga-guest” prefix is a static value and is what Messaging Server and the clients use to determine that the domain is a guest domain.

The guest domain is automatically provisioned when the domain is provisioned. For existing domains, the guest domain is provisioned the first time a guest user is provisioned on that domain. Once a Guest Client domain is provisioned, there is a delay (up to 5 minutes) before the domain is available on both nodes. Until the domain is available on both nodes, the Guest Client feature does not work properly.

The following Application Programming Interfaces (APIs) have been added to the ProvisioniongAdapter to support the Guest Client functionality:

POST https://<UMS_Hostname>/padapter/userservice/impguest – Provision a guest user account

DELETE https://<UMS_Hostname>/padapter/userservice/impguest/jid/{jid} – Delete a guest user account

Connectivity The guest client connects to Messaging Server IMP via the BOSH interface.

In addition, the guest client must call the ProvisioningAdapter in the Messaging Server to provision and delete guest accounts.

Guest User Account Cleanup A cleanup process runs on the Messaging Server once per day to delete any expired guest client accounts. The following configuration items can be set in the CLI to control the behavior of the cleanup process.

UMS_CLI/Applications/IMP/IMP/GuestUser> set accountCleanupTime 01:32:00 set accountExpiryInHours 48 set enableAccountCleanup true accountCleanupTime is the time at which the job should run each day. The actual run

time is randomized to run at some time within the specified time + 60 minutes.

accountExpiryInHours specifies when a guest account is considered expired. If an account was created over 48 hours ago (in this example), the account is considered expired and is deleted when the cleanup job runs.

enableAccountCleanup allows the operator to enable/disable the account cleanup job. The job only needs to be run on a single node within a cluster. If desired, the operator can enable the job on one of the nodes and disable the job on the other node.


12.5 Sharing Server (USS) Provisioning The Sharing Server must to be configured with a CA-signed certificate. Wildcard certificates are supported; however, self-signed certificates are not supported by the Guest Client.

For details on certificate installation on the Sharing Server, see section 8.2.2 Sharing Server Configuration.


BroadWorks Collaborate Video Server (UVS)

The Video Server (UVS), introduced in Release 21.sp1, enables audio and video collaboration within the Business Communicator My Room feature.

The Video Server supports Business Communicator Desktop (Mac, Windows) and Business Communicator Mobile (iOS, Android).

The Video Server interoperates with hardware video phones supporting H.264 AVC constrained baseline profile up to level 3.1.

The Video Server interoperates with the BroadWorks WebRTC Server (WRS) (Release 20.sp1 and above).

The Video Server supports the Guest Client and requires BroadWorks Release 21.0 and Business Communicator Release 21.0.

13.1 Networking Considerations Deploying video collaboration can introduce several challenges from a network perspective. Primarily, video rooms can require large amounts of bandwidth where a single video stream can require anywhere from 128Kbps for Common Intermediate Format (CIF) resolution to 1Mbps for 720p resolution. High bandwidth requirement in itself is not a critical issue in that proper network planning can mitigate problems. More importantly from a video conferencing quality of experience perspective is the impact that packet loss, jitter, and network latency can have on a video conference.

Packet Loss: Due to the high amount of compression and motion-compensated prediction utilized by video codecs, even a small amount of packet loss can result in visible degradation of the video quality. Packet loss tolerances for good video quality is highly subjective and can depend on a variety of factors, including video resolution, frame rate, configured data rate, and endpoint. Network performance targets for packet loss should be in the <0.1 percent range.

Jitter: Tolerance of video codecs to jitter depends on a number of factors, but most importantly all packets that comprise a video frame must be delivered before the replay buffer is depleted. Otherwise, degradation of the video quality can occur. Network performance targets for jitter should be in the <40 msec range.

Latency: Latency requirements for video collaboration are in line with requirements for VoIP voice and the network performance target should be in the <150 msec range. Video collaboration brings the additional requirement of voice and audio synchronization. This often requires that audio and video media have the same service-level across the network.

For an overview of BroadWorks video capabilities and additional considerations when deploying video services, see the BroadWorks Video Services Solution Guide [34].


Bandwidth Considerations Bandwidth requirements per video collaboration leg vary depending on video resolution. The following are transmission bitrate limits for video resolutions supported by the BroadWorks Collaborate Video Server.

NOTE: Data rates in this table exclude IP, UDP, and RTP headers.

Resolution Maximum transmitted video payload bitrate

Up to CIF Up to 512 kbps

Up to VGA Up to 768 kbps

Up to 720pHD Up to 1.75 Mbps Note that average bitrates are typically lower and may vary based on video characteristics such as motion and noise.

Traffic Prioritization The Video Server supports setting of the Type of Service (ToS) byte, which can be used to implement scalable service differentiation using mechanisms such as legacy ToS and Diffserv. The ToS byte for all RTP packets (both video and audio) can be set via the CLI under the UVS_CLI/Applications/VideoStreaming/Interfaces/RTP level and represents the decimal value of the ToS byte. For example, to set the DSCP value Assured Forwarding per-hop behavior to AF41, the Video Server typeOfService parameter would be set to “34”.

13.2 Video Server (UVS) Provisioning This section describes the configuration required on the Video Server (UVS).

The Video Server (UVS) must be installed following the instructions in the BroadWorks Software Management Guide [12].

Audio-only From the Video Server CLI, configure the following attributes in the VideoStreaming application.

Disable video mixing capabilities.

UVS_CLI/Applications/VideoStreaming/GeneralSettings> set numVideoProcesses 0 The u-law codec is populated by default. Configure other codecs that are to be used in the network. For example, to add G.722:

UVS_CLI/Applications/VideoStreaming/Interfaces/CFW/AudioCodecs> add g722 The offered telephone-event payload type is by default set to 101. Set this attribute to a different value if a different telephone-event payload type is standardized on in the network. For example, if the network standardizes on 100:

UVS_CLI/Applications/VideoStreaming/Interfaces/RTP> set defaultTelephoneEventRtpPayloadType 100


The session audit interval is by default set to 1200 seconds. If the Application Server is configured with a larger interval, the session audit interval on the Video Server must be increased to be greater than or equal to the interval configured in the Application Server. For example, to increase the interval to 3600 seconds:

UVS_CLI/Applications/VideoStreaming/Interfaces/SIP> set sessionAuditIntervalInSeconds 3600

Video-centric The u-law codec is populated by default. Configure other codecs that are to be used in the network. For example, to add G.722:

UVS_CLI/Applications/VideoStreaming/Interfaces/CFW/AudioCodecs> add g722 The offered telephone-event payload type is by default set to 101. Set this attribute to a different value if a different telephone-event payload type is standardized on in the network. For example, if the network standardizes on 100:

UVS_CLI/Applications/VideoStreaming/Interfaces/RTP> set defaultTelephoneEventRtpPayloadType 100 Add the H.264 codec to the configuration. For example:

UVS_CLI/Applications/VideoStreaming/Interfaces/CFW/VideoCodecs> add h264 The OfferedVideoPayloads level specifies the maximum resolution negotiated by the Video Server. The Video Server is by default populated to negotiate at most CIF resolution. Update the resolution in the OfferedVideoPayloads level if a higher maximum resolution is to be negotiated or deployed. For example, if VGA resolution is the maximum resolution to be deployed:

UVS_CLI/Applications/VideoStreaming/Interfaces/RTP/OfferedVideoPayloads> set h264 resolution vga If a resolution greater than 4CIF is being deployed, set maxEncodedVideoResolution to “720pHD”. For example:

UVS_CLI/Applications/VideoStreaming/Services/Conferencing> set maxEncodedVideoResolution 720pHD The session audit interval is by default set to “1200” seconds. If the Application Server is configured with a larger interval, the session audit interval on the Video Server must be increased to be greater than or equal to the interval configured in the Application Server. For example, to increase the interval to 3600 seconds:

UVS_CLI/Applications/VideoStreaming/Interfaces/SIP> set sessionAuditIntervalInSeconds 3600


13.3 Network Server Provisioning This section describes the configuration required on the Network Server to support the Video Server (UVS).

Video Server (UVS) Resource Network Element From the Network Server CLI, add the Video Server as a Resource NE as shown in the following example.

NS_CLI/System/Device/ResourceNE> get neName uvs1 Resource NE Type Location Stat Cost Stat Weight Poll OpState State Dflt Dflt Cost Dflt Weight Services ====================================================================================================================== uvs1 uvs 1240364 1 99 true enabled OnLine true 1 99 cfw-collab NS_CLI/System/Device/ResourceNE/Address> get neName uvs1 Resource NE Address Cost Weight Port Transport ========================================================= uvs1 <UVS_IP> 1 99 - unspecified

13.4 Application Server Provisioning This section describes the Application Server configuration to support the Video Server.

System Wide Collaborate Settings The system wide Collaborate Settings are available from the Application Server CLI. Configure the system wide settings as shown in the following example.

AS_CLI/Service/Collaborate> set collaborateRoomIdLength 6 set instantRoomIdleTimeoutSeconds 300 set collaborateRoomMaximumDurationMinutes 1440 set supportOutdial false set maximumCollaborateRoomParticipants 15 set activeTalkerRefreshIntervalSeconds 2 set terminateCollaborateRoomAfterGracePeriod false set collaborateGracePeriod 0 Hours 30 Minutes set sendActiveCollaborateRoomNotification false set collaborateFromAddress [email protected]

System Video Server (UVS) Parameters From the Application Server CLI, configure the system Video Server parameters as follows.

AS_CLI/System/CallP/Routing/VideoServerSelection> set videoServerResponseTimerMilliseconds 15000 set videoServerSelectionRouteTimerMilliseconds 800 set useStaticVideoServerDevice false


Device Management The following device management tag must be added to the BroadTouch_Tags tag set:

%CONFERENCE_TYPE% = uvs

For more information about device management, see the Business Communicator for Desktop Configuration Guide [14].

System Call Processing Policy Profile From System → Resources, select the Call Processing Policy Profile link as shown in Figure 37.

Figure 37 Call Processing Policy Profile


Add or modify an existing Call Processing Policy Profile and add the Collaborate Subscriber Type to the Call Processing Profile as shown in Figure 38.

Figure 38 Call Processing Policy Profile Modify


Modify the newly created Collaborate Subscriber Type Profile setting for the Call Processing Policy Profile as shown in Figure 39.

Figure 39 Call Processing Policy Profile – Collaborate Subscriber Type Profile

Authorize Collaborate Services to the Enterprise and Group Authorize the Collaborate – Audio and the Collaborate – Video user services to the Enterprise and then to the Groups.

From the Enterprise Resource → Services menu, authorize the Collaborate – Audio and the Collaborate – Video user services.

From the Group Resource → Services menu, authorize the Collaborate – Audio and the Collaborate – Video user services.


Figure 40 shows the Group Resources → Services menu. The Enterprise Resources → Services menu is identical.

Figure 40 Group Resources → Services Menu

Collaborate Bridge From the group services menu, select Collaborate Bridges from Advanced Services to create a new Collaborate Bridge or to manage an existing Collaborate Bridge. When the Collaborate – Video or the Collaborate – Audio service is authorized for the group, a default Collaborate Bridge is created (that is, <group name>-default).

Figure 41 shows the Group Services menu with the Collaborate Bridges service.

Figure 41 Group Services Menu with Collaborate Bridges Service


From the Group options services menu, select the Collaborate Bridges link. Figure 42 shows the Collaborate Bridges page.

Figure 42 Collaborate Bridges Menu

Click the Edit button for the Default Collaborate Bridge and select the Profile Link to display the Collaborate Bridge Profile page. Figure 43 shows the Collaborate Bridge Profile page.

Figure 43 Collaborate Bridge Profile


Assign a Number to the Collaborate Bridge (Default or non-default). Figure 44 shows the Collaborate Bridge Address page.

Figure 44 Collaborate Bridge Address

NOTE: Extension assigned to the Collaborate Bridge and Group must have a Default Calling Line ID to be functional OR assign an external directory number (DN) to the bridge.

Assign Collaborate –Audio/Video User Services From the User → Profile menu, select the Assign services link and assign the Collaborate – Video and the Collaborate – Audio user services to the user. Figure 45 shows the Assign Services page for users.

Figure 45 Assign Services Page


Business Communicator licenses (IM only, audio, video) are required for the overall solution to work. In addition, the Integrated IMP service is required since the solution relies on IMP capabilities.

NOTE: For license information, see section 14.1.1 Business Communicator License Requirements.

Collaborate Rooms – My Room Users can manage collaborate rooms, configure instant room common settings, add project rooms, and view the bridge assigned to them from the users Collaborate options menu item as shown in Figure 46 and Figure 47.

Figure 46 End-user Collaborate Options Menu

Figure 47 Collaborate Rooms Page


Select Edit for the My Room Room Type to Configure the Collaborate room settings as shown in Figure 48.

Figure 48 Collaborate Room – Modify Page

Collaborate Rooms – Project Room Users can add project rooms, from the Collaborate options menu item as shown in Figure 49.



Click the Add Project Room button, enter a Project Room Name, and then click the OK button as shown in Figure 50.

Figure 50 Collaborate Room – Add Page

The newly created Project Room is listed at the bottom of the Collaborate Rooms page as shown in Figure 51.



Select the Edit link next to your Project Room to configure or modify the Collaborate room settings as shown in Figure 52.

Figure 52 Collaborate Room (Project Room) – Modify Page

The scheduling details section of the Collaborate Room is different based on the Scheduling Type. The available scheduling types are One Time, Recurring, and Reservationless.

The following figures show the scheduling details for One Time, Recurring, and Reservationless Scheduling Types.

Figure 53 Scheduling Details – One Time


Figure 54 Scheduling Details – Recurring

Figure 55 Scheduling Details – Reservationless


Solution Requirements and Compatibilities

The following section outlines BroadWorks software requirements, supported mobile platforms, file exchange formats, codecs, required ports, and capacity requirements.

14.1 BroadWorks Requirements Business Communicator capabilities are offered with specific BroadWorks releases and require user licenses assigned to their corresponding user profile. The following subsections show the license and software requirements.

Business Communicator License Requirements The following table lists the Business Communicator license requirements.

License

Service(s)

Xtended Xtended +

IM&P

Xtended +

IM&P +

Audio

Xtended +

IM&P +

Audio +

Video

Desktop

BroadTouch Business Communicator Desktop X X

BroadTouch Business Communicator Desktop – Audio X

BroadTouch Business Communicator Desktop – Video X

Integrated IM&P X X X

Shared Call Appearance 1 X X X X

Meet-Me Conferencing 2 X X X

Collaborate – Audio X X X

Collaborate Video X X X

Mobile

BroadTouch Business Communicator Mobile X X

BroadTouch Business Communicator Mobile – Audio X

BroadTouch Business Communicator Mobile – Video X




Collaborate – Audio2 X X X

Collaborate – Video2 X X X

Tablet

BroadTouch Business Communicator Tablet X X

BroadTouch Business Communicator Tablet – Audio X


License

Service(s)

Xtended Xtended +

IM&P

Xtended +

IM&P +

Audio

Xtended +

IM&P +

Audio +

Video

BroadTouch Business Communicator Tablet – Video X




1 Shared Call Appearance (optional) – This is not required when Business Communicator is the user’s primary device. For more information, see section 4.2 User Provisioning Steps.

2 Conferencing is a core component of the Business Communicator My Room User Experience. Conferencing services can be provided by the Video Server (UVS) or by BroadWorks Meet-Me Conferencing. For details on Meet-Me Conferencing, see section 7 BroadWorks Meet-Me Conferencing. For details on the Video Server (UVS), see section 13.2 Video Server (UVS) Provisioning.

Business Communicator License Requirements – Xsi Only Without SCA The following table lists the Business Communicator license requirements for the Xsi Only Configuration without Shared Call Appearance (SCA). For more information, see Appendix A: Business Communicator Xsi Only Configuration Without SCA.

License

Service(s)

Xtended Xsi Only

Xtended +

IM&P

Xtended +

IM&P +

Audio

Xtended +

IM&P +

Audio +

Video

Desktop 1

BroadTouch Business Communicator Desktop X N/A N/A N/A

1 The Business Communicator Xsi Only Configuration without SCA is available with Business Communicator Desktop only. For more information on this configuration, see Appendix A: Business Communicator Xsi Only Configuration Without SCA.


BroadWorks Software Requirements The following tables list the BroadWorks service-specific licenses and patches needed for Business Communicator client Releases 20.x and 21.x.

BroadWorks Licenses Releases Licenses

19.0, 19.sp1 20.0

BroadTouch Business Communicator Mobile BroadTouch Business Communicator Mobile – Audio BroadTouch Business Communicator Mobile – Video BroadTouch Business Communicator Desktop BroadTouch Business Communicator Desktop – Audio BroadTouch Business Communicator Desktop – Video BroadTouch Business Communicator Tablet BroadTouch Business Communicator Tablet – Audio BroadTouch Business Communicator Tablet – Video Integrated IM&P Shared Call Appearance (Optional) Meet-Me Conferencing (Optional)

20.sp1 BroadTouch Business Communicator Mobile BroadTouch Business Communicator Mobile – Audio BroadTouch Business Communicator Mobile – Video BroadTouch Business Communicator Desktop BroadTouch Business Communicator Desktop – Audio BroadTouch Business Communicator Desktop – Video BroadTouch Business Communicator Tablet BroadTouch Business Communicator Tablet – Audio BroadTouch Business Communicator Tablet – Video Integrated IM&P Shared Call Appearance (Optional) Meet-Me Conferencing (Optional)

21.0, 21.sp1 BroadTouch Business Communicator Mobile BroadTouch Business Communicator Mobile – Audio BroadTouch Business Communicator Mobile – Video BroadTouch Business Communicator Desktop BroadTouch Business Communicator Desktop – Audio BroadTouch Business Communicator Desktop – Video BroadTouch Business Communicator Tablet BroadTouch Business Communicator Tablet – Audio BroadTouch Business Communicator Tablet – Video Integrated IM&P Shared Call Appearance (Optional) Meet-Me Conferencing (Optional)3 Collaborate – Audio3 Collaborate – Video3 Collaborate – Messaging Collaborate – Sharing 1, 2

1 The Collaborate – Sharing license is an “overlay” license and it assumes that Collaborate –

Messaging has already been licensed.


2 When upgrading from a previous release and not using the BroadCloud IM&P service, subscribers need the new “Collaborate – Sharing” service assigned to enable the sharing functionality of Business Communicator, Release 21.0. The assignCollaborateSharingToIMPUsers script located in /usr/local/broadworks/bw_base/bin/ can be used to automatically assign the Collaborate – Sharing Service to IMP Users. For details, see section 8.2.1.2 Assign the Collaborate – Sharing Service Following an Upgrade to Release 21.0.

3 Conferencing is a core component of the Business Communicator My Room User Experience. Conferencing services can be provided by the Video Server (UVS) or by BroadWorks Meet-Me Conferencing. For details on Meet-Me Conferencing, see section 7 BroadWorks Meet-Me Conferencing. For details on the Video Server (UVS), see section 13.2 Video Server (UVS) Provisioning.

BroadWorks Patches For a complete list of patches, go to the Software Download page on BroadSoft Xchange, select the server (for example, AS, UMS, USS, UVS, XSP, and so on), the BroadWorks Release (for example, R20.sp1), the Operating System (for example, Linux/Red Hat) and then select the Individual Patches tab to list the available patches corresponding to the set search criteria. The Software Download site is available from the following location: http://xchange.broadsoft.com/php/xchange/support/broadworks/softwaredistribution/softwaredownload. If you have trouble with the Xchange link, copy and paste it into a web browser.

For additional information on the patching process, see section 8 of the BroadWorks Patching Procedure in the BroadWorks Software Management Guide [12].

Release Patches Description

19.0 AP.as.19.0.574.ap193747 DTMF transmission fix.

AP.as.19.0.574.ap224732 Introduces BWE164-x Device Management tag 1.

19.sp1 AP.as.19.sp1.574.ap193747 DTMF transmission fix.

AP.as.19.sp1.574.ap184775 AP.platform.19.sp1.574.ap184775

Forced logout of multiple same client sessions 1.

AP.as.19.sp1.574.ap224732 Introduces BWE164-x Device Management tag 1.

20.0 AP.as.20.0.606.ap234941 AP.as.20.0.606.ap235444 AP.as.20.0.606.ap235107

Meet-Me Moderator Control fixes.

AP.xsp.20.0.606.ap339087 AP.as.20.0.606.ap343670

Fix for the Business Communicator Desktop Visual Voice Mail feature introduced in Business Communicator Desktop Release 21.2.0.

20.sp1 AP.as.20.sp1.606.ap234941 AP.as.20.sp1.606.ap235444 AP.as.20.sp1.606.ap235107

Meet-Me Moderator Control fixes.

AP.xsp.20.sp1.606.ap339087 AP.as.20.sp1.606.ap343670


http://xchange.broadsoft.com/php/xchange/support/broadworks/softwaredistribution/softwaredownload

http://xchange.broadsoft.com/php/xchange/support/broadworks/softwaredistribution/softwaredownload


Release Patches Description

21.0 AP.xsp.21.0.551.ap339087 AP.as.21.0.551.ap343670 AP.as.21.0.551.ap343572


AP.as.21.0.551.ap343504 AP.as.21.0.551.ap343760 AP.as.21.0.551.ap343918

Fixes for N-way calls.

21.sp1 AP.xsp.21.sp1.551.ap339087 AP.as.21.sp1.551.ap343572 AP.as.21.sp1.551.ap343670

Fixes for the Business Communicator Desktop Visual Voice Mail feature introduced in Business Communicator Desktop Release 21.2.0.

AP.as.21.sp1.551.ap343504 AP.as.21.sp1.551.ap343760 AP.as.21.sp1.551.ap343918

Fixes for N-way calls.

AP.ums.21.sp1.551.ap342782 AP.ums.21.sp1.551.ap344033

Presence Server and Custom Presence Rules (CPR) support.

1 For more information on these Business Communicator client settings, see the Business

Communicator for Desktop Configuration Guide [14] and/or the Business Communicator (Android and iOS Mobile-R21.1.1 and Android-R20.0.0 and iOS Tablet-R20.1.1) Configuration Guide [15].

14.2 Collaborate Guest Client Requirements The Collaborate Guest Client is an Xtended web application that allows a non-BroadWorks user (a guest) to participate in a Multi-User Chat, screen share, and audio/video conferencing hosted by a BroadWorks user in their My Room on the Business Communicator Release 21 client.

Browser Requirements Audio/Video Conferencing requires Web Real-Time Communications (WebRTC) support on the browser. Multi-User Chat and screen share functionality do not require WebRTC support. Following sections describe the Guest Client browser requirements with and without WebRTC support.

14.2.1.1 WebRTC

WebRTC support is required for Audio / Video Collaboration.

Google Chrome (version 31 and above)

− Windows (Windows 7, Windows 8 [Classic], and Windows 8.1 [Classic])

− OS X (10.8 and 10.9)


14.2.1.2 No WebRTC

Google Chrome (version 31 and above)


− OS X (10.8 and 10.9)

Internet Explorer 11


Safari 7

− OS X (10.8 and 10.9)

14.3 BroadCloud Software Requirements The following table lists BroadCloud software requirements.

BroadCloud Release

Web Collaboration (Desktop Share) 12 and higher

NOTE: The BroadCloud Web Collaboration version can be verified through the user’s Web Collaboration portal by placing the mouse cursor over the help button located at the top right of the screen.

14.4 Client Platform Requirements For supported Desktop, Mobile, and Tablet platforms, see the Business Communicator (Desktop-R21.1.0, Mobile-R21.1.1, iOS Tablet-R20.1.1, and Android Tablet-R20.0.0) Product Guide [20] located on Xchange at the following location:



14.5 Port Requirements

Business Communicator The following table captures the typical ports used depending on the service/function provided through Business Communicator.

Service/ Feature

Ports Protocol

Desktop Mobile

User Login 80 80 HTTP

443 443 HTTPS (SSL/TLS)

IM&P 5222 5222 XMPP

Audio 5060 5060 through 5080 3 SIP(UDP/TCP)

8500 through 8598 8500 through 8598 RTP

Video 5060 5060 through 5080 3 SIP(UDP/TCP)

8600 through 8698 8600 through 8698 RTP




Service/ Feature

Ports Protocol

Desktop Mobile

File Transfer Proxy 1081, 1082 2 XMPP

52644 through 52645 SOCKS

Desktop Share (BroadWorks Collaborate Sharing Server)

8443 HTTPS (SSL/TLS)

Desktop Share (BroadCloud IM&P)

443 HTTPS (SSL/TLS)

Outlook Add-in1 5000, 5500 MAPI

1 Ports serving the Outlook Add-in allow connections only from the Localhost (Outlook must co-reside on the same platform hosting the Business Communicator Desktop client).

2 Port 1082 is used by BroadCloud IM&P in failover scenarios and not applicable to BroadWorks Collaborate IM&P.

3 It is strongly recommended to use port 5075.

Collaborate Servers The following table captures the ports used on the Collaborate Servers.

Messaging Server

Ports Protocol

443 HTTPS (Provisioning)

1081 SOCKS-5 (File Exchange)

5222 XMPP over TLS (IM&P)

5269 XMPP over TLS (Federation)

5277 Proprietary (Used between Messaging Server nodes)

5280 BOSH (IM&P)

5281 BOSH (IM&P secure)

Sharing Server

8443 HTTPS

14.6 UC-enabled Devices Advanced SIP phones or clients designated as UC-enabled have integrated the following BroadWorks/BroadCloud IM&P capabilities:

Provision IM&P access via Device Management

Retrieve and display IM&P contacts

Display Presence

Publish Presence


For the list of currently supported devices, see the Partner Equipment Interoperability Summary located on Xchange at the following location: http://xchange.broadsoft.com/php/xchange/support/broadworks/integration/processdocuments.


14.7 System Capacity Requirements To validate the Xtended Services Platform resources required to support Business Communicator deployments, use the BroadWorks System Capacity Planner [5].

http://xchange.broadsoft.com/php/xchange/support/broadworks/integration/processdocuments

http://xchange.broadsoft.com/php/xchange/support/broadworks/integration/processdocuments


Feature Interactions

15.1 Incoming Call Termination Interactions Business Communicator services, such as Call Back and Call-Through, rely on BroadWorks Mobility, Remote Office, and/or BroadWorks Anywhere features to enable these capabilities.

The following table captures call termination behaviors against a called party (with multiple telephony endpoints) based on feature precedence and settings. The called party has SCA with device profiles of type Business Communicator Desktop, Mobile and Tablet (respectively) enabled as endpoints.

BroadWorks Features Telephony Endpoints

BroadWorks Mobility

Remote Office

BroadWorks Anywhere

Fixed Mobile Business Communicator

RO BWA

M D T

Off Off Off X X X X

Off Off On (NM) X X X X X

Off Off On (M) X X∩ X∩ X X X

* On (NM) * X

* On (M) * X X

On (Fixed) Off Off X X X X

On (Mobile) Off Off X

On (Both) Off Off X X∩ X∩ X X

On (Fixed) Off On (NM) X X X X X

On (Fixed) Off On (M) X X∩ X∩ X X X

On (Mobile) Off On (*) X

On (Both) Off On (NM) X X∩ X∩ X X X

On (Both) Off On (M) X X∩ X∩ X X X

Legend Mobile: This is the mobile phone number assigned to BroadWorks Mobility feature. RO: This is the Remote Office location. BWA: This is the BroadWorks Anywhere location. (M): The feature provisioned with phone number matching BroadWorks Mobility mobile phone number. (NM): The feature provisioned with phone number not matching BroadWorks Mobility mobile phone number. ∩: Business Communicator Mobile client and mobile’s native call handler both alert the user of an incoming call. User can choose to accept/reject (on Android) or answer/decline (on iOS) the Call-Through either user interface (UI). Typically, Business Communicator client is first to provide ringing, followed by native handler-applied ringing. Delay between applied ringing is variable and depends on network considerations (that is, geographic location, device roaming, and possibly other factors). Note that in some circumstances, calls can be routed to a user’s voice mail due to transient call states. *: Does not matter


Integrated Instant Messaging and Presence

This section describes the steps to provision Instant Messaging and Presence on the BroadWorks platform.

16.1 Integrated IM&P Service The following section describes the provisioning steps required, on BroadWorks, to configure and enable the Integrated IM&P service.

Service Provider/Enterprise-level Configuration Authorize the Integrated IM&P user service to the service provider or enterprise as shown in the following example.

AS_CLI/SubscriberMgmt/ServiceProvider/UserServices> set broadsoft "Integrated IMP" true true ...Done

Group-level Configuration Authorize the Integrated IM&P service to the group as shown in the following example.

AS_CLI/SubscriberMgmt/Group/UserServices/Authorize> set broadsoft engineering service "Integrated IMP" true true ...Done

User-level Configuration Assign the IM&P service to the user as shown in the following figure.

Figure 56 Assign Integrated IM&P Service to User


Integrated IM&P Activation Activate Integrated IM&P for users as shown in the following figure.

Figure 57 Integrated IM&P Activation

Verify the users IM&P ID and domain shown on the user’s Profile page as shown in the following figure.

Figure 58 IM&P ID in User’s Profile


Messaging Server Proxy (HAProxy) Configuration Guidelines

A standard deployment of the Messaging Server (UMS) requires it to be publicly addressable through a demilitarized zone (DMZ). For more information, see the UMS: Messaging Server Feature Description [10]. However, the Messaging Server contains user data that may need to be further secured in order to comply with mandatory network security requirements. In these cases, placing the Messaging Server in the DMZ may not be permitted. A solution to this restriction is to front the Messaging Server with a proxy, allowing the Messaging Server to be moved from the DMZ to the MZ. This section outlines the steps necessary for fronting the Messaging Server with HAProxy.

17.1 HAProxy HAProxy is a free, thin, and fast software proxy offering high availability, load balancing, and proxying for TCP and HTTP-based applications. It is particularly suited for web sites or servers hosting a high data traffic service, such as the Messaging Server. For a complete description of the capabilities, see the HAProxy website at www.haproxy.org.

If you have trouble with the link, copy and paste it into a web browser.

Despite HAPoxy’s powerful features, only the proxy feature is required for a solution to front the Messaging Server. Other features may be useful in certain deployment scenarios; however, those scenarios are not discussed here. Figure 58 provides a network diagram showing how HAProxy is positioned in the DMZ. HAProxy is installed with two interfaces: one for internet data traffic and the other for Messaging Server traffic. HAProxy is configured to proxy only the traffic from the required ports to the Messaging Server.

The following sections provide guidelines for HAProxy installation and configuration required to front the Messaging Server. For installation and configuration details not covered here, see the HAProxy Configuration Guide [26].

http://www.haproxy.org/


Figure 59 Network Diagram of Messaging Server (UMS) Fronted by HAProxy

17.2 HAProxy Availability HAProxy is a free software-based proxy from open source. It supports many flavors of OS including Linux, Solaris, FreeBSD, and so on. HAProxy version 1.4.25 or later is recommended for this solution.

For mainstream Linux, (CentOS, Red Hat, Debian, Ubuntu), HAProxy is now included in the distribution. For example, on CentOS 6, set up access to the EPEL software repository and install HAProxy using the following commands.

[root@hap1 ~]# rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm [root@hap1 ~]# yum -y install haproxy For other OS types, the HAProxy source code is available from the HAProxy web site (http://haproxy.1wt.eu). If you have trouble with the link, copy and paste it into a web browser.

http://haproxy.1wt.eu/


The following section describes the steps required to build and install HAProxy from its source code.

17.3 HAProxy Build and Install To build HAProxy from the source code, the following tools are required:

GNU make

GCC

GNU ld

Download the HAProxy source code to the target machine and unzip. Run the following commands to build HAProxy.

[root@hap1 ~]# cd haproxy-1.4.25 [root@hap1 ~]# make TARGET=linux2628 Supported TARGETs include:

linux22: Linux 2.2

linux24: Linux 2.4 and above (default)

linux24e: Linux 2.4 with support for a working epoll (> 0.21)

linux26: Linux 2.6 and above

linux2628: Linux 2.6.28 and above (enables splice and tproxy)

solaris: Solaris 8 or 10 (others are untested)

freebsd: FreeBSD 5 to 8.0 (others are untested)

osx: Mac OS/X

openbsd: OpenBSD 3.1 to 5.2 (others are untested)

aix52: AIX 5.2

cygwin: Cygwin

generic: any other OS

custom: to manually adjust every setting

To install HAProxy, run the make command. This generates the HAProxy executable binary in the /usr/local/sbin/ (or default bin) directory.

[root@hap1 ~]# make install

17.4 HAProxy Configuration There are three sources of parameter settings for HAProxy configuration.

1) Command-line arguments, which always take precedence.

2) /etc/haproxy/haproxy.conf: global section, which sets process-wide parameters.

3) /etc/haproxy/haproxy.conf: proxies sections including defaults, listen, frontend, and backend.


Relevant parameters are identified in the following subsections. Address labels in the configuration are identified as follows:

x.x.x.x: log server IP address

y.y.y.y: HAProxy access IP address (public)

z.z.z.z: BroadWorks Messaging Server IP address (private)

Global Parameters Parameters in the global section of the haproxy.conf file are process-wide and often OS-specific. Some parameters also have command-line equivalents.

Global Parameters Purpose

daemon Makes the process fork into the background.

maxconn 1024 Sets the maximum per-process number of concurrent connections. Proxies stop accepting connections when this limit is reached.

log x.x.x.x local0 debug Adds a global syslog server. Up to two global servers can be defined. They receive logs for startups and exits, as well as all logs from proxies configured with log global.

Defaults Parameters Parameters in the defaults section of the haproxy.conf file set default values for all other sections following the defaults declaration.

Default Parameters Purpose

log global Use log configuration defined in the global section.

mode tcp Set mode to “TCP”. In this mode, HAProxy simply forwards bidirectional traffic between two sides.

Listen Parameters Parameters in the listen sections of the haproxy.conf file define what traffic HAProxy should forward and where to forward. It is generally useful for TCP-only traffic.

A listen section must be added for each Messaging Server port used by the clients. Note that TCP connections are always initiated by the client, so there is no need to configure HAProxy listening ports for traffic sent from the Messaging Server via HAProxy to the clients.

Listen Parameters Purpose

listen <name> Example: listen xmpp-client

<name> unique text identifier

bind [<address>]:<port_range> Example: bind y.y.y.y:5222

This statement tells HAProxy to listen for traffic on the specified port(s). The “bind” statement can be combined into the “listen” statement. Example: listen xmpp-client *:5222


Listen Parameters Purpose

server <name> <address>[:[port]] [param*] Example: server ums z.z.z.z:5222

This statement tells HAProxy where to forward the traffic. To forward to the Messaging Server, set as follows: <name> unique text identifier <address>[:[port]] UMS address and port

HAProxy Reference Configuration This section provides a minimal reference HAProxy configuration required to front the Messaging Server. Data received at the following ports is proxied:

5222 – XMPP from the Business Communicator clients

5269 – XMPP from federated IM&P servers

1080/1081 – TCP for File Transfer

5280 – BOSH from the BroadWorks Receptionist application

5281 – Secure BOSH Connection

NOTE 1: The BroadWorks Receptionist application must be provisioned with the access side address of the HAProxy. This is configured from the BroadWorks Application Server (AS) CLI.

NOTE 2: The Messaging Server (UMS) supports HTTP connectivity using BOSH on port 5280. Additionally, it supports HTTPS secure connections on port 5281.

AS_CLI/Service/IntegratedIMP> set boshURL http://<UMSClusterFQDN>:5280/xmpp-httpbind or AS_CLI/Service/IntegratedIMP> set boshURL https://<UMSClusterFQDN>:5281/xmpp-httpbind /etc/haproxy/haproxy.conf:

global daemon maxconn 1024 log 10.2.66.48 local0 debug log 10.2.66.48 local1 debug log-tag fwei99 debug defaults log global mode tcp option tcplog option dontlognull option redispatch retries 3 timeout connect 5000ms listen xmpp-client *:5222 server ums1iop1 199.19.193.80:5222 listen xmpp-server *:5269


server ums1iop1 199.19.193.80:5269 listen ums-prov *:443 server ums1iop1 199.19.193.80:443 listen ums-ftp1 *:1080 server ums1iop1 199.19.193.80:1080 listen ums-ftp2 *:1081 server ums1iop1 199.19.193.80:1081 listen ums-bosh *:5280 server ums1iop1 199.19.193.80:5280/xmpp-httpbind listen ums-bosh *:5281 server ums1iop1 199.19.193.80:5281/xmpp-httpbind

17.5 HAProxy Start Start the HAProxy service using the following command or configure HAProxy to automatically start on system boot.

[root@hap1 ~]# haproxy –f /etc/haproxy/haproxy.conf


BroadCloud

IM&P and Desktop Share functionality are provided by either BroadWorks Collaborate or BroadCloud. This section covers BroadCloud Instant Messaging and Presence and BroadCloud Web Collaborate.

18.1 BroadCloud Instant Messaging and Presence This section describes the BroadCloud IM&P service.

On-Boarding Process The BroadCloud IM&P service offers a provisioning interface that can be accessed by BroadWorks to enable flow-through provisioning of a user’s XMPP account in BroadCloud when a user is assigned Integrated IM&P.

Before BroadCloud accepts any provisioning requests, the BroadWorks system must be successfully “on-boarded” so that it is recognized as a valid BroadWorks system authorized to provision into BroadCloud. The on-boarding process is a business process whereby the network operator purchases IM&P users for the BroadCloud IM&P service. When these users are purchased, the network operator also receives a set of BroadCloud provisioning administrator credentials that are configured in BroadWorks and are used to log in to the BroadCloud Operations Support System (OSS) portal.

Application Server Configuration The BroadWorks system must have the messaging interface configured at the system level. This includes the provisioning administrator credentials. On the BroadWorks Application Server, the messaging interface must be configured using the following CLI commands.

Release 21 AS_CLI/Interface/Messaging> set provisioningUrl https://prov.broadcloud.broadsoft.com/oss set provisioningUserId [yourBCAdminUserID] set provisioningPassword set enableSynchronization true Pre-Release 21 AS_CLI/Interface/BroadCloud> set provisioningUrl https://prov.broadcloud.broadsoft.com/oss set provisioningUserId [yourBCAdminUserID] set provisioningPassword set enableSynchronization true Additionally, the Integrated IM&P service must have a service domain defined. On the BroadWorks Application Server, the service domain must be configured using the following CLI command.

AS_CLI/Service/IntegratedIMP> set serviceDomain [yourBCIMPDomain]

https://prov.broadcloud.broadsoft.com/oss


Furthermore, as of BroadWorks Release 20.0, the defined service domain setting (at the system level) can be overridden at the Service Provider/Enterprise and/or Group level. This provides added flexibility in managing user domains across respective levels. At the Service Provider/Enterprise or Group level, the associated Integrated IM&P service domain can be set through the Services → Integrated IM&P menu as shown in the following figure (for example, the Service Provider/Enterprise level).

Figure 60 Integrated IM&P Service Domain Setting (Service Provider or Enterprise Level) – Release 20.0

Figure 61 Integrated IM&P Service Domain Setting (Service Provider or Enterprise Level) – Release 21.0

Authorize the Integrated IM&P service to the service provider/enterprise, then to the group and assign the service to the user.


NOTE: For the steps to provision the Instant Messaging and Presence service on BroadWorks, see section 16 Integrated Instant Messaging and Presence.

DNS Record Lookup of IM&P (XMPP) Service The Business Communicator clients, depending on settings defined in their respective configuration file template (config.xml and/or mobile-config.xml and/or tablet-config.xml), support an A (Address) or SRV (Service) DNS record lookup to resolve the IP address of the server hosting the IM&P (XMPP) service.

For more information on the DNS record lookup settings, see the Business Communicator for Desktop Configuration Guide [14] and/or the Business Communicator for Android and iOS Configuration Guide [15].

Additional BroadCloud Instant Messaging and Presence Documentation Additional documentation describing the BroadCloud IM&P service and how it is deployed and configured can be found on Xchange at:

http://xchange.broadsoft.com/php/xchange/productservices/broadcloud/instantmessaging


For complete procedures required to enable IM&P services, see the BroadCloud Instant Messaging & Presence Service Guide [27].

18.2 BroadCloud Web Collaboration This section describes the BroadCloud Web Collaboration service and how it integrates with the UC-One solution (with Business Communicator) to enable the Desktop Share functionality.

On-Boarding Process The on-boarding process is a business process whereby the network operator or service provider purchases the BroadCloud Web Collaboration service package (specifically, Web-UC-One).

Upon completion of the on-boarding process, BroadSoft provides the service provider with the following:

Authentication credentials for the BroadCloud Web Collaboration APIs

Credentials for the BroadCloud Web Collaboration administration portal

Business Communicator Client End-User Configuration The Business Communicator Desktop client requires the end user’s Web Collaboration credentials to enable the Desktop Share functionality. For more information, see the Business Communicator for Desktop Configuration Guide [14].

Additional BroadCloud Web Collaboration Documentation Additional documentation describing the BroadCloud Web Collaboration service, how it is deployed and configured, can be found on Xchange at http://xchange.broadsoft.com/php/xchange/productservices/broadcloud/


http://xchange.broadsoft.com/php/xchange/productservices/broadcloud/instantmessaging

http://xchange.broadsoft.com/php/xchange/productservices/broadcloud/


For complete procedures required to Web Collaboration services, see the BroadCloud Web Collaboration Service Guide [28].


Appendix A: Business Communicator Xsi Only Configuration Without SCA

When deploying Business Communicator as a basic click-to-call application, it may be beneficial to deploy it using a simplified configuration without Shared Call Appearance (SCA).

This appendix describes the configuration details to deploy Business Communicator in a click-to-dial only simplified configuration without SCA.

The following simplifications have been made:

SCA is not required.

Only a system-level device profile type is required. There is no need to create and assign a device profile to each user.

No Device Management tags are used in the simplified configuration file, which is the same for all users.

The configuration file hosted on the DMS is unauthenticated, as it contains no end user credentials.

In this configuration, BroadWorks Device Management is used only as a web server to host the unauthenticated simplified Business Communicator configuration file and optionally, the Web Button Configuration file. Alternately, these files can be hosted on another Web Server.

19.1 Solution Configuration The following is a summary of the steps that must be performed to deploy the Business Communicator Xsi Only configuration:

Authorize the Business Communicator Desktop user service.

Download and customize the Business Communicator configuration file(s).

Create the Business Communicator Device Profile Type.

Add the configuration file(s) to the Device Profile Type.

Test the configuration.

Authorize and Assign the Business Communicator Desktop User Service To use Business Communicator, the appropriate BroadWorks service licenses are required by either purchasing or requesting temporary license files (for evaluation purposes) from BroadSoft.

Get and apply new license files, which include license quantities for the following service:

BroadTouch Business Communicator Desktop

The “BroadTouch Business Communicator Desktop” user service must be authorized for the enterprise and group.

Authorize corresponding quantities of the following service to the Enterprise(s) and Group(s):


Each user must have a corresponding client license assigned to their BroadWorks account.


Assign the following user service to the users:


Download and Customize the Configuration File Download the Business Communicator Xsi Only (non-SCA) configuration file template from BroadSoft Xchange at: http://xchange.broadsoft.com/php/xchange/system/files/BroadTouch/BusinessCommunicator/Releases/Release_9/software/non-SCA-config-template-21_2_0.zip

Customize the Business Communicator (BC) configuration file as required and optionally create and customize the Web Button Configuration file.

For details on the configuration options, see the Business Communicator for Desktop Configuration Guide [14].

Create a Device Profile Type This section describes the steps necessary to add and configure a device profile type.

19.1.3.1 Add the Device Profile Type

Browse to System → Resources → Identity/Device Profile Types and then click Add to add a new device profile type.

Enter an Identity/Device Profile Type name (for example, Business Communicator – Xsi Only).

The Standard and Advanced settings are not used and can be left with the default values.

19.1.3.2 Device Management Settings

Enable Device Management by selecting “Device Management” in the Device Configuration options.

Configure the Device Management settings as described in following table. Settings not mentioned should be left at their default value, which usually means the option is not checked.

Parameter Value

Device Access Protocol http

Device Access FQDN <BroadWorks-XSP-Cluster-Address>

Examples: xsp.yourdomain.com xsp2.xdp.broadsoft.com

Device Access Port 80

Device Access Context Name dms

Device Access URI bc/dt/

Add Device Files This section describes how to add the configuration file and optionally, the Web Button Configuration file to the device profile type.

For additional documentation describing Device Management, how it is deployed and configured, see the BroadWorks Device Management Configuration Guide [2], which is available on Xchange at xchange.broadsoft.com.

http://xchange.broadsoft.com/php/xchange/system/files/BroadTouch/BusinessCommunicator/Releases/Release_9/software/non-SCA-config-template-21_2_0.zip

http://xchange.broadsoft.com/php/xchange/system/files/BroadTouch/BusinessCommunicator/Releases/Release_9/software/non-SCA-config-template-21_2_0.zip




19.1.4.1 Add the Business Communicator Configuration Template File

Go to System → Resources → Identity/Device Profile Types. Search for and select the Business Communicator – Xsi Only device profile type. Select the Files and Authentication link.

On the Files and Authentication page, select Add to add a new file. Add the Business Communicator configuration template as described in the following table. Note that settings not mentioned should be left at their default settings.

Parameter Value

Device Access File Format config.xml

Repository File Format config.xml

File Category Static


Assign File Custom

Upload File Browse to the simplified BC xml configuration file to upload.



The following figure shows settings for the Business Communicator configuration file template.

Figure 62 Configuration Template File for Business Communicator – Xsi Only

The Business Communicator Device Xsi Only configuration file is accessible from:

http://<xsp hostname>:80/<device access context name>/<device access URI>/<device access file format> This is the Login URL that must be used with the Business Communicator Desktop client with the simplified Xsi Only configuration.

For the previous example, the access URL is as follows

http://xsp2.xdp.broadsoft.com:80/dms/bc/dt/config.xml

19.1.4.2 Add the Web Button Configuration File (Optional)

Go to System → Resources → Identity/Device Profile Types. Search for and select the Business Communicator – Xsi Only device profile type. Select the Files and Authentication link.

http://xsp2.xdp.broadsoft.com/dms/bc/dt/config.xml


On the Files and Authentication page, select Add to add a new file. Add the Configurable Web Button template as described in the following table. Note that settings not mentioned should be left at their default settings.

Parameter Value

Device Access File Format webbutton_config.xml

Repository File Format webbutton_config.xml



Assign File Custom

Upload File Browse to the webbutton_config.xml file to upload.


Device Access HTTP Authentication Basic The following figure shows settings for the Web Button Configuration file.

Figure 63 Web Button Configuration File


The Web Button Configuration file is accessible from:

http://<xsp hostname>:80/<device access context name>/<device access URI>/<device access file format> For the previous example, the Web Button Configuration file URL is:

http://xsp2.xdp.broadsoft.com:80/dms/bc/dt/webbutton_config.xml

http://xsp2.xdp.broadsoft.com/dms/bc/dt/webbutton_config.xml


Appendix B: OCI-P Sample Code to Create “UC-One” User in BroadWorks

The following Open Client Interface-Provisioning (OCI-P) sample code, provided as reference, shows exactly all the steps necessary to deploy a “UC-One” enabled user in BroadWorks.

The following BroadWorks system setup must be completed as a prerequisite:

BroadWorks Device Management setup complete, including BroadTouch_Tags Device Management Tag Sets set up and configured.

“Business Communicator – PC” and “Business Communicator – Mobile” identity device profile types have been created and configured.

BroadWorks Application Server is configured and able to provision to the Messaging Server.

Service provider or enterprise created in BroadWorks.

Group created in BroadWorks, with available phone numbers and required BroadWorks services.

Group has the “New User Services Template” configured with the required User services.

With the above system setup in place, the OCI-P sample code does the following:

Creates a BroadWorks user.

Creates a “Primary Device” for the user.

Configures the “Primary Device” with a line/port, and gives the user a phone number and extension.

Creates a Business Communicator Desktop device for the user.

Creates a Business Communicator Mobile device for the user.

Configures the device password for Business Communicator – Desktop.

Configures the device password for Business Communicator – Mobile.

Configures Shared Call Appearance for the user.

Adds the user’s Business Communicator Desktop device as an SCA.

Adds the user’s Business Communicator Mobile device as an SCA. (At this point, the user has three devices – the primary and the two Business Communicator SCAs. Having three devices like this is not mandatory and it varies based on the offering.)

Sets the user’s SIP authentication.

Turns on Integrated IM&P (which triggers the BroadWorks Application Server to create an IM&P account on the BroadWorks Messaging Server).

Configures the user’s voice mail.

Adds the user to a Meet-Me bridge.


For each of the following commands, the echo parameter contains what each command does if it is not obvious from the actual command type. This OCI-P code is sent directly (after replacing the relevant data elements) to BroadWorks using the OCI Client Kit. It is available on Xchange in the Software Download area, at xchange.broadsoft.com. (If you have trouble with the Xchange link, copy and paste the link in a web browser.) In addition, this code can be used as a model for your provisioning application.

For more information on OCI-P development, see the forums at developer.broadsoft.com.

<?xml version="1.0" encoding="ISO-8859-1"?> <BroadsoftDocument protocol="OCI" xmlns="C" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sessionId xmlns="">13288937697220.345553</sessionId> <command xsi:type="UserAddRequest17sp4" xmlns="" echo="Create a BroadWorks user"> <serviceProviderId>ServiceProvider_xyz</serviceProviderId> <groupId>some_group</groupId> <userId>[email protected]/userId> <lastName>User 1</lastName> <firstName>BTBC</firstName> <callingLineIdLastName></callingLineIdLastName> <callingLineIdFirstName></callingLineIdFirstName> <password>Welcome1</password> <language>English</language> <timeZone>America/Denver</timeZone> <address/> </command> <command xsi:type="PasswordModifyRequest" xmlns="" echo="Reset Password to reset password expiry"> <userId>[email protected] </userId> <newPassword>Welcome1</newPassword> </command> <command xsi:type="GroupAccessDeviceAddRequest14" xmlns="" echo="Create a primary device for user"> <serviceProviderId>ServiceProvider_xyz</serviceProviderId> <groupId>some_group</groupId> <deviceName>btbcuser1_genericSIP</deviceName> <deviceType>Generic SIP Phone</deviceType> <protocol>SIP 2.0</protocol> <transportProtocol>Unspecified</transportProtocol> </command> <command xsi:type="UserModifyRequest16" xmlns="" echo="Configure Line/Port and phone number for primary device”> <userId>[email protected]</userId> <phoneNumber>3033331234</phoneNumber> <extension>1234</extension> <sipAliasList xsi:nil="true"/> <endpoint> <accessDeviceEndpoint> <accessDevice> <deviceLevel>Group</deviceLevel> <deviceName>btbcuser1_genericSIP</deviceName> </accessDevice> <linePort>[email protected]</linePort> <contact xsi:nil="true"/> </accessDeviceEndpoint>

http://xchange.broadsoft.com/

http://developer.broadsoft.com/


</endpoint> </command> <command xsi:type="GroupAccessDeviceAddRequest14" xmlns="" echo="Create a Desktop BTBC device for user"> <serviceProviderId>ServiceProvider_xyz</serviceProviderId> <groupId>some_group</groupId> <deviceName>btbcuser1_btbc_pc</deviceName> <deviceType>Business Communicator - PC</deviceType> <protocol>SIP 2.0</protocol> <transportProtocol>Unspecified</transportProtocol> </command> <command xsi:type="GroupAccessDeviceAddRequest14" xmlns="" echo="Create a Mobile BTBC device for user"> <serviceProviderId>ServiceProvider_xyz</serviceProviderId> <groupId>some_group</groupId> <deviceName>btbcuser1_btbc_mob</deviceName> <deviceType>Business Communicator - Mobile</deviceType> <protocol>SIP 2.0</protocol> <transportProtocol>Unspecified</transportProtocol> </command> <command xsi:type="GroupAccessDeviceModifyRequest14" xmlns="" echo="Set BTBC desktop device username/password for Device Management"> <serviceProviderId>ServiceProvider_xyz</serviceProviderId> <groupId>some_group</groupId> <deviceName>btbcuser1_btbc_pc</deviceName> <protocol>SIP 2.0</protocol> <netAddress xsi:nil="true"/> <port xsi:nil="true"/> <outboundProxyServerNetAddress xsi:nil="true"/> <stunServerNetAddress xsi:nil="true"/> <macAddress xsi:nil="true"/> <serialNumber xsi:nil="true"/> <description xsi:nil="true"/> <configurationMode>Default</configurationMode> <physicalLocation xsi:nil="true"/> <transportProtocol>Unspecified</transportProtocol> <useCustomUserNamePassword>true</useCustomUserNamePassword> <accessDeviceCredentials> <userName>[email protected]</userName> <password>any_password</password> </accessDeviceCredentials> </command> <command xsi:type="GroupAccessDeviceModifyRequest14" xmlns="" echo="Set BTBC Mobile device username/password for Device Management"> <serviceProviderId>ServiceProvider_xyz</serviceProviderId> <groupId>some_group</groupId> <deviceName>btbcuser1_btbc_mob</deviceName> <protocol>SIP 2.0</protocol> <netAddress xsi:nil="true"/> <port xsi:nil="true"/> <outboundProxyServerNetAddress xsi:nil="true"/>


<stunServerNetAddress xsi:nil="true"/> <macAddress xsi:nil="true"/> <serialNumber xsi:nil="true"/> <description xsi:nil="true"/> <configurationMode>Default</configurationMode> <physicalLocation xsi:nil="true"/> <transportProtocol>Unspecified</transportProtocol> <useCustomUserNamePassword>true</useCustomUserNamePassword> <accessDeviceCredentials> <userName>[email protected]</userName> <password>any_password</password> </accessDeviceCredentials> </command> <command xsi:type="UserSharedCallAppearanceModifyRequest" xmlns="" echo="Configure Shared Call Appearance For User" > <userId>[email protected]</userId> <alertAllAppearancesForClickToDialCalls>true</alertAllAppearancesForClickToDialCalls> <alertAllAppearancesForGroupPagingCalls>false</alertAllAppearancesForGroupPagingCalls> <allowSCACallRetrieve>true</allowSCACallRetrieve> <multipleCallArrangementIsActive>true</multipleCallArrangementIsActive> <allowBridgingBetweenLocations>false</allowBridgingBetweenLocations> <bridgeWarningTone>None</bridgeWarningTone> <enableCallParkNotification>false</enableCallParkNotification> </command> <command xsi:type="UserSharedCallAppearanceAddEndpointRequest14sp2" xmlns="" echo="Add a Shared Call Appearance for BTBC desktop to the user"> <userId>[email protected]</userId> <accessDeviceEndpoint> <accessDevice> <deviceLevel>Group</deviceLevel> <deviceName>btbcuser1_btbc_pc</deviceName> </accessDevice> <linePort>[email protected]</linePort> </accessDeviceEndpoint> <isActive>true</isActive> <allowOrigination>true</allowOrigination> <allowTermination>true</allowTermination> </command> <command xsi:type="UserSharedCallAppearanceAddEndpointRequest14sp2" xmlns="" echo="Add a Shared Call Appearance for BTBC mobile to the user"> <userId>[email protected]</userId> <accessDeviceEndpoint> <accessDevice> <deviceLevel>Group</deviceLevel> <deviceName>btbcuser1_btbc_mob</deviceName>


</accessDevice> <linePort>[email protected]</linePort> </accessDeviceEndpoint> <isActive>true</isActive> <allowOrigination>true</allowOrigination> <allowTermination>true</allowTermination> </command> <command xsi:type="UserAuthenticationModifyRequest" xmlns="" echo="Set SIP Authentication for user"> <userId>[email protected]</userId> <userName>sipa_1937d</userName> <newPassword>sipp_8953a</newPassword> </command> <command xsi:type="UserIntegratedIMPModifyRequest" xmlns="" echo="Turn On Integrated IM&P, will create user in BroadCloud XMPP"> <userId>[email protected]</userId> <isActive>true</isActive> </command> <command xsi:type="UserVoiceMessagingUserModifyVoiceManagementRequest" xmlns=""> <userId>allservices</userId> <isActive>true</isActive> <processing>Deliver To Email Address Only</processing> <voiceMessageDeliveryEmailAddress>[email protected]</voiceMessageDeliveryEmailAddress> <usePhoneMessageWaitingIndicator>true</usePhoneMessageWaitingIndicator> <sendVoiceMessageNotifyEmail>false</sendVoiceMessageNotifyEmail> <voiceMessageNotifyEmailAddress xsi:nil="true"/> <sendCarbonCopyVoiceMessage>false</sendCarbonCopyVoiceMessage> <voiceMessageCarbonCopyEmailAddress xsi:nil="true"/> <transferOnZeroToPhoneNumber>false</transferOnZeroToPhoneNumber> <transferPhoneNumber xsi:nil="true"/> <alwaysRedirectToVoiceMail>false</alwaysRedirectToVoiceMail> <busyRedirectToVoiceMail>true</busyRedirectToVoiceMail> <noAnswerRedirectToVoiceMail>true</noAnswerRedirectToVoiceMail> <outOfPrimaryZoneRedirectToVoiceMail>false</outOfPrimaryZoneRedirectToVoiceMail> </command> <command xsi:type="GroupMeetMeConferencingModifyInstanceRequest" xmlns="" echo="add users to bridge"> <serviceUserId>demogroup1_bridge</serviceUserId> <serviceInstanceProfile> <name>Demo Group 1 Bridge</name> <callingLineIdLastName>Bridge</callingLineIdLastName> <callingLineIdFirstName>Demo Group 1</callingLineIdFirstName>


<department xsi:type="GroupDepartmentKey" xsi:nil="true"/> <language>English</language> <timeZone>America/Denver</timeZone> </serviceInstanceProfile> <allocatedPorts> <quantity>10</quantity> </allocatedPorts> <securityPinLength>6</securityPinLength> <allowIndividualOutDial>true</allowIndividualOutDial> <operatorNumber xsi:nil="true"/> <conferenceHostUserIdList> <userId>[email protected]</userId> </conferenceHostUserIdList> <playWarningPrompt>false</playWarningPrompt> <conferenceEndWarningPromptMinutes>10</conferenceEndWarningPromptMinutes> <enableMaxConferenceDuration>false</enableMaxConferenceDuration> <maxConferenceDurationMinutes> <hours>3</hours> <minutes>0</minutes> </maxConferenceDurationMinutes> <maxScheduledConferenceDurationMinutes> <hours>23</hours> <minutes>45</minutes> </maxScheduledConferenceDurationMinutes> </command> </BroadsoftDocument>


References

[1] Jonathan Rosenberg, Henning Schulzrinne, “Session Initiation Protocol (SIP): Locating SIP Servers”, RFC 3263, Internet Engineering Task Force, July 2002. Available from www.ietf.org.

[2] BroadSoft, Inc. 2015. BroadWorks Device Management Configuration Guide, Release 21.0. Available from BroadSoft at xchange.broadsoft.com.

[3] BroadSoft, Inc. 2015. BroadWorks Meet-Me Conferencing Guide, Release 21.0. Available from BroadSoft at xchange.broadsoft.com.

[4] BroadSoft, Inc. 2015. BroadWorks Meet-Me Conferencing Quick Reference Guide, Release 21.0. Available from BroadSoft at xchange.broadsoft.com.

[5] BroadSoft, Inc. 2015. BroadWorks System Capacity Planner. Available from BroadSoft at xchange.broadsoft.com.

[6] BroadSoft, Inc. 2015. Outlook Add-in for Business Communicator User Guide. Available from BroadSoft at xchange.broadsoft.com.

[7] BroadSoft, Inc. 2014. BroadWorks Sharing Server Command Line Interface Administration Guide, Release 21.sp1. Available from BroadSoft at xchange.broadsoft.com.

[8] BroadSoft, Inc. 2014. BroadWorks Messaging Server Command Line Interface Administration Guide, Release 21.sp1. Available from BroadSoft at xchange.broadsoft.com.

[9] BroadSoft, Inc. 2014. BroadWorks Messaging Server and Sharing Server Release Notes, Release 20.sp1. Available from BroadSoft at xchange.broadsoft.com.

[10] BroadSoft, Inc. 2014. UMS: Messaging Server Feature Description, Release 20.0. Available from BroadSoft at xchange.broadsoft.com.

[11] BroadSoft, Inc. 2014. BroadWorks Profile Server Configuration Guide, Release 21.0. Available from BroadSoft at xchange.broadsoft.com.

[12] BroadSoft, Inc. 2015. BroadWorks Software Management Guide, Release 21.0. Available from BroadSoft at xchange.broadsoft.com.

[13] BroadSoft, Inc. 2015. BroadWorks Maintenance Guide, Release 21.0. Available from BroadSoft at xchange.broadsoft.com.

[14] BroadSoft, Inc. 2015. Business Communicator for Desktop Configuration Guide, Release 21.2.0. Available from BroadSoft at xchange.broadsoft.com.

[15] BroadSoft, Inc. 2015. Business Communicator (Android and iOS Mobile-R21.1.1 and Android-R20.0.0 and iOS Tablet-R20.1.1) Configuration Guide. Available from BroadSoft at xchange.broadsoft.com.

[16] BroadSoft, Inc. 2015. Business Communicator (Android) Release Notes, Release 21.2.1. Available from BroadSoft at xchange.broadsoft.com.

[17] BroadSoft, Inc. 2015. Business Communicator (iOS) Release Notes, Release 21.2.1. Available from BroadSoft at xchange.broadsoft.com.

[18] BroadSoft, Inc. 2015. Business Communicator (Desktop) Release Notes, Release 21.2.0. Available from BroadSoft at xchange.broadsoft.com.

[19] BroadSoft, Inc. 2015. Business Communicator (iOS Tablet) Release Notes, Release 20.1.1. Available from BroadSoft at xchange.broadsoft.com

http://www.ietf.org/




















[20] BroadSoft, Inc. 2015. Business Communicator (Desktop-R21.2.0, Mobile-R21.2.1, iOS Tablet-R20.1.1, and Android Tablet-R20.0.0) Product Guide. Available from BroadSoft at xchange.broadsoft.com.

[21] BroadSoft, Inc. 2014. BroadWorks VoiceXML and CCXML Developer’s Guide, Release 21.0. Available from BroadSoft at xchange.broadsoft.com.

[22] BroadSoft, Inc. 2015. Business Communicator for Desktop User Guide, Release 21.2.0. Available from BroadSoft at xchange.broadsoft.com.

[23] BroadSoft, Inc. 2014. Business Communicator for Android User Guide, Release 20.1.0. Available from BroadSoft at xchange.broadsoft.com.

[24] BroadSoft, Inc. 2014. Business Communicator for iPhone User Guide, Release 20.1.0. Available from BroadSoft at xchange.broadsoft.com.

[25] BroadSoft, Inc. 2014. Business Communicator Tablet (iPad) User Guide, Release 20.0.0. Available from BroadSoft at xchange.broadsoft.com.

[26] HAProxy.org 2014. HAProxy Configuration Manual, version 1.4.25 or later. Available in the Documentation section at http://www.haproxy.org.

[27] BroadSoft, Inc. 2013. BroadCloud Instant Messaging & Presence Service Guide. Available from BroadSoft at xchange.broadsoft.com.

[28] BroadSoft, Inc. 2014. BroadCloud Web Collaboration Service Guide. Available from BroadSoft at xchange.broadsoft.com.

[29] BroadSoft, Inc. 2012. BroadCloud Web Collaboration Meet-Me Audio Conferencing Integration Guide. Available from BroadSoft at xchange.broadsoft.com.

[30] BroadSoft, Inc. 2013. BroadSoft BroadCloud Web Collaboration Administration Portal Guide. Available from BroadSoft at xchange.broadsoft.com.

[31] BroadSoft, Inc. 2015. BroadWorks WebRTC Server Product Description. Available from BroadSoft at xchange.broadsoft.com.

[32] BroadSoft, Inc. 2015. BroadWorks Release Notes, Release 21.0. Available from BroadSoft at xchange.broadsoft.com

[33] BroadSoft, Inc. 2014. Collaborate Guest Client Feature Description, Release 21.0. Available from BroadSoft at xchange.broadsoft.com

[34] BroadSoft, Inc. 2015. BroadWorks Video Services Solution Guide, Release 21.0. Available from BroadSoft at xchange.broadsoft.com.

[35] BroadSoft, Inc. 2015. BroadWorks Performance Measurement Interface Specification, Release 21.sp1. Available from BroadSoft at xchange.broadsoft.com.

If you have trouble with any link, copy and paste it into a web browser.







http://www.haproxy.org/










uc-one solution guidebergoon.com/files/ucone-solutionguide-r21.pdf · 2015-07-27 · uc-one...

Documents