Monday, March 28, 2011

IMtegrity - Steps to Enable Action Rule Debugging

IMtegrity provides the ability to configure 'action rules' that may get executed as IMtegrity is importing Sametime chat conversations into the IMtegrity database.  These action rules may:
  • Send notification emails based on the content of a Sametime chat message
  • Flag a conversation for later review
  • Forward the conversation to an external compliance repository
  • etc...
In some cases, it might be helpful to view debug the debug messages produced by the action rule engine.  The following describes how to enable a debug mode to display the debug messages within the action rule engine:

 - Start the "imtconfig.exe" tool

- Make sure that "Commit long-running chat logs to disk" is set to "0" (=never)
- Disable / Uncheck the option "Enable IMTegrity diagnostic output"
- Set "When importing XML files, log:" to "Debug"
- Click Apply, then OK


This will produce detailed debug output on the Domino server console and log.nsf when the importer imports chat logs and applies/processes your rules.

- On the Domino server console, enter > tell imtegrity pause
- Perform a chat which includes the keyword your "Action" rule should trigger on
- After the chat concluded, enter > tell imtegrity import to import the log for that chat
- Enter > tell imtegrity resume

On the domino console and in the log.nsf you should see debug output similar to the following:

03/26/2011 11:11:00 PM IMtegrity: Found a total of 1 enabled rules, 1 for this server
03/26/2011 11:11:00 PM IMtegrity: Loaded action rule 'Check for name'
03/26/2011 11:11:00 PM IMtegrity: Loaded 0 inclusion, 0 exclusion, 1 action rules from imtconfig.nsf
03/26/2011 11:11:00 PM IMtegrity: Log importer for imtchatlog4.nsf started
03/26/2011 11:11:00 PM IMtegrity: Searching D:\Logs\ for Sametime chat logs...
03/26/2011 11:11:00 PM IMtegrity: Searching file mask imt4_*_single.xml (#1)
03/26/2011 11:11:00 PM IMtegrity: Found #1: imt4_17d095a2-b19e-4a1b-b3d7-d395650be87f_single.xml
03/26/2011 11:11:00 PM IMtegrity: Processing imt4_17d095a2-b19e-4a1b-b3d7-d395650be87f_single.xml
03/26/2011 11:11:00 PM IMtegrity: Rendering table #1/1
03/26/2011 11:11:00 PM IMtegrity: Processing action rule 'Check for name'
03/26/2011 11:11:00 PM IMtegrity: >Message: Matching messages against '*taylor*'
03/26/2011 11:11:00 PM IMtegrity: >Message: 'seen john taylor lately?' matches '*taylor*' (@ 3/26/2011 11:10:41 PM)
03/26/2011 11:11:00 PM IMtegrity: >Message: Satisfied rule: True
03/26/2011 11:11:00 PM IMtegrity: >Name: No participant names specified
03/26/2011 11:11:00 PM IMtegrity: >Group: No groups specified
03/26/2011 11:11:00 PM IMtegrity: >Party: No number specified
03/26/2011 11:11:00 PM IMtegrity: >Time: No times specified
03/26/2011 11:11:00 PM IMtegrity: >Len: No length specified
03/26/2011 11:11:00 PM IMtegrity: >MsgCount: No number specified
03/26/2011 11:11:00 PM IMtegrity: >WordCount: No number specified
03/26/2011 11:11:00 PM IMtegrity: >Lookup: No directory lookup specified
03/26/2011 11:11:00 PM IMtegrity: Satisfied action rule 'Check for name'
03/26/2011 11:11:00 PM Opened session for VMWare/IMtegrity (Release 7.0.2)
03/26/2011 11:11:00 PM IMtegrity: Sent notification to CN=John Taylor/O=IMtegrity@IMtegrity
03/26/2011 11:11:00 PM IMtegrity: Importing imt4_17d095a2-b19e-4a1b-b3d7-d395650be87f_single.xml
03/26/2011 11:11:00 PM IMtegrity: Processing time was 0.305 seconds
03/26/2011 11:11:00 PM IMtegrity: Removing log file imt4_17d095a2-b19e-4a1b-b3d7-d395650be87f_single.xml
03/26/2011 11:11:00 PM IMtegrity: Searching file mask imt4_*_start.xml (#2)
03/26/2011 11:11:00 PM IMtegrity: Searching file mask imt4_*_part*.xml (#3)
03/26/2011 11:11:00 PM IMtegrity: Searching file mask imt4_*_final.xml (#4)
03/26/2011 11:11:00 PM IMtegrity: Searching file mask imt4_*_file.xml (#5)
03/26/2011 11:11:00 PM IMtegrity: Imported 1 Sametime chat logs
03/26/2011 11:11:00 PM IMtegrity: Log importer finished


Typically, Instant may request:
The debug output so we can see what's going on.
Check the output for any mail router errors which could be related to the rule trying to send the email but failing.
ZIP and attach your imtconfig.nsf database so we can take a look at your rules.

No comments: