PutAMQP

Accepts IDOL documents and generates messages which are then sent to one or more AMQP message brokers.

NOTE: This processor supports AMQP v1.0 only.

Properties

Name Default Value Description
IDOL License Service  

An IdolLicenseServiceImpl that provides a way to communicate with an IDOL License Server.

Document Registry Service   A DocumentRegistryServiceImpl controller service that manages and updates a document registry database. This ensures that documents are indexed in the correct order.
Indexer Batch Size 100

The maximum number of FlowFiles to accumulate before indexing documents.

Indexing documents in larger batches can be more efficient; indexing smaller batches more frequently means that an individual document might spend less time in the queue.

Documents might be indexed in incomplete batches if the Indexing Interval Duration is reached first.

Indexing Interval Duration 5 min

The maximum amount of time to wait between indexing batches of documents. Documents might be indexed more frequently than this if the Indexer Batch Size is reached first.

Waiting longer and indexing documents in larger batches can be more efficient; indexing smaller batches more frequently means that an individual document might spend less time in the queue.

Brokers   A comma-separated list of AMQP brokers in the format host:port.
Truststore Filename   The location of a certificate to use to validate the certificate provided by the broker. The certificate can be in PEM format.
Username   The user name to use to authenticate with the brokers.
Password   The password to use to authenticate with the brokers.
Queue   The name of the message queue to write to.
Key Field Path   The path of the field in the IDOL document metadata to use as the message key. You can select a sub-field by using slash-separated field names such as FieldName/SubFieldName.
Value Field Path   The path of the field in the IDOL document metadata to use as the message body. You can select a sub-field by using slash-separated field names such as FieldName/SubFieldName.
Metadata Mapping Mode Full

Specifies how to convert document metadata into message headers:

  • Full - Document metadata is converted into message headers. The header names are full XPath-like indexed field paths, for example FIELD1[1]/@attr.
  • Simple - Document metadata is converted into message headers. The header names are generated without the indexes, for example FIELD1_attr.
  • None - Document metadata is not converted by default. Use "Header Field Names" and "Header Field Paths" instead.
Header Field Names
Header Field Paths
 

You can use these properties to map IDOL document fields to message headers. If you want to set these properties, OpenText recommends using the guided setup wizard (click ADVANCED and follow the instructions on the GUIDED SETUP tab).

  • IDOL document metadata field paths are slash-separated and can reference attributes using the "@" character. For example, to reference an attribute called "name" on a field named "MyField", enter MyField/@name.
  • The header name can contain placeholders, $1, $2, ... $N that correspond to the Nth asterisk wildcard (*) in the corresponding IDOL document metadata field path.
  • An asterisk wildcard (*) that is used in a path can match only a whole field name or attribute name.

Relationships

Name Description
success FlowFiles that were indexed successfully.
failure FlowFiles that failed to be indexed.