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 |
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 |
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, should be modified |
Description | Description of the external server. Optional. | Your Server's Description | 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.
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 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 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.
The ADSyncGroupSeparator must match the Group Naming - Separator parameter configured in VFC in the Organization Units section of Active Directory Synchronization, under Administration.
The SupportedPlatforms parameter is an internal setting for the Integrator and must not be modified.
Related information
Configuring database connection (VFC Deployment Guide)
Active Directory Synchronization Configuration Reference (VFC Administration Guide)
DataMapping
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 |
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 |
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.
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 |