Skip Headers

Oracle Workflow API Reference
Release 2.6.3

Part Number B10286-02
Previous Next       Contents Index Glossary
         Previous  Next          Contents  Index  Glossary

Mapping Between WF_EVENT_T and OMBAQ_TEXT_MSG

If you use the Oracle8i Database, you can optionally implement Oracle Message Broker (OMB) to propagate event messages between systems. OMB queues require messages to be stored in a structure defined by a Java Message Service abstract datatype called OMBAQ_TEXT_MSG.

Oracle Workflow provides a queue handler called WF_EVENT_OMB_QH which you can use to translate between the standard Workflow WF_EVENT_T message structure and the OMBAQ_TEXT_MSG structure. See: Setting Up the WF_EVENT_OMB_QH Queue Handler, Oracle Workflow Administrator's Guide and Agents, Oracle Workflow Developer's Guide.

Among other attributes, the OMBAQ_TEXT_MSG datatype contains an attribute called TEXT_LOB, which contains the message payload in CLOB format, and another attribute called HEADER, whose datatype is another ADT called OMBAQ_HEADER.

OMBAQ_HEADER in turn contains an attribute called PROPERTIES, whose datatype is a third ADT, a named varying array called OMBAQ_PROPERTIES. The maximum size of OMBAQ_PROPERTIES is 1000, and the datatype of its elements is a fourth ADT, OMBAQ_PROPERTY.

The following table shows how the attributes of the WF_EVENT_T message structure are mapped to the attributes within the OMBAQ_TEXT_MSG structure.

WF_EVENT_T OMBAQ_TEXT_MSG
WF_EVENT_T.PRIORITY ombaq_properties(5).str_value [name = PRIORITY]
WF_EVENT_T.SEND_DATE ombaq_properties(6).str_value [name = SENDDATE]
WF_EVENT_T.RECEIVE_DATE ombaq_properties(7).str_value [name = RECEIVEDATE]
WF_EVENT_T.CORRELATION_ID ombaq_properties(8).str_value [name = CORRELATIONID]
WF_EVENT_T.EVENT_NAME ombaq_properties(9).str_value [name = EVENTNAME]
WF_EVENT_T.EVENT_KEY ombaq_properties(10).str_value [name = EVENTKEY]
WF_EVENT_T.EVENT_DATA text_lob (CLOB)
WF_EVENT_T.FROM_AGENT.NAME ombaq_properties(1).str_value [name = FROMAGENTNAME]
WF_EVENT_T.FROM_AGENT.SYSTEM ombaq_properties(2).str_value [name = FROMAGENTSYSTEM]
WF_EVENT_T.TO_AGENT.NAME ombaq_properties(3).str_value [name = TOAGENTNAME]
WF_EVENT_T.TO_AGENT.SYSTEM ombaq_properties(4).str_value [name = TOAGENTSYSTEM]
WF_EVENT_T.ERROR_SUBSCRIPTION ombaq_properties(11).str_value [name = ERRORSUBSCRIPTION]
WF_EVENT_T.ERROR_MESSAGE ombaq_properties(12).str_value [name = ERRORMESSAGE1]
WF_EVENT_T.ERROR_MESSAGE ombaq_properties(13).str_value [name = ERRORMESSAGE2]
WF_EVENT_T.ERROR_STACK ombaq_properties(14).str_value [name = ERRORSTACK1]
WF_EVENT_T.ERROR_STACK ombaq_properties(15).str_value [name = ERRORSTACK2]
WF_EVENT_T.PARAMETER_LIST ombaq_properties(16).str_value [name = <first_parameter_name>]
... ...
WF_EVENT_T.PARAMETER_LIST ombaq_properties(115).str_value [name = <hundredth_parameter_name>]

Note: You can use any names you choose for the parameters in the parameter list for an event, except the reserved words that are used for the other event properties. The reserved words are:
                 PRIORITY, SENDDATE, RECEIVEDATE, CORRELATIONID,
EVENTNAME, EVENTKEY, FROMAGENTNAME,
FROMAGENTSYSTEM, TOAGENTNAME, TOAGENTSYSTEM,
ERRORSUBSCRIPTION, ERRORMESSAGE1, ERRORMESSAGE2,
ERRORSTACK1, ERRORSTACK2
Note: Oracle Message Broker and the OMBAQ_TEXT_MSG datatype are no longer used in the Oracle9i Database and higher. In these versions of the Oracle Database, you can use the Messaging Gateway and Internet access features of Oracle Advanced Queuing to propagate event messages, in place of Oracle Message Broker.

See Also

Oracle AQ Driver ADTs, Oracle Message Broker Administration Guide


         Previous  Next          Contents  Index  Glossary


Oracle Logo
Copyright © 2003 Oracle Corporation.

All rights reserved.