Bookshelf Home | Contents | Index | PDF     

Transports and Interfaces: Siebel Enterprise Application Integration > EAI JMS Transport > Detailed Input and Output Specifications for the EAI JMS Transport >

Input Arguments Used by the Dispatch Step

Table 13 shows the options for each input argument of the JMS Transport methods, except user-defined properties and arguments used by the Dispatch step. R denotes a required argument; NR denotes an optional argument; and I denotes an argument that is ignored.

Table 13. Dispatch Step Input Arguments
Input Argument
Send
Publish
Send
Receive
Receive
Subscribe
Receive Dispatch
Receive Dispatch Send
Subscribe Dispatch

ConnectionFactory

R

R

R

R

R

R

R

R

ReceiveQueue

I

I

R

R

I

R

R

I

ReceiveTimeout

I

I

NR

NR

NR

NR

NR

NR

SendQueue

R

I

R

I

I

I

R1

I

Topic

I

R

I

I

R

I

I

R

ConnectionUsername*

NR

NR

NR

NR

NR

NR

NR

NR

ConnectionPassword*

NR

NR

NR

NR

NR

NR

NR

NR

SendUsername**

NR

I

NR

I

I

NR

I

I

SendPassword**

NR

I

NR

I

I

NR

I

I

ReceiveUsername**

I

I

NR

I

I

I

NR

I

ReceivePassword**

I

I

NR

I

I

I

NR

I

TopicUsername**

I

NR

I

I

NR

I

I

NR

TopicPassword**

I

NR

I

I

NR

I

I

NR

SubscriberIdentifier

I

I

I

I

R

I

I

R

JMS Headers

JMSPriority

NR

NR

NR

I

I

I

NR2

I

JMSDeliveryMode

NR

NR

NR

I

I

I

NR2

I

JMSExpiration

NR

NR

NR

I

I

I

NR2

I

JMSReplyTo

NR

NR

I3

I

I

I

NR2

I

JMSType+

NR

NR

NR

I

I

I

NR2

I

JMSCorrelationID+

NR

NR

NR

I

I

I

I4

I

Dispatch

Connection
Subsystem++

NR

NR

NR

NR

NR

NR

NR

NR

DataHandling
Subsystem+++

I

I

I

I

I

NR

NR

NR

DispatchService

I

I

I

I

I

R5

R5

R5

DispatchMethod

I

I

I

I

I

R5

R5

R5

DispatchWorkflow
Process

I

I

I

I

I

R5

R5

R5

DispatchRuleSet

I

I

I

I

I

R5

R5

R5

ConverterService++++

I

I

I

I

I

NR

NR

NR

Some special notes regarding particular values in Table 13:

  • R1: When the JMSReplyTo header is used, the SendQueue value is ignored.
  • NR2: These values are assigned to the reply message during the Send step.
  • I3: The JMSReplyTo header of the sent message is set to the value of the ReceiveQueue argument.
  • I4: 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.
  • R5: One of 3 combinations is required for these method arguments: (DService && Dmethod), DWProcess, or DRuleSet.
  • *: The ConnectionUsername and ConnectionPassword input parameters apply to IBM WebSphere MQ only.

    NOTE:  When sending messages to IBM WebSphere MQ, ConnectionUsername and ConnectionPassword are recommended for all Windows platforms.

  • **: The SendUsername, SendPassword, ReceiveUsername, ReceivePassword, TopicUsername, and TopicPassword input parameters apply to Oracle WebLogic only.
  • +: This input argument 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.

In place 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 14 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 14. Values for Input Arguments
Input
Default
Allowable
Values
Special Values
If Value Invalid

ConnectionFactory

NONE

JNDI connection factory name

Not applicable

ERROR

ReceiveQueue

NONE

JNDI queue name

Not applicable

ERROR

ReceiveTimeout

3000

Any integer greater than or equal to 0

0: Wait indefinitely

Noninteger defaults to 3000

Integer less than 0 defaults to 0

ConnectionUsername

NONE

Valid username

Not applicable

Not applicable

ConnectionPassword

NONE

Valid password

Not applicable

Not applicable

SendQueue

NONE

JNDI queue name

Not applicable

ERROR

SendUsername

NONE

Valid username

Not applicable

Not applicable

SendPassword

NONE

Valid password

Not applicable

Not applicable

ReceiveUsername

NONE

Valid username

Not applicable

Not applicable

ReceivePassword

NONE

Valid password

Not applicable

Not applicable

TopicUsername

NONE

Valid username

Not applicable

Not applicable

TopicPassword

NONE

Valid password

Not applicable

Not applicable

Topic

NONE

JNDI topic name

Not applicable

ERROR

SubscriberIdentifier

NONE

ANY STRING

Not applicable

Not applicable

JMS Headers

JMSCorrelationID

NOT SET

ANY STRING

Not applicable

Not applicable

JMSPriority

javax.jms.Message.
DEFAULT_PRIORITY
(4)

Any integer from 0 to 9

(0 lowest; 9 highest)

DEFAULT

JMSDeliveryMode

javax.jms.Delivery
Mode.PERSISTENT

PERSISTENT, NON_PERSISTENT

Not applicable

DEFAULT

JMSExpiration

javax.jms.Message.
DEFAULT_TIME_TO_
LIVE (0)

Any nonnegative integer

0: Message never expires

DEFAULT

JMSReplyTo

NOT SET

JNDI queue name

Not applicable

ERROR

JMSType

SiebelJMSMessage

ANY STRING

Not applicable

Not applicable

Dispatch

ConnectionSubsystem

NONE

A JMSSubsys named subsystem

Not applicable

ERROR

DataHandlingSub
system

NONE

An EAITransportData
HandlingSubsys named subsystem

Not applicable

ERROR

DispatchService

NONE

Business service name

Not applicable

ERROR

DispatchMethod

NONE

Business service method

Not applicable

ERROR

DispatchWorkflow
Process

NONE

Workflow name

Not applicable

ERROR

DispatchRuleSet

NONE

Rule set name

Not applicable

ERROR

ConverterService

NONE

Business service name

Not applicable

ERROR
    
Transports and Interfaces: Siebel Enterprise Application Integration Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices.