Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description

Default value

Modifiable

Eid

The Environment ID of the VFC environment for which the Integrator is configured (VFC equivalent of a Tenant ID).

0000

Yes, can be modified

MediaRepositoryDbConnectionString

The connection string to access the VFC Database. The minimum required parameters are supplied as default values, separated by semicolons.

Server=...,1433;Initial Catalog=verba;User Id=...;Password=...;Connect Timeout=15;Encrypt=False;TrustServerCertificate=False;ApplicationIntent=ReadWrite;MultiSubnetFailover=False

Yes, must be modified

MediaRepositoryServerUrl

The FQDN or NetBIOS name of the Media Repository server to send requests to the VFC.

https://YourVfcMediaRepositoryServer

Yes, must be modified

AdSyncGroupSeparator

The Group Naming Separator used in VFC as part of the synchronization of Active Directory Organizational Units to VFC Groups.

/

Yes, can be modified

SupportedPlatforms

The platform names and types of switches supported by the Integrator that can be synchronized between VFC and WFE when marking calls and creating data sources. Must not be modified.

avaya-dmcc, Phone

cisco-network, Phone

zoom_phone, Phone

zoom_meeting, Application

ipc-unigy, Trader

ip-trade, Trader

No

ConfiguredPlatforms

The list of configured switch types that are synchronized between VFC and WFE when marking calls and creating data sources. The Integrator does not run until at least one of the supported platform names is added to ConfiguredPlatforms.

example-platform

Yes, must be modified

...

  • The data source name defined by WfeDatasource must be unique per WFE installation.
  • The comma-separated list of VFC recorders defined by VfcServers must all be in the same time zone.
  • VfcPlatform must be one of the values from the ConfiguredPlatforms parameter in the WFE section of the appsettings.Production file. The value of this parameter populates the Recorded Platform property of the data source that is created in WFE.
  • There must be at least one data source object configured in this section for each platform specified in the ConfiguredPlatforms setting.
  • The Extensions parameter can be omitted, in which case all existing extensions are associated with the data source. If included, the parameter is in the format of a comma-separated list of individual extensions or extension ranges. Individual extensions are supported in an alphanumeric format, while extension ranges are supported in the integer range format <startExtension>-<endExtension>. In extension ranges, both the startExtension and endExtension values are included as configured for the data source.
  • The Timezone value must be specified in the IANA time zone format <area>/<location>. For example, Africa/Windhoek, or America/Los_Angeles.

...

Parameter

Description

Default value

Modifiable

IntervalMs

The delay between batches of calls processed to be marked to WFE in milliseconds.

5000

Modify with caution

ReadBatchSize

The number of calls to be read from the VFC database and marked to be sent to WFE at a given time.

1000

Modify with caution

PostCallDelayInMinutes

The delay between a VFC call being completed and it being considered for call marking to WFE.

1

Modify with caution

VirtualRecorderSerialNoWfeApiRootPath

The Serial Number path address of the WFE recorder object created to represent the VFC installation from which the Integrator is synchronizing recorded call metadata. The calls marked to WFE are associated with this virtual recorder. Must be unique to a VFC installation. Refer to the Configuration Guide for the format requirements of the parameter.

Empty

Yes, must be modified

WfeApiRootPath

The path address of the WFE Data Marking API.

/api/recording/marking/v1

No

InitialHistoryDays

The earliest point in time that the Integrator marks call data. It is configured as a number of days in the past to mark as the initial watermark for marking calls, and the Integrator does not check for calls before this point in time.

0

Yes, can be modified

...

Data Marking API.

/api/recording/marking/v1

No

InitialHistoryDays

The earliest point in time that the Integrator marks call data. It is configured as a number of days in the past to mark as the initial watermark for marking calls, and the Integrator does not check for calls before this point in time.

0

Yes, can be modified


Call marking is the process of reading in a call record from the VFC database, evaluating it against the Integrator configuration, and sending it to the WFE database. These parameters define how often calls get marked, and how many call records are processed at a time.

...

  • The values of InternalMs and ReadBatchSize can be adjusted depending on call volumes.
  • The PostCallDelayInMinutes starts after the last update is made to the call record in the database. Any of the internal VFC services can update a record, therefore the parameter is specific to system configuration. The value can be adjusted depending on system and network connection speed. Setting the parameter to too large a value can result in calls taking excessively long to be synchronized for use by WFE applications. In cases of high call volumes, this can also cause large batches of data to be processed simultaneously, increasing network traffic. Too short a time value can result in calls being marked repeatedly as VFC internal services update the database record of the call, causing excess load on the system and the network.The VirtualRecorderSerialNo must specify the Serial Number of the External Server created earlier in the VFC to WFE Metadata Integrator deployment process, and it must be unique to both a VFC and a WFE installation. It must be a 6-digit number in the format XXXYYY, where XXX is a 3-digit unique identifier for the VFC installation, and YYY is a 3-digit unique counter, incrementing for each Integrator.
  • InitialHistoryDays specifies a number of days before the current time, and the Integrator only marks calls that were made since that point in time. This parameter is only applied on the first run of the Integrator.

...