Capture Verification Collector properties
Capture Verification requires Collector configuration properties to set up a connection between a Collector and a data source.

The Data Sources pane shows the list of available data sources associated with organizations and any configured Collectors for each data source. Use the search field to locate a data source or Collector in the list.
For data sources with External Recorder or IP Trade switch/sub-type, you can configure multiple Collectors per data source. These Collectors show as child items under the data source in the Data Sources pane.
For other data sources, you can only configure one Collector per data source. The Collector is automatically assigned to a data source. The data source and its Collector show as a single item in the Data Sources pane.
The color of the dot in front of the name of a Collector indicates the connection status of the Collector.
Color |
Connection status |
---|---|
Blue |
Connecting... or Disconnecting... |
Red |
Connection failed |
Orange |
Connected with issues or System setup issue |
Green |
Connected |
Gray |
Disconnected |
The icons in the Data Sources pane indicate if an item is a Collector or data source.
Icon type |
Description |
---|---|
|
A phone data source. |
|
A trader data source. |
|
An application data source. |
|
A Collector configured for a data source with External Recorder or IP Trade switch/sub-type. |
If a Collector is already created for a data source with External Recorder or IP Trade switch/sub-type, more Collectors can be added directly from the Data Sources pane. The add button on the right side of the data source entry in the pane becomes active when at least one Collector exists. After clicking the button, the Collector configuration screen opens and the Collector properties can be filled in.

Type of switch associated with the data source.

Activates or deactivates the Collector. If selected, the Collector collects data from the data source.

Configuration properties the Collector uses to connect to the data source.
The properties available and required depend on the type of Collector selected, so the Collector type must be selected first.
Property |
Description |
Default |
---|---|---|
Collector name |
Unique name for the Collector. |
Name of the data source |
Collector type |
Type of Collector available for the selected data source. If the field is disabled, no other type of Collector can be created for the selected data source.
|
Varies based on data source type |
When the type of Collector is selected, the required properties can be configured.
Property |
Collector type |
Description |
Default |
---|---|---|---|
Hostname |
BT TradeSense WBA Genesys CX API Genesys PureEngage SFTP Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
IP address or Fully Qualified Domain Name (FQDN) for the data source host. |
api.zoom.us for Zoom Phone API and Zoom Meeting API Blank for all other Collector types |
Port |
BT TradeSense WBA Genesys CX API Genesys PureEngage SFTP Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
Port number that the Collector uses to connect to the data source host. |
22 for SFTP 443 for all other Collector types |
Domain |
SFTP |
If the connection requires the Windows domain name, the name for the domain. |
|
Username |
Genesys PureEngage SFTP Unigy Blue Wave API |
If the data source requires the Collector to use account credentials for access, the user name for the account. |
|
Password |
Genesys PureEngage SFTP Unigy Blue Wave API |
If the data source requires the Collector to use account credentials for access, the password for the account. |
|
Account ID |
Zoom Meeting API Zoom Phone API |
If the connection requires the Collector to use account credentials for access, the unique identifier for the account. |
|
Client ID |
Genesys CX API Zoom Meeting API Zoom Phone API |
If the data source requires the Collector to use account credentials for access, the client key or identifier. |
|
Client secret |
Genesys CX API Zoom Meeting API Zoom Phone API |
If the data source requires the Collector to use account credentials for access, the client value or secret. |
|
Path |
Local SFTP |
Location of the files on the data source host that the Collector needs to access. Example: /cisco/440XXX |
|
File pattern |
Local SFTP |
Regular expression Capture Verification uses to identify the required Call Detail Record (CDR) files on the data source host. Capture Verification locates the required CDRs by file pattern. Each file pattern is specific to a switch type. For example, for Cisco Unified Call Manager, the default CDR file names start with CDR_ or cdr_. |
^(CDR_|cdr_).* for CiscoCM feed type data sources ^(C-|c-|S|s).* for Avaya feed type data sources |
Collector API version |
Unigy Blue Wave API |
Version of the switch API the Collector connects to. |
3.2/1.1 |
Trust invalid certificates |
BT TradeSense WBA Unigy Blue Wave API |
When checked, all server certificates are trusted, even if they are invalid. |
Cleared |
API key/token |
BT TradeSense WBA |
If the data source requires the Collector to use an API key or API token for authentication, the value of the API key or token. |
|
Use multiple TradeSense endpoints |
BT TradeSense WBA |
If selected, it allows the configuration of connection details for a second BT TradeSense endpoint to be used in resilient TradeSense deployments. |
|
Alternative hostname |
BT TradeSense WBA |
IP address or Fully Qualified Domain Name (FQDN) for the secondary TradeSense endpoint. Only available if Use multiple TradeSense endpoints is selected. |
|
Alternative port |
BT TradeSense WBA |
Port number that the Collector uses to connect to the secondary TradeSense endpoint. Only available if Use multiple TradeSense endpoints is selected. |
|
Alternative API key/token |
BT TradeSense WBA |
If the secondary TradeSense endpoint requires the Collector to use an API key or API token for authentication, the value of the API key or token. Only available if Use multiple TradeSense endpoints is selected. |
|
Use TLS |
Genesys PureEngage Unigy Blue Wave API |
When checked, the Collector uses the TLS (Transport Layer Security) protocol version 1.2 to encrypt the connection to the API. |
Cleared |
Group IDs (Queue IDs) |
Genesys CX API Genesys PureEngage Zoom Meeting API Zoom Phone API |
Unique identifiers for switch user groups or queues. If specified, Capture Verification only collects CDRs for calls or meetings with a participant that is part of one or more of the listed groups or queues. You can add multiple group or queue IDs by entering multiple values separated with a comma and selecting Apply, or you can add multiple values one by one. You can edit or delete values using the buttons under Actions. |
|
Stream identification method |
Kinesis Stream |
Method of uniquely identifying the Kinesis stream.
|
Stream ARN |
Value |
Kinesis Stream |
Unique identifier for the Amazon Kinesis stream. Enter the value in the format required by the selected Stream identification method. For example:
|
|
Region |
Genesys CX API Kinesis Stream |
Region hosting the call center. To set the region, either select a pre-defined region from the list, or enter a custom region. If specifying a custom region, only enter the region code, not the region name. For example, for the region with the name Europe (Frankfurt), enter the region code, eu-central-1. |
|
Authentication method |
Kinesis Stream |
Method of authenticating the Identity and Access Management (IAM) user the Collector uses to access AWS.
|
Access key |
Access key ID |
Kinesis Stream |
Access key ID for the IAM user in AWS. Only available if the Authentication method is Access key. |
|
Access key secret |
Kinesis Stream |
Access key secret for the IAM user in AWS. Only available if the Authentication method is Access key. |
|
Role ARN |
Kinesis Stream |
Amazon resource name (ARN) that uniquely identifies the role of the IAM user. Only available if the Authentication method is IAM role. |
|
Role session name |
Kinesis Stream |
Name that uniquely identifies the IAM role session. Only available if the Authentication method is IAM role. |
|
External ID |
Kinesis Stream |
External ID used in the IAM role trust policy. Only available if the Authentication method is IAM role. |
|
Use proxy server for API connection |
Zoom Meeting API Zoom Phone API |
When selected, the Collector connects to the switch data source API through a proxy server. |
Cleared |
Proxy address |
Zoom Meeting API Zoom Phone API |
IP address or Fully Qualified Domain Name (FQDN) for the proxy server. Only available if Use proxy server for API connection is selected. |
|
Proxy port |
Zoom Meeting API Zoom Phone API |
Port number that the Collector uses to connect to the proxy server. Only available if Use proxy server for API connection is selected. |
|
Proxy username |
Zoom Meeting API Zoom Phone API |
User name for the account that the Collector uses to connect to the proxy server. Only available if Use proxy server for API connection is selected. |
|
Proxy password |
Zoom Meeting API Zoom Phone API |
Password for the account that the Collector uses to connect to the proxy server. Only available if Use proxy server for API connection is selected. |
|
Delayed collection interval |
Genesys PureEngage |
Length of time leading up to the most recent CDR collection during which the delayed collection gathers CDRs. Collectors for Genesys PureEngage integrations run multiple separate collection cycles. As CDR records of long and ongoing calls can be made available by the switch after the default collection, a delayed collection cycle runs in parallel to the default collection cycle to gather these CDRs. The delayed collection cycle runs as a sweep of a broader time range leading up to the most recent default collection cycle. The polling frequency of the delayed collection is different to the default collection, as it only runs again if the same amount of time has passed as its collection time range. The minimum value is 05:00 (5 minutes) and the maximum is 360:00 (6 hours). Format: mm:ss |
30:00 (30 minutes) |
Deferred collection offset |
Genesys PureEngage |
Time period by which a secondary, deferred collection cycle is delayed in time. Collectors for Genesys PureEngage integrations run multiple separate collection cycles. As CDR records of long and ongoing calls can be made available by the switch after the default collection, a deferred collection cycle runs in parallel to the default collection cycle to gather these CDRs. The polling frequencies of the deferred and default collections are identical, but the deferred collection runs a configurable time interval later. The minimum value is 01:00 (1 hour), and the maximum value is 120:00 (5 days). Format: hh:mm |
24:00 (24 hours) |

Advanced properties are settings that define the way Capture Verification collects and stores data. Capture Verification uses the defaults for a Collector type unless modified. The properties required depend on the type of Collector selected.
Property |
Collector type |
Description |
Default |
---|---|---|---|
Remove processed files |
Local |
If selected, Capture Verification deletes CDR data copied from the switch after processing the data. |
Selected |
Move processed files to |
Local |
If selected, Capture Verification moves the CDR data copied from the switch to a specified destination after processing. |
Cleared |
Enter valid path |
Local |
Destination for CDR files copied from the switch when Move processed files to is selected. |
Cleared |
Request timeout interval |
BT TradeSense WBA Genesys CX API Genesys PureEngage Kinesis Stream Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
The time span before the request to the switch data source API times out. Format: mm:ss |
05:00 (5 minutes) |
Retry delay |
BT TradeSense WBA Genesys CX API Genesys PureEngage Kinesis Stream Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
Adds a time delay between attempts to connect to the switch data source API. |
5 (5 seconds) |
Retry count |
BT TradeSense WBA Genesys CX API Genesys PureEngage Kinesis Stream Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
The maximum number of retries the Collector carries out before the attempt to connect to the switch data source API fails. |
5 (5 attempts) |
Results per request |
Genesys CX API Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
The number of CDR records the switch data source API returns in response to a request. |
30 for Zoom Phone API 20 for all other Collectors (20 records) |
Memory cache lifetime |
Genesys CX API Genesys PureEngage Unigy Blue Wave API Zoom Phone API |
The length of time to keep cached data received from the switch data source API before removing from memory. Applies to individual data records in the cache.
|
100 (100 hours) |
Daily cache refresh time |
Genesys CX API Unigy Blue Wave API |
Time of day when the Collector refreshes its cached data received from the switch data source API.
Format: hh:mm |
01:00 (1 AM) |
Cached call lifetime |
BT TradeSense WBA |
Length of time to cache the CDR data of ongoing calls received from the TradeSense WBA before removing from memory and processing. Format: d.hh:mm:ss |
1.00:00:00 (1 day) |
Call end check delay |
BT TradeSense WBA |
Length of time between Capture Verification checks to see if ongoing calls have completed. Format: d.hh:mm:ss |
00:00:30 (30 seconds) |
Matching delay |
BT TradeSense WBA Genesys CX API Genesys PureEngage Kinesis Stream Local SFTP Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
Adds a time delay to the collection of CDR data to avoid a mismatch with recording data. As soon as Capture Verification collects CDR data for a call segment, it attempts to match the CDR data to recording data. If recording data for the call segment is still being processed, the Collector is not able to match the CDR to recording data and logs an issue. A time delay added to the collection of CDR data allows for recording data to become available, reducing the number of false issues. Format: d.hh:mm |
00:25 (25 minutes) |
Time offset |
BT TradeSense WBA Genesys PureEngage Local SFTP Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
Tolerance Capture Verification uses when matching call data to recording data or recording data to call data. Format: mm:ss If time offset is set to 10 seconds (00:10), Capture Verification searches for corresponding call or recording data that starts or ends at the same time, plus or minus 10 seconds. |
00:05 (5 seconds) |
Read delay |
BT TradeSense WBA Genesys CX API Genesys PureEngage Kinesis Stream Local SFTP Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
Collector polling frequency. Local and SFTP Collectors actively poll the data source for data. Read delay is the time between polls. |
300 (5 minutes) for Genesys PureEngage 10 for all other Collectors (10 seconds) |
Read limit |
BT TradeSense WBA Genesys CX API Kinesis Stream Local SFTP Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
Maximum page size (number of rows) a Collector reads from a data source in a single query. Setting a maximum ensures that not all data is loaded at the same time. Loading large amounts of data could cause an unresponsive state due to connection or memory issues. |
300 for Zoom Phone API and Zoom Meeting API 1000 for all other Collectors (1000 records) |
Collection start point |
BT TradeSense WBA Genesys CX API Genesys PureEngage Kinesis Stream Local SFTP Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
Earliest point in time that Capture Verification matches call data to recording data. Format: d.hh:mm:ss |
1.00:00:00 (1 day) |
CDR definition |
Local SFTP |
CDR definition to use when processing CDR files collected from the switch data source. The Collector can be configured to process non-standard CDR formats for Avaya Aura switch data sources. The format of the CDR file can be defined in a JSON file, which is uploaded to Capture Verification to create a CDR definition. A CDR definition can be assigned to one or more Collectors. |
Default |
Manage CDR definitions |
Local SFTP |
Opens the Manage CDR definitions menu to create, edit, or delete CDR definitions. |
|
Store Call Detail Records |
BT TradeSense WBA Genesys PureEngage Kinesis Stream Local SFTP Unigy Blue Wave API Zoom Meeting API Zoom Phone API |
If selected, Capture Verification saves the unprocessed CDR data copied from the switch to the Automated Verification database with the processed data. |
Cleared |
Email redaction domain whitelist |
Zoom Meeting API |
The list of email domains that are exempt from redaction. The user emails of all Zoom meeting participants are redacted in Capture Verification, unless their email domain is on the whitelist. If no domains are configured, Capture Verification does not redact any user emails. You can add multiple domains by entering multiple values separated with a comma and selecting Apply, or you can add multiple values one by one. You can edit or delete values using the buttons under Actions. Example: If |
|
Configure a Capture Verification Collector