api.scheduler Работа с планировщиком

• api.scheduler.getStatus()

  Получение списка всех правил выполнения задачи и информации по ним (название, период в мс, дата если разовый запуск, включено или выключено) для всех задач планировщика. Информация о расписании выводится на экран в формате JSON

• api.scheduler.getStatus(uuid)

  Получение списка всех правил выполнения задачи и информации по ним (название, период в мс, дата если разовый запуск, включено или выключено) для определенной задачи планировщика .

  Параметр метода:

  • uuid — uuid задачи планировщика

• api.scheduler.getStatus(uuid, triggerName)

  Получение информации о конкретном правиле выполнения задачи (название, период в мс, дата если разовый запуск, включено или выключено) для определенной задачи планировщика.

  Параметры метода:

  • uuid — uuid задачи планировщика
  • triggerName — название правила выполнения задачи планировщика

• api.scheduler.getTriggersInfo(uuid, onlyEnabled)

  Получение информации о расписании определенной задачи планировщика (только включенные правила выполнения задачи или все).

  Параметры метода:

  • uuid — uuid задачи планировщика
  • onlyEnabled — true (возвращает только включенные правила выполнения задачи планировщика; false (аналогичен .getStatus('uuid задачи')

• api.scheduler.interruptJob(uuid)

  Прерывание выполнения задачи планировщика. Метод вызывает появление ошибки Thread Death в логах

  Параметр метода:

  • uuid — uuid задачи планировщика

• api.scheduler.run(uuid)

  Запуск задачи планировщика.

  Параметр метода:

  • uuid — uuid задачи планировщика

• api.scheduler.setTriggerDate(uuid, triggerName, date)

  Установка даты разового запуска задачи планировщика. Дата разового запуска расписания не может быть в прошлом. Действует для правил выполнения задачи с типом "Выполнение в определенную дату и время".

  Параметры метода:

  • uuid — uuid задачи планировщика
  • triggerName — название правила выполнения задачи планировщика

  • date —дата разового запуска задачи планировщика

    Дата в формате: 'dd.MM.yyyy HH:mm:ss'

    def date = utils.formatters.strToDate('str', 'dateFormat')

    Дата в формате: 'dd.MM.yyyy HH:mm'

    def date = utils.formatters.strToDateTime('str')

• api.scheduler.setTriggerPeriod(uuid, triggerName, period, strategy, startingDate)

  Установка периода для запуска задачи планировщика (1). Действует для правил выполнения задачи с типом "Периодическое выполнение". Период устанавливается в мс. Метод редактирует уже созданные триггеры.

  Параметры метода:

  • uuid — uuid задачи планировщика
  • triggerName — название правила выполнения задачи планировщика

  • period — период выполнения задачи планировщика: ежедневно, еженедельно, ежемесячно, ежегодно

    def period = 'daily'\'weekly'\'monthly'\'yearly'

  • strategy — стратегия расчета периода со старта расписания или с момента последнего запуска

    def strategy = 'from_start'\'from_last_execution'

  • startingDate — дата, с которой начнется выполнение периодического правила

• api.scheduler.setTriggerInterval(uuid, triggerName, interval, strategy, startingDate)

  Установка периода для запуска задачи планировщика (2). Действует для правил выполнения задачи с типом "Периодическое выполнение". Период устанавливается в мс. Метод редактирует уже созданные триггеры.

  Параметры метода:

  • uuid — uuid задачи планировщика
  • triggerName — название правила выполнения задачи планировщика

  • interval — интервал выполнения задачи планировщика

    def interval = api.types.newDateTimeInterval(length, interval)

    где length — число, interval — строка, возможные значения 'SECOND','MINUTE','HOUR'

    Пример. Получение интервала "раз в 3 минуты":

    def interval = api.types.newDateTimeInterval(3, 'MINUTE')

  • strategy — стратегия расчета периода со старта расписания или с момента последнего запуска

    def strategy = 'from_start'\'from_last_execution'

  • startingDate — дата, с которой начнется выполнение периодического правила

• api.scheduler.disableTrigger(triggerName)

  Выключение правила выполнения задачи планировщика.

  Параметр метода:

  • triggerName — название правила выполнения задачи планировщика

• api.scheduler.enableTrigger(triggerName)

  Включение правила выполнения задачи планировщика.

• api.scheduler.deleteTask(uuid)

  Принудительное удаление задачи планировщика. При удалении задачи "Обработка входящей почты" также удаляет необработанные сообщения, которые мешают удалению задачи.

  Параметр метода:

  • uuid — uuid задачи планировщика