Instructions for Detailed Workpoint Server workflow logging

Products

• CA Identity Manager
• CA Identity Governance
• CA Identity Portal

Issue/Introduction

How can I enable detailed Workpoint logging to troubleshoot issues with CA Identity Manager (IM) Workflow.

Environment

Identity Manager 14.x

Resolution

Overall Logging configuration for Identity Manager can be found in the documentation here:  Identity Manager Server Logging 

There are two layers of logging related to Workpoint.   The first is the Identity Manager interaction with the Workpoint workflow server such as when Identity Manager initiates and passes data to the Workpoint server or receives information back.   These are controlled and configured through the normal Identity Manager logging configuration, for example in the logging jsp pages:

The second layer is within Workpoint itself as it processes a workflow.   To update this logging:

1. Edit the \iam_im.ear\config\workpoint-server.properties file

Uncomment these lines:

#log4j.category.com.workpoint=WARN, WSSysOut, WSFile1
#log4j.additivity.com.workpoint=false

Replace the WARN with DEBUG above.

Also uncomment all these lines:

# WSSysOut is set to be a FileAppender which outputs to System.out.
#
#log4j.appender.WSSysOut=org.apache.log4j.ConsoleAppender
#log4j.appender.WSSysOut.Target=System.out 
#log4j.appender.WSSysOut.layout=org.apache.log4j.PatternLayout
#log4j.appender.WSSysOut.layout.ConversionPattern=%d [%t] %-5p %c %x - %m%n 
# WSFile1 is set to be a RollingFileAppender which outputs to WorkPoint.log
# It will save the last 5 files and create a new file after the file size# hits 1 Meg.
#log4j.appender.WSFile1=org.apache.log4j.RollingFileAppender
#log4j.appender.WSFile1.File=./WorkPoint.log
#log4j.appender.WSFile1.MaxFileSize=1MB
#log4j.appender.WSFile1.MaxBackupIndex=5 
#log4j.appender.WSFile1.layout=org.apache.log4j.PatternLayout
#log4j.appender.WSFile1.layout.ConversionPattern=%d [%t] %-5p %c %x - %m%n

This will help generate the Workpoint.log.
 

2. Edit the \iam_im.ear\config\wpqmonitor.log4j.properties file:

Uncomment these lines:

# wp.log4j.appender.list=QueueMonitorFileLog
# wp.log4j.root.level=WARN

Replace the WARN with DEBUG above. This will help generate the wpqmonitor.log.

3. Restart Identity Manager service


The Workpoint.log and the wpqmonitor.log will be generated in the same location as the server.log, \standalone\log\ 

Additional Information

Details on log level settings can be found in

KB 33573 Adjusting logging levels in Identity Manager
and
KB 220684 How to enable debug logging in Identity Portal