(9.0+) Configuration Translation API logging

Configuration Translation API web service generates the following log files:

ConfigurationTranslationAPI Logs

XML (web config) configuration file setting is used to configure the following:

Where the active files are located
What log level to write logs
Name of the active log file and folder

Important

When troubleshooting an issue, be sure to set the log level to the appropriate level to capture all the necessary information.

Configuration translation API logs

These logs show the requests for data to be displayed in Configuration UI and when data is changed along with the user who submitted the change.

XML Configuration File Settings

To locate the xml (web config) configuration file used by Configuration Translation API you must first locate the installation location of Callback. This can be found in the registry of the server in the following location. The setting will be a file path on the server.

XML Configuration File Location

This can be located on each server in the registry

HKEY_LOCAL_MACHINE\SOFTWARE\Virtual Hold
- InstallationLocation

Here is an example of a common setting: C:\Program Files (x86)\Virtual Hold Technology

The file path will be appended with \VirtualHoldPub\ConfigurationTranslationAPI.

Here is an example of a common file path C:\Program Files (x86)\Virtual Hold Technology\VirtualHoldPub\ConfigurationTranslationAPI.

In this location are 1 xml (web config) configuration files for Configuration Translation API

XML File Name

web.config

Logging section in XML Files


Description	Setting	Values	Default
File path where active logs should be written	logFilePath	*Any valid directory path	Missing: C:\VHTPlatform\Logs Empty: Applications Working Directory
Log level to write active logs	level	**Number Any value 1-10	Missing of Blank: 5
Size of the active Log	N/A		8 MB
Name of log folder	name	Text	Missing or Blank: Name of Applcation file
Name of log file	name	Text	Missing or Blank: Name of Application file
How long to keep active files in the active directory	Controlled by Archive Service
When to start new log file	Active file size exceeds 8MB

*Should always be the root for ALL log files.

**Log level 10 will provide the best info.


Log level	Included in logging
0	No log
1-4	Should never be used. Insufficient logging.
5	Default setting, used by most systems. Requests to change data and who submitted the change.
6	Logs authentication results. Developer use only.
7	Logs authentication results. Developer use only.
8	Logs method results.
9	Logs all parameters passed in the URL.
10	Logs all the requests and return data passed through the API.