E.12 Guidelines for Enabling Workflow Logging

The Workflow Engine log level is controlled by the -Dcom.microfocus.workflow.logging.level property typically set in the setenv.sh file in the /TOMCAT_INSTALLED_HOME/bin/ directory. For example, /opt/netiq/idm/apps/tomcat/bin/setenv.sh on Linux. The value of -Dcom.microfocus.workflow.logging.level=ALL controls the amount of information that the Workflow Engine logs. By default, the logging is set to INFO. Logs are saved in the catalina.out file. You can set other levels when you are troubleshooting for more verbose messages. After setting the log level, restart Tomcat. For example, restart Tomcat by performing the following command:

systemctl restart netiq-tomcat.service

All loggers specific to the Workflow Engine are defined in the workflow_logging.xml file located in the Identity Applications installed location. You can set the severity level for each logger at any level in the hierarchy by editing this file. You also need to manually add the workflow packages in workflow_logging.xml file to enable workflow logging.

To add a workflow package:

  1. Navigate to workflow_logging.xml file location.

    Linux: /opt/netiq/idm/apps/tomcat/conf/workflow_logging.xml

    Windows: C:\NetIQ\idm\apps\tomcat\conf\workflow_logging.xml

  2. Open the file in a text editor, add the required workflow package and set the level for log messages. For example:

    <logger name="com.novell.soa.af.impl.timers" level="DEBUG" additivity="true">
            </logger>
  3. Save the file and issue a restart to Tomcat.

    Similarly, add other workflow packages in the workflow_logging.xml file. You cannot add them from dashboard in this release.

The Workflow Engine generates events in the CEF standard format and publishes them to the configured audit server. The package level log details are specified in the workflow_logging.xml file. Alternatively, you can set these values in the ism-configuration.properties file.

If a parameter value is specified as ${com.netiq.ism.audit.cef.host:localhost} in the workflow_logging.xml file, the value for the parameter specified in the ism-configuration.properties file takes precedence. Otherwise, the default value specified after the ":" is considered. If the value is directly specified (hardcoded) in the workflow_logging.xml file, the Workflow Engine does not check the value (even if it is specified) in the ism-configuration.properties file. For example, the value will look like this in the workflow_logging.xml file: <param name="SyslogHost" value="localhost" />.