VFC to WFE Metadata Integrator Configuration Guide
Available in 9.7.7 and above
Overview
The VFC to WFE Metadata Integrator must be configured to connect to both the VFC and WFE environments.
When the Integrator is installed, appsettings.json, a default configuration file is created in the Integrator installation folder (referenced as INSTALLDIR in the Installation Guide), where the Vfc.Integrator.Service.exe file is located. This file is read-only, and only serves as a reference for the default values supplied with the installation.
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 DOTNET_ENVIRONMENT environment variable configured on the server. Any references to appsettings.Production apply to this file.
The configuration of the Integrator must take place in the appsettings.Production.json file, and missing or incorrect values can cause the Integrator service to fail.
Not all parameters in the file must be modified. Always refer to the following modifiable columns, whether a specific parameter can be modified.
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.
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:
Ensure all steps in the Prerequisites and Deployment process sections of the VFC to WFE Metadata Overview are complete.
Follow the Installation Guide to install the VFC to WFE Metadata Integrator. Verify the installation returned no errors.
Compulsory appsettings parameter configuration
There are values in the appsettings.Production file that must be configured to match your deployment. Some of these values include default values, some of which need to be overwritten with correct values or the Integrator cannot run. Some of the values are optional to edit or include.
WFE
Parameters to configure that describe WFE-related settings.
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 |
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 |
SiteGroupPath | 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, must be modified |
Description | Description of the external server. Optional. | Your Server's Description | Yes, can be modified |
UserContextRequestUsername | The username of the WFE user to be used as the API user that has the Assignment Manager privilege is authenticated to send requests to the WFE API synchronizing custom data. | … | Yes, can be modified |
CustomDataAssociationRole | The WFE role to which Custom Data fields are associated in WFE. | … | 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.
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.
To synchronize custom data, both the UserContextRequestUsername and CustomDataAssociationRole fields need to be filled in, and both the user and the role have to exist and be valid in WFE.
Related information
Organizations and groups (WFE User Management Guide)
Synchronize and replay VFC conversations in WFE
Synchronize Intelligent Voice risk metadata
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 |
ObfuscateMeetingTopic | If set to true, the topics of meeting recordings are set to "Meeting" instead of using the value of the To Info metadata field. Only available for Zoom Meetings integrations. | false | Yes, can be modified |
IvTranscriptionEnabled | Determines if the VFC Integrator should wait for the Intelligent Voice Transcription to be finished before call marking. This adds the risk score to the custom data of the call. | false | Yes, can be modified |
SupportedVfcDataSources | The recorded platforms or import sources describing the types of switch data sources supported by the Integrator that can be synchronized between VFC and WFE when marking calls and creating data sources. Must not be modified. |
| No |
ConfiguredVfcDataSources | 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 VfcDataSource values listed in SupportedVfcDataSources is added to ConfiguredVfcDataSources. | Empty | Yes, must be modified |
The Eid must describe the VFC environment the Integrator is configured for. The default environment ID is 0000, so the parameter only needs to be modified if the environment ID of the VFC environment has been configured to be different.
The MediaRepositoryDbConnectionString is a semicolon-separated string of values that are parsed as the connection details to the VFC database from which the Integrator reads data. The minimum required connection details are supplied as the default value for the MediaRepositoryDbConnectionString parameter, but you must edit this string to fit your deployment requirements. After the secrets in the appsettings file are encrypted, the value of the parameter shows an AES256 hash of the connection string.
The user used in the MediaRepositoryDbConnectionString parameter requires the db_owner SQL server-level role. For more information, see: SQL Server role and permission requirements
The value of the ADSyncGroupSeparator parameter must match the Group Naming - Separator parameter configured in VFC in the Organization Units section of Administration > Active Directory Synchronization.
The ObfuscateMeetingTopic parameter is only applied to newly processed Zoom Meetings recordings.
If the IvTranscriptionEnabled parameter is set to true, it can take 30 minutes or longer to synchronize the metadata of a call to WFE as the transcription process must complete before the call can be synchronized.
The SupportedVfcDataSources parameter is an internal setting for the Integrator and must not be modified.
The ConfiguredVfcDataSources parameter requires at least one of the VfcDataSource values listed in SupportedVfcDataSources specified. Do not enter a full SupportedVfcDataSources object.
Related information
Encrypt secrets stored in the Integrator configuration file
Configuring database connection (VFC Deployment Guide)
Active Directory Synchronization Configuration Reference (VFC Administration Guide)
Synchronize and replay VFC conversations in WFE
Synchronize Intelligent Voice risk metadata
DataMapping - Data Sources
Data source configuration parameters used to create WFE data sources that accurately represent VFC recorded switches.
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 |
VfcDataSourceName | The VFC Platform ID or import source type of the recorded switch platform. Specifies the data source type in WFE. Must be one of the ConfiguredVfcDataSources values. | example-platform | Yes, must be modified |
ImportSourceIDs | The IDs of import sources to synchronize as separate WFE data sources. If not specified, all import sources of the switch type specified in VfcDataSourceName are synchronized as a single WFE data source. | Empty | Can be omitted If included, 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.
VfcDataSourceName must be one of the values from the ConfiguredVfcDataSources 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 ConfiguredVfcDataSources setting.
The ImportSourceIDs parameter is not required if the VfcDataSourceName parameter describes a recorded platform type data source. It can be omitted if the data source is an import source, in which case all VFC data sources with the specified VfcDataSourceName are associated with the same data source in WFE. If included, the parameter is in the format of a comma-separated list of individual import source IDs.
The Extensions parameter is not required if the VfcDataSourceName parameter describes an import source type data source. It can be omitted if the data source is a recorded platform, in which case all existing extensions are associated with the same data source in WFE. 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.
Only a subset of IANA time zones is supported in WFE. Select a value to use from the following list that represents your required time zone the closest:
IANA time zone | UI value |
|---|---|
GMT-12:00 | (GMT-12:00) International Date Line West |
Pacific/Honolulu | (GMT-10:00) Hawaii |
America/Anchorage | (GMT-09:00) Alaska |
America/Los_Angeles | (GMT-08:00) Pacific Time (US & Canada) |
America/Phoenix | (GMT-07:00) Arizona |
America/Denver | (GMT-07:00) Mountain Time (US & Canada) |
America/Costa_Rica | (GMT-06:00) Central America |
America/Chicago | (GMT-06:00) Central Time (US & Canada) |
America/Monterrey | (GMT-06:00) Guadalajara, Mexico City, Monterrey |
Canada/Saskatchewan | (GMT-06:00) Canada Central Standard Time |
America/Bogota | (GMT-05:00) Bogota, Lima, Quito |
America/New_York | (GMT-05:00) Eastern Time (US & Canada) |
America/Indianapolis | (GMT-05:00) Indiana (East) |
America/Asuncion | (GMT-04:00) Paraguay Standard Time |
America/Caracas | (GMT-04:00) Caracas |
America/Halifax | (GMT-04:00) Atlantic Time (Canada) |
America/Manaus | (GMT-04:00) Manaus |
America/La_Paz | (GMT-04:00) La Paz, Guadeloupe |
America/Santiago | (GMT-04:00) Santiago |
America/St_Johns | (GMT-03:30) NewfoundLand |
America/Montevideo | (GMT-03:00) Montevideo |
America/Sao_Paulo | (GMT-03:00) Brasilia |
America/Buenos_Aires | (GMT-03:00) Buenos Aires, Georgetown |
America/Godthab | (GMT-03:00) Greenland |
Atlantic/South_Georgia | (GMT-02:00) Mid-Atlantic |
Atlantic/Azores | (GMT-01:00) Azores |
Atlantic/Cape_Verde | (GMT-01:00) Cape Verde Is. |
GMT | Greenwich Mean Time |
Africa/Casablanca | (GMT) Casablanca |
Europe/London | (GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London |
Europe/Berlin | (GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna |
Europe/Prague | (GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague |
Europe/Paris | (GMT+01:00) Brussels, Copenhagen, Madrid, Paris |
Europe/Sarajevo | (GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb |
Africa/Bangui | (GMT+01:00) West Central Africa |
Europe/Athens | (GMT+02:00) Athens |
Asia/Amman | (GMT+02:00) Amman |
Europe/Bucharest | (GMT+02:00) Bucharest |
Africa/Cairo | (GMT+02:00) Cairo |
Africa/Harare | (GMT+02:00) Harare, Pretoria |
Europe/Helsinki | (GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius |
Asia/Jerusalem | (GMT+02:00) Jerusalem |
Europe/Kaliningrad | (GMT+02:00) Kaliningrad (RTZ 1) |
Europe/Istanbul | (GMT+03:00) Istanbul |
Asia/Riyadh | (GMT+03:00) Kuwait; Riyadh |
Africa/Nairobi | (GMT+03:00) Nairobi |
Asia/Baghdad | (GMT+03:00) Baghdad |
Europe/Minsk | (GMT+03:00) Minsk |
Europe/Moscow | (GMT+03:00) Moscow, St. Petersburg (RTZ 2) |
Europe/Volgograd | (GMT+03:00) Volgograd |
Asia/Tehran | (GMT+03:30) Tehran |
Asia/Yerevan | (GMT+04:00) Yerevan |
Asia/Tbilisi | (GMT+04:00) Tbilisi |
Asia/Muscat | (GMT+04:00) Abu Dhabi, Muscat |
Asia/Baku | (GMT+04:00) Baku |
Europe/Samara | (GMT+04:00) Izhevsk, Samara (RTZ 3) |
Asia/Kabul | (GMT+04:30) Kabul |
Asia/Yekaterinburg | (GMT+05:00) Ekaterinburg (RTZ 4) |
Asia/Karachi | (GMT+05:00) Islamabad, Karachi, Tashkent |
Asia/Calcutta | (GMT+05:30) Calcutta, Chennai, Mumbai, New Delhi |
Asia/Colombo | (GMT+06:00) Sri Jayawardenepura |
Asia/Katmandu | (GMT+05:45) Kathmandu |
Asia/Omsk | (GMT+06:00) Omsk (RTZ 5) |
Asia/Almaty | (GMT+06:00) Almaty, Astana |
Asia/Dhaka | (GMT+06:00) Dhaka |
Asia/Rangoon | (GMT+06:30) Rangoon |
Asia/Tomsk | (GMT+07:00) Tomsk (RTZ 6) |
Asia/Novosibirsk | (GMT+07:00) Novosibirsk (RTZ 6) |
Asia/Bangkok | (GMT+07:00) Bangkok, Hanoi, Jakarta |
Asia/Krasnoyarsk | (GMT+07:00) Krasnoyarsk (RTZ 6) |
Asia/Irkutsk | (GMT+08:00) Irkutsk (RTZ 7) |
Asia/Shanghai | (GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi |
Asia/Ulan_Bator | (GMT+08:00) Ulaan Bataar |
Asia/Singapore | (GMT+08:00) Kuala Lumpur, Singapore |
Australia/Perth | (GMT+08:00) Perth |
Asia/Taipei | (GMT+08:00) Taipei |
Asia/Tokyo | (GMT+09:00) Osaka, Sapporo, Tokyo |
Asia/Seoul | (GMT+09:00) Seoul |
Asia/Yakutsk | (GMT+09:00) Yakutsk (RTZ 8) |
Australia/Adelaide | (GMT+09:30) Adelaide |
Australia/Darwin | (GMT+09:30) Darwin |
Australia/Brisbane | (GMT+10:00) Brisbane |
Australia/Sydney | (GMT+10:00) Canberra, Melbourne, Sydney |
Pacific/Guam | (GMT+10:00) Guam, Port Moresby |
Australia/Hobart | (GMT+10:00) Hobart |
Asia/Vladivostok | (GMT+10:00) Vladivostok, Magadan (RTZ 9) |
Asia/Srednekolymsk | (GMT+11:00) Chokurdakh (RTZ 10) |
Pacific/Guadalcanal | (GMT+11:00) Solomon Is., New Caledonia |
Asia/Anadyr | (GMT+12:00) Anadyr, Petropavlovsk-Kamchatsky (RTZ 11) |
Pacific/Auckland | (GMT+12:00) Auckland, Wellington |
Pacific/Fiji | (GMT+12:00) Fiji, Kamchatka, Marshall Is. |
Pacific/Apia | Pacific/Apia |
Pacific/Tongatapu | (GMT+13:00) Nuku'alofa |
See Switches and data sources for more information about the creation of data sources in WFE.
Related information
DataMapping - Groups
Parameters to configure group name synchronization.
Parameter | Description | Default value | Modifiable |
|---|---|---|---|
FileLocation | File location of the CSV file containing the mapping of VFC group names to values suitable for WFE. Optional. | Empty | Yes, can be modified |
UniqueIdentifier | Optional parameter to use if multiple child groups in VFC have the same name. Marks a level in all VFC group hierarchies. The name of the groups on that level is added to the names of their child groups in WFE as a suffix, to ensure the child group names are unique. The value must be 1 or higher. | -1 | Yes, can be modified |
HierarchyLevelDepth | Optional parameter that determines the lowest level in a VFC group hierarchy that gets created as a separate group in WFE. Sub-groups under this level are not created as groups in WFE, and their users get assigned to the parent group on the level specified by this setting instead. The value must be 1 or higher. If the parameter is not specified or set to the default value, all VFC groups are synchronized to WFO as unique groups. | -1 | Yes, can be modified |
Related information
DataMapping - Users
Parameters to configure user login ID, role, and permission synchronization.
Parameter | Description | Default value | Modifiable |
|---|---|---|---|
SynchronizeUserLogins | Selects which users have their VFC Login IDs synchronized to WFE to be the usernames for the newly created users.
| None | Yes, can be modified |
UserNamePostFix | Postfix appended to the Login ID to make usernames unique in multi-tenanted VFC and WFE environments. Optional. | Empty | Yes, can be modified |
SynchronizeAccessRights | If set to true, the access rights of group members are synchronized to WFE. Optional. | false | Yes, can be modified |
AgentRoleName | Specifies the name of the WFE role assigned to a member of a VFC group. Optional. | Agent | Yes, can be modified |
GroupSupervisorRoleName | Specifies the name of the WFE role assigned to a supervisor or investigator of a VFC group. Optional. | Supervisor | Yes, can be modified |
The UserNamePostFix value has a maximum length of 15 characters, and cannot contain whitespaces or the following characters: “&!\ /[]:;|!,+*?<>@'
VFC group members can only view and replay their own calls. VFC group supervisors and investigators can view and replay the calls of all members of their group. Select corresponding WFE roles that have the same level of access rights for calls.
Only existing WFE roles can be configured in the AgentRoleName and GroupSupervisorRoleName parameters. If the roles do not exist in WFE, create them before configuring the Integrator.
Related information
Secrets
Parameters to configure to authenticate access to the WFE and VFC APIs.
Parameter | Description | Default value | Modifiable |
|---|---|---|---|
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 |
The WfeApiKey parameter must specify the Key ID and Key value of the External API Key created earlier in the VFC to WFE Metadata Integrator deployment process.
The VfcApiUser parameter must specify the user name and password of the API User created earlier in the VFC to WFE Metadata Integrator deployment process.
When the secrets are encrypted, the configuration file only shows the following parameter:
Parameter | Description | Default value | Modifiable |
|---|---|---|---|
Secret | Encrypted hash value representing the WfeApiKey and VfcApiUser values. |
| No |
Related information
Encrypt secrets stored in the Integrator configuration file
Generate an API key (WFE Enterprise Configuration and Administration Guide)
User Configuration (VFC Administration Guide)
Non-compulsory appsettings parameter configuration
There are values in the appsettings.Production file that are internal to the Integrator and have been configured for optimal operation. Most of these values should only be changed with caution.
HighAvailability
Parameters relating to the Integrator resilience.
Parameter | Description | Default value | Modifiable |
|---|---|---|---|