file connector

Description - Renames a file specified in the file source

Runtime Class - com.ibi.agents.XDPFFileOpsAgent



Parameter Groups

 ParameterTypeDescription
*Name:stringOriginating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
*Search Type:stringInterpret the file name using the following search pattern.

Select from one of the following options:
  • None {none} - No file selection pattern
  • DOS Expression {dos} - File selection pattern is DOS like (contains only '*' and '?' wild cards)
  • Regular Expression {regex} - File selection pattern is full Java Regular Expression
* - denotes required
 ParameterTypeDescription
Name:stringDestination file to be operated on. Wild cards accepted. Required except for delete, size, exists
* - denotes required
 ParameterTypeDescription
Is Directory:booleanSpecifies whether file target is a directory. Assumes file if not specified.
Create DirectorybooleanCreate directory if it doesn't exist.
* - denotes required
 ParameterTypeDescription
RetryintegerIf non-zero, will retry the operation n times at one-second intervals
* - denotes required
 ParameterTypeDescription
*Out DocumentstringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • Result {result} - Return results of the operation; will be status document if operation is not prepend or append.
  • Status {status} - Return status document
  • Original {original} - Return the document passed in
*Action on FailurestringWhether input document or status document returned on failure

Select from one of the following options:
  • Input {input} - Return status document on error
  • Status {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found. This may or may not be a failure.
OnParseErrorCould not parse a document.
Description - Lists the contents of a file directory

Runtime Class - com.ibi.agents.XDFileDirListAgent



Parameter Groups

 ParameterTypeDescription
*Directory Path:stringThe directory path to list its contents.
* - denotes required
 ParameterTypeDescription
Include:stringWhat items should be included in the listing.

Select from one of the following options:
  • Files {file} - Include only file names
  • Subdirectories {subdir} - Include only subdirectory names
  • All {all} - Include both files and subdirectories
Selection Expression:stringRegular expression used to select files/directories, based on Pattern Type.
Pattern Type:stringIf the Selection Expression is supplied, indicate whether it should be interpreted as a regular expression or a DOS-style wildcard.

Select from one of the following options:
  • Regular Expression {regex} - Full regular expressions used in selection
  • DOS-style Wild card {wildcard} - DOS-style wildcards (* and ? only)
* - denotes required

Output Events

NameDescription
OnNotFoundThe resource was not found and this is considered an error.
OnFailedOperationCould not perform the operation requested.
Description - Writes a document to a physical file

Runtime Class - com.ibi.agents.XDFileEmitAgent



Parameter Groups

 ParameterTypeDescription
Data Source:stringValue or expression to represent a data source. If not set, defaults to the input document.
* - denotes required
 ParameterTypeDescription
XML Namespace Provider:stringProvider for the mapping between XML namespace prefix and namespace URI within XPath expressions.
* - denotes required
 ParameterTypeDescription
*Directory:stringThe target directory of the output file.
*File Name:stringThe output target file name; supports '*' which expands to a file timestamp.
* - denotes required
 ParameterTypeDescription
File Encoding:stringEncoding to apply to the target output file being written. Does not apply when output is bas64.

Select from one of the following options:
  • Leave {leave} - Make no changes (input document carries encoding)
  • Platform {platform} - Use platform's encoding, not inbound message encoding
  • US-ASCII - Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set
  • CP-037/EBCDIC {CP037} - Eight but EBCDIC encoding
  • ISO-8859-1 - ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1
  • UTF-8 - Eight-bit UCS Transformation Format
  • UTF16-BE {UTF-16BE} - Sixteen-bit UCS Transformation Format, big-endian byte order
  • UTF16-LE {UTF-16LE} - Sixteen-bit UCS Transformation Format, little-endian byte order
  • UTF16 {UTF-16} - Sixteen-bit UCS Transformation Format, byte order identified by [optional] byte order mark
Base64 Decode:booleanIf set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified.
Append:booleanIf set to true, the output will be appended to the file if it already exists
Append CRLF:booleanIf set to true, a carriage return and a line feed will be written at end of target file.
Emit Zero Length Files:booleanIf true, emit empty files if the process creates them.
* - denotes required
 ParameterTypeDescription
Output Document:stringOutput document of the object.

Select from one of the following options:
  • iWay Status Document {status} - Replace input with standard iWay status document
  • Original Input Document {input} - Output of node is original document
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found. This may or may not be a failure.
Description - Checks for size of file specified by the file source

Runtime Class - com.ibi.agents.XDPFFileOpsAgent



Parameter Groups

 ParameterTypeDescription
*File Name:stringThe name of the file to calculate the size of.
* - denotes required
 ParameterTypeDescription
Retry:integerIf non-zero, will retry the operation n times at one-second intervals
* - denotes required
 ParameterTypeDescription
*Size:stringRegister name: stores the size of the file specified in the source.
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • Result {result} - Return results of the operation; will be status document if operation is not prepend or append.
  • Status {status} - Return status document
  • Original {original} - Return the document passed in
*Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • Input Document {input} - Return status document on error
  • Status Document {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found. This may or may not be a failure.
OnParseErrorCould not parse a document.
Description - Embeds a specified binary, xml or text file in the input document

Runtime Class - com.ibi.agents.XDPFFileReadAgent



Parameter Groups

 ParameterTypeDescription
*File Name:stringSource file to be read.
*Format:stringFormat of the source file

Select from one of the following options:
  • Flat {flat}
  • XML {xml}
  • JSON {json}
  • Stream {stream}
* - denotes required
 ParameterTypeDescription
Encoding:stringCharacter set encoding to be performed on input. Base 64 is required for flat binary data

Select from one of the following options:
  • cp037
  • ISO-8859-1
  • ISO-8859-8
  • SJIS
  • UNICODE
  • UTF-8
  • UTF8
*Base64 Encode:booleanBase64 encode the read in document when embedding
* - denotes required
 ParameterTypeDescription
*Embed:booleanWhether to embed the data from the read operation into the input document
Tag:stringName of the node to wrap the data read in flat format.
Parent Tag:stringThe tag in the input document where the data should be embedded.
* - denotes required
 ParameterTypeDescription
Retry:integerIf non-zero, will retry the operation n times at one-second intervals
* - denotes required
 ParameterTypeDescription
*Delete File Source:booleanWhether to delete the file read on a successful read.
* - denotes required

Output Events

NameDescription
OnNotFoundThe resource was not found. This may or may not be a failure.
OnParseErrorCould not parse a document.
OnFailedOperationCould not perform the operation requested.
Description - Appends a file to the beggining of another file

Runtime Class - com.ibi.agents.XDPFFileOpsAgent



Parameter Groups

 ParameterTypeDescription
*File Name:stringFile name of the data source to be prepended to the target file.
*Search Type:stringInterpret the file name using the following search pattern.

Select from one of the following options:
  • None {none} - No file selection pattern
  • DOS Expression {dos} - File selection pattern is DOS like (contains only '*' and '?' wild cards)
  • Regular Expression {regex} - File selection pattern is full Java Regular Expression
* - denotes required
 ParameterTypeDescription
*File Name:stringFile which the source will be prepended to.
* - denotes required
 ParameterTypeDescription
Is Directory:booleanSpecifies whether file target is a directory. Assumes file if not specified.
Create Directory:booleanCreate directory if it doesn't exist.
* - denotes required
 ParameterTypeDescription
Retry:integerIf non-zero, will retry the operation n times at one-second intervals
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • Result {result} - Return results of the operation; will be status document if operation is not prepend or append.
  • Status {status} - Return status document
  • Original {original} - Return the document passed in
*Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • Input Document {input} - Return status document on error
  • Status Document {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found. This may or may not be a failure.
OnParseErrorCould not parse a document.
Description - Move a file from source to target

Runtime Class - com.ibi.agents.XDPFFileOpsAgent



Parameter Groups

 ParameterTypeDescription
*File Name:stringSource file to move.
*Search Type:stringInterpret the file name using the following search pattern.

Select from one of the following options:
  • None {none} - No file selection pattern
  • DOS Expression {dos} - File selection pattern is DOS like (contains only '*' and '?' wild cards)
  • Regular Expression {regex} - File selection pattern is full Java Regular Expression
* - denotes required
 ParameterTypeDescription
*File Name:stringDestination of the moved file.
* - denotes required
 ParameterTypeDescription
Is Directory:booleanSpecifies whether file target is a directory. Assumes file if not specified.
Create Directory:booleanCreates directory if it doesn't exist.
* - denotes required
 ParameterTypeDescription
Retry:integerIf non-zero, will retry the operation n times at one-second intervals
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • Result Document {result} - Returns the results of the operation.
  • Status Document {status} - Returns a status document
  • Original Document {original} - Return the document passed in
*Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • Input Document {input} - Return status document on error
  • Status Document {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found. This may or may not be a failure.
OnParseErrorCould not parse a document.
Description - Deletes a file specified by the file source

Runtime Class - com.ibi.agents.XDPFFileOpsAgent



Parameter Groups

 ParameterTypeDescription
*File Name:stringOriginating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document
*Search Type:stringInterpret the file name using the following search pattern.

Select from one of the following options:
  • None {none} - No file selection pattern
  • DOS Expression {dos} - File selection pattern is DOS like (contains only '*' and '?' wild cards)
  • Regular Expression {regex} - File selection pattern is full Java Regular Expression
* - denotes required
 ParameterTypeDescription
Retry:integerIf non-zero, will retry the operation n times at one-second intervals
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • Result Document {result} - Returns the result of the operation.
  • Status Document {status} - Returns a status document
  • Original Document {original} - Returns the document passed in
*Action on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • Input {input} - Return status document on error
  • Status {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found. This may or may not be a failure.
OnParseErrorCould not parse a document.
Description - Creates a

Runtime Class - com.ibi.agents.XDPFFileOpsAgent



Parameter Groups

 ParameterTypeDescription
*Directory Name:stringThe directory to create.
* - denotes required
 ParameterTypeDescription
Retry:integerIf non-zero, will retry the operation n times at one-second intervals
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • Result {result} - Returns the result of the operation.
  • Status {status} - Returns a status document
  • Original {original} - Returns the document passed in
*Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • Input Document {input} - Return status document on error
  • Status Document {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found. This may or may not be a failure.
OnParseErrorCould not parse a document.
Description - Copy a file from source to target

Runtime Class - com.ibi.agents.XDPFFileOpsAgent



Parameter Groups

 ParameterTypeDescription
*File Name:stringSource File to be copied.
*Search Type:stringInterpret the file name using the following search pattern.

Select from one of the following options:
  • None {none} - No file selection pattern
  • DOS Expression {dos} - File selection pattern is DOS like (contains only '*' and '?' wild cards)
  • Regular Expression {regex} - File selection pattern is full Java Regular Expression
* - denotes required
 ParameterTypeDescription
*File Name:stringFile destination to copy the file to.
* - denotes required
 ParameterTypeDescription
Is Directory:booleanSpecifies whether file target is a directory. Assumes file if not specified.
Create Directory:booleanCreate direcory if it does not exist.
* - denotes required
 ParameterTypeDescription
Retry:integerIf non-zero, will retry the operation n times at one-second intervals
* - denotes required
 ParameterTypeDescription
*Out Document:stringDocument returned by operation (bad input defaults to result)

Select from one of the following options:
  • Result Document {result} - Return results of the operation; will be status document if operation is not prepend or append.
  • Status Document {status} - Return status document
  • Original Document {original} - Return the document passed in
*Return on Failure:stringWhether input document or status document returned on failure

Select from one of the following options:
  • Input Document {input} - Return status document on error
  • Status Document {status} - Return status document on error
* - denotes required

Output Events

NameDescription
OnFailedOperationCould not perform the operation requested.
OnNotFoundThe resource was not found. This may or may not be a failure.
OnParseErrorCould not parse a document.