Selective recording rule configuration

Owned by Kiss, Mate
Last updated: Jul 09, 2024

Selective recording rules can be used to define when an extension should be recorded in a more complex way based on various CDR fields.

Currently, this feature is supported only in Microsoft Teams policy-based recording and  Cisco JTAPI-based integrations such as Cisco UCCX, Cisco UCCE, and Genesys.

Prerequisites for rule based selective recording

CUCM configuration for selective recording

The Verba JTAPI user must have the Standard CTI Allow Recording group membership.

The extension configuration is detailed in the Adding a new extension for recording in Cisco UCM.
The Recording Option at the Directory Number has to be set to Selective (Step 4b), and the Phone Device has to be added to the Verba JTAPI user as Controlled Device.(Step 8)

Verba configuration for selective recording

The Recording Mode of the Extension has to be set to full.

Recording rule configuration

You can add / modify / delete recording rules under the Users / Recording Rules menu.


The following table describes the available fields in the basic recording rule configuration:

Field Name

Description

ID
Auto-generated identifier

Name

Name of the recording rule

DescriptionLonger description of the recording rule
Rule SectionsThe rule logic

Rule section

A recording rule consists of several rule sections. The sections are evaluated in sequence one after the other. The recorder engine will perform the first matching section's action, and the rest will not be evaluated.

Each section defines the desired action and various filters that will be evaluated in order to determine if the section matches a conversation or not. The logical relation between the filters is AND so that all of the filters should match the conversation (within a section).

If a section has no filters, then it will always be evaluated as matching. Such section can be used to define a default behavior, practically as the last section of a rule. If no section matches a conversation, then no action will be performed, that is the conversation will not be recorded.

The following table describes the available fields within a recording rule section:

Field Name

Description

ID
Auto-generated identifier.

Name

Name of the section.

Action

What should the system do when this section matches a conversation.

Possible actions:

  • Do not record
  • Record
CTI Triggered Recording

If the recording is not triggered automatically by the PBX, but the recorder has to initiate the recording, then this option has to be turned on.

Example: when a Cisco extension's recording mode is Selective.

Filters

Defines when this section should be performed.

The following CDR information can be used in the filters:

  • Caller Party
    • The phone number, UPN, or other unique user ID of the calling party.
  • Called Party
    • The phone number, UPN, or other unique user ID of the called party.
  • Any Party
    • The phone number, UPN, or other unique user ID of any of the call parties. In case of meetings, it applies to all meeting participants.
  • Partition (Cisco JTAPI)
    • The partition ID of the Cisco partition.
  • Genesys Field
    • Any Genesys metadata template field can be set as a filter by specifying the Property ID of the field.
    • Custom user data fields should be prefixed with "UserData.", for example: UserData.ShouldRecord
  • Cisco UCCE Field
    • Any UCCE metadata template field can be set as a filter by specifying the Property ID of the field.
  • Cisco UCCX Field
    • Any UCCX metadata template field can be set as a filter by specifying the Property ID of the field.

  • Microsoft Teams Field

    • Any Microsoft Teams metadata template field can be set as a filter by specifying the Property ID of the field.

  • Nimbus Field

    • Any Nimbus metadata template field can be set as a filter by specifying the Property ID of the field.

  • Caller Tenant (Microsoft Teams)

    • The Microsoft Teams tenant ID associated with the tenant of the calling party. Works only with P2P calls.

  • Called Tenant (Microsoft Teams)

    • The Microsoft Teams tenant ID associated with the tenant of the called party. Works only with P2P calls.

  • Any Tenant (Microsoft Teams)

    • The Microsoft Teams tenant ID associated with the tenant of any of the call parties.


Matching patterns (the listbox next to the field):

  • DOS: DOS-style wildcard characters can be used
    • asterisk (*) matches any sequence of characters
    • question mark (?) matches any single character
  • Regular Expression
  • Simple