iWay queue (ordered) - send a message
Search form
Description - Emits to the ordered transfer queue
Runtime Class - com.ibi.agents.XDOrderedEmitAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Type: string Determines the content of the message.
Select from one of the following options:
- Delete {del} - Sends a message to delete the message group
- Document {doc} - Sends a document payload
- Last Document {docend} - Sends a document payload with the end of group signal
- End Signal {end} - Sends just the end of group signal
- Keep Alive {keepalive} - Sends a signal to reset the timer for the unended group timeout
* Group Key: string Identifies the group for this message. Messages belonging to a group will execute strictly in order one after the other but concurrently with messages belonging to other groups.
Sort Key: string Determines the sort key of this message when the ordered queue sorting mode is not chronological.
* - denotes required
Parameter Type Description Respect Transactionality: boolean If set, the emit respects the transactionality of the channel. If not set, the emit is always done.
* - denotes required
Parameter Type Description * Return: string Return from this object.
Select from one of the following options:
- Response Document {response} - Returns the results of the operation.
- Status Document {status} - Returns a status document
- Input Document {input} - Return the document passed in
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDOrderedEmitAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Type: string Determines the content of the message.
Select from one of the following options:
- Delete {del} - Sends a message to delete the message group
- Document {doc} - Sends a document payload
- Last Document {docend} - Sends a document payload with the end of group signal
- End Signal {end} - Sends just the end of group signal
- Keep Alive {keepalive} - Sends a signal to reset the timer for the unended group timeout
* Group Key: string Identifies the group for this message. Messages belonging to a group will execute strictly in order one after the other but concurrently with messages belonging to other groups.
Sort Key: string Determines the sort key of this message when the ordered queue sorting mode is not chronological.
* - denotes required
Parameter Type Description Respect Transactionality: boolean If set, the emit respects the transactionality of the channel. If not set, the emit is always done.
* - denotes required
Parameter Type Description * Return: string Return from this object.
Select from one of the following options:
- Response Document {response} - Returns the results of the operation.
- Status Document {status} - Returns a status document
- Input Document {input} - Return the document passed in
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| Type: | string | Determines the content of the message.
Select from one of the following options:
|
* | Group Key: | string | Identifies the group for this message. Messages belonging to a group will execute strictly in order one after the other but concurrently with messages belonging to other groups. | Sort Key: | string | Determines the sort key of this message when the ordered queue sorting mode is not chronological. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Respect Transactionality: | boolean | If set, the emit respects the transactionality of the channel. If not set, the emit is always done. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Return: | string | Return from this object.
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| OnParseError | Could not parse a document. |
| OnNotFound | The resource was not found. This may or may not be a failure. |
| OnTimeOut | The operation timed out. |
| OnCancelled | The service has responded to a cancellation request. |
| OnNotFound | The resource was not found and this is considered an error. |
| OnFailedOperation | Could not perform the operation requested. |