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

Конфигурация шага

Конфигурация шага осуществляется через объект JobStep. Объект JobStep является частью объекта Job (Задание) и содержит следующие свойства:

  • name: Название шага.
  • messageClass: Класс сообщения, которое должно быть отправлено.
  • configuration: Настройки шага.
  • selectionMode: Режим обработки выборки в шаге.

Название (Name)​

Название шага — это строка, которая используется для идентификации шага в журнале выполнения задания (job run log).

Класс сообщения (Message class)​

Класс сообщения определяет класс того сообщения, которое будет отправлено при выполнении данного шага.

Конфигурация (Configuration)​

Конфигурация шага представляет собой массив, который может содержать любые данные, необходимые обработчику шага для его выполнения.

Кроме того, в конфигурации можно ссылаться на переменные окружения, используя следующий синтаксис: job_env('<env_variable_name>').

Режим обработки выборки (Selection Processing mode)​

Режим обработки выборки — это перечисление (enum), которое определяет, как шаг должен обрабатывать выбранные элементы:

  • SelectionProcessingMode::FOR_EACH: Шаг выполняется для каждого выбранного элемента в отдельности. Например, если в задание передано 10 выбранных элементов, сообщение будет отправлено 10 раз, и, соответственно, обработчик шага будет запущен 10 раз. Используйте метод getSubjectFromMessage() в классе AbstractAutomationActionHandler, чтобы получить доступ к текущему элементу в обработчике.
  • SelectionProcessingMode::FOR_ALL: Шаг выполняется один раз для всех выбранных элементов сразу. Например, если в задание передано 10 выбранных элементов, сообщение будет отправлено один раз, и обработчик шага выполнится единожды. Используйте метод getSubjectsFromMessage() в классе AbstractAutomationActionHandler, чтобы получить доступ ко всем элементам в обработчике..

Вы можете предложить улучшение документации или задать вопрос в комментариях.
Если вам нужна полноценная консультация — вы можете заказать её на нашем сайте.