Use the FTEInput node to receive files using the WebSphere® MQ File Transfer Edition.
This topic contains the following sections:
For information about configuring the FTEInput node, see Configuring the FTEInput node.You can use the FTEInput node to extend IBM® Integration Bus support for file processing through its integration with WebSphere MQ File Transfer Edition. WebSphere MQ File Transfer Edition is a managed file transfer product that uses WebSphere MQ as the transport.
The FTEInput node is contained in the File drawer of the palette, and is represented in the IBM Integration Toolkit by the following icon:
You can view information about samples only when you use the product documentation that is integrated with the IBM Integration Toolkit or the online product documentation. You can run samples only when you use the product documentation that is integrated with the IBM Integration Toolkit.
The FTEInput node terminals are described in the following table.
| Terminal | Description |
|---|---|
| Failure | The output terminal to which a message is routed if an error occurs before a message is propagated to the Out terminal. Messages propagated to this terminal are not validated, even if you have specified, using the Validate property, that validation is to take place. |
| Out | The output terminal to which a message is routed if it has been successfully extracted from the input file. If no errors occur within the input node, a message received from an external resource is always sent to the Out terminal first. |
| End of Data | The output terminal to which the End of Data message is routed after all the messages in a file have been processed. The End of Data message flow transaction is initiated only if this terminal is attached. |
| Catch | The output terminal to which the message is routed if an exception is thrown downstream and caught by this node. Exceptions are caught only if this terminal is attached. |
The following tables describe the node properties that you can set on a specified tab. The column headed M indicates whether the property is mandatory (marked in the toolkit with an asterisk if you must enter a value when no default is defined). The column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).
When the FTEInput node propagates a message, it stores information about it in the LocalEnvironment.FTE and LocalEnvironment.FTE.Transfer message trees. If the input file is empty, an empty message is propagated (assuming that it is valid). If you specify a file name pattern that contains wildcard characters in the File name filter property, the FTEInput node copies the characters in the file name matched by wildcards, together with any intermediate characters, to the LocalEnvironment.Wildcard.WildcardMatch message tree. See Using local environment variables with file nodes for more information.
Description properties
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Node name | No | No | FTE Input | The name of the node. |
| Short Description | No | No | None | A brief description of the node. |
| Long Description | No | No | None | Text that describes the purpose of the node in the message flow. |
Basic properties
| Property | M | C | Default | Description | mqsiapplybaroverride command property |
|---|---|---|---|---|---|
| Directory filter | No | Yes | None | The WebSphere MQ File Transfer Edition destination directory from which input files are processed. | inputDirectory |
| File name filter | Yes | Yes | * | A file name or string containing optional wildcard characters (* or ?) identifying the file or files to process from the Input directory. | filenamePattern |
| Action on successful processing | Yes | No | No Action | The action the node takes on the file after
successfully processing the contents. Valid options are:
|
Input Message Parsing properties
| Property | M | C | Default | Description | mqsiapplybaroverride command property |
|---|---|---|---|---|---|
| Message Domain | No | No | None | The domain that is used to parse the incoming message. | |
| Message Set | No | No | None | The name or identifier of the message set in
which the incoming message is defined. If you set this property, and then update the project dependencies to remove this message set reference, a warning is issued. Either update the Message Set property, or restore the reference to this message set project. |
|
| Message Type | No | No | None | The name of the incoming message. | |
| Message Format | No | No | None | The name of the physical format of the incoming message. | |
| Message coded character set ID | Yes | Yes | Broker System Default | The ID of the coded character set used to interpret bytes of the file being read. | messageCodedCharSetIdProperty |
| Message encoding | Yes | Yes | Broker System Determined | The encoding scheme for numbers used to interpret bytes of the file being read. Valid values are Broker System Determined or a numeric encoding value. For more information about encoding, see Data conversion. | messageEncodingProperty |
Parser Options properties
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Parse timing | No | No | On Demand | Specifies when an input message is parsed. Valid
values are:
For a full description of this property, see Parsing on demand. |
| Build tree using XML schema data types | No | No | Cleared | Specifies whether the syntax elements in the message tree have data types taken from the XML schema. |
| Use XMLNSC compact parser for XMLNS domain | No | No | Cleared | Specifies whether the XMLNSC Compact Parser
is used for messages in the XMLNS Domain. If you set this property,
the message data appears under XMLNSC in nodes that are connected
to the output terminal when either of the following items is XMLNS:
|
| Retain mixed content | No | No | Cleared | Specifies whether the XMLNSC parser creates elements in the message tree for mixed text in an input message. If you select the check box, elements are created for mixed text. If you clear the check box, mixed text is ignored and no elements are created. |
| Retain comments | No | No | Cleared | Specifies whether the XMLNSC parser creates elements in the message tree for comments in an input message. If you select the check box, elements are created for comments. If you clear the check box, comments are ignored and no elements are created. |
| Retain processing instructions | No | No | Cleared | Specifies whether the XMLNSC parser creates elements in the message tree for processing instructions in an input message. If you select the check box, elements are created for processing instructions. If you clear the check box, processing instructions are ignored and no elements are created. |
| Opaque elements | No | No | Blank | Specifies a list of elements in the input message that are to be opaquely parsed by the XMLNSC parser. Opaque parsing is performed only if validation is not enabled (that is, if Validate is None); entries that are specified in Opaque Elements are ignored if validation is enabled. |
Retry properties
| Property | M | C | Default | Description | mqsiapplybaroverride command property |
|---|---|---|---|---|---|
| Retry mechanism | Yes | No | Failure | How the node handles a flow failure. Valid options
are:
|
|
| Retry threshold | Yes | Yes | 0 | The number of times to try the flow transaction again when the Retry mechanism property value is Short retry. | retryThreshold |
| Short retry interval (seconds) | No | Yes | 0 | The interval, in seconds, between each retry if the Retry threshold property is not zero. | shortRetryInterval |
| Long retry interval (seconds) | No | Yes | 300 | The interval between retries, if the Retry mechanism property is Short and long retry and the retry threshold has been exhausted. | longRetryInterval |
| Action on failing file | Yes | Yes | No Action | The action that the node takes with the input
file if all attempts to process the contents of the input file fail.
Valid options are:
|
Records and Elements properties
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Record detection | Yes | No | Whole File | The mechanism used to identify records in the
input file. Valid options are:
Note: If you select the Parsed
Record Sequence option, the parser specified in Message domain must be DFDL, XMLNSC
or MRM.
|
| Length | Yes | No | 80 | The length of each record, in bytes, when Fixed Length record detection is selected. |
| Delimiter | Yes | No | DOS or UNIX Line End | The type of delimiter bytes that separate, or
end, each record when Delimited record
detection is selected. Valid options are:
|
| Custom delimiter | No | No | None | The delimiter bytes, expressed in hexadecimal, when Delimited record detection and Custom Delimiter are selected. This property is mandatory only if the Delimiter property is set to Custom Delimiter. |
| Delimiter type | Yes | No | Postfix | The position of the delimiter when Delimited record detection is
selected. Valid options are:
|
Validation properties
For a full description of these properties, see Validation properties.
| Property | M | C | Default | Description | mqsiapplybaroverride command property |
|---|---|---|---|---|---|
| Validate | No | Yes | None | This property controls whether validation takes
place. Valid values are:
|
validateMaster |
| Failure action | No | No | Exception | This property controls what happens if validation
fails. Valid values are:
|
Transactions properties
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Transaction mode | No | No | No | The transaction mode on this input node determines
whether the rest of the nodes in the flow are executed under sync
point. Valid options are:
|
Instances properties.
For a full description of these properties, see Configurable message flow properties.
| Property | M | C | Default | Description | mqsiapplybaroverride command property |
|---|---|---|---|---|---|
| Additional instances pool | No | Yes | Use Pool Associated with Message Flow | The pool from which additional instances are
obtained.
|
componentLevel |
| Additional instances | No | Yes | 0 | The number of additional instances that the node can start if the Additional instances pool property is set to Use Pool Associated with Node. | additionalInstances |
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Events | No | No | None | Events that you have defined for the node are
displayed on this tab. By default, no monitoring events are defined
on any node in a message flow. Use Add, Edit,
and Delete to create, change or delete monitoring
events for the node; see Configuring monitoring event sources using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |
Last updated Friday, 21 July 2017