Gateway side correlation pool member group settings

Use this member group to record traffic at a Session Interface Protocol (SIP) Trunk. This includes environments in which SIP trunk sessions are replicated by an edge device such as Acme Packet SBC to the Recorder.

SIP Trunk Recording is established at the member group level (not at the extension level). For more information—including additional configuration details—see SIP trunk recording, and the Avaya or Genesys Integration Guide.

When used with an IP Trade data source Third-party systems that provide data to the system, including employee and device states, and data change events. Typical data sources are phone switches, PBXs, or LANs., only the Recorder Control Type, Recorder Load Balancing Type, and Recorder Fallback Type settings are available. Each of these settings is configured with a default value that cannot be changed. For more information, see the IP Trade Unified Integration Guide.

When used with a Five9 VoiceStream data source, the Recorder Control Type and Recorder Load Balancing type are configured with a default value that cannot be changed. The other settings are configurable. For more information, see the Five9 VoiceStream Integration with Recorder Guide.

The Gateway Side Correlation Pool member group type is only available for Avaya, Genesys, IP Trade, Five9 VoiceStream, and Generic phone data sources. In certain cases In Risk Management, use cases to group interactionss according to the needs of the enterprise. Interactions can reside in multiple cases simultaneously., you may need to configure a Collection data source—see Create a collection data source for gateway recording.

VOX metadata with Gateway Correlation recording

With Gateway Correlation recording, the CTI feed provides all extension-level information. If the IP Recorder is disconnected from the CTI feed (either through disconnection from the Recorder Integration Service itself or the CTI adapter going down), the resulting VOX recordings will not have extension-level information associated with them. Customers can choose to retain or discard these VOX recordings through the Recorder Fallback setting in the member group.

Setting

Description

Name

Type a unique name for the member group.

Description

Type a description for this extension group (optional).

Recorder Control Type

  • Recorder Controlled—Use this option when the Recorder itself (rather than the Integration Service) starts and stops recording. This option applies to IP interception environments where recording occurs through SIP session replication or standard SIP trunk spanning.

  • Full Delivery (External Controlled)—Use this option in compliance delivery SIPREC recording environments where recording is controlled by a 3rd party application.

  • Selective Delivery (Duplicate Streamed)—Use this option in selective recording SIPREC environments where the Integration Service issues requests to start recording to a 3rd party application.

Recorder Load Balancing Type

Select one of the following:

  • None—A single recorder records all calls and no load balancing will occur.

  • Media Only—Multiple recorders are used to record the calls and all recorders will be aware of signaling (both call control and media control messages) for all calls. Only one of the recorders will be aware of the audio. Example deployments are:

    • Using a load balancing device or link protector to manage the traffic.

    • Using IP Analyzer to control a group of recorders.

  • Media with Signaling—Multiple recorders are used to record the calls. Use only in Recorder Controlled environments where one of the recorders will be aware of the call (that is, call control and media control messages + audio), while other recorders are not aware of this call. Do not use this option in CTI controlled environments. An example deployment would be the use of Acme Packet SBC to load balance the traffic.

This setting is unavailable when Selective Delivery (Duplicate Streamed) is selected as the Recorder Control Type.

Recorder Fallback Type

Select one of the following:

  • Never (Application)—If CTI is disconnected, no audio or screen recording will occur. If CTI is up, CTI segments will be retained.

  • On CTI Disconnection (Performance)—If CTI is disconnected, audio recording continues (VOX-detected segments will be retained), but screen recording does not. If CTI is up, only CTI segments with recorded audio are retained; if we receive CTI for a call but no audio (for any reason), recording will not occur. VOX segments (not associated to CTI calls) will be discarded. You can set a Rollback Period in the phone data source to specify the length of time preceding a disconnection for which recordings will be held.

  • Always (Liability)—If CTI is disconnected, audio recording continues (VOX-detected segments will be retained), but screen recording does not. If CTI is up, both CTI- and VOX- detected segments will be retained. (If a signalling protocol is configured, it will be used before VOX to record the call.)

This setting is unavailable when Selective Delivery (Duplicate Streamed) is selected as the Recorder Control Type.

Recorder Selection Expression

This setting allows individual calls to be directed to the recorder associated with this member group based on specific call data (for example, the call’s trunk group).

Select an Attribute from the dropdown list, then type a value in the Expression field. The "expression" is a standard regular expression and can be used to create a selection based on multiple values for the selected attribute. If the call data matches the expression, the call will be recorded by this recorder.

The Recorder Selection Expression is limited to one hundred (100) characters.

The match must be identical and the attribute to be evaluated must be present when the attempt to record is made. If the exact data in the Expression field for that attribute is not present in the call data, then the call will not be recorded by any recorder to which a Gateway-Side Correlation Pool member group is assigned (the call can still be recorded by other member groups or recorders if the configuration of your system allows).

If you are using a custom attribute, you must first add this attribute to the system, under Recording Management > Custom Data—see Create, edit or delete an attribute.

You must also select either LineFirst or LineExclusive as the Recording Resource Allocation Behavior—see Create a phone data source.

The Recorder Selection Expression feature is no longer required to record internal calls using DMCC with SIPREC solutions. When a selective extension pool is available, recording of internal calls through DMCC is done automatically.

Correlation Key

Create a Correlation Key to use an attribute other than the default (see your Integration Guide for details) to establish an association between a call recording and its CTI attributes.

You should only do this if instructed to do so by your support representative.

A Correlation Key allows the Integration Service to associate the CTI attributes of a call with the call recording in custom configurations. When a call is received by a data source in a SIP recording environment, the following occurs:

  • CTI attributes are sent from the data source to the Integration Service (to provide the Integration Service with call metadata).

  • SIP messages are sent from the data source to the Recorder (to set up the call on the Recorder).

The Correlation Key associates a CTI attribute with a matching value in a SIP header field. To create a correlation key:

  1. Click the Add button.

  2. From the CTI Attributes drop-down box, select an Attribute.

  3. In the Recorder Attribute text box, type the name of a SIP message header that specifies the same value as a CTI Attribute.

Example:

The following example illustrates the use of a Correlation Key:

  • A data source sends the CTI attribute “SomeID” (a unique identifier of the call) to the Integration Service.

    For this data source, the equivalent CTI attribute might be mapped to a custom attribute called “SomeID”.

  • The data source also sends a SIP request to the Recorder that includes a header called Vendor-SomeID header. This SIP header specifies the same value as the equivalent CTI attribute.

In this scenario, to create the Correlation Key, select SomeID as the CTI Attribute, and specify Vendor-SomeID as its associated Recorder Attribute in the text box.

 

Notes:

  • Create multiple Correlation Keys only if there is no single Correlation Key that can accomplish the association of CTI attributes to call recordings for every call. If you specify multiple keys, the order will be the order of preference (that is, the system will use the second key only if the first key doesn’t establish a correlation, and so on).

  • IP Gateway Side recording is the only form of IP recording for which you configure a Correlation Key. All other IP recording configurations use the CTI attribute and the SIP message header that specify the device extension as the common value that ensures that a call’s CTI attributes are associated to its recording. With Gateway Side recording, the Recorder cannot identify the device extension in a SIP message header, so the system relies on a different attribute (other than device extension) to make the association.

  • The correlation keys are required to be unique in the call space. This means that no two (2) independent calls shall have the same correlation value. Related calls may share a correlation value, but are expected to contain identical media for the portion of time they overlap.

  • The correlation keys are recommended to be unique, non-repeating, and call specific identifiers. Selecting a correlation key that does not have these qualities can yield undesired results in recording and playback Process of selecting a recorded interaction, playing it back to listen to the call, and viewing the content of the interaction on the screen..

  • Unique means that no two (2) independent calls share the same value at the same time.

  • Non-repeating means that no two (2) independent calls share the same value ever.

  • Call specific means that as the call is updated / moved, the identifier updates / moves with the call.

  • If the correlation value changes, it must do so in the signaling (e.g. SIPREC) and CTI feed simultaneously.

  • For SIP feeds, the correlation key should come from a SIP header.

  • For SIPREC feeds, the correlation key should come from the metadata XML.

  • Customers should minimize the number of correlation keys to be tracked by the system. More keys will complicate the configuration, impact performance, and make troubleshooting and support more difficult.

IP Network Region

  • Network - Select this type to assign all phones on a subnet to the member group. Complete these additional fields:

    • Network - Enter the IP address that identifies the network on which the phones reside.

    • Mask - Specify the subnet mask applicable to the network on which the phones reside.

      Specifying a subnet mask of 255.255.255.255 is the same as specifying an individual IP address.

  • Host IP - Select this type to assign a phone to the member group using the phone IP address.

    In the Network setting, enter the IP address of the phone.

  • Host Name - Select this type to assign a phone to the member group using the phone host name.

In the Network setting, enter the host name of the phone.

Shared Recorders

Use to associate one or more Recorders with this Member Group.

Shared Recorder Adapter Proxy Services

A Recorder Adapter Proxy Service (RAPS) server role association Relationship between server roles, where one server role relies on the configuration and functionality of another server role to perform its tasks. is valid only when either Selective Delivery (Duplicate Streamed) or Full Delivery (External Controlled) is selected as the Recorder Control Type. A RAPS server role Entity that contains a logical, predefined set of components (system software or certified third-party software) deployed in the Data Center and Site Zones that provide specific functionality for the system. association is mandatory to support SIP scaling. If you have a legacy SIP deployment, and do not want to support SIP scaling, it is not necessary to associate a RAPS server role to the member group.

Advanced Parameters

Use the Key and Value fields to enter the advanced parameters required for your system. Only add advanced parameters in consultation with Verint Support or Field Engineers.

In your Phone data source you must specify the IP Address or Host Name of the call center's SIP trunk interface. Set the Server Type under Settings > Device IP Configuration to PSTN Side - Far End.

Create and edit member groups and extensions

Member groups

Create a phone data source