Enqueue

Enqueues a message to a named server internal or ordered queue. Often the enqueue function is used with a Scheduler to cause a channel to take some action at a specified time.

To use enqueue, issue the following command:

enqueue  <qname> [<input>] [switches]

where:

<qname>

Is the name of an existing internal or ordered queue. Although the queue must exist, its associated listener does not need to be active or in a running state.

<input>

The input to add to the queue. If this value is omitted, a signal document (as shown in the flow command) is passed. For more information, see Flow.

Note: The input can be contained in a file. To do so, append the _file() iFL function to reference the file path. For example:

enqueue myq _file('c:/data/myinput.xml')
switches

Is a switch you can specify, which provides specific instructions for processing and handling the input/message in the queue. The following table lists and describes the switches that are supported by the enqueue command:

Switch

Applies To

Description

-xml

internal and ordered queues

The input is in XML format and will be parsed accordingly. This is the default switch for the enqueue command.

-json

internal and ordered queues

The input is in JSON format and will be parsed accordingly.

-flat

internal and ordered queues

The input is in flat format and will not be parsed or manipulated.

-priority

internal queue

Indicates the priority of the message when the target is an internal (not ordered) queue. The default priority is 4.

-key <key>

ordered batch queue

The key that identifies this message group in the ordered batch queue.

-delete

ordered batch queue

Sends the delete batch (of <key>) group in the ordered batch queue.

-end

ordered batch queue

Sends an end of batch signal, causing the batch identified by the <key> value to be released for processing.

-map <pairs>

internal and ordered queues

Adds token=value pairs to the standard signal document if used, as the parameter map.

The pairs will also be set as DOC level special registers (SREGs) in the execution environment.

This must be the last switch specified on the line. In addition, all tokens that follow this switch are considered as token=value pairs. The equal (=) and comma (,) characters are optional.

The message (or end of batch signal) will be passed to the process flow as the identified queue is processed by its associated listener.

The following is an example of issuing the enqueue command.

Enter command:>enqueue iqueue1 -map one=111<signal protocol="enqueue" timestamp="2015-04-20T13:26:29.509Z" 
type="command" version="2">
    <parms count="1">
       <parm name="one">111</parm>
    </parms>
</signal>