PF File Operations Service (com.ibi.agents.XDPFFileOpsAgent)

Syntax:

com.ibi.agents.XDPFFileOpsAgent

iIT Service Object:

misc: PF File Ops Agent

Description:

This service performs operations on the specified file(s) including copy, move, rename, prepend, append, delete, size, and exist.

Parameters:

Parameter

Description

Operation *

Command to execute when service goes active.

File (from) *

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.

File (to)

Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists.

Size

Special register designated to hold size. Required for size.

Out Document *

Document returned by operation (bad input defaults to result).

Action on Failure *

Determines whether 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 PF File Operations Service (com.ibi.agents.XDPFFileOpsAgent).

Line Edge

Description

OnError

Error

OnSuccess

Success

OnFailure

Failure

OnCustom

  • OnError
  • OnSuccess
  • OnFailure
  • fail_parse
  • fail_notfound
  • fail_operation

Example:

If running it using the move operation on a specified file, the result is:

<?xml version="1.0" encoding="UTF-8" ?>
<manager>
<status>OK</status>
<msg>Success</msg>
</manager>