IAPJMS_TOPICNAME

Activity Monitoring and Work Queue Delta Configuration

Summary

This attribute defines the JMS topic name for the JMS destination that is used to audit an individual case of a procedure and system events, if activity monitoring is enabled.

Applies To

This attribute must be set for ALL processes.

Permissible Values

The attribute value must be a string. The JMS topic name format depends on your J2EE environment. See the documentation supplied with your J2EE Application Server for more information about how you should format your JMS topic name for your J2EE environment. However, iProcess Engine forces a maximum length of 511 characters for the length of the process attribute.

Default Value

The attribute is assigned the following default value when iProcess Engine is installed.

Machine ID

Process

Instance

Value

0

ALL

0

IATOPIC

Notes

If activity monitoring is enabled, the BG process sends JMS messages to a JMS topic name that you can specify using this attribute. The JMS topic name can be static or dynamically configured at run-time.

This attribute is used with the IAPJMS_SIMPLETOPIC process attribute:

If the value of IAPJMS_SIMPLETOPIC is 1, the JMS topic name specified in the IAPJMS_TOPICNAME process attribute is static.
If the value of IAPJMS_SIMPLETOPIC is 0, the JMS topic name specified in the IAPJMS_TOPICNAME process attribute is dynamically configured at run-time to include the iProcess procedure name and step name.

For example, if the IAPJMS_TOPICNAME is IAPTOPIC and IAPJMS_SIMPLETOPIC is 0, then all messages are addressed to one of the following JMS topic names, depending on the activity being audited:

IAPTopic.procedurename.START
IAPTopic.procedurename.stepname.START
IAPTopic.procedurename.stepname.END
IAPTopic.procedurename.END

where:

procedurename is the name of the iProcess procedure

stepname is the name of the step in the iProcess procedure.

Some applications demand that the JMS topic name be configured this way. However, you may want to configure the JMS topic name this way if you want to use lots of small topics as opposed to one single large topic.

The following table shows which audit trail messages are logged to which topics. (See Understanding Audit Trails for a complete listing of audit trail messages and their corresponding Message IDs).

JNDI Name

Activity (Message ID)

IAPTopic.procedurename.START

Case started by UserName (000)

IAPTopic.procedurename.stepname.START

StepDescription processed to UserName (001)

StepDescription forwarded to UserName (004)

Sub-Case started from StepDescription (016)

IAPTopic.procedurename.stepname.END

All activities not covered by any of the other listed topics.

IAPTopic.procedurename.END

Case terminated normally (009)

Case terminated prematurely by UserName (008)

Case terminated abnormally (007)

Any other activity that has a blank stepname.

See Also

IAPJMS_PUBLISH, IAPJMS_PORTNO, IAPJMS_ROLLBACK, IAPJMS_SYNCHRONOUS, IAPJMS_SIMPLETOPIC, IAPJMS_TIMEOUT, JVMPROPS, SWLIB_PATH