Variable Logger

Enables processes to send messages about variable values to the system log or to log files on the file system of the AEM forms Server.

For information about using the Variable Logger service, see Services Reference for AEM forms

log operation

Logs messages about process variables to system resources or saves them to a text file:

  • Messages logged to system resources are reported using either the application server log or Standard Out. The configuration of the application server determines where the server log is saved, and what system resource is used for Standard Out. You can set the type of information that is logged when you use system logging.

  • Messages logged to a text file are saved in a file on the file system of the AEM forms Server.

    When the Log operation is executed, the current values of all process variables are logged. For example, the following items were added to the system log for a process that includes the string variable named stringVar :

    2008-04-10 16:54:30,718 WARN  [com.adobe.idp.dsc.variablelogger.VariableLoggerService] [PID:7] /process_data/@stringvar - String:      This is the value of the string 
    2008-04-10 16:54:30,718 WARN  [com.adobe.idp.dsc.variablelogger.VariableLoggerService] Variable Properties: 
    VP1207841667573:length = [100]

For information about the General and Route Evaluation property groups, see Common operation properties .

System Logging properties

Properties for logging variable values to system resources.

Log To System Logger

Select to have messages about variables sent to the application server log.

Log To Standard Out

Select to have messages about variables sent to Standard Out.

Logging Level

The severity level that you want to use for the log items in the system log. You can select one of the following values.

  • Off (no information is logged)

  • Debug

  • Info

  • Warning

  • Severe

    For example, when Info is selected, log entries for a the stringVar variable value are logged as INFO messages in the JBoss log:

    2008-04-10 16:53:53,937 INFO  [com.adobe.idp.dsc.variablelogger.VariableLoggerService] [PID:6] /process_data/@str4ingvar - String:      The string value.

    When Warning is selected, the log entries in the JBoss log are logged as WARN messages:

    2008-04-10 16:54:30,718 WARN  [com.adobe.idp.dsc.variablelogger.VariableLoggerService] [PID:7] /process_data/@str4ingvar - String:      The string value

Directory Logging properties

Properties for logging information to text files on the file system.

Log To A directory

Select to have messages about variables saved to files on the file system.

Directory Path

A string value that represents the directory in which to save the log files. If the directory does not exist, it is created automatically.

File Name Prefix

A string value that represents the prefix to use for the file name in which the log is saved. The file name extension.log is appended to the prefix.

Logging Mode

Specifies whether information for each new process instance overwrites previous log entries. You can select one of the following values.

Overwrite:
The information in the log file is overwritten when messages for a new instance are logged.

Append:
Information for each process instance is logged to the same file, appending new information to the end of the file.

CreateNew:
A new log file is created for each process instance. A unique prefix is added to each log file name.

Exceptions

The exception event attached to this operation can receive Java.io.IOException , VariableLoggerConfigurationException , and VariableLoggerExecutionException exceptions.

Variable Logger exceptions

The Variable Logger service provides the following exceptions for throwing exception events.

Java.io.IOException

Thrown when a file input/output error occurs on the AEM forms Server.

VariableLoggerConfigurationException

Thrown when a configuration error occurs on the AEM forms Server.

VariableLoggerExecutionException

Thrown when an execution error occurs on the AEM forms Server.