The Queues Page
| Field | Description |
|---|---|
| Search | Looks for queues that match your input. Searches according to queue name and description. |
| Has Trigger | Enables you to filter queues according to whether or not they have triggers. The following options are available: All No Yes |
| Reset to defaults | This button is displayed only if you made changes to any of the filters described above, and enables you to return to the default settings. Please note that this button also resets the number of items displayed per page. |
Add | Opens the Add Queue window, which enables you to create a new queue. |
| Name | The name of the queue. The maximum value is 50 characters. |
| Description | The description of the queue. The maximum value is 250 characters. |
| In Progress | The number of queue items that are currently being processed, and have the In Progress status. |
| Remaining | The number of queue items that have not been processed yet, and have the New status. |
| Average Time | The average time that was required to process the queue items, expressed in seconds. |
| Successful | The total number of transactions that were processed successfully. |
| App Exception | The total number of transactions that failed with an application exception. |
| Biz Exceptions | The total number of transactions that failed with a business exception. |
| Process | The process to be launched by an associated Trigger. |
| More Actions | Displays a menu with the following options: Edit - enables you to edit the queue description on the Update Queue window. View Transactions - displays the transactions of the corresponding queue, in the Transactions page. Add / Edit Trigger - displays the Add Trigger or Edit Trigger window on the Triggers page. Monitor Queue - displays the Monitoring page for the corresponding queue. View Chart - displays a line chart of the transaction status evolution over a specific amount of time for the corresponding queue, in the Chart window. Upload Items - displays the Upload Items page for the corresponding queue. Remove - deletes the corresponding queue. Assigned transactions belonging to the queue are no longer visible in the Review Requests page. |
The Create Queue Window
| Field | Description |
|---|---|
| Name | Mandatory. The name of the queue (this name is used in Studio to identify the queue you want to work with). |
| Description | Optional. The description of your queue. |
| Unique Reference | Optional. Enables you to enforce unique references in all the transactions that are to be added to the queue, by selecting the Yes button. If the No button is selected, then the queue can contain transactions with duplicate references. This option cannot be edited, and displays if the current queue enforces unique references or not. |
| Auto Retry | Mandatory. Indicates if Orchestrator should retry to process items in the queue when an Application Exception is encountered. Yes or No are the available options. If you select No, the Max # of retries field is no longer displayed. |
| Max # of Retries | Mandatory. The number of times Orchestrator should retry to process an item when an Application Exception is encountered. By default, the value is 1. The maximum number of retries is 50. |
| Specific Data JSON Schema | Optional. File size limited to 256kb by default. Enables you to upload a JSON schema for the specific data of all transactions in the queue. All transactions added to the queue must adhere to the schema or an error will be triggered and the request to add the transaction will fail. Note: The uploaded schema is not enforced retroactively, existing transaction items are not affected. |
| Output Data JSON Schema | Optional. File size limited to 256kb by default. Enables you to upload a JSON schema for the output data of all transactions in the queue. If a transaction status is set to Successful but its output data violates the schema, then the transaction will fail with a Business Exception. |
| Analytics Data JSON Schema | Optional. File size limited to 256kb by default. Enables you to upload a JSON schema for the analytics data generated when a transaction status is set to Successful. If a transaction status is set to Successful but its analytics data violates the schema, then the transaction will fail with a Business Exception. |
| Enable SLA for this queue Toggle | Optional. Used to enable SLA predictions for the current queue. If enabled, you must also set the following parameters: Process - the process that will handle the queue items. SLA - the value in Days and Hours of the item deadline. The maximum value is 90 days. |
| Risk SLA | Optional. Only available if you selected Enable SLA for this queue. Used to define a time frame before the SLA expiration where the queue items are deemed at risk of not meeting the deadline. If enabled, you must also set the Days and Hours of the Risk SLA, keeping in mind that it must be smaller than the defined SLA. |
The Chart Window
| Field | Description |
|---|---|
| Business Exceptions | The average time that was required to process transactions that failed with a business exception, expressed in seconds. |
| Application Exceptions | The average time that was required to process transactions that failed with an application exception, expressed in seconds. |
| Successful Transactions | The average time that was required to process successful transactions, expressed in seconds. |
| Time Period | Display transaction information in the chart for the: Last hour Last day Last week Last 30 days |
| Transaction Status Filter | Remove or add a transaction status filter from the chart, by clicking it. The following options are available: Successful Application Exception Business Exception Total |
The Upload Items Window
| Field | Description |
|---|---|
| Browse | Enables you to select the .csv file you want to upload. |
| Process All Independently | Processes all items individually and adds them to the queue, if successful. If not, it returns a list of those whose processing failed. You have the option to download the list into a .csv file. |
| All or Nothing | Adds the items only if all of them are successfully processed. Otherwise none is added. |
| Cancel | Cancel the upload activity and return to the Queues page. |
| Upload | Has two purposes: Uploads the .csv file into your Orchestrator instance, if the file is compliant with the supported formatting rules. Uploads the items into the corresponding queue, according to the selected upload strategy. |
| Download | Enables you to download a .csv file containing the unprocessed rows in the initially uploaded file. Only displayed if there are unprocessed items when using the Process All Independently upload strategy. |
Updated 2 years ago