Description - Renames a file specified in the file source

Runtime Class - com.ibi.agents.XDPFFileOpsAgent

Parameter Groups

• Source
• Target
• Target Settings
• Advanced Settings
• Post Action

	Parameter	Type	Description
*	Name:	string	Originating 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:	string	Interpret 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

	Parameter	Type	Description
	Name:	string	Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists

* - denotes required

	Parameter	Type	Description
	Is Directory:	boolean	Specifies whether file target is a directory. Assumes file if not specified.
	Create Directory	boolean	Create directory if it doesn't exist.

* - denotes required

	Parameter	Type	Description
	Retry	integer	If non-zero, will retry the operation n times at one-second intervals

* - denotes required

	Parameter	Type	Description
*	Out Document	string	Document 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 Failure	string	Whether 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

Name	Description
OnFailedOperation	Could not perform the operation requested.
OnNotFound	The resource was not found. This may or may not be a failure.
OnParseError	Could not parse a document.

Description - Lists the contents of a file directory

Runtime Class - com.ibi.agents.XDFileDirListAgent

Parameter Groups

• Source
• Filtering

	Parameter	Type	Description
*	Directory Path:	string	The directory path to list its contents.

* - denotes required

	Parameter	Type	Description
	Include:	string	What 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:	string	Regular expression used to select files/directories, based on Pattern Type.
	Pattern Type:	string	If 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

Name	Description
OnNotFound	The resource was not found and this is considered an error.
OnFailedOperation	Could not perform the operation requested.

Description - Writes a document to a physical file

Runtime Class - com.ibi.agents.XDFileEmitAgent

Parameter Groups

• Source
• Source Settings
• Target
• Target Settings
• Post Action

	Parameter	Type	Description
	Data Source:	string	Value or expression to represent a data source. If not set, defaults to the input document.

* - denotes required

	Parameter	Type	Description
	XML Namespace Provider:	string	Provider for the mapping between XML namespace prefix and namespace URI within XPath expressions.

* - denotes required

	Parameter	Type	Description
*	Directory:	string	The target directory of the output file.
*	File Name:	string	The output target file name; supports '*' which expands to a file timestamp.

* - denotes required

	Parameter	Type	Description
	File Encoding:	string	Encoding 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:	boolean	If set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified.
	Append:	boolean	If set to true, the output will be appended to the file if it already exists
	Append CRLF:	boolean	If set to true, a carriage return and a line feed will be written at end of target file.
	Emit Zero Length Files:	boolean	If true, emit empty files if the process creates them.

* - denotes required

	Parameter	Type	Description
	Output Document:	string	Output 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

Name	Description
OnParseError	Could not parse a document.
OnFailedOperation	Could not perform the operation requested.
OnNotFound	The 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

• Source
• Advanced Settings
• Registers
• Post Action

	Parameter	Type	Description
*	File Name:	string	The name of the file to calculate the size of.

* - denotes required

	Parameter	Type	Description
	Retry:	integer	If non-zero, will retry the operation n times at one-second intervals

* - denotes required

	Parameter	Type	Description
*	Size:	string	Register name: stores the size of the file specified in the source.

* - denotes required

	Parameter	Type	Description
*	Out Document:	string	Document 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:	string	Whether 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

Name	Description
OnFailedOperation	Could not perform the operation requested.
OnNotFound	The resource was not found. This may or may not be a failure.
OnParseError	Could 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

• Source
• Source Settings
• Document Settings
• Advanced Settings
• Post Action

	Parameter	Type	Description
*	File Name:	string	Source file to be read.
*	Format:	string	Format of the source file Select from one of the following options: Flat {flat} XML {xml} JSON {json} Stream {stream}

* - denotes required

	Parameter	Type	Description
	Encoding:	string	Character 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:	boolean	Base64 encode the read in document when embedding

* - denotes required

	Parameter	Type	Description
*	Embed:	boolean	Whether to embed the data from the read operation into the input document
	Tag:	string	Name of the node to wrap the data read in flat format.
	Parent Tag:	string	The tag in the input document where the data should be embedded.

* - denotes required

	Parameter	Type	Description
	Retry:	integer	If non-zero, will retry the operation n times at one-second intervals

* - denotes required

	Parameter	Type	Description
*	Delete File Source:	boolean	Whether to delete the file read on a successful read.

* - denotes required

Output Events

Name	Description
OnNotFound	The resource was not found. This may or may not be a failure.
OnParseError	Could not parse a document.
OnFailedOperation	Could not perform the operation requested.

Description - Appends a file to the beggining of another file

Runtime Class - com.ibi.agents.XDPFFileOpsAgent

Parameter Groups

• Source
• Target
• Target Settings
• Advanced Settings
• Post Action

	Parameter	Type	Description
*	File Name:	string	File name of the data source to be prepended to the target file.
*	Search Type:	string	Interpret 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

	Parameter	Type	Description
*	File Name:	string	File which the source will be prepended to.

* - denotes required

	Parameter	Type	Description
	Is Directory:	boolean	Specifies whether file target is a directory. Assumes file if not specified.
	Create Directory:	boolean	Create directory if it doesn't exist.

* - denotes required

	Parameter	Type	Description
	Retry:	integer	If non-zero, will retry the operation n times at one-second intervals

* - denotes required

	Parameter	Type	Description
*	Out Document:	string	Document 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:	string	Whether 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

Name	Description
OnFailedOperation	Could not perform the operation requested.
OnNotFound	The resource was not found. This may or may not be a failure.
OnParseError	Could not parse a document.

Description - Move a file from source to target

Runtime Class - com.ibi.agents.XDPFFileOpsAgent

Parameter Groups

• Source
• Target
• Target Settings
• Advanced Settings
• Post Action

	Parameter	Type	Description
*	File Name:	string	Source file to move.
*	Search Type:	string	Interpret 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

	Parameter	Type	Description
*	File Name:	string	Destination of the moved file.

* - denotes required

	Parameter	Type	Description
	Is Directory:	boolean	Specifies whether file target is a directory. Assumes file if not specified.
	Create Directory:	boolean	Creates directory if it doesn't exist.

* - denotes required

	Parameter	Type	Description
	Retry:	integer	If non-zero, will retry the operation n times at one-second intervals

* - denotes required

	Parameter	Type	Description
*	Out Document:	string	Document 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:	string	Whether 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

Name	Description
OnFailedOperation	Could not perform the operation requested.
OnNotFound	The resource was not found. This may or may not be a failure.
OnParseError	Could not parse a document.

Description - Deletes a file specified by the file source

Runtime Class - com.ibi.agents.XDPFFileOpsAgent

Parameter Groups

• Source
• Advanced Settings
• Post Action

	Parameter	Type	Description
*	File Name:	string	Originating 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:	string	Interpret 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

	Parameter	Type	Description
	Retry:	integer	If non-zero, will retry the operation n times at one-second intervals

* - denotes required

	Parameter	Type	Description
*	Out Document:	string	Document 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:	string	Whether 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

Name	Description
OnFailedOperation	Could not perform the operation requested.
OnNotFound	The resource was not found. This may or may not be a failure.
OnParseError	Could not parse a document.

Description - Creates a

Runtime Class - com.ibi.agents.XDPFFileOpsAgent

Parameter Groups

• Source
• Advanced Settings
• Post Action

	Parameter	Type	Description
*	Directory Name:	string	The directory to create.

* - denotes required

	Parameter	Type	Description
	Retry:	integer	If non-zero, will retry the operation n times at one-second intervals

* - denotes required

	Parameter	Type	Description
*	Out Document:	string	Document 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:	string	Whether 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

Name	Description
OnFailedOperation	Could not perform the operation requested.
OnNotFound	The resource was not found. This may or may not be a failure.
OnParseError	Could not parse a document.

Description - Copy a file from source to target

Runtime Class - com.ibi.agents.XDPFFileOpsAgent

Parameter Groups

• Source
• Target
• Target Settings
• Advanced Settings
• Post Action

	Parameter	Type	Description
*	File Name:	string	Source File to be copied.
*	Search Type:	string	Interpret 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

	Parameter	Type	Description
*	File Name:	string	File destination to copy the file to.

* - denotes required

	Parameter	Type	Description
	Is Directory:	boolean	Specifies whether file target is a directory. Assumes file if not specified.
	Create Directory:	boolean	Create direcory if it does not exist.

* - denotes required

	Parameter	Type	Description
	Retry:	integer	If non-zero, will retry the operation n times at one-second intervals

* - denotes required

	Parameter	Type	Description
*	Out Document:	string	Document 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:	string	Whether 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

Name	Description
OnFailedOperation	Could not perform the operation requested.
OnNotFound	The resource was not found. This may or may not be a failure.
OnParseError	Could not parse a document.

Subscribe to file connector