Administrator Guide

Administrator Guide

User Logs

User Logs

A transformation can output failure events to a user-defined log.
If an anchor fails to find text in the source document, it can write a message in the user log. This can occur even if the anchor is defined as optional, so that the failure does not terminate the transformation processing.
The user log can contain the following information:
  • Failure level: Information, Warning, or Error
  • Name of the component that failed
  • Failure description
  • Location of the failed component in the script
  • Additional information about the transformation status, such as the values of data holders.
To define the user-log output, assign the
on_fail
property of the appropriate transformation components.
On Windows platforms, you can find the user log in the following directory:
<INSTALL_DIR>\DataTransformation\UserLogs
On Linux and UNIX platforms, you can find the user log in the following directory:
<INSTALL_DIR>/UserLogs
You can customize the location with the configuration editor.
By default, each execution of a transformation generates a user log having a unique name:
<service_name>+<unique_string>.log
A transformation can set the user-log location at runtime by using
SetValue
actions to assign the following system variables. Set the phase property of
SetValue
to
initial
, ensuring that
SetValue
runs before any component that writes to the user log.
Variable
Description
VarServiceInfo/StandardError/StandardErrorDir
Directory path of the user log
VarServiceInfo/StandardError/StandardErrorName
File name of the user log
Data Transformation
purges old user logs stored in the location that is defined in the Configuration Editor. If you store user logs in another location,
Data Transformation
does not purge them. For more information, see Days to Keep History.

0 COMMENTS

We’d like to hear from you!