BroadSoft Partner Configuration Guide - MiaRec Partner Configuration Guide MiaRec Call Recording...

BroadSoft Partner Configuration Guide

MiaRec Call Recording System

Sep 2015

Document Version 1.2

333 W. Santa Clara St, Suite 803 San Jose, CA 95133 +1.866.324.6717

WWW.MIAREC.COM

MiaRec

BROADSOFT PARTNER CONFIGURATION GUIDE – MIAREC MIAREC DOCUMENT NUMBER

©2015 MIAREC PAGE 2 OF 25

BroadWorks® Guide

Copyright Notice

© 2015 MiaRec, Inc. All rights reserved.

Trademarks

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



Document Revision History

Version Reason for Change

1.1 Introduced document for MiaRec MiaRec call recording system version 3.0.655 validation with BroadWorks Release 19.SP1.

1.2 Updated documentations for MiaRec version 5.0

MiaRec



Table of Contents

1 Overview .............................................................................................................................................6

2 Interoperability Status ......................................................................................................................7

2.1 Verified Versions ........................................................................................................................... 7

2.2 Interface Capabilities Supported .................................................................................................. 8

2.3 Known Issues ............................................................................................................................... 9

3 BroadWorks Configuration .......................................................................................................... 10

3.1 Add Call Recording Device on Application Server .................................................................. 10

3.2 Authorize Call Recording Service to User ................................................................................ 10

3.3 Configure Group Call Recording Platform ............................................................................... 10

3.4 Create Group Call Recording User .......................................................................................... 11

3.5 Configure Call Recording User Address .................................................................................. 11

3.6 Assign Call Recording User service ......................................................................................... 12

3.7 Configure User Call Recording Service ................................................................................... 12

4 MiaRec Configuration .................................................................................................................... 13

4.1 Deployment Scenarios .............................................................................................................. 13

4.2 Configure SIPREC Recording Interface on MiaRec Server.................................................... 15

4.2.1 Enable SIPREC Interface................................................................................................. 16

4.2.2 TCP/UDP port for SIPREC signaling............................................................................... 16

4.2.3 UDP Ports Range for RTP Media Data ........................................................................... 16

4.2.4 Dual / Single Media Stream ............................................................................................. 17

4.2.5 Public Ip-address .............................................................................................................. 17

4.3 Configure Users ......................................................................................................................... 18

4.3.1 Add new tenant ................................................................................................................. 19

4.3.2 Add extensions to tenant .................................................................................................. 20

4.3.3 Add role ............................................................................................................................. 22

4.3.4 Add group .......................................................................................................................... 22

4.3.5 Add new user .................................................................................................................... 23

4.4 Configure Firewall on MiaRec Server ....................................................................................... 24

References ............................................................................................................................................... 25

MiaRec



Table of Figures

Figure 1 Configure Call Recording Platform ........................................................................................... 10 Figure 2 Create Group Call Recording User ........................................................................................... 11 Figure 3 Configure Group Call Recording User Address ....................................................................... 11 Figure 4 Assign Call Recording Service .................................................................................................. 12 Figure 5 Configure Call Recording Service ............................................................................................. 12 Figure 6 MiaRec Deployment on Service Provider Premises ................................................................ 13 Figure 7 MiaRec Deployment on Customer Premises ........................................................................... 14 Figure 8 Configure Recording Interfaces ................................................................................................ 15 Figure 9 Configure SIPREC Recording Interface ................................................................................... 16 Figure 10 MiaRec multi-tenancy .............................................................................................................. 18 Figure 11 Add Tenant ............................................................................................................................... 19 Figure 12 Add Extentions ......................................................................................................................... 20 Figure 13 Add Extention Form ................................................................................................................. 21 Figure 14 Add Role ................................................................................................................................... 22 Figure 15 Add User .................................................................................................................................. 23

MiaRec



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



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.SP1 3.0.655 None

MiaRec



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:

Yes 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 Yes

Terminator Recording Yes

Originator and Terminator Recording Yes

Session Audit Yes

Session Timer Yes

Call Control Services

Call Waiting Yes

Call Hold Yes

Blind Transfer Yes

Attended Transfer Yes

Three-Way Call Yes

Network Three-Way Call Yes

Call Park Yes

Call Pickup Yes

Direct Call Pickup with Barge-in Yes

IVR Services Auto Attendant Yes

MiaRec



BroadWorks Call recorder Interoperability Test Plan Support Table

Test Plan Package Test Plan Package Items Supported Comments

Voice Messaging Yes

Call Center Yes

TCP TCP Yes

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

3.0

.655

No issue is identified.

MiaRec



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 1.2.3.4 5060 UDP dual

1.0

3.2 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

MiaRec



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

MiaRec



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

MiaRec



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

MiaRec



Figure 7 MiaRec Deployment on Customer Premises

MiaRec



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

MiaRec



Click on “Configure” link for SIPREC interface.

Figure 9 Configure SIPREC Recording Interface

4.2.1 Enable SIPREC Interface

Check “Enable SIPREC recording” box.

4.2.2 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.

4.2.3 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



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.

4.2.5 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



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

MiaRec



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



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

MiaRec



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

MiaRec



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

4.3.4 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



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 on-demand only” or “never record”) as well as web-access settings (login and password).

Figure 15 Add User

MiaRec



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.

5080 (TCP) 5080 (UDP)

TCP and UDP ports for SIPREC signaling data. These ports can be changed in MiaRec.ini configuration file.

22000 - 23999 (UDP) Port range for receiving RTP media packets from BroadWorks. This port range can be changed in MiaRec.ini configuration file.

MiaRec



References

[1] MiaRec, Inc.. 2015. MiaRec Admin Guide. Available online at www.miarec.com/documentation

[2] BroadSoft, Inc. 2013. BroadWorks Call Recording Interoperability Test Plan, Release 19.sp1. Available from BroadSoft at broadsoft.com/xchange.

[3] BroadSoft, Inc. 2013. BroadWorks Call Recording Interface Guide, Release 19.0. Available from BroadSoft at xchange.broadsoft.com.

http://www.miarec.com/documentation

http://www.broadsoft.com/xchange

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

BroadSoft Partner Configuration Guide - MiaRec Partner Configuration Guide MiaRec Call Recording...

Documents

Transcript of BroadSoft Partner Configuration Guide - MiaRec Partner Configuration Guide MiaRec Call Recording...