BroadSoft Partner Configuration Guide

Transcription

1 BroadSoft Partner Configuration Guide MiaRec Call Recording System Sep 2015 Document Version W. Santa Clara St, Suite 803 San Jose, CA

2 BroadWorks Guide Copyright Notice Trademarks 2015 MiaRec, Inc. All rights reserved. BroadWorks and BroadWorks Assistant Enterprise, BroadWorks Call Center, BroadWorks Communicator, BroadWorks Receptionist, and BroadWorks Deployment Studio are trademarks of BroadSoft, Inc. Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft Corporation. Other product names mentioned in this document may be trademarks or registered trademarks of their respective companies and are hereby acknowledged. This document is printed in the United States of America MIAREC PAGE 2 OF 25

3 Document Revision History Version Reason for Change 1.1 Introduced document for MiaRec MiaRec call recording system version validation with BroadWorks Release 19.SP Updated documentations for MiaRec version MIAREC PAGE 3 OF 25

4 Table of Contents 1 Overview Interoperability Status Verified Versions Interface Capabilities Supported Known Issues BroadWorks Configuration Add Call Recording Device on Application Server Authorize Call Recording Service to User Configure Group Call Recording Platform Create Group Call Recording User Configure Call Recording User Address Assign Call Recording User service Configure User Call Recording Service MiaRec Configuration Deployment Scenarios Configure SIPREC Recording Interface on MiaRec Server Enable SIPREC Interface TCP/UDP port for SIPREC signaling UDP Ports Range for RTP Media Data Dual / Single Media Stream Public Ip-address Configure Users Add new tenant Add extensions to tenant Add role Add group Add new user Configure Firewall on MiaRec Server References MIAREC PAGE 4 OF 25

5 Table of Figures Figure 1 Configure Call Recording Platform Figure 2 Create Group Call Recording User Figure 3 Configure Group Call Recording User Address Figure 4 Assign Call Recording Service Figure 5 Configure Call Recording Service Figure 6 MiaRec Deployment on Service Provider Premises Figure 7 MiaRec Deployment on Customer Premises Figure 8 Configure Recording Interfaces Figure 9 Configure SIPREC Recording Interface Figure 10 MiaRec multi-tenancy Figure 11 Add Tenant Figure 12 Add Extentions Figure 13 Add Extention Form Figure 14 Add Role Figure 15 Add User MIAREC PAGE 5 OF 25

6 1 Overview This guide describes the configuration procedures required for the MiaRec LLC. MiaRec call recording system for interoperability with BroadWorks. The MiaRec is a call recording platform that communicates with BroadWorks over the Session Initiation Protocol (SIP) interface and conforms to the SIP Recording (SIPREC) standard. This guide describes the specific configuration items that are important for use with BroadWorks. It does not describe the purpose and use of all configuration items on the MiaRec. For those details, see the MiaRec Admin Guide [1] supplied by MiaRec MIAREC PAGE 6 OF 25

7 2 Interoperability Status This section provides the known interoperability status of the MiaRec call recording system with BroadWorks. This includes the version(s) tested, the capabilities supported, and known issues. Interoperability testing validates that the device interfaces properly with BroadWorks via the SIP interface. Qualitative aspects of the device or device capabilities not affecting the SIP interface such as display features, performance, and audio qualities are not covered by interoperability testing. Requests for information and/or issues regarding these aspects should be directed to MiaRec. 2.1 Verified Versions The following table identifies the verified MiaRec call recording system and BroadWorks versions and the month/year the testing occurred. If the device has undergone more than one test cycle, versions for each test cycle are listed, with the most recent listed first. The Compatible Versions column in the following table identify specific MiaRec versions which the partner has identified as compatible and should interface properly with BroadWorks. Generally, maintenance releases of the validated version are considered compatible and may not be specifically listed here. For any questions concerning maintenance and compatible releases, contact MiaRec. NOTE: Interoperability testing is usually performed with the latest generally available (GA) device firmware/software and the latest GA BroadWorks release and service pack at the time the testing occurs. If there is a need to use a non-verified mix of BroadWorks and device software versions, customers can mitigate their risk by self-testing the combination themselves using the BroadWorks Call Recording Interoperability Test Plan [2]. Verified Versions Date (mm/yyyy) BroadWorks Release MiaRec Verified Version MiaRec Compatible Versions 01/2014 Release 19.SP None 2015 MIAREC PAGE 7 OF 25

8 2.2 Interface Capabilities Supported The MiaRec call recording system has completed interoperability testing with BroadWorks using the BroadWorks Call Recording Interoperability Test Plan [2]. The results are summarized in the following table. The BroadWorks test plan is composed of packages, each covering distinct interoperability areas, such as Basic call scenarios and Redundancy scenarios. Each package is composed of one or more test items, which in turn, are composed of one or more test cases. The test plan exercises the SIP interface between the device and BroadWorks with the intent to ensure interoperability sufficient to support the BroadWorks feature set. The Supported column in the following table identifies the MiaRec call recording system s support for each of the items covered in the test plan packages, with the following designations: Test item is supported. No Test item is not supported. NA Test item is not applicable to the device type. NT Test item was not tested. Caveats and clarifications are identified in the Comments column. NOTE: DUT in the following table refers to the Device Under Test, which in this case is the MiaRec call recording system. BroadWorks Call recorder Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments Basic Originator Recording Terminator Recording Originator and Terminator Recording Session Audit Session Timer Call Control Services Call Waiting Call Hold Blind Transfer Attended Transfer Three-Way Call Network Three-Way Call Call Park Call Pickup Direct Call Pickup with Barge-in IVR Services Auto Attendant 2015 MIAREC PAGE 8 OF 25

9 MiaRec BroadWorks Call recorder Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments Voice Messaging Call Center TCP TCP 2.3 Known Issues This section lists the known interoperability issues between BroadWorks and specific partner release(s). Issues identified during interoperability testing and known issues identified in the field are listed. The following table provides a description of each issue and, where possible, identifies a workaround. The verified partner device versions are listed with an X indicating that the issue occurs in the specific release. The issues identified are device deficiencies or bugs, so typically not BroadWorks release dependent. If the testing was performed by BroadSoft, then the Issue Number is a BroadSoft ExtraView partner issue number. If the testing was performed by the partner or a third party, then the partner may or may not supply a tracking number. For more information on any issues related to the particular partner device release, see the partner release notes. Issue Number Issue Description Partner Version No issue is identified MIAREC PAGE 9 OF 25

10 3 BroadWorks Configuration This section describes the general steps required to enable BroadWorks for Call Recording. 3.1 Add Call Recording Device on Application Server Add Call Recording from the Application Server command line interface (CLI) to make it available for use. AS_CLI/Service/CallRecording> add [name] [netaddress] [port] [transporttype] [mediastream] [schemaversion] description [description label] Example: AS_CLI/Service/CallRecording>add MiaRec UDP dual Authorize Call Recording Service to User Authorize the Call Recording service from the Group Resources Services page. 3.3 Configure Group Call Recording Platform Configure the group with Call Recording added in section 3.1 Add Call Recording Device on Application Server from the Group Resources Group Call Recording Platform page. Figure 1 Configure Call Recording Platform 2015 MIAREC PAGE 10 OF 25

11 3.4 Create Group Call Recording User Create a user in the group as the Call Recording User. Make sure that the Call Recording service is assigned to the user. Figure 2 Create Group Call Recording User 3.5 Configure Call Recording User Address Configure the Call Recording user s address information. Figure 3 Configure Group Call Recording User Address 2015 MIAREC PAGE 11 OF 25

12 3.6 Assign Call Recording User service Assign the Call Recording service to a user from the User Profile Assign Services page. Figure 4 Assign Call Recording Service 3.7 Configure User Call Recording Service Configure the user Call Recording service from the User Call Control Call Recording page. The Call Recording service, when provisioned for the user, can be turned on by selecting Always or On-Demand or can be turned off by selecting Never. Figure 5 Configure Call Recording Service 2015 MIAREC PAGE 12 OF 25

13 4 MiaRec Configuration The capabilities of the MiaRec have been verified for use with BroadWorks based on the settings described in this section. For more information on the meaning, purpose, and applicability of individual configuration items, see the MiaRec Admin Guide [1]. 4.1 Deployment Scenarios MiaRec call recording software supports deployment on service provider premises (Figure 6) and customer premises (Figure 7). This guide covers configuration steps for both scenarios. Figure 6 MiaRec Deployment on Service Provider Premises 2015 MIAREC PAGE 13 OF 25

14 Figure 7 MiaRec Deployment on Customer Premises 2015 MIAREC PAGE 14 OF 25

15 4.2 Configure SIPREC Recording Interface on MiaRec Server In MiaRec web portal navigate to Administration -> System Configuration -> Recording Interfaces. Figure 8 Configure Recording Interfaces 2015 MIAREC PAGE 15 OF 25

16 Click on Configure link for SIPREC interface. Figure 9 Configure SIPREC Recording Interface Enable SIPREC Interface Check Enable SIPREC recording box TCP/UDP port for SIPREC signaling Change parameters Signaling UDP port and Signaling TCP port according to the port configuration in section 3.1 Add Call Recording Device on Application Server. By default MiaRec is listening on port 5080 for both TCP and UDP signaling data UDP Ports Range for RTP Media Data If necessary, change default values of UDP port range for RTP media packets. Edit parameters Begin RTP port range and End RTP port range. Make sure that the port range is large enough for anticipated number of concurrently recorded calls. One concurrent call requires one UDP port for single media stream recording and two UDP ports for dual media stream recording MIAREC PAGE 16 OF 25

17 4.2.4 Dual / Single Media Stream MiaRec software automatically supports both dual and single media streams from BroadWorks, as a result, there is no configuration necessary for this Public Ip-address If MiaRec server is located behind NAT, then specify public-ip address which is used by Broadworks to establish SIPREC connection. Make sure that port forwarding is configured properly on your NAT router. If MiaRec server and Broadworks are in the same network, then leave this parameter empty MIAREC PAGE 17 OF 25

18 4.3 Configure Users MiaRec supports multi-tenant configuration. Multiple tenant accounts may have own set of users, groups, roles, and extensions. Tenant users have access to data only within boundaries of own tenant account. Tenant's data is isolated from each other. MiaRec provides self-service capability to tenants. For example, tenant administrator may reset own users passwords, modify role permissions, move existing user into another group, etc. Figure 10 MiaRec multi-tenancy 2015 MIAREC PAGE 18 OF 25

19 4.3.1 Add new tenant In MiaRec web portal navigate to Administration -> User Management -> Tenants and click Add tenant. Figure 11 Add Tenant Once tenant account is created, you can add Extensions, Users, Groups and Roles to it MIAREC PAGE 19 OF 25

20 4.3.2 Add extensions to tenant Open extensions tab on newly created tenant s profile page and click Add Extension or Add range. Figure 12 Add Extentions 2015 MIAREC PAGE 20 OF 25

21 Extension in MiaRec is a "phone number", "phone name" and/or "broadworks user id". It is recommended to use a broadworks user ids as extension in MiaRec software. This will allow to change easily user s phone number without necessity to modify MiaRec configuration. Figure 13 Add Extention Form 2015 MIAREC PAGE 21 OF 25

22 4.3.3 Add role Each user in MiaRec system should be assigned a role. The role defines what system resources are accessible by user and what operations are permitted on these resources. Create at least one role for tenant (for example, User role ). Navigate to tenant s profile page and click Add role button. Figure 14 Add Role Add group Create at least one group for each tenant. Navigate to tenant s profile page and click Add group button to accomplish this MIAREC PAGE 22 OF 25

23 4.3.5 Add new user Navigate to tenant s profile page and click Add user. On user s profile page you can specify recording settings (like record always, record ondemand only or never record ) as well as web-access settings (login and password). Figure 15 Add User 2015 MIAREC PAGE 23 OF 25

24 4.4 Configure Firewall on MiaRec Server Create exception rules in firewall for the following ports: Port Description 80 (TCP) Web interface to MiaRec call recording system. This port can be changed during or after installation (TCP) 5080 (UDP) TCP and UDP ports for SIPREC signaling data. These ports can be changed in MiaRec.ini configuration file (UDP) Port range for receiving RTP media packets from BroadWorks. This port range can be changed in MiaRec.ini configuration file MIAREC PAGE 24 OF 25

25 References [1] MiaRec, Inc MiaRec Admin Guide. Available online at [2] BroadSoft, Inc BroadWorks Call Recording Interoperability Test Plan, Release 19.sp1. Available from BroadSoft at broadsoft.com/xchange. [3] BroadSoft, Inc BroadWorks Call Recording Interface Guide, Release Available from BroadSoft at xchange.broadsoft.com MIAREC PAGE 25 OF 25