FTEOutput node

Use the FTEOutput node to write messages to files by using the IBM® MQ File Transfer Edition.

Information about file transfers is held on storage queues that are controlled by IBM MQ, so you must install IBM MQ on the same computer as IBM App Connect Enterprise if you want to use the capabilities that are provided by the FTEOutput node. You must also create the system queues required by the FTEOutput node; see Creating the default system queues on an IBM MQ queue manager.

This topic contains the following sections:

Purpose

You can use the FTEOutput node to extend IBM App Connect Enterprise support for file processing through its integration with IBM MQ File Transfer Edition. IBM MQ File Transfer Edition is a managed file transfer product that uses IBM MQ as the transport.

The FTEOutput node is contained in the File drawer of the palette, and is represented in the IBM App Connect Enterprise Toolkit by the following icon:

FTEOutput node icon

Using this node in a message flow

You can use the FTEOutput node in any flow that is designed to send a file across a IBM MQ File Transfer Edition network.

Terminals and properties

The FTEOutput node terminals are described in the following table:

Terminal	Description
In	The input terminal that accepts a message for processing by the node.
Finish File	The input terminal that accepts a message that triggers the final processing of a file.
Out	The message received on the In terminal is propagated to this terminal if the record is written successfully. The message is unchanged except for status information in the Local Environment.
End of Data	The message received on the Finish File terminal is propagated to this terminal if the file is processed successfully.
Failure	The output terminal to which the message is routed if a failure is detected when a message is propagated.

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 IBM App Connect Enterprise 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 FTEOutput node propagates a message, either to the Out terminal or to the End of Data terminal, it stores information about it in the LocalEnvironment.WrittenDestination.FTE message tree. You can override the Destination agent, Destination queue manager, Job name, Destination file directory, Destination file name, and Overwrite files on destination system properties using additions to the LocalEnvironment.Destination.FTE 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 Output	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
Job name	No	Yes	None	The name for the transfer that appears in the transfer logs and the metadata.	jobName
Destination agent	No	Yes	None	The name of the destination agent to send the file to. If Destination agent is not specified, and not overridden using the LocalEnvironment tree, it will default to the agent embedded in the Integration Server.	destinationAgent
Destination queue manager	No	Yes	None	The name of the destination queue manager to send the file to.	destinationQMgr
Destination file directory	No	Yes	None	The remote directory that the destination agent writes the file to.	destinationDirectory
Destination file name	Yes	Yes	None	The specific file name or a pattern containing a single wildcard that defines the name of the file to be created by the destination agent.	destinationFileName
Mode	No	Yes	Binary transfer (no conversion)	The mode to transfer the file in. Valid values are: Binary transfer (no conversion) Text transfer (ASCII/EBCDIC and CR/LF automated)	transferMode
Disable computation of MD5 check sum	Yes	Yes	FALSE	Specifies whether the computation of the MD5 check sum on the transferred file is disabled.	checkSumDisabled
Overwrite files on destination system	Yes	Yes	FALSE	Specifies whether files on the destination system can be overwritten when the destination agent moves files of the same name there. If the destination agent fails to overwrite the file, the transfer fails and the transfer logs report the failure. The FTEOutput node does not throw or log any errors.	overwriteDestination

Request properties

Property	M	C	Default	Description
Data location	No	No	$Body	The location in the input message tree that contains the record to be written to the output file. The default value, $Body, means the entire message.

Records and Elements properties

Property	M	C	Default	Description
Record definition	Yes	No	Record is Whole File	Specifies how records are placed in the output file. Valid options are: Record is Whole File Record is Unmodified Data Record is Fixed Length Data Record is Delimited Data
Length (bytes)	Yes	No	80	The required length of the output record. The property is available only when Record is Fixed Length Data is specified in Record definition.
Padding byte (hexadecimal)	Yes	No	20	The 2-digit hexadecimal byte to be used to pad short messages. The property is available only when Record is Fixed Length Data is specified in Record definition.
Delimiter	Yes	No	Broker System Line End	The delimiter to be used. The property is available only when Record is Delimited Data is specified in Record definition. Valid options are: Broker System Line End Custom Delimiter (hexadecimal)
Custom delimiter (hexadecimal)	Yes	No	None	The delimiter byte sequence to be used. The property is available only when Record is Delimited Data is specified in the Record definition property, and Custom Delimiter (hexadecimal) is specified in the Delimiter property.
Delimiter type	Yes	No	Postfix	This property specifies how delimiters are to be inserted between records. The property is available only when Record is Delimited Data is specified in Record definition. Valid options are: Postfix Infix

Validation properties

For a full description of these properties, see Validation properties.

Property	M	C	Default	Description	mqsiapplybaroverride command property
Validate	Yes	Yes	Inherit	This property controls whether validation takes place. Valid values are: None Content and Value Content Inherit	validateMaster
Failure action	Yes	No	Exception	This property controls what happens if validation fails. The property is available only if you set Validate to Content or Content and Value. Valid values are: User Trace Local Error Log Exception Exception List

The Monitoring properties of the node are described in the following table.

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. You can enable and disable events that are shown here by selecting or clearing the Enabled check box.