File Append Accumulation (com.ibi.agents.XDFileAppendAgent)

Syntax:

com.ibi.agents.XDFileAppendAgent

Description:

As information is presented to this agent, it is appended to a named file.

Parameters:

Parameter

Description

Source of Data

If empty, the input data is used. Otherwise, the source of the data to write can be specified, for example, as an xpath expression.

Destination File Path

The full path to the file where the data is to be appended. If the file is not open for the append operation, it is created or opened as appropriate.

Close File

A value that, when true, causes the file to be closed. In a streaming mode, the iFL expression _iseos() can close the file at the end of a stream, however other expressions can be used. No data is stored when this value is true.

Return

Shows what should be returned from the agent. For example:

  • status. A status document from the flow.
  • input. Emit the original input received by this agent.

Want EOS

Asks whether this agent be called at EOS. If the Close File parm is configured to test EOS, then this must be true. If another approach is used, such as detecting the end of a batch of input, then this may not need to be set to true.

Available Response Edges:

Line Edge

Description

success

The data was appended to the file.

fail_parse

Invalid iFL expression.

fail_notfound

The file path cannot be located.

fail_operation

The append operation failed.

This service agent differs from the appending agent offered by the file accumulation agent and the file ops agent, in that the target file remains open. It is the responsibility of the application to close the file, checking with the Close File configuration value set to true.