...
When the Integrator first runs, it creates its editable configuration file, appsettings.<environmentName>.json. The default value of environmentName is Production, otherwise, if configured, the value matches the environment variable DOTNET_ENVIRONMENT environment variable configured on the server. Any references to appsettings.Production apply to this file.
...
More configuration settings are stored in the PersistedSettings.json file, which must not be manually modified. When updating, repairing, or uninstalling an existing Integrator installation, the appsettings.Production and PersistedSettings files, the Logs folder and its contents remain, while all other files get removed.
| Note |
|---|
| You must restart the Integrator service after making changes to the appsettings.Production file. |
Prerequisites
Before you begin the configuration, the following items must be completed:
...
Parameter | Description | Default value | Modifiable |
|---|---|---|---|
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 |
- The ParentOrganizationName parameter must specify the name of the parent organization created earlier in the VFC to WFE Metadata Integrator deployment process.
- The ParentGroupName parameter must specify the name of the parent group created earlier in the VFC to WFE Metadata Integrator deployment process.
Related information
Organizations and groups (WFE User Management Guide)
VFC
Parameters to configure that describe VFC-related settings.
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). | 0000SiteGroupPath | The WFE Installations path to the Site that the external server is associated to, specifying the Site Group between the Enterprise node and the Site. | VFC Site Group | Yes, can be modified |
| SiteName | The name of the WFE Site to which the external server is associated. | VFC Site | Yes, can be modified | ||
| ServerName | The host name of the VFC Media Repository. | VFC Media Repository Hostname | Yes, should be modified | ||
| Description | Description of the external server. Optional. | Your Server's Description | Yes, can be modified | MediaRepositoryDbConnectionString | The connection string to access the VFC Database. The minimum required parameters
- The ParentOrganizationName parameter must specify the name of the parent organization created earlier in the VFC to WFE Metadata Integrator deployment process.
- The ParentGroupName parameter must specify the name of the parent group created earlier in the VFC to WFE Metadata Integrator deployment process.
- The recommended value for the ServerName parameter is the host name of the VFC Media Repository, as it allows for an easy identification of the VFC deployment in WFE.
Related information
Organizations and groups (WFE User Management Guide)
VFC
Parameters to configure that describe VFC-related settings.
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 switch 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 switch types platform names is added to ConfiguredPlatforms. | example-platform | Yes, must be modified |
...
Parameter | Description | Default value | Modifiable |
|---|---|---|---|
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. | avayaexample-dmccplatform | 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 |
- 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 filefile. 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 an array 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 | 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 |
...
- 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 Integratorto 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.
- 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.
...