File I/O receiver

The properties of this node are described.

Configuration properties

Table 1. File I/o receiver configuration properties
Property Description
Runtime Tab
Sub Service Name Enter a unique identifier for each asynchronous receiver within a service definition.
Note: When configuring a sub-flow, do not enter a Sub Service Name beginning with "YIF".
Includes Pattern Enter the comma separated list of files to process together. For example, to specify all files with the posCreateOrder.* name, use .*\posCreateOrder.*. If not specified, processes all files in the incoming directory in the order specified by the File Processing Sequence.
Note: All files matching this pattern are eligible for processing, so only put them in the incoming directory when they are complete. For example, do not FTP files directly into this directory; instead, FTP them elsewhere and then move them into place when finished.
Encoding Type Enter the character encoding of the input file. Takes JVM-supported values such as UTF-8, UTF-16, ASCII, and ANSI. Byte order mark (BOM) is mandatory on UTF-16 files, but optional on UTF-8 files. The request will be rejected without valid BOM for UTF-16 encoding. BOM not only indicates byte order, but may also provide the additional benefit of indicating which of the Unicode representations the text is encoded in.

Non-ASCII characters are not allowed in the header and trailer fields.

Defaults to the Sterling Application Platform default for the JVM, unless otherwise specified.

File Processing Sequence Enter the order in which to processes files from the Incoming Directory. Values are: LastModifiedTime (date) and ByName (name). Defaults to Last Modified Time.
Maximum Errors Per File Enter the number of logged errors before the Receiver to terminates processing the file. If set to 0, it defaults to 1. If not specified, defaults to 10.
Polling Frequency (seconds) Enter the time (in seconds) to poll the source directory for unprocessed files. Defaults to 600 seconds.
Create EOF Message Select this field if you want to create EOF message. If checked the framework creates an EOF message at the end of each file processed and pass to the next service component. For more information about creating EOF messages, see Enabling EOF messages in the application platform framework.
Do Not Fragment If you check this box, the output XML file is not fragmented into 'n' number of separate files. For example, for a load, if you create two different load lines, the output XML file contains the "Load" root element and two "LoadList" child elements.

If you do not check this box, the root element is deleted from the output XML file and a separate XML file is created for each of the child elements.

File Tab
Incoming Directory Enter the directory in which to look for input files.
Note: Ensure the directory has the appropriate read/write permissions and that the full path name has been specified. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
Completion Directory Enter the directory into which the processed files are archived after they have been processed.
Note: Ensure the directory has the appropriate read/write permissions and that the full path name has been specified. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
Working Directory Enter the directory into which the files from the incoming directory are moved before processing begins.
Note: Ensure the directory has the appropriate read/write permissions and that the full path name has been specified. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
Error Directory Enter the directory into which any errors in the file being processed are created. A new error file is created for each file processed.
Note: Ensure the directory has the appropriate read/write permissions and that the full path name has been specified. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
Error File Suffix Enter the name to append to error files. The error file records errors that occur while processing the input file. Defaults to .err.
Completion File Suffix Required if the Completion Directory is specified. Defaults to .done.
Server Tab
Server Name Enter the name of the integration server instance which actually executes the service.

For more information about creating a new server, see "Adding a New Server".

Exception Tabs See Table 1 for the receiver link exception handling properties.

Connection properties

The following are the File I/O node's connection properties:

Table 2. File I/o connection properties
Connection Node Connection Rules
Can be the first node after the start node Only for services invoked asynchronously
Can be placed before
  • FTP transport node
  • Text Translator component node
  • End node
Can be placed after
  • Start node
  • FTP transport node
  • Text Translator component node
Passes data unchanged Transport nodes do not modify data