Avro File Emit Service

Syntax:

com.ibi.agents.XDAvroFileEmitAgent

Description:

This service converts an XML document into Avro binary format and writes the result in an Avro container file. The input document must follow the conventions of the XML representation documented with the Avro File Read service.

The root element in the input document can be <av:avro>, in which case multiple objects will be written to the container, one per <av:item> sub-element. If the root element is <av:item>, a single object will be written to the container. Any other root element will cause a failure. The av prefix stands for the XML Namespace http://iwaysoftware.com/avro. The actual name of the prefix is immaterial.

Avro requires the presence of a schema. The Avro File Emit service can use the schema specified in its parameter, or it can use the schema stored in the input document as the default. The only way to store a schema in the document is to use another Avro component that produces XML, for example the Avro File listener, the Avro File Read service or the Avro File Iterator service.

Parameters:

The following table describes the parameters of the Avro File Emit service.

Parameter

Description

Avro Schema

Path to the Avro Schema file. If absent, the schema stored with the document will be used.

Target Directory

The target output directory.

File Pattern

The output file name, which can contain an asterisk (*) which gets expanded to a fine timestamp.

Avoid Preemitter

Indicate which preemitter(s) should be avoided.

Return

Whether the out document will be the input document or a status document

Respect Transactionality

If set, the emit respects the transactionality of the channel. If not set, the emit is always done.

Edges:

The following table describes the edges that are returned by the Avro File Emit service.

Edge

Description

success

The Avro data was successfully converted to XML.

fail_parse

An iFL expression could not be evaluated.

fail_operation

The operation could not be completed successfully.


iWay Software