Enable debug logging for the Clarity Mail Service Feature

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

This KB article covers the loggers needed for an end-to-end debugging of the clarity mail service feature.

Environment

Clarity 16.4.2

Resolution

The Mail Service Loggers:

• com.ca.clarity.union.mailservice
• com.ca.ppm.nmc.mailservice.providers.MailServiceAIProcessorImpl
• com.ca.ppm.nmc.mailservice.processor.handlers.RecvMailMessage
• com.ca.ppm.nmc.mailservice.processor.handlers.MailParser
• com.ca.ppm.nmc.mailservice.processor.handlers.ConnectSession
• mailservice
• com.ca.ppm.nmc.mailservice.processor.factory.MailServiceProcessorFactory

Steps to edit the Clarity Application Logger Configuration:

1. Login to the Clarity application as an admin user
2. Modify the URL field to: http://example.com/niku/nu#action:security.logs
3. Click on Edit Configuration
4. Scroll down to Category and click Add Category
5. Type the component name: example: com.ca.ppm.nmc.mailservice.providers.MailServiceAIProcessorImpl into the Other Name window
6. Change Appender to STDOUT.
7. Change the Priority drop-down box to debug.
8. Click the Save button.
9. If you have multiple application servers repeat steps 3-8 above
10. If "Detect Log Configuration Changes Automatically" flag is NOT checked stop and start the BG and  APP services
    
    

Initiate an action item and action it using the mail service workflow and later view the debug logs from $CLARITY_HOME\logs folder:

• app-ca.log
• bg-ca.log