VFC to WFE Metadata Integrator Troubleshooting Guide
- Kiss, Mate
AVAILABLE IN 9.7.7 AND ABOVE
Overview
Troubleshooting information aims to provide resolutions to specific issues that can occur while using or configuring the VFC to WFE Metadata Integrator.
Configuration
See the VFC to WFE Metadata Integrator Configuration Guide for more information on the configuration process.
Log files
The VFC to WFE Metadata Integrator offers extensive log configuration functionality, which can be amended to provide more information when troubleshooting.
The Integrator writes its log to the following file:
where INSTALLDIR is the installation directory of the Integrator, and YYYYMMDD represents the current date. The log file path is configured in the Serilog section of the appsettings.Production.json file.
A new log file is created both at set time intervals and when the log file size exceeds the value configured in the appsettings.Production file. The default configuration defines the time interval as every day, and the log file size as 100 MB.
The previous log file gets added to a .tar.gz file. The location where the archived log files are saved can be configured in the Internal section of the appsettings.Production file. By default, they are saved in a folder called Archived that is placed within the Logs folder. By omitting the parameter to configure the archived folder path, the archived log files are placed in the Logs folder, next to the active log file.
You can configure the archived log file compression level and the number of archived log files that are kept. When the maximum number of archived log files is reached, the oldest archive file is removed.
Refer to the Configuration Guide for more information on logging configuration.
If you require more detailed logging for troubleshooting, you can change the logging settings for the Integrator by editing the appsettings.Production configuration file.
Section | Parameter | Description | Default value |
|---|---|---|---|
Serilog | MinimumLevel | Log level setting of the application. Only increase the log level temporarily when you are doing troubleshooting. Leaving the log level on Debug/Verbose level can have an adverse effect on system performance which could lead to data loss in critical situations. | Information |
Serilog | fileSizeLimitBytes | Maximum size of a log file in bytes. If a file reaches the file size limit, the next log message is written into the next file. | 104857600 |
Related information
Troubleshooting steps
- Verify that the appsettings.Production.json file has been created.
- Verify that the Log folder and a log file in it have been created.
- Verify that the configured parameters in the WFE, VFC, Secrets, and DataMapping sections of the appsettings.Production.json file are accurate.
- If the appsettings.Production.json file was modified, restart the Integrator service.
Troubleshooting examples
Missing appsettings.Production.json | |
|---|---|
Log message | Unhandled exception. System.IO.FileNotFoundException: The configuration file 'appsettings.Production.json' was not found and is not optional. The expected physical path was 'C:\Program Files (x86)\VFC Integrator\appsettings.Production.json'. |
Cause | The appsettings.Production.json file is not present in the installation folder of the Integrator. |
Solution | The appsettings.Production.json configuration file must be present in the installation folder of the Integrator. Rerun the installation process or add the file to the folder manually. |
Invalid JSON in appsettings.Production.json | |
|---|---|
Log message | Unhandled exception. System.IO.InvalidDataException: Failed to load configuration from file 'C:\Program Files (x86)\VFC Integrator\appsettings.Production.json'. ---> System.FormatException: Could not parse the JSON file. |
Cause | Empty or corrupted appsettings.Production.json file. |
Solution | Check the appsettings.Production.json configuration file contains valid configuration details. |
Invalid JSON in appsettings.Production.json | |
|---|---|
Log message | Unhandled exception. System.ArgumentNullException: Value cannot be null. (Parameter 'uriString') |
Cause | Empty or corrupt appsettings.Production.json file. |
Solution | Check the appsettings.Production.json configuration file contains valid configuration details. |
Missing VFC API user name | |
|---|---|
Log message | Appsettings Config Error: VFC API Username shouldn't be empty |
Cause | The VFC API user name value is empty. |
Solution | Enter a valid user name in the appsettings.Production file. |
Missing VFC API password | |
|---|---|
Log message | Appsettings Config Error: VFC API Password shouldn't be empty |
Cause | The VFC API password value is empty. |
Solution | Enter a valid password in the appsettings.Production file. |
Invalid WfeApiKey values | |
|---|---|
Log message | System.Net.Http.HttpRequestException: WfeApiKey Id or Value not valid |
Cause | The values for WfeApiKey contain invalid data. |
Solution | Check the values in the WfeApiKey parameter of the appsettings.Production file match the details of the External API key created for the WFE tenant. |
Parent organization does not exist | |
|---|---|
Log message | Check if organisation with name 'Your VFC integration Organization name' exists. |
Cause | The WFE parent organization configured in the appsettings.Production file does not exist with the name specified in the ParentOrganizationName parameter. |
Solution | Create the parent organization or check that the name is correctly configured. |
Parent group does not exist | |
|---|---|
Log message | The provided parent group 'Your VFC integration Group name' doesn’t exist. |
Cause | The WFE parent group configured in the appsettings.Production file does not exist with the name specified in the ParentGroupName parameter. |
Solution | Create the parent group or check that the name is correctly configured. |
Invalid VFC database connection string | |
|---|---|
Log message | Can not connect to the VFC database with the configured connection string. Check configuration value of 'Vfc.MediaRepositoryDbConnectionString' |
Cause | The VFC database connection string configured in the appsettings.Production file is incorrect. |
Solution | Enter valid connection details to the VFC database in the MediaRepositoryDbConnectionString parameter of the appsettings.Production file. |
Invalid VFC Media Repository address | |
|---|---|
Log message | System.Net.Http.HttpRequestException: No such host is known. (yourvfcmediarepositoryserver:443) |
Cause | The address to the VFC Media Repository server configured in the appsettings.Production file is incorrect. |
Solution | Enter the correct address of the VFC Media Repository server in the MediaRepositoryServerUrl parameter of the appsettings.Production file. |
Untrusted root authentication error | |
|---|---|
Log message | Can't reach the VFC Provisioning API v3 at '/verba/ws-provisioning-3' please check the ConnectionStrings and Secrets configuration values. System.Net.Http.HttpRequestException: The SSL connection could not be established, see inner exception. ---> System.Security.Authentication.AuthenticationException: The remote certificate is invalid because of errors in the certificate chain: UntrustedRoot |
Cause | The VFC Media Repository server certificate installed on the server running the Integrator is invalid or is missing. |
Solution | Ensure that a valid certificate is installed on the server, and that the date and time of the server is correct. |