Manage AMQP documents

Use the Documents tab to add and remove BOD and JSON documents and to configure queue routing for individual documents. The AMQP connector exchanges messages through configured AMQP queues. Supported document formats depend on the connector configuration and the message processing scenario.

Add documents

  1. Review the Use Default Queue for all documents check box.

    The check box is selected by default:

    • When selected, the fields are locked for manual editing, but the Consumer Default Queue address is used as the default Write to Queue address, and the Producer Default Queue Address is used as the default Read from Queue address.
    • When cleared, the default values are retained, but the fields become editable for per-document overrides. If no override is specified for a document, the default queue addresses are used.
  2. Click + Add to open the document selector.
  3. Select one or more BOD or JSON documents in the Select Documents dialog box.
  4. Click OK to add the documents.
  5. Use the check boxes to indicate whether the document is written (Write) to a queue or read (Read) from a queue.
  6. Click Save to commit the changes.

Remove documents

  1. Select the check box next to one or more documents in the list.
  2. Verify that the blue banner shows the number of selected records.
  3. Click the Delete icon.
  4. Click Save to commit the changes.

Configure per-document queue overrides

When Use Default Queue for all documents is cleared, you can specify queue routing for individual documents.

  1. Clear the Use Default Queue for all documents check box.

    The default queue values are retained, though not visible on the page, but the fields become editable.

  2. Specify this information for each document:
    Write to Queue
    Specify a queue address to override the consumer default queue address for the document.
    Read from Queue
    Specify a queue address to override the producer default queue address for the document.
    Priority
    Optionally specify a priority from 0 through 9. The default value is 4. The priority is included as a message property when the document is sent.
  3. Click Save to commit the changes.
Note: 

Each document added to the connector is identified by its registered document name and type.

  • For BOD documents, the BOD noun and verb combination serves as the identifier, for example, Sync.SalesOrder.
  • For JSON documents, the document name from the ION registry is used.

The connector uses this identification to route messages to the correct queue and to match incoming messages to the expected document schema.

When the AMQP consumer reads messages from a queue, it filters each message by its BODType (or document name for JSON documents). Only messages whose type matches a configured document with reading enabled are processed and delivered to ION.

Messages whose type does not match any configured document are handled by the configured dead-letter strategy:

  • Reject: The broker rejects the message and, if configured, routes it to the broker's dead-letter queue (DLQ).
  • Republish: The connector routes the message to the configured error queue.

If no dead-letter strategy is configured or the broker does not have a DLQ configured, the message is discarded and a warning is logged in the Message Tracker.

If a queue contains messages with multiple BODType values (for example, DA_JSON, ANYDOC_DA, and Sync.PurchaseOrder) and the connection point is configured to read only Sync.PurchaseOrder, only Sync.PurchaseOrder messages are consumed for processing. All other messages are handled by the configured dead-letter strategy.