tMomInput – Docs for ESB 5.x

Component family

Internet

Function

Fetches a message from a queue on a Message-Oriented middle ware
system and passes it on to the next component.

Purpose

tMomInput makes it possible to
set up asynchronous communications via a MOM server.

Basic settings

Use existing connection

Select this check box and in the Component List click the
relevant connection component to reuse the connection details you already defined.

Keep listening

Select this check box to keep the MOM server listening for and
fetching new messages.

-For JBoss Messaging server,
with this check box selected, the Sleeping
time (in sec) field will appear.

-For Active MQ server, with this
check box selected, the Sleeping time (in
sec) field will disappear.

Sleeping time (in sec)

Set the frequency by typing in numbers.

(Available when ActiveMQ or
JBoss Messaging is selected in
the MQ Server list.)

MQ Server

Select the MOM server to be used from the list. According to the
server selected, the parameters required differ slightly.

Host/Port

Fill in the Host name or IP address of the MOM server and
Port.

Username

Connection login to the server you select in the MQ Server list.

Password

Connection password to the server you select in the MQ Server list.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.

Message From

Type in the message source, exactly as expected by the server;
this must include the type and name of the source. e.g.: queue/A or
topic/testtopic

Note that the field is case-sensitive.

(Available when ActiveMQ or
JBoss Messaging is selected in
the MQ Server list.)

Message Type

Select the message type, either: Topic or Queue.

(Available when ActiveMQ or
JBoss Messaging is selected in
the MQ Server list.)

Message Body Type

Select the message body type, either: Text , Bytes or
Map

Schema and Edit
Schema

A schema is a row description, it defines the number of fields
that will be processed and passed on to the next component.

In the context of tMomInput
usage, the schema is comprised of two columns: From and Message,
and the column names are read only.

Websphere MQ

Channel

Fill this field with the name of the channel through which the
data connection is established. The default value is
DC.SVRCONN.

Queue Manager

A system program that provides a logical container for the message
queue and is responsible for transferring data to other queue
managers via message channels. Fill this field with the name of the
queue manager to which the data connection is made.

Message Queue

A queue from which message queueing applications can put messages
on, and get messages. Fill this field with the name of the message
queue.

Is using message id to fetch

Select this check box to fetch messages according to their
IDs.

Commit (delete message after reading from the
queue)

Select this check box to force a commit after reading each message
from the queue.

Select this check box to indicate to the queue manager that all
the messages read from the server will not be deleted when the
connection to server is cut off.

Receive number of messages

Select this check box to set the number of messages that you will
receive on the console.

Failover

Select this check box to show the server address table.

In that table, you can define multiple MQ servers for
failover.

Advanced settings

Additional options

Define the failover transport options in the table. This table is
available only if you select the Failover check box in the Basic settings view.

For example, enter maxReconnectAttempts in the Option name field and then 0 in the Option
value field so that no attempt is made to retry the
connection when no server is available for the failover mode.

For more information about the transport options, see http://activemq.apache.org/failover-transport-reference.html.

Select an acknowledgement mode from the list to indicate that the
client will acknowledge any messages it receives:

Auto Acknowledge: With this
acknowledgement mode, the client automatically acknowledges a
message when it has either successfully returned from a call to
receive,or the message listener it has called to process the message
successfully returns.

Client Acknowledge: With this
acknowledgement mode, the client acknowledges a message by calling a
message’s acknowledge method.

Dups OK Acknowledge: This
acknowledgement mode instructs the session to lazily acknowledge the
delivery of messages.

For further information about the usage of Jms headers, see https://publib.boulder.ibm.com/iseries/v5r2/ic2924/books/csqzaw07.pdf.

Select this check box to receive the Jms headers through the
mapping from Jms fields onto MQ Series fields. When this check box
is checked, you can specify the Jms header and the corresponding
reference column name in the line(s) you added by clicking the plus
button in the Parameters table. For
further information about the usage of Jms headers, see https://publib.boulder.ibm.com/iseries/v5r2/ic2924/books/csqzaw07.pdf.

Select this check box to receive the Jms properties mapped to MQMD
fields. When this check box is checked, you can specify the property
name, the property type and the reference column name in the line(s)
you added by clicking the plus button in the Parameters table. For further information about the
usage of Jms properties, see https://publib.boulder.ibm.com/iseries/v5r2/ic2924/books/csqzaw07.pdf.

(Available when ActiveMQ or
JBoss Messaging is selected in
the MQ Server list.)

Select this check box to disable Commit(delete message after reading from the queue)
check box and Backout removed
messages check box in the Basic
settings view and open the queue to browse
messages.

Select this check box to set one or more message descriptors by
adding new fields for MQMD(message queuing message descriptor) in
the Parameters table:

Field Name: Select one or more
message descriptors from the list to retrieve header information of
the message.

Reference Column Name: The header
and properties information of the message.

For further information, see http://publib.boulder.ibm.com/infocenter/wmqv7/v7r0m0/index.jsp?topic=%2Fcom.ibm.mq.csqzak.doc%2Ffr13040_.htm/.

(Available when WebSphere MQ is
selected in the MQ Server
list.)

Select this check box to specify the header of the message:

MQRFH2 fixed Portion: Select this
check box and click the plus button to add one or more lines to
specify the Version, Encoding, Format, Flags,
NameValueCCSID and CodedCharSetId as needed for the fixed
portion of MQRFH2 header.

MCD folder: Select this check box
and click the plus button to add one or more lines to specify the
fields and the reference column names for the properties that
describe the format of the message.

JMS folder: Select this check box
and click the plus button to add one or more lines to specify the
fields and the reference column names for the transportation of JMS
header fields and JMSX properties.

USR folder: Select this check box
and click the plus button to add one or more lines to specify the
fields and the reference column names for the transportation of
application-defined properties associated with the message.

For further information about MQRFH2 header, see http://publib.boulder.ibm.com/infocenter/wmbhelp/v6r1m0/index.jsp?topic=%2Fcom.ibm.etools.mft.doc%2Faq06920_.htm.

(Available when WebSphere MQ is
selected in the MQ Server
list.)

Select this check box to enable the CipherSpec list from which you
can specify the CipherSpec to be used with WebSphere MQ SSL.

For further information about CipherSpec, see http://publib.boulder.ibm.com/infocenter/wmqv6/v6r0/index.jsp?topic=%2Fcom.ibm.mq.csqzas.doc%2Fsy12870_.htm.

(Available when WebSphere MQ is
selected in the MQ Server
list.)

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a
Job level as well as at each component level.

Dynamic settings

Click the [+] button to add a
row in the table and fill the Code
field with a context variable to choose your MQ Server connection
dynamically from multiple connections planned in your Job.

The Dynamic settings table is available only when the
Use an existing connection check box is selected in the
Basic settings view. Once a dynamic parameter is
defined, the Component List box in the Basic settings view becomes unusable.

For more information on Dynamic settings and context
variables, see Talend Studio User Guide.

Global Variables

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

NB_LINE: the number of rows read by an input component or
transferred to an output component. This is an After variable and it returns an
integer.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio
User Guide.

Usage

This component is generally used as a start component. It must be
linked to an output component.

Limitation

Make sure the relevant ActiveMQ, JBoss Messaging or Websphere MQ
server is launched.

This component requires installation of its related jar files. For more information about the
installation of these missing jar files, see the section describing how to configure the
Studio of the Talend Installation and Upgrade Guide.