Skip to main content

API Queue Management

Updated over 3 months ago

This feature provides an overall view of the training records log, detailed information regarding each record and provides the ability to reschedule any record which may not have been successful.

Important note: The API queue page is only configured for a Training Records feed, which is not SFTP.

Overview

The dropdown (far right) should you wish to review historic information (weeks). Please be advised that if you select over four weeks the bar chart will default to only show the last 30 days.

Recent activity - Shows a doughnut chart of (All activities by default are selected you can deselect by clicking on the relevant icon above the doughnut chart).

  • [New Items] - items added to the queue.

  • [API Errors] - items which are in an error state.

  • [API Retry exceeded] - items which have timed out due to being in the queue too long.

  • [Delivered] - items which have been successfully delivered to the 3rd party.

This week - Shows bar chart of daily activities (up-to 30 days in the past) (All activities by default are selected you can deselect by clicking on the relevant icon above the bar chart).

  • [New Items] - items added to the queue.

  • [API Errors] - items which are in an error state.

  • [Delivered] - items which have been successfully delivered to the 3rd party.

Task Information

  • If no task is currently scheduled to Process the API Queue, a button is displayed allowing me to schedule the task with default behaviour (retry every 5 minutes, run indefinitely)

  • if a task is scheduled

    • Scheduling information
      This section shows the name, next execution and retry period of the current task.

      • Previous executions
        This displays up-to the last 4 executions of the task and indicates if the task was successful or failed (tick or cross before the execution date/time)

API Queue - Items

  • Current Queue - renders a list of all items currently in-queue for processing (up-to 10'000), using the search you can find a specific user, domain, or training.

  • Queue Archive - renders a list of all items which have been successfully processed (up-to 10'000), using the search you can find a specific user, domain, or training.

  • Stuck in Queue - renders a list of all items which have failed to be processed (up-to 10'000), using the search you can find a specific user, domain, or training.

You can drilldown into a piece of training from the API Queue table (Current/Archive/Stuck), and have the ability to review the API Information. This will show the API Payload and API Confirmation.

API Queue - Extend and Requeue items

Current items - the overview displayed in [API Queue - item log] allows you to [Extend retry period]

  • This extends the Queued until date by 7 days from today.

Stuck items - the overview displayed in [API Queue - item log] allows you to [Requeue item]

  • This puts the training back into the "current" queue and sets the Queued until 7 days in the future.

Did this answer your question?