IAP Message Types
There are two types of messages:
|
•
|
The Monitor Event Detail message (MED). A BG process sends this message. The message is addressed to the JMS topic configured in the IAPJMS_TOPICNAME process attribute. |
|
•
|
The Monitor Event Request message (MER). The MER message is sent to the iProcess database to update the activity monitoring configuration information. It can be sent by SSO or by using the SWDIR\bin\swutil IMPMONITOR command. |
The Monitor Event Detail Message (MED)
Every MED message sent from the IAPJMS process to the external application consists of the following components:
|
•
|
message body. The message body contains the detailed XML for the events that are being monitored. The MED XML format is defined by the SWAuditMessage.xsd schema. |
These messages can be sent in either a basic format or an extended format. You can specify which format is used by setting the IAPSCHEMA parameter in the SWDIR\etc\staffcfg configuration file. See the section "Tuning the iProcess Engine Using SWDIR\etc\staffcfg Parameters" in the TIBCO iProcess Engine: Administrator’s Guide for details of this parameter.
The extended format provides the following additional information in the message body:
|
•
|
Description and type of the audit user. The basic format identifies the audit user; in the extended format the description and type of the audit user can be specified. |
|
•
|
Addressee. The basic format contains no addressee information. The extended format identifies the name, description and type of the addressee of the step for OPEN, KEEP, RELEASE and FORWARD actions. |
|
•
|
Main procedure of a sub-case. The basic format contains no information about the main procedure of a sub-case. The extended format identifies the procedure name and description. |
|
•
|
Parent procedure of a sub-case. The basic format identifies the parent procedure. The extended format adds a procedure description. |
For examples of these IAPJMS messages, see the section "Examples of Configuring Activity Monitoring Information" in the TIBCO iProcess™ Modeler Integration Techniques guide.
Filtering Message Event Request (MER) Messages
Every MER message sent to the iProcess database to update the activity monitoring configuration information consists of XML requesting the events to monitor. The MER XML format is defined by the SWMonitorList.xsd schema.