VFC to WFE Metadata Integrator Configuration Guide

ApplicationServerUrl

The URL of the Application Server that runs the WFO_ProductionDomain_ProductionServer service, used to send requests to the WFE APIs.

https://YourWfeApplicationServer

Yes, must be modified

NamePrefix

The prefix for the WFE user groups generated as part of the integration process. Must be unique to an Integrator deployment. Limited to 10 characters.

YourTenantName-YourOrgName-

Yes, must be modified

ParentOrganizationName

The name of the WFE parent organization to contain and manage users and associate with data sources. Must be unique to an Integrator deployment and across the WFE tenant.

Your VFC integration Organization name

Yes, must be modified

ParentGroupName

The name of the WFE parent group to contain integrated VFC groups which will be actively managed by the VFC Integrator. Must be unique to an Integrator deployment and across the WFE tenants. Note: WFE group names are limited to 50 characters, which includes the name prefix and the actual group name.

Your VFC integration Group name

Yes, must be modified

VfcSyncedEmployeeGroupName

The name of the user group in WFE which contains all employees synchronized from VFC. Must be unique to an Integrator deployment and across the WFE tenant. Note: WFE group names are limited to 50 characters, which includes the name prefix and the actual group name.

VFC Synced

Yes, can be modified

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

WfeDatasource

The name of the WFE data source that is to be created. Must be unique across the WFE installation.

YourWfeDatasourceName

Yes, must be modified

VfcServers

The list of the FQDNs or NetBIOS names of VFC recorders whose recorded calls get marked to the configured WFE data source.

Your.Vfc.RecorderServer

Yes, must be modified

VfcPlatform

The VFC Platform ID of the recorded switch platform. Specifies the data source type in WFE. Must be one of the ConfiguredPlatform values.

example-platform

Yes, must be modified

Timezone

The time zone of the VFC recorded switch platform in the IANA time zone format <area>/<location>. This value is set as the time zone of the WFE data source in the GMT offset time zone format when created. Refer to the Configuration Guide for the list of supported time zones.

Europe/London

Yes, must be modified

Extensions

The list of extensions to associate to the WFE data source. Individual extensions, extension ranges, and a combination of both are supported. Individual extensions can be entered as alphanumeric values, while extension ranges must be integers in the format <startExt>-<endExt>. Optional.

Empty

Can be omitted

If included, must be modified

WfeApiKey

The External API Key generated in WFE. Requires the Key ID and Key Value configured.

…

Yes, must be modified

VfcApiUser

The VFC user details for the dedicated API User with the "API Access Only" flag set.

Empty

Yes, must be modified

LockTimeout

The VFC database lock timeout period of this Integrator instance. The timeout starts when the database does not receive a heartbeat signal from the Integrator. When the timeout period elapses, this Integrator loses ownership and other Integrators can claim it.

00:10:00

Modify with caution

DependencyRecheckIntervalSeconds

The timeout period after all failing dependency readiness checks are retried.

30

Modify with caution

ResyncStartAtTimeOfDay

The time of day when the next attempt is made to synchronize user, group, recording expectation, and extension data. Ranging from 00:00:00 to 23:59:59 in the hh:mm:ss format. The time is in the time zone of the server on which the Integrator runs.

01:00:00

Yes, can be modified

PermanentErrorRetryDelay

The time delay to retry a synchronization attempt if a persistent error happens that needs human interaction (for example, a configuration problem). Ranging from 00:00:00 to 23:59:59 in the hh:mm:ss format.

00:01:00

Modify with caution

TransientErrorRetryDelay

The time delay to retry a synchronization attempt if a temporary error happens that does not need human interaction (for example, a network outage). Ranging from 00:00:00 to 23:59:59 in the hh:mm:ss format.

00:00:05

Modify with caution

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

VirtualRecorderSerialNo

The Serial Number 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

WfeApiExtensionsChunkSize

The number of VFC extensions to be sent to the WFE API at a given time.

1000

Modify with caution

VfcDbExtensionsBatchSize

The number of VFC extensions to be read from the VFC database at a given time.

1000

Modify with caution

MaximumCachedEntries

The maximum number of contact objects to be stored in the cache. Default: 200000.

200000

Modify with caution

MaximumSupportedContactStartTimeDifference

Absolute expiration time of the contact cache entries relative to the current time, in the format hh:mm:ss, between 00:00:00 and 12:00:00. Also defines the maximum time difference allowed between the start times of the call sessions under the same contact.

12:00:00

Modify with caution

DefaultSoftCacheLifeTime

The time interval after which cached responses from WFE APIs are invalidated if the cache was not used. In the format dd.HH:mm:ss.SSS (where dd and SSS are optional values).

00:10:00

Modify with caution

HardCacheLifeTime

The time interval after which a cached response from a WFE API is always invalidated, no matter what the status of the API is. In the format dd.HH:mm:ss.SSS (where dd and SSS are optional values).

12:00:00

Modify with caution

MaxCacheSize

Maximum number of responses from WFE APIs to HTTP requests to be stored at any given time.

1000

Modify with caution

SoftCacheLifeTimes

The time interval after which a cached response from a specific WFE API is invalidated if the cache was not used. Overwrites the value set in DefaultSoftCacheLifeTime for the specified API. In the format dd.HH:mm:ss.SSS (where dd and SSS are optional values).

"/wfo/api/em/recorder/v2/datasources": "00:10:00"

Modify with caution

ArchivedFolderName

The path and folder name to store the zipped archived logs. It is relative to the Serilog path parameter configured. If left empty or the parameter is omitted, the archived files are created in the Serilog log folder.

Archived

Yes, can be modified

CompressionLevel

The level of compression. The value is one of the following: NoCompression, Fastest, Optimal, SmallestSize. Default: SmallestSize.

SmallestSize

Modify with caution

KeptArchivesCount

The number of archived log files to keep. Setting to 0 means all archived log files are kept.

30

Modify with caution

Using

The log event sinks used.

Serilog.Sinks.Console,

Serilog.Sinks.File

Yes, can be modified

MinimumLevel

The minimum log level of the application.

Information

Modify with caution

WriteTo

List of output objects and their corresponding log configuration.

Yes, can be modified

Name

Output type name.

Modify with caution

path

File path and name to write logs to in “File” outputs.

Logs\\log_.log

Modify with caution

rollingInterval

The time interval when Serilog starts writing to a new log file.

Day

Modify with caution

rollOnFileSizeLimit

The file size limit when Serilog starts writing to a new log file.

true

Modify with caution

fileSizeLimitBytes

The maximum size of the active log file, in bytes.

104857600

Modify with caution

retainedFileCountLimit

The maximum number of not archived log files.

1

Modify with caution

hooks

The services which are monitored for logging.

Vfc.Integrator.Service.Logging.SerilogHooks::ArchiveHook, Vfc.Integrator.Service

No

outputTemplate

Defines the format of the log messages.

For Console:

[{Timestamp:yyyy-MM-dd HH:mm:ss.fff} {Level:u3} {ThreadId:000}] ({SourceContext}) {Scope:l} {Message:j}{NewLine}{Exception}

For File:

[{Timestamp:yyyy-MM-dd HH:mm:ss.fff} {Level:u3} {ThreadId:000}] {Scope:l} {Message:j}{NewLine}{Exception}

No