The following is an example of the dynamoMessagingSystem.xml file mentioned in Step 5 of Adding Custom Alert Messages to Gears above. By creating /atg/dynamo/messaging/dynamoMessagingSystem.xml and placing it in the gear’s CONFIGPATH, it will be parsed by the ATG PatchBay feature. This makes the message available to the Scenario module, so that you can configure scenarios based on the new alert messages.
The jms-type value is the type of the message, i.e. the “message type” string passed to the GearMessage constructor. The message-class value is the name of the Java class that implements the message. (As noted previously, in this example the two are the same, but that need not be the case.) The display-name is how the message event will appear in the Scenario module.
<?xml version="1.0" encoding="utf-8"?> <dynamo-message-system> <!--DSS message registry definitions --> <message-registry> <message-family> <message-family-name> paf </message-family-name> <message-type> <jms-type> atg.portal.gear.docexch.DocumentCreatedMessage </jms-type> <message-class> atg.portal.gear.docexch.DocumentCreatedMessage </message-class> <message-context>session</message-context> <display-name>Document Created</display-name> <description> Generated after DocumentFormHandler gear creates a new document </description> </message-type> ... </message-family> </message-registry> </dynamo-message-system>
For more information about configuring and using the Dynamo Message System, see the Dynamo Message System chapter in the ATG Programming Guide.
