File read (com.ibi.agents.XDPFFileReadAgent)

Syntax:

com.ibi.agents.XDPFFileReadAgent

iIT Service Object:

format: File read

Description:

Embeds a specified binary, xml or text file in the input document

Parameters:

Parameter

Description

Name of File *

The f ile to be read. Relative or absolute file paths are supported explicitly or through a SREG or XPath expression evaluated using the incoming document.

Delete After Read

Determines whether the file is deleted on a successful read.

Format

Format of the input data. Select one of the following options from the drop-down list:

  • flat (default)
  • XML
  • json
  • stream

Tag

The name of the node in which to wrap the data read, in flat format.

Character Set Encoding

The character set encoding to be performed on input. Base 64 is required for flat binary data.

Base64 Encode *

Base64 encode the read in document when embedding.

Embed *

Determines whether to embed the data from the read operation into the input document.

Parent Tag

Determines where in the input document the input data should be embedded.

Retry

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

Edges:

The following table lists the available Line Edge for the File read (com.ibi.agents.XDPFFileReadAgent).

Line Edge

Description

OnError

An exception occurred during execution.

OnSuccess

The operation was successful.

OnFailure

A fail condition occurred during execution.

OnParseError

Could not parse a document.

OnFailedOperation

Could not perform the operation requested.

OnNotFound

The resource was not found and this is considered an error.