...
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 ||
| 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 | |||
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. | avaya-dmcc, Phone cisco-network, Phone zoom_phone, Phone zoom_meeting, Application ipc-unigy, Trader ip-trade, Trader | No | ConfiguredPlatforms | The 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 supported platform names VfcDataSource values listed in SupportedVfcDataSources is added to ConfiguredPlatformsConfiguredVfcDataSources. | example-platformEmpty | 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 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, under Administration.
- The SupportedPlatforms ObfuscateMeetingTopic parameter is only applied to newly processed Zoom Meetings recordings.
- 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)
...
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 | |
VfcPlatformVfcDataSourceName | 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 ConfiguredPlatform ConfiguredVfcDataSources values. | example-platform | Yes, must be modifiedTimezone | |
| ImportSourceIDs | The | time zone of the VFC recorded switch platform in the IANA time zoneIDs 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.
- VfcPlatform VfcDataSourceName must be one of the values from the ConfiguredPlatforms 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 ConfiguredPlatforms ConfiguredVfcDataSources setting.
- The Extensions parameter 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 existing extensions 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 commaa 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 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.
...
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. 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
Secrets
Parameters to configure to authenticate access to the WFE and VFC APIs.
...
- 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)
...