File operations Service (com.ibi.agents.XDPFFileOpsAgent)

Syntax:

com.ibi.agents.XDPFFileOpsAgent

iIT Service Object:

format: File operations

Description: Performs operations on the specified file(s) including copy, move, rename, prepend, append, delete, size, and exist.

Parameters:

Parameter

Description

Operation *

The command to execute when the agent goes active.

File (from) *

The originating file to be operated on. Relative or absolute file paths are supported explicitly or through iFL.

File (from) Pattern *

Select from the pattern to use when searching for files.

  • none - the file (from) is the literal name.
  • dos - the file (from) contains only a DOS-like pattern syntax (*, ?).
  • regex - the file (from) contains full Java Regular Expression syntax.

File (to)

The destination file to be operated on. Wild cards are accepted. Required except for delete, size, and exists.

File (to) a directory name

File (to) references a directory. If it is unclear whether the path names a directory or a file name, Service Manager will assume the path names a file.

File (to) Create Directories

Creates directories if they doesn't exist. Used only for copy, move, rename, and append operations.

Size

A special register designated to hold size. Required for the size operation.

Out Document *

The document returned by the operation (bad input defaults to result).

Action on Failure *

Determines whether an input document or status document is returned on failure.

Retry

If non-zero, will retry the operation n times at one-second intervals.

Edges:

The following table lists the available Line Edges for the File operations Service (com.ibi.agents.XDPFFileOpsAgent).

Line Edge

Description

OnError

An exception occurred during execution.

OnSuccess

The operation was successful.

OnFailure

A fail condition occurred during execution.

OnFailedOperation

Could not perform the operation requested.

OnNotFound

The resource was not. This may or may not be an failure.

OnParseError

Could not parse a document.