Перейти к основному содержимому

Планировщик периодических заданий

Планировщик заданий предназначен для обеспечения возможности планировать и выполнять периодические задания в соответствии с настройками.

В консоли администрирования предусмотрена возможность управления запланированными заданиями, а именно:

  • получать список задач и параметры конкретной задачи;
  • создавать, удалять, редактировать настройки задач;
  • создавать, удалять, редактировать триггеры задач;
  • создавать, удалять, редактировать действия задач;
  • получать список задач выполняемых в текущий момент;
  • запускать и останавливать задачи, при попытке запустить уже запущенную задачу выдавать сообщение о невозможности загрузки;
  • выгружать задачу в виде файла в формате JSON;
  • загружать задачу из файла с определенной структурой в формате JSON;
  • просматривать историю выполнения за период задачи/всех задач.

Для работы с сервисом планировщика заданий перейдите на страницу https://<Platform_instance_URL>/admin/ и в меню консоли администрирования выберите раздел Task Sheduler.

Регистрация периодической задачи​

Чтобы зарегистрировать периодическую задачу в консоли администрирования в разделе Task Sheduler:

  1. Перейдите в раздел Task Sheduler консоли администрирования Платформы на вкладку Tasks.
  2. Нажмите значок + под надписью Tasks .
  3. В окне Tasks:
    • введите название периодической задачи;
    • добавьте описание;
    • введите количество попыток повторного запуска;
    • введите интервал между повторными запусками в секундах;
    • отметьте флажком задачу как активную, неактивную задачу запустить нельзя;
    • отметьте флажком задачу как системную при необходимости, чтобы отдельно ее выделить, как задачу, в которую не следует вносить изменения.

3.1 задайте триггер — период выполнения задачи:

  • имя триггера;
  • начало и конец времени выполнения задачи;
  • периодичность выполнения задачи;
  • добавьте еще триггер при необходимости;
  • нажмите Add.

3.2 задайте действие (Action) — вызов метода сервиса, зарегистрированного в Платформе. Поддерживаются все типы REST API. Для вызова метода сервиса:

  • задайте имя действия;
  • выберите тип REST API;
  • выберите из выпадающего списка сервис;
  • выберите из выпадающего списка метод выбранного сервиса;
  • выберите из выпадающего списка формат тела сообщения;
  • заполните тело запроса на основании контракта выбранного метода сервиса;
  • добавьте еще действие при необходимости;
  • нажмите Add.
  1. Нажмите Create. Созданная настроенная периодическая задача будет добавлена в список задач.

Запуск периодической задачи​

Пtриодическая задача может запускаться автоматически по расписанию или вручную.

Для запуска вручную следует выбрать задачу в списке задач, нажать на нее и в карточке задачи нажать Start.

Редактирование периодической задачи​

При изменении любых параметров задачи новые параметры будут применены только при следующем запуске задачи.

История запусков периодической задачи​

История запусков всех периодических задач находится на вкладке History в разделе Task Sheduler.

История запусков выбранной периодической задачи находится на вкладке History в карточке задачи.

В истории запусков указаны: статус задачи, время начала запуска, тип триггеров, тип действия, время начала и время окончания действия.

Если запуск периодической задачи закончился с ошибкой, то при наведении на элемент Error на вкладке History или в карточке задачи будет выдана подробная информация об ошибке.