Bookshelf Home | Contents | Index | PDF     

Transports and Interfaces: Siebel eBusiness Application Integration Volume III > Java Message Service Transport > Detailed Input and Output Specifications >

About 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
Input
Send
Publish
Send
Receive
Receive
Subscribe
Receive Dispatch
Receive Dispatch Send
Subscribe Dispatch

ConnectionFactory

*

*

*

*

*

*

*

*

ReceiveQueue

-

-

*

*

-

*

*

-

ReceiveTimeout

-

-

OPT

OPT

OPT

OPT

OPT

OPT

SendQueue

*

-

*

-

-

-

*1

-

Topic

-

*

-

-

*

-

-

*

SubscriberIdentifier

-

-

-

-

*

-

-

*

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

-

Some special notes regarding particular values in Table 9:

  • OPT2: For ReceiveDispatchSend, the JMS headers are assigned to the reply message during the Send step
  • *1: For ReceiveDispatchSend, the JMSReplyTo header of the received message is ignored. The reply is always sent to the given SendQueue. If JMSReplyTo is provided as an input to ReceiveDispatchSend, then it is assigned to the header of the reply sent during the Send step.
  • -3: For ReceiveDispatchSend, the JMSCorrelationID of the reply message cannot be provided as an input. The JMSCorrelationID is automatically set to the JMSCorrelationID of the received message, unless empty, in which case it is set to its JMSMessageID.
  • -4: For SendReceive, the JMSReplyTo header of the sent message is set to the value of the ReceiveQueue argument.

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
Input
Default
Allowable Vaues
Special Values
If Value Invalid

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

SendQueue

NONE

JNDI queue name

 

ERROR

Topic

NONE

JNDI topic name

 

ERROR

SubscriberIdentifier

NONE

ANY STRING

 

N/A

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
    
Transports and Interfaces: Siebel eBusiness Application Integration Volume III