Utilities › Invoke Java Operator › Input Parameters › Logger

Logger

Use Logger?

Set this field to true to use an instance of an org.apache.log4j.Logger object to log data to the specified log file. The logger handles opening and closing the file. The logger is available in the context of the main method and can be used as 'logger.debug()', 'logger.info()', and so on.

True

Prompts the operator to use true. The operator uses an instance of ‘logger’.

False

Prompts the operator to use false. The operator does not use an instance of ‘logger’.

Blank

Prompts the operator to use the value set in the Use Default Logger field of the operator category. If this value is blank at the operator category level, Use logger? is set to false by default.

Any other value prompts the operator to use false, and the operator does not use an instance of ‘logger’.

If an instance of ‘logger’ is used, then it is available in the context of the main method of the operator. 'logger' is used as follows:

• logger.debug("my log message")
• logger.info("my log message")
• logger.warn("my log message")
• logger.error("my log message")
• logger.fatal("my log message")

If an instance of ‘logger’ is not used, the 'logger' object does not exist in the context of the main method of the operator.

Log File Path

The path to the log file used by the logger. This path must point to a file that resides on the CA Process Automation agent host. If this field is empty, the operator inherits the value set in the Default Log File Path field of the operator category.

Log Level

Specify the log level of the logger.

0

Prompts the operator to use DEBUG, which causes the logger to write Debug, Info, Warn, Error, and Fatal log messages.

1

Prompts the operator to use INFO, which causes the logger to write Info, Warn, Error, and Fatal log messages.

2

Prompts the operator to use WARN, which causes the logger to write Warn, Error, and Fatal log messages.

3

Prompts the operator to use ERROR, which causes the logger to write Error and Fatal log messages.

4

Prompts the operator to use FATAL, which causes the logger to write Fatal log messages.

Blank

Prompts the operator to inherit the value set in the Default Log Level of the operator category. If this value is blank at the operator category level, Log Level is set to Debug by default.

Any other integer value

Prompts the operator to use DEBUG.

Note: You can overwrite the log level at run time in the main method of the operator. This example sets the log level to Fatal:

import org.apache.log4j.Level;
logger.setLevel((Level) Level.FATAL);

Append to Log File?

Set this field to true to append any data from this operator to the log file (if it exists).

True

Prompts the operator to use true. The operator appends to the log file.

False

Prompts the operator to use false. The operator deletes the content of the existing log file before writing the new data from the operator.

Blank

Prompts the operator to use the value set in the Append to Default Log File? field of the operator category. The operator can append to the log file depending on what the value is set at. If this value is blank at the operator category level also, Append to Log File? is set to false by default.

Any other value prompts the operator to use false, and the operator does not append to the log file.

Log Data Without Logging Info?

Set to true to let the logger write the data with no additional logging information. Only the log message is written.

Set to false to write additional logging information in the following format:

Day Month Year Hours:Minutes:Secs Log_level [UUID of the Invoke_Java operator that logged this message]: log message

True

Prompts the operator to use true. The logger writes data with no additional logging information.

False

Prompts the operator to use false. The logger writes data with additional logging information.

Blank

Prompts the operator to use the value set in the Default Log Data Without Logging Info? field of the operator category. If this value is blank at the operator category level, Log Data Without Logging Info? is set to false by default.

Any other value prompts the operator to use false. The logger writes data with additional logging information.