Queue
Monitoring queue records of background jobs, examining the content of failed jobs, and requeuing with corrected body.
The Job queue screen lists records of background jobs run by the system (such as order or customer integration messages). You can track here whether a job has entered the queue, whether it has been processed, or if it encountered an error. You can examine the content of a failed job and, if necessary, correct the content and requeue the job. This screen is typically used by operations and support teams investigating integration issues.
Accessing the screen
Navigate via the menu: OMS – Order Management › Setup › Queue. If you do not see it in the menu, your account does not have permission for this screen.
Screen sections
- Header: Job queue with the description "Records of background jobs." below.
- Filter area: date range, key, and status fields; with Clear and Filter buttons below.
- List: queue records. Above the list are the Per page selection, refresh button, and Columns menu.
- Note: below the list, a brief note reminding that the date range is required and the key matches exactly.
- Record drawer: a panel that opens from the right when you click a row. The list remains open behind.
Filtering and searching
| Field | Purpose | Tip |
|---|---|---|
| Date range | Filters records by the selected date range. The start day covers from 00:00, the end day until 23:59. | If left empty, records from yesterday and today (approximately the last 24 hours) are fetched; in this case, the date fields appear empty. For older records, select the range yourself. |
| Key | Searches by the job's search key (e.g., order number or customer number). | The value must match exactly; partial numbers will not return results. |
| Status | Returns only records with the selected status. | Default is All. Options: Created, Wait, Completed, Error. |
Filters are not applied until you press the Filter button (or press Enter in a field); if there are modified but unapplied filters, the Filter button is highlighted. Clear resets all filters and immediately reloads the list with the default range.
Tip: The queue table is very busy. Wide date ranges may respond slowly; if you know the time of the job you are looking for, keep the range narrow and search with Key if possible.
List
| Column | Meaning |
|---|---|
| Identity | The queue record number. |
| Job | The job name (which background job it is). This column cannot be hidden. |
| Key | The job's primary search key; usually the related order or customer number. |
| Created | The date and time the record entered the queue. |
| Status | The job's current status, shown with a colored badge (see Statuses). |
| Processed | The date and time the job was processed; if not yet processed, shows —. |
- Page size can be 25, 50, or 100; default is 25.
- You can hide or show columns from the Columns menu; your selection is saved in your browser.
- Clicking column headers does not sort.
- Navigate pages using the page buttons below the list. The refresh button above reloads the list with the same filters.
- Clicking a row or selecting Open detail from the three-dot menu at the row end opens the record drawer.
Record drawer
The drawer's title is in the format Queue record #<number>. The open record's number is also written in the page URL; if you share the URL while the drawer is open, the recipient sees the same record. Closing the drawer with Close keeps the list in place.
Record fields
| Field | Description |
|---|---|
| Identity | The queue record number. |
| Job | The job name. |
| Supplier | Supplier information linked to the record. |
| Key 1, Key 2, Key 3 | The job's search keys. The Key column in the list corresponds to Key 1. |
| Status | The job's current status. |
| Created | The time the record entered the queue. |
| Next process | The next scheduled processing time for the job. |
| Processed | The time the job was processed. |
Empty fields appear as —.
Queue body and result
- Queue body: the content carried by the job. If the content is JSON, it is displayed indented for readability.
- Result value and Result message: the result and message written to the record when the job is processed. When examining a failed job, first check the Result message field. These two fields are read-only and are not sent when requeuing.
Actions
Opening the record logs
If the record's Key 1 value is filled, a Show logs link appears below the record fields. This link opens ComHub logs filtered by this key in a new tab. This allows you to examine integration activity for the same order or customer side-by-side with the queue record.
Save and requeue
Used to rerun a job that has failed or needs to be retried, with the same or corrected content.
- Open the record from the list.
- If necessary, correct the content in the Queue body field. To discard your changes, press the Undo changes button; this button only appears if you have modified the body.
- Optionally, write why you are requeuing in the Note field (up to 500 characters, not required).
- Press the Save and requeue button.
- In the opened Requeue the record? window, verify the job name and key. The window reminds you that a new queue record will be created with this body and the order/customer integration will be retried.
- To confirm, press the Save and requeue button in the window; to cancel, press Cancel. While processing, the button shows Saving….
Result:
- A notification "Requeued: #<number>" appears; the number is the new record number.
- The list refreshes and the drawer shows the new record.
- The old record remains unchanged; history is preserved.
- If the operation fails, the confirmation window closes, an error message appears at the top of the drawer, and your edited body remains. You can read the error and try again.
Notes:
- Requeuing cannot be undone; the job will run again and integration may be sent again to the other side. Do not requeue the same job multiple times in a row.
- If the Queue body is empty, a Required field warning appears below the field and the button is disabled.
- If the body is JSON when first opened, the edited version must also be valid JSON. Otherwise, a The body is not valid JSON warning appears and the button remains disabled.
- If you do not have permission to requeue, the body is read-only and below the field it says "You do not have permission to requeue; the body is read-only." The Note field and button are not visible.
Statuses
| Status (text on screen) | Meaning | Next step |
|---|---|---|
Created (blue) |
The job was queued but not yet processed. | Check later to see if the status has changed. |
Wait (yellow) |
The job is waiting. | Open the record and check the Next process time. |
Completed (green) |
The job completed successfully. | No action needed. |
Error (red) |
The job encountered an error. | Open the record, examine the Result message and logs via Show logs; if you need to fix the cause, correct the body and requeue. |
If you see a status code other than these in the list, it is shown as is with a blue badge.
Common situations
- The list is empty, it says "No records found." When date fields are empty, the list covers only the last 24 hours (yesterday and today). If the job you are looking for is older, expand the Date range and press Filter. If you used Key, ensure the value is exact and correct; partial search is not supported.
- I changed the filter but the list did not change. Filters apply when you press the Filter button. A highlighted Filter button indicates unapplied changes.
- The list loads very slowly. Narrow the date range and search with Key if possible.
- The drawer says "Something went wrong." The record could not be read. Retry with Retry; if the problem persists, notify your system administrator.
- I do not see the Save and requeue button. Your account lacks permission to requeue; you can only view the record.
- I requeued but the old record is still
Error. This is expected behavior: the operation creates a new record. Follow the result by the status of the new record indicated in the notification.