BIB AND JTAPI CONFIGURATIONS - Avaya Support

Page | 1

© 2015 KnoahSoft. All Rights Reserved. Confidential.

BIB AND JTAPI CONFIGURATIONS – v4.2

Page | 2


Contents Introduction .................................................................................................................................................. 3

Understanding Cisco UCM BIB Configuration ............................................................................................... 3

Configuring SIP UCM Trunk Recorder ........................................................................................................... 4

Configuring Recording Profile ................................................................................................................... 4

Configuring Trunk...................................................................................................................................... 6

Verifying the configured details ............................................................................................................ 8

Configuring Call Routing ........................................................................................................................... 8

Configuring Route List ............................................................................................................................... 9

Configuring Route Pattern ...................................................................................................................... 11

Enabling BIB on Selected Phones ............................................................................................................ 12

Enabling ACR on Selected Phone extensions/lines ................................................................................. 13

Verifying the configurations................................................................................................................ 14

JTAPI Configuration ..................................................................................................................................... 14

Downloading JTAPI 64 bit plug-in from Cisco UCM ................................................................................ 14

Configuring JTAPI-CTI Application User in Cisco UCM ............................................................................ 15

Enabling JTAPI Tracing for Troubleshooting Purposes ............................................................................ 16

Verification of the JTAPI Configuration ................................................................................................... 16

Page | 3


Introduction

In order to successfully record a phone call, in an enterprise environment, KnoahSoft requires the

following four types of information:

Phone call signaling

Call media

Phone IP mapping/phone identification

Optional ACD login information.

In a Built-in-Bridge(referred to as BIB) based call recording environment, Cisco Built-in-Bridge provides

the call media needed for call recording and Cisco/JTAPI provides the phone call signaling and phone IP

mapping information for call recording.

This document details the UCM configuration needed to enable Built-in-Bridge (including Automatic call

recording) and to enable JTAPI needed for call recording. KnoahSoft requires UCM 6.x or above to

support Built-in-Bridge environment.

Understanding Cisco UCM BIB Configuration

To successfully record calls using UCM with BIB configuration:

1. Establish a connection between Harmony UCMTrunkRecorder and UCM by defining the following

parameters in the Call Manager:

Trunk

Device Pool

Calling Search Space

Destination Address

Destination Port

2. Define the following with appropriate parameters, to trace the route pattern of a particular call.

Page | 4


Route Group – In Selected Devices, select the trunk that reaches Recorder’s dial number.

Route List – Enable the route list and select the appropriate route groups to the trunk that reaches the Recorder’s dial number. Ensure the UCM group is default.

Route Pattern – Enable the Route Option and define the Gateway Route List to the trunk that reaches the Recorder’s dial number.

3. Define the Recording Profile and match it with the Route Pattern to include the Call Search Space

and Recorder’s dial number.

4. Enable BIB in the phone device settings. This will provide the phone device with UCM SIP trunk

number to dial and transmit the copy of the call media from phone to Harmony recorder

5. Enable Automatic Call Recording option on the phone extension/line of a built-in-bridge enabled

phone device for the Recording Profile. This will enable phone to duplicate the call media need for

call recording and for transmitting in the step above.

Configuring SIP UCM Trunk Recorder

UCM Trunk Recorder configurations include:

1. Configuring Recording Profile

2. Configuring and verifying trunk details

3. Configuring call routing, rout group, group list, and route pattern

4. Enabling BIB (Built in Bridge) on the phone devices and ACR (Automatic Call Recording) to selected

phone extension/line on a built-in-bridge enabled phone

Configuring Recording Profile

► To configure recording profile:

1. Open the Unified Cisco Call Manager interface in any web browser

2. Accept Certificate.

3. Enter the Username and Password to login

4. Configure Recording Profile

5. Navigate to Device > Device Settings > Recording Profile.

Page | 5


6. Check if there are any existing profiles by clicking on “Find”

7. Here we see two recording profiles.

8. Select IAFRecProfile1.

9. IAFRecProfile1 has Recording Calling Search Space as “KSInidaLabCSS” and Recording Destination

Address* as “77777”. The Calling Search Space should match with the Cisco IP Phone DN’s on which

the BIB and ACR are enabled.

10. Specifying the Destination Address and Recording Calling Search Space is important. Click “Save” to

save the recording profile.

11. Go back to Recording Profiles.

Page | 6


12. Select IAFRecProfile2 (Second profile for second set of phones)

13. IAFRecProfile1 has Recording Calling Search Space as “KSInidaLabCSS” and “Recording Destination

Address* as “66666”.

Configuring Trunk

► To configure trunk:

1. Go to Device > Trunk. The Trunk screen appears.

2. Click Find to check if any trunks are already configured in the system.

The Find and List Trunks page, listing all configured trunks, appears.

3. To add a new trunk, click Add New at the top left of the screen. The Trunk Configuration page

appears.

4. In the Trunk Configuration > Device Information section, enter the following details:

Device Name

Description

Device Pool fields.

The remaining fields can be left with default values.

Page | 7


Note: Do not select Media Termination Point Required check box.

5. In Call Routing Information > Inbound Calls section, configure the Calling Search Space and ensure

it matches with the details mentioned in Recording Profile. Leave the remaining fields with default

values.

6. In the SIP Information section:

Page | 8


Enter the recorder server IP address (where UCM Recorder is installed) in the Destination Address field.

Enter the port number as 5060 in the Destination Port field.

7. Click Save to save the details.

Verifying the configured details

► To ensure all the details are configured correctly:

1. Go to Find and List Trunks screen.

2. Select the required trunk from the list and check if the following details are configured

appropriately:

Device Information

Device Name

Description

Device Pool

Inbound Calls

Calling Search Space of second Recording Profile (If only one Recording Profile exists the same can be used)

SIP Information

IP Address of the second recorder server is configured in the Destination Address field.

Destination Port number is entered as 5060.

Configuring Call Routing

► To add a call routing:

1. Go to Call Routing > Route/Hunt > Route Group.

Page | 9


2. Click Find to check if there are any existing route groups or click Add New to add a new route group.

3. Enter the route group name in the Route Group Name text box

4. Select the required distribution algorithm from the Distribution Algorithm drop-down list

5. In Find Devices to ADD Route Groups section, select the desired device(s) from the Available

Devices list.

6. Click Add to Route Group. The selected device(s) will appear in Current route Group Members >

selected Devices field.

7. Click Save.

Configuring Route List

► To configure route list:

1. Go to Call Routings > Route/Hunt > Route List.

The Find and List Route lists screen appears.

Page | 10


2. Click Find, to see if there are any existing route lists or click Add New to add a new route list.

The Route List Configuration page appears.

3. In the Route List Configuration section, enter name and description of the route list in the respective

text boxes.

4. Select the required communications manager group from the Cisco Unified Communications

Manager Group text box.

5. Select Enable this route list (Change effective on Save; on reset required) check box.

6. Click Save. The Route List Member Information section appears.

7. Click Add Route Group, to add a Route Group to the Route List. The list of route groups appears.

8. Select the desired group(s) and click Add. The selected group(s) appear in Selected Groups field.

Page | 11


9. Click Save. The Route List is Saved and displayed in the Rout List screen.

Configuring Route Pattern

► To configure route pattern:

1. Go to Call Routing > Route/Hunt > Route Pattern.

2. Click Find to see the existing route patterns or click Add New to add a new route pattern.

3. In the Pattern Definition section:

Enter route pattern in the Route Pattern text box. Note: Route Pattern should not be the name, but the actual pattern.

Select the route partition from the Route Partition drop-down list.

Select the required route list from the Gateway/Route List drop-down list.

Page | 12


Leave the Remaining fields with default values and click Save. The route pattern is displayed in the Rout pattern list page. Similarly configure the remaining Route Patterns.

Enabling BIB on Selected Phones

► To enable BIB on selected phones:

1. Go to Bulk Administration > Query > Update Phones. The Update Phones Query page appears.

2. In the Update Phones Query section, select the desired filter criteria in the respective drop-down

fields and click Save. The list of phones matching the criteria appears.

3. Click Next. The Update Phones screen appears.

4. In the Device Information section, select Built in Bridge check box and set it to On from the

corresponding drop-down list.

Page | 13


5. In the Job Information section, select Run Immediately option. Leave the remaining fields with

default values.

6. Click Submit.

Enabling ACR on Selected Phone extensions/lines

► To enable ACR on selected phone extension/lines:

1. Go to Bulk Administration > Phones > Add/Update Lines > Updated Lines

2. The Update Lines Query screen appears.

3. Enter the filter criteria based on the phones DN’s to enable with ACR for Device Name using option.

4. Click Find. The list of phone DN records is displayed.

5. Click Next.

6. In the Line Null on Device Null section select Recording Option and Recording Profile check boxes.

Page | 14


1. Select Automatic Call Recording Enabled from the Recording Option drop-down list.

2. Select the appropriate recording profile from the Recording Profile drop-down list.

7. In the Job Information section, select Run Immediately option.

Leave the remaining fields with default values.

8. Click Submit.

Verifying the configurations

Once you enable BIB, to validate the settings:

Make a call and check in wireshark for SIP messages and voice streams.

Check the UCM Recorder log for SIP INVITE messages.

Manually dial the BIB trunk number from the phone to check if the phone can reach Harmony recorder.

JTAPI Configuration

Downloading JTAPI 64 bit plug-in from Cisco UCM

► To download JTAPI 64 bit plug-in from Cisco UCM

1. Go to Applications > Plugins. The Find and List Plug-ins page appears.

2. Click Download against ‘Cisco JTAPI 64-bit Client for Windows’ and install it on the server.

Page | 15


Configuring JTAPI-CTI Application User in Cisco UCM

1. Go to User Management > Application User.

The Find and List Application Users screen appears.

2. Click Add New to add new application user.

The Application User Configure screen appears.

3. In the Application User Information section,

Configure User ID and Password in the respective fields.

Select ‘Standard Presence Group’ option from the Presence Group drop-down list.

4. In the Device Information section,

1. Click Find more Phones. The list of the phones appears.

2. Select the required phones and click Add Selected. If you want all the phones to be selected, click Select All and then Add Selected.

The added devices are displayed in Controlled Devices field.

3. Leave CAPF information filed as it is

5. In the Permissions Information selection,

Page | 16


Select the below user groups in the Group field.

Standard CTI Allow Call Monitoring

Standard CTI Allow Call park Monitoring

Standard CTI Allow Call Recording

Standard CTI Allow Control All Devices

Standard CTI Allow Control Of Phones Supporting Connected Xfer and Conf

Standard CTI Enabled

Click Add to User Group.

NOTE: The 9900 and 8900 series phone models (SIP) will be supported only if ‘Standard CTI Allow Control Of Phones Supporting Connected Xfer and Conf’ is added. This allows events to flow to Ciso JTAPI client.

Click Save. Once you click Save, the page Roles are automatically displayed in the Roles field.

Enabling JTAPI Tracing for Troubleshooting Purposes

1. Enable JTAPI Tracing.

2. Click Log Destination tab and configure the required parameters.

NOTE: Enabling JTAPI Plug-in Tracing might impact call recording. So, please do it only under the supervision of KnoahSoft support.

Verification of the JTAPI Configuration

Use the Cisco JTRACE sample program (Part of the JTAPI Plug-in install) to verify the JTAPI Configuration.

To verify, do the following

1. Open JTAPITools directory [The location where JTAPI plugin is installed], and copy test.bat file at this

location with the following line

java.exe -classpath .;"D:\Program Files\Cisco\JTAPI64Tools\lib\jtapi.jar" jtrace.JTrace <server name> <login> <password> <device1> <device2> …. <device N>

<Server name> is the hostname or IP address of your Cisco Unified Communications Manager.

< device1> <device2> are directory numbers of IP phones. The phones must be part of the associated devices of a given user as administered in the Cisco Unified Communications Manager administration web page.

Page | 17


The < login> and <password> are similarly administered in Cisco Unified Communications Manager

Example: java.exe -classpath .;"D:\Program Files\Cisco\JTAPI64Tools\lib\jtapi.jar" jtrace.JTrace 172.16.7.22 KnoahSoft kn0@hs0ft 4831 4780 4746 4819 4783 4553 4749 4814 4830

2. From command line navigate to the JTAPITools directory and execute the following command:

.\test.bat

3. The JTrace application opens windows for each device and traces the Cisco Unified Communications

Manager JTAPI events observed at the device.

4. Make a test call on one of the line configured in the JTAPI

5. Make sure you receive the phone events.

6. Cisco JTAPI Events: 1—Off Hook,2—On Hook,3—Ring Out,4—Ring In,5—Connected,6—Busy,7—

Line In Use,8—Hold,9—Call Waiting,10—Call Transfer,11—Call Park,12—Call Proceed,13—In Use

Remotely,14—Invalid Number

Documents

BIB AND JTAPI CONFIGURATIONS - Avaya Support