© 2021 Ribbon Communications Operating Company, Inc. © 2021 ECI Telecom Ltd. All rights reserved. The compilation (meaning the collection, arrangement and assembly) of all content on this site is protected by U.S. and international copyright laws and treaty provisions and may not be used, copied, reproduced, modified, published, uploaded, posted, transmitted or distributed in any way, without prior written consent of Ribbon Communications Inc.
The trademarks, logos, service marks, trade names, and trade dress (“look and feel”) on this website, including without limitation the RIBBON and RIBBON logo marks, are protected by applicable US and foreign trademark rights and other proprietary rights and are the property of Ribbon Communications Operating Company, Inc. or its affiliates. Any third-party trademarks, logos, service marks, trade names and trade dress may be the property of their respective owners. Any uses of the trademarks, logos, service marks, trade names, and trade dress without the prior written consent of Ribbon Communications Operating Company, Inc., its affiliates, or the third parties that own the proprietary rights, are expressly prohibited.
This document outlines the best practices for configuring Ribbon SBC SWe Lite for SIPREC feature verification.
The Ribbon Session Border Controller Software Edition Lite (SBC SWe Lite) provides best-in-class communications security. Microservices design to optimize resource allocation, dynamic scaling, automated lifecycle management are all attributes of the SBC SWe Lite, delivering edge SBC capabilities, such as robust network security, overload controls, SIP normalization, SIP Recording, IPv4-IPv6 interworking, and audio transcoding.
The NICE Engage Platform provides comprehensive omnichannel interaction recording. Omnichannel recording helps organizations provide customers a coherent experience by providing a single place to define and implement compliance and quality practices across all channels.
SIP Recording (SIPREC) is a recording capability that helps users to comply with regulations, to monitor the quality of service of representatives, to store call information for quality analysis, and so on. The Ribbon SBC SWe Lite supports SIPREC towards multiple recorders based on the Internet Engineering Task Force (IETF) standard.
The Ribbon SBC SWe Lite SIPREC supports the RFC standard for a SIP recording interface. To support SIPREC, the SBC SWe Lite acts as a Session Recording Client (SRC) initiating a Recording Session (RS) towards a Session Recording Server (SRS). The SBC SWe Lite initiates a recording session for all the Communication Sessions (CS) to record over SIP towards the SRS. The CS output is based on the SBC SWe Lite's Web UI configuration for enabling recording.
SIP Recording is supported on the SBC SWe Lite for the following purposes:
Table 1 Terminology
Term | Definition |
---|---|
CS | Communication Session |
RS | Recording Session |
SRC | Session Recording Client |
SRS | Session Recording Server |
This document provides configuration best practices for deploying Ribbon's SBC SWe Lite for SIPREC interop. Note that these are configuration best practices, and each customer may have unique needs and networks. Ribbon recommends that customers work with network design and deployment engineers to establish the network design that best meets their requirements.
It is not the goal of this guide to provide detailed configurations that meets the requirements of every customer. Use this guide as a starting point and build the SBC configurations in consultation with network design and deployment engineers.
This is a technical document intended for telecommunications engineers to configure both the Ribbon SBC and the third-party product. Navigating the third-party product as well as the Ribbon SBC SWe Lite GUI is required. Understanding the basic concepts of TLS/TCP/UDP, IP/Routing, and SIP/SRTP is also necessary to complete the configuration and for any required troubleshooting.
Before proceeding with the interop, make sure you have the following:
The configuration uses the following equipment and software:
Table 2 Requirements
Product | Equipment | Software Version |
---|---|---|
Ribbon Networks | Ribbon SBC SWe Lite | 9.0.1 |
Third-party Equipment | NICE Engage platform | 4.1 |
Administration and Debugging Tools | Wireshark LX Tool | 3.2.7 2.1.0.6 |
To install and run the SBC SWe Lite on the VMware ESXi, refer to Installing SBC SWe Lite on VMware ESXi.
Open any browser and enter the SBC SWe Lite IP address.
Click Enter and log in with a valid User ID and Password.
For more details on Licenses, refer to Working with Licenses.
A trusted certificate authority issues a Trusted CA Certificate. Trusted CA Certificates are imported to the SBC SWe Lite to establish its authenticity on the network.
From the Settings tab, navigate to Security > SBC Certificates > Trusted CA Certificates.
The following procedure shows you how to import Trusted Root CA Certificates, using either the File Upload or Copy and Paste method.
Follow the above steps to import the SIPREC App Server certificates.
This section describes how to manage the way Ribbon SBC SWe Lite interfaces with the network. The SBC SWe Lite supports five system-created logical interfaces known as Administrative IP, Ethernet 1 IP, Ethernet 2 IP, Ethernet 3 IP, and Ethernet 4 IP. In addition to the system-created logical interfaces, the SBC SWe Lite supports user-created VLAN logical sub-interfaces.
From the Settings tab, navigate to Networking Interfaces > Logical Interfaces.
Administrative IP
The SBC SWe Lite system supports a logical interface called the Admin IP (Administrative IP, also known as the Management IP). A Static IP or DHCP is used for running the initial setup of the SBC SWe Lite system.
s
Ethernet 1 IP
Ethernet 2 IP
Static routes communicate with remote networks. In a production environment, static routes are mainly configured for routing from a specific network to another network and accessed through one point or one interface (that is, single path access or default route).
Destination IP
Specifies the destination IP address.
Mask
Specifies the network mask of the destination host or subnet. If the 'Destination IP Address' field and 'Mask' field are both 0.0.0.0, the static route is called the 'default static route'.
Gateway
Specifies the IP address of the next-hop router to use for this static route.
Metric
Specifies the cost of this route, hence indirectly specifying the preference of the route. Lower values indicate more preferred routes. The typical value is 1 for most static routes, indicating that static routes are preferred over dynamic routes.
SIP Profiles control how the SBC Edge communicates with SIP devices. They control important characteristics, such as session timers, SIP header customization, SIP timers, MIME payloads, and option tags.
From the Settings tab, navigate toSIP > SIP Profiles.
SIP Server
SIP Server Tables contain information about the SIP devices connected to the SBC Edge. The entries in the tables provide information about the IP Addresses, ports, and protocols used for communicating with each server.
From the Settings tab, navigate to SIP > SIP Server Tables.
From the Type drop-down box, select SIP Server.
Click OK.
From the Settings tab, navigate to SIP > SIP Server Tables.
From the Create SIP Server drop-down list, select IP/FQDN.
UAC - IPv4
UAC - IPv6
UAS - IPv4
UAS - IPv6
The number of Sip Server Table Entries depends on the requirements.
SIP Recorder
A SIP Recorder Table contains information about the Network interface through which the SRC initiates recording requests toward the SRS. To support the SIPREC, the SBC Edge acts as a Session Recording Client (SRC), initiating a Recording Session (RS) toward a Session Recording Server (SRS). The SBC Edge initiates a recording session for all the Communication Sessions (CS). The CS output is based on the SBC Edge's Web UI configuration for enabling recording. The SIP Server (SIP Recorder) supports either an FQDN or IP Address (V4 or V6). Each SIPREC Server entry enables configuring multiple servers. When the standby SRS is configured, the SBC Edge sends the recording first to the active SRS. If the request fails (due to server reachability fault), the SBC SWe Lite sends the recording session to the standby SRS.
From the Settings tab, navigate to SIP > SIP Server Tables.
From the Type drop-down box, select SIP Recorder.
Click OK.
From the Settings tab, navigate to SIP > SIP Server Tables
From the Create SIP Server drop-down list, select IP/FQDN.
SIPREC - IPv4
SIPREC - IPv6
A SIP Recorder Table contains information about how a Signaling Group starts a SIP Recording (SIPREC) session. Through the configuration options, you select the Recording Server (SIP Server), SIP channels, routing, and media, which directs the SBC to communicate with the Session Recording Server (SRS).
From the Settings tab, navigate to SIP > SIP Recording.
SIP Recording Table 1
SIP Recording Table 2
For details on the SIP Recording (SIPREC) feature, refer to Working with SIP Recording - SIPREC.
Configure Media Profiles
From the Settings tab, navigate to Media > Media Profiles.
From the Create Media Profile drop-down box at the top of the Media Profiles page, select Voice Codec Profile.
From the Codec drop-down box, select a codec.
Codec - G.729
Codec - G.726
From the Settings tab, navigate to Media > Media Lists.
Signaling groups allow grouping telephony channels for routing and shared configuration. They are used for routing calls and selecting Call Routes.
From the Settings tab, navigate to Signaling Groups (Add SIP SG).
INGRESS_SG
When the SIPREC is enabled for the specific Signaling Group, this field allows you to select an entry from a SIP Recording Table, using the drop-down list. This list is populated from the entries configured in the SIP Recording table. For details, refer to Creating and Modifying Entries in the SIP Recorder Table.
EGRESS_SG
INGRESS_SGV6
EGRESS_SGV6
Transformation Tables facilitate the conversion of names, numbers, and other fields when routing a call. They can, for example, convert a public PSTN number into a private extension number or a SIP address (URI). Every entry in a Call Routing Table requires a Transformation Table and is available for user selection. Transformation tables are also configurable as a reusable pool that Action Sets can reference.
Each Transformation Table contains a list of entries for creating routing rules. Create each rule in the available order until you reach the end of the table, or when a mandatory entry fails to execute.
From the Settings tab, navigate to Call Routing > Transformation.
Click the Create ( ) icon.
Admin State:
Enabled - The default state is Enabled.
Match Type:
Optional: Optional entries must match at least one of the Input Field types.
When a call arrives at a Transformation Table, the incoming message contains several Informational Elements (IEs). These IEs include important call information, such as Called Address/Number, Called Extension, Calling Name, Redirecting Number, and others.
Each IE is processed row-by-row in the Transformation Table.
Value (Input/Output):
Specifies the value to match against the selected type. Depending upon the type selected, values are free-form or selected from a menu.
For details on Transformation Table Entry configuration, refer to Creating and Modifying Entries to Transformation Tables. For call digit matching and manipulation through the use of regular expressions, refer to Creating Call Routing Logic with Regular Expressions.
Call Routing tables allow you to configure flexible routes for transferring calls between Signaling Groups and translating the calls.
From the Settings tab, navigate to Call Routing > Call Routing Table.
Call Routing Tables are one of the central connection points of the system, linking Transformation Tables, Message Translations, Cause Code Reroute Tables, Media Lists, and the three types of Signaling Groups (ISDN, SIP, and CAS).
In the SBC Edge, call routing occurs between Signaling Groups.
To route any call to or from a call system connected to the SBC, you must first configure a Signaling Group to represent that device or system. The following list illustrates the hierarchical relationships of the various Telephony routing components of an SBC call system:
Each call routing entry describes how to route the call and also points to a Transformation Table, which defines the conversion of names, numbers, and other fields when routing a call.
To create an entry:
Set the following fields:
Admin State:
Enabled - Enables the call route entry for routing the call, displaying it in the configuration header as
Route Priority:
Shows the priority of the route from 1 (highest) to 10 (lowest). Regardless of the order of the routes in the table, higher priority routes are matched first, before matching the lower priority routes.
Number/Name Transformation Table:
Specifies the Transformation Table for this routing entry. The drop-down list is populated from the entries in the Transformation Table.
Destination Signaling Groups:
Specifies the Signaling Groups used as the destination of calls. The first operational Signaling Group from the list is chosen to place the call. Click the Add/Edit button to select the destination signaling group.
Audio Stream Mode:
DSP (default entry): The SBC uses DSP resources for media handling (transcoding); however, it does not support the capabilities and features between endpoints if they are not supported within the SBC (codec/capability mismatch). When you configure DSPs, the Signaling Groups support the DSP in a specific order.
Media Transcoding:
Enabled: Enable Transcoding on SIP-to-SIP calls.
This section describes the steps to configure the SBC SWe Lite with TLS for the SIPREC.
A SIP Recorder Table contains information that a Signaling Group uses to start a SIP Recording (SIPREC) session. Use the configuration options to select the Recording Server (SIP Server), SIP channels, routing, and media, which direct the SBC to communicate with the Session Recording Server (SRS).
From the Settings tab, navigate to SIP > SIP Recording.
SIP Server Tables contain information about the SIP devices connected to the SBC Edge. The entries in the tables provide information about the IP Addresses, ports, and protocols used for communicating with each server. The table entries also contain links to counters that are useful for troubleshooting.
From the Settings tab, navigate to SIP > SIP Server Tables > SIPRECORDER_1. Click the expand ( ) icon next to the entry.
Make sure you meet the following configuration requirements:
Make sure that the NICE Engage Platform is running on 6.15 or later versions for TLS support.
You must export and copy the certificate installed on each server in .cer format to all the other servers. For example, if you exported the certificate from the appserver, then be sure to copy it to AIR1/AIR2 and Interact servers.
Repeat the above steps to import each certificate for other servers.
Double click on the .cer Certificate and go to the Details tab. Select the Serial Number field and copy the serial number of the certificate.
The following checklist depicts the set of services/features covered through the configuration defined in this Interop Guide.
Table 3 Feature Coverage
Sr. No | Supplementary Services/Features | Coverage |
---|---|---|
1 | SIPREC License Test | |
2 | Call Setup and Termination | |
3 | IP-Interworking | |
4 | Direct Media | |
5 | Call Transfer (Blind/Unattended) | |
6 | Call Transfer (Attended) | |
7 | Multiple Call Transfer - Blind | |
8 | Multiple Call Transfer - Attended | |
9 | Call with Audio and Video | |
10 | DTMF - Inband and RFC2833 | |
11 | Round Robin Option for SRS recorder | |
12 | Channel Hunting | |
13 | Metadata Validation | |
14 | Transcode Calls | |
15 | 4xx/5xx Response Handling | |
16 | Call Hold and Resume | |
17 | Call Forward - Unconditional, Busy, and No Answer | |
18 | SIP Keepalive | |
19 | MESSAGE/INFO/REFER/SUBSCRIBE/NOTIFY Handling | |
20 | Long Duration Calls | |
21 | Upgrade and Downgrade Test | |
22 | FAX | |
23 | Basic Calls - Skype Clients | |
24 | Transfer Calls (Blind and Attended) - Skype Clients | |
25 | Conference Calls - Skype Clients | |
26 | Call Park and Retrieve | |
27 | Basic Calls - Teams Clients | |
28 | Call Hold and Resume - Teams Clients | |
29 | Call Transfer before and after connect - Teams Clients | |
30 | Call Queue | |
31 | Music On Hold | |
32 | Call Conference | |
33 | Voice Mail | |
34 | Simultaneous Ringing | |
35 | E911 Calls | |
36 | Group Call Pickup | |
37 | SRTP on Recording Session |
Legend
Supported | |
Not Supported |
Note the following limitations about this Interop:
SBC SWe Lite supports recording of incoming calls only.
For any support related queries about this guide, please contact your local Ribbon representative or the following numbers and website:
For detailed information about Ribbon products and solutions, visit:
https://ribboncommunications.com/products
For detailed information about the NICE Engage platform, visit:
https://www.nice.com/
This Interoperability Guide describes how to successfully configure the NICE interop for Ribbon SBC SWe Lite and NICE Engage platform SIPREC server.
The guide provides information about all tested features and capabilities. It records all limitations, notes, and observations to provide you with an accurate understanding of what this guide covers and what it does not.
Configuration guidance in this document enables you to replicate the same base setup; however, you may require additional configuration changes to suit the exact deployment environment.
© 2021 Ribbon Communications Operating Company, Inc. © 2021 ECI Telecom Ltd. All rights reserved.