Queue Item
The Queue Item option under the Items column offers users the ability to view detailed information about a specific work item within a queue. When clicking on a particular Queue, a dedicated window opens, providing insights into various attributes associated with that specific queue. Here's a brief explanation of the information presented in the Queue Item window:
The Name, Key and Default Strategy are displayed as a header representing the Queue details:
Name: Displays the name of the queue item, which helps identify the specific task or work item.
Key: Shows the unique identifier assigned to the queue item for programmatic reference.
Default Strategy: Indicates the default sorting strategy or priority assigned to the queue item within the queue.
The Queue Item section represents essential attributes and enabling actions such as editing, priority adjustment, and history viewing, this feature empowers users to efficiently manage and monitor the progress of individual items, contributing to streamlined and effective automation processes.
- Add Queue Item: For adding a queue through a queue item, refer Adding a queue section for detail procedure.
The Queue Item window includes a table that presents detailed information about the selected queue item. This table provides insights into the following attributes:
ID: A unique identifier for the queue item, enabling accurate tracking and reference.
Priority: Displays the priority level assigned to the queue item. Priority determines the order in which items are processed.
Status: Represents the current status of the queue item (e.g., New, In Progress, Completed).
Custom Status: Shows any custom status or stage that the item may transition through during its processing.
Created At: Indicates the timestamp when the queue item was initially created.
Next Execution: Displays the scheduled time for the next execution or processing of the queue item.
Fastrack: Provides an On/Off toggle option for Fastrack, which allows expedited processing of the item if enabled.
Action: Offers several options for managing the queue item:
- Edit: Allows users to edit the attributes and properties of the queue item. For more details refer Update Queue Item section.
- Change Priority: Permits users to modify the priority level of the item for dynamic prioritization.
- History: Provides access to the history of actions and changes associated with the queue item. For more details refer View Queue Item History section.
The Queue Item option under the Items column in the Orchestrator's Queue tab offers users a detailed view of specific work items within a queue. By presenting essential attributes and enabling actions such as editing, priority adjustment, and history viewing, this feature empowers users to efficiently manage and monitor the progress of individual items, contributing to streamlined and effective automation processes.
Add Queue Item
Here's a brief procedure for adding a queue through a queue item:
Log in to the AutomatR Orchestrator application using your credentials.
Navigate to Queues Tab >> Queue window >> Items Column >> Queue Item.
For initiating Queue Creation, locate and click on the Add button. This action will open the queue creation form.
From the Priority drop-down list, select the desired priority level for the new queue item. Choose from options like Low, Medium, or High, depending on the urgency or importance of the task.
Choose a Custom Status from the drop-down list that best represents the initial stage or status of the queue item. This status may reflect the current state of the task within your workflow.
Enter Name for the queue item in the provided Data field. This name should succinctly identify the task or work item.
Enter an integer value in the Retry Count field. This value specifies how many times the queue item should be retried in case of failure during processing.
For entering Expires On, use the date picker and time picker and select the expiration date and time for the queue item with (dd-mm-yyyy hr-min) format.
Similarly, use the date picker and time picker to enter or select the Scheduled execution date and time for the queue item. Use the (dd-mm-yyyy hr-min) format.
Take a moment to review the entered information, including Priority, Custom Status, Data Name, Retry Count, Expires On, and Scheduled At. Ensure accuracy and completeness.
Once you're satisfied with the details, click the Add button. This action will finalize the queue creation process and add the new queue item to the Orchestrator.
You will be receiving a confirmation message indicating that the queue item has been successfully added. Verify that the new queue item appears in the queue list.
You can now manage, monitor, and track the progress of the queue item within the Orchestrator's Queue tab. Use options like sorting strategies, custom statuses, and history logs to ensure efficient processing and optimization.
Note: It's important to ensure that the entered information is accurate and appropriate for the specific task. Properly setting the priority, custom status, retry count, expiration date, and scheduled execution time will help streamline the automation workflow and ensure successful task execution.
Adding a queue in the Orchestrator application involves selecting priority, custom status, providing data name, specifying retry count, setting expiration and scheduled execution times, and confirming the details before clicking the Add button. This process ensures organized and efficient management of work items within the queue, contributing to smooth automation processes.
Update Queue Item
In the AutomatR Orchestrator application's Queue tab, the Edit option under the Actions column allows users to modify and update the attributes and properties of a specific queue item. When selecting the Edit option, a form opens, presenting users with a set of options to adjust and fine-tune various aspects of the selected queue item. Here's a concise explanation of the information and options available within the Edit form:
Priority: The drop-down feature allows users to select a new priority level for the queue item. Priority determines the order in which items are processed, with options such as Low, Medium, and High.
Custom Status: Enables users to assign a custom status or stage to the queue item. Custom statuses provide insights into the current stage of processing, with options like New, In Progress, Received, Working, Done, and additional user-defined custom options.
Data: Enter a name for the queue item. This name serves as an identifier or description for the specific task.
Retry Count: Allows users to specify the number of times the queue item should be retried in case of failure during processing. Accepts only integer values.
Expires On: Enables users to set an expiration date for the queue item. After the specified date, the item may be considered outdated and no longer processed.
Scheduled At: Permits users to schedule a specific execution time for the queue item. This option is useful for precise timing and coordination of task processing.
Update: After adjusting the desired attributes and properties within the Edit form, users need to click the Update option. This action applies the changes made to the queue item, ensuring that the modified settings take effect.
The Edit option under the Actions column empowers users to modify and fine-tune the attributes and properties of specific queue items. By offering options to adjust priority, assign custom statuses, update data fields, set retry counts, and schedule processing times, this feature enhances the flexibility and adaptability of automation workflows. After making the necessary adjustments, users can click the Update option to apply the changes and ensure optimal management of queue items within the Orchestrator environment.
View Queue Item History
In the AutomatR Orchestrator application's Queue tab, the History option under the Actions column provides users with insights into the historical actions and changes associated with a specific queue item. When selecting the History option, a dedicated window opens, displaying a comprehensive table of events related to the selected queue item. Here's a brief explanation of the information and options available within the History window:
History Window:
The History window presents a table that offers a detailed overview of past actions and modifications made to the selected queue item. The table includes the following columns:
Action: Displays the type of action that occurred, such as Added, updated, expired or other relevant events.
Changed by API or Name of the User: Indicates the source of the change. This column may display either the name of the user who initiated the action or an indication that the change was made through an API call.
Changed On: Presents the timestamp when the action or change took place.
Info (Information Details): By clicking on the info icon, users can access additional detailed information about the specific action or change. The information details window provides insights into attributes such as:
- Action: The nature of the action (e.g., updated, expired, etc.).
- Changed By Name/Type: The name of the user who made the change or the type of API that triggered the change.
- Custom Status: Any custom status assigned during the action.
- Priority: The new priority assigned.
- Status Name: The new status name after the change.
- Retry Count: The updated retry count, if changed.
- Failures Count: The count of failures associated with the item.
- Changed On: The timestamp of the specific change.
The History option under the Actions column in the Orchestrator's Queue tab offers users a comprehensive history log of actions and modifications associated with a specific queue item. By providing detailed information, transparency, and an audit trail of changes, this feature enables users to effectively track the lifecycle of the queue item and make informed decisions regarding its management and processing within the Orchestrator environment.