Transports and Interfaces: Siebel Enterprise Application Integration > Java Message Service Transport > Detailed Input and Output Specifications >
Input Arguments Used by the Dispatch Step
Table 9 reflects the optionality of each input argument except user-defined properties and arguments used by the Dispatch step. An asterisk (*) denotes a required argument, OPT denotes an optional argument, and a dash (-) denotes an argument that is ignored.
Table 9. Dispatch Step Input Arguments
|
|
|
|
|
|
|
|
|
ConnectionFactory
|
* |
* |
* |
* |
* |
* |
* |
* |
ReceiveQueue
|
- |
- |
* |
* |
- |
* |
* |
- |
ReceiveTimeout
|
- |
- |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
SendQueue
|
* |
- |
* |
- |
- |
- |
*1 |
- |
Topic
|
- |
* |
- |
- |
* |
- |
- |
* |
ConnectionUsername |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
ConnectionPassword |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
SendUsername |
OPT |
- |
OPT |
- |
- |
OPT |
- |
- |
SendPassword |
OPT |
- |
OPT |
- |
- |
OPT |
- |
- |
ReceiveUsername |
- |
- |
OPT |
- |
- |
- |
OPT |
- |
ReceivePassword |
- |
- |
OPT |
- |
- |
- |
OPT |
- |
TopicUsername |
- |
OPT |
- |
- |
OPT |
- |
- |
OPT |
TopicPassword |
- |
OPT |
- |
- |
OPT |
- |
- |
OPT |
SubscriberIdentifier
|
- |
- |
- |
- |
* |
- |
- |
* |
JMS Headers |
JMSPriority
|
OPT |
OPT |
OPT |
- |
- |
- |
OPT2 |
- |
JMSDeliveryMode
|
OPT |
OPT |
OPT |
- |
- |
- |
OPT2 |
- |
JMSExpiration
|
OPT |
OPT |
OPT |
- |
- |
- |
OPT2 |
- |
JMSReplyTo
|
OPT |
OPT |
-4 |
- |
- |
- |
OPT2 |
- |
+JMSType
|
OPT |
OPT |
OPT |
- |
- |
- |
OPT2 |
- |
+JMSCorrelationID
|
OPT |
OPT |
OPT |
- |
- |
- |
-3 |
- |
Dispatch |
++ConnectionSubsystem |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
OPT |
+++DataHandlingSubsystem |
- |
- |
- |
- |
- |
OPT |
OPT |
OPT |
DispatchService |
- |
- |
- |
- |
- |
OPT5 |
OPT5 |
OPT5 |
DispatchMethod |
- |
- |
- |
- |
- |
OPT5 |
OPT5 |
OPT5 |
DispatchWorkflowProcess |
- |
- |
- |
- |
- |
OPT5 |
OPT5 |
OPT5 |
DispatchRuleSet |
- |
- |
- |
- |
- |
OPT5 |
OPT5 |
OPT5 |
++++ConverterService |
- |
- |
- |
- |
- |
OPT |
OPT |
OPT |
Some special notes regarding particular values in Table 9:
- OPT2: These values are assigned to the reply message during the Send step.
- OPT5: One of 3 combinations is required for these method arguments: (DService && Dmethod), DWProcess, or DRuleSet.
- *1: The JMSReplyTo header of the received message is ignored. The reply is always sent to the configured SendQueue. The JMSReplyTo header of the reply will be set to this value.
- -3: The JMSCorrelationID of the reply message cannot be set directly. The JMSCorrelationID of the reply message is set to the JMSCorrelationID of the received message, unless empty, in which case it is set to its JMSMessageID.
- -4: The JMSReplyTo header of the sent message is set to the value of the ReceiveQueue argument.
- +: An input argument that can also be used as an output argument.
- ++: For this input argument, a subsystem may be provided instead of the connection parameters. However, it must contain the same required method arguments as used for the connection parameters.
- +++: For this input argument, a subsystem may be provided instead of the dispatch parameters. However, it must contain the same required method arguments as used for the dispatch parameters.
- ++++: This input argument is used to process the output of the received message before dispatching.
- The ConnectionUsername and ConnectionPassword input parameters apply to IBM MQ only.
- The SendUsername, SendPassword, ReceiveUsername, ReceivePassword, TopicUsername, and TopicPassword input parameters apply to BEA WebLogic only.
In lieu of providing the arguments individually, the single argument ConnectionSubsystem may be provided. Its value must be the name of a valid named subsystem of type JMSSubsys, and it must include all of the arguments that are required by the method to which it is passed. See About the JMS Receiver for more information about that named subsystem. JMS message properties are also supported as input arguments (properties) as described in JMS Headers and Properties. Table 10 provides details for each input argument about the allowable values, default values, and special values, as well as the behavior if an invalid value is passed.
Table 10. Values for Input Arguments
|
|
|
|
|
ConnectionFactory
|
NONE
|
JNDI connection factory name
|
|
ERROR
|
ReceiveQueue
|
NONE
|
JNDI queue name
|
|
ERROR
|
ReceiveTimeout
|
3000
|
ANY INTEGER x >= 0
|
0: Wait indefinitely
|
Non-int = 3000 < 0 = 0
|
ConnectionUsername |
NONE |
Valid username |
|
|
ConnectionPassword |
NONE |
Valid password |
|
|
SendQueue
|
NONE
|
JNDI queue name
|
|
ERROR
|
SendUsername |
NONE |
Valid username |
|
|
SendPassword |
NONE |
Valid password |
|
|
ReceiveUsername |
NONE |
Valid username |
|
|
ReceivePassword |
NONE |
Valid password |
|
|
TopicUsername |
NONE |
Valid username |
|
|
TopicPassword |
NONE |
Valid password |
|
|
Topic
|
NONE
|
JNDI topic name
|
|
ERROR
|
SubscriberIdentifier
|
NONE
|
ANY STRING
|
|
N/A
|
JMS Headers |
JMSCorrelationID
|
NOT SET
|
ANY STRING
|
|
N/A
|
JMSPriority
|
javax.jms.Message.DEFAULT_PRIORITY ( = 4)
|
ANY INTEGER 0 <= x <= 9
|
(0 lowest; 9 highest)
|
DEFAULT
|
JMSDeliveryMode
|
javax.jms.DeliveryMode.PERSISTENT
|
PERSISTENT, NON_PERSISTENT
|
|
DEFAULT
|
JMSExpiration
|
javax.jms.Message.DEFAULT_TIME_TO_LIVE (= 0)
|
ANY INTEGER x >= 0
|
0: Message never expires
|
DEFAULT
|
JMSReplyTo
|
NOT SET
|
JNDI queue name
|
|
ERROR
|
JMSType
|
SiebelJMSMessage
|
ANY STRING
|
|
N/A
|
Dispatch |
ConnectionSubsystem |
NONE |
A JMSSubsys named subsystem |
|
ERROR |
DataHandlingSubsystem |
NONE |
An EAITransportDataHandlingSubsys named subsystem |
|
ERROR |
DispatchService |
NONE |
Business service name |
|
ERROR |
DispatchMethod |
NONE |
Business service method |
|
ERROR |
DispatchWorkflowProcess |
NONE |
Workflow process |
|
ERROR |
DispatchRuleSet |
NONE
|
Rule set name |
|
ERROR |
ConverterService |
NONE
|
Business service name |
|
ERROR |
|