Модуль "Задачи процесса"

Описание

Предназначен для управления запланированными задачами в рамках процесса. Доступен в карточке процесса.

process task card process
рис. 1. Общий вид
process task controls
рис. 2. Элементы управления
process task create task form
рис. 3. Форма добавления задачи

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

Включение вкладки в процессе
processTaskShow=1
Включение шага мастера
step=1
{@inc:step}
createWizard.step.{@step}.title=<div class="h4 mt-4">Планирование задач:</div>
createWizard.step.{@step}.class=ru.bgcrm.core.task.process.wizard.ProcessTaskStep

API

Класс:

ru.bgcrm.core.task.process.struts.ProcessTaskAction

Создание задачи процесса

method: createProcessTask

url: /user/processTask.do?action=createProcessTask&processId=:processId&taskId=:taskId&config=:config&scheduledTime=:scheduledTime&maxRetries=:maxRetries

Входные параметры
Название Обязателен Описание

processId

Да

ID процесса

taskId

Да

ID задачи процесса

config

Да, по-умолчанию пустая строка

Конфиг задачи

scheduledTime

Да

Запланированное время задачи процесса

maxRetries

Нет, по-умолчанию 0

Максимальное количество попыток

Ответ
{
  "id": 1,
  "processId": 12345,
  "task": {
    "id": 3,
    "title": "Задача №2",
    "type": "zadacha2",
    "clazz": "test_class",
    "script": "",
    "enabled": true
  },
  "config": "",
  "scheduledTime": 1697137200000,
  "executedTime": null,
  "status": "PENDING",
  "retries": 0,
  "result": null,
  "maxRetries": 1,
  "cancellable": true
}

Отмена задачи процесса

method: cancelProcessTask

url: /user/processTask.do?action=cancelProcessTask&id=:id

Входные параметры
Название Обязателен Описание

id

Да

ID задачи процесса

Ответ
{
  "id": 1,
  "processId": 12345,
  "task": {
    "id": 3,
    "title": "Задача №2",
    "type": "zadacha2",
    "clazz": "test_class",
    "script": "",
    "enabled": true
  },
  "config": "",
  "scheduledTime": 1689002617000,
  "executedTime": null,
  "status": "CANCELLED",
  "retries": 0,
  "result": null,
  "maxRetries": 1,
  "cancellable": true
}

Получение задачи процесса по ID задачи

method: getProcessTaskById

url: /user/processTask.do?action=getProcessTaskById&id=:id

Входные параметры
Название Обязателен Описание

id

Да

ID задачи процесса

Ответ
{
  "id": 1,
  "processId": 12345,
  "task": {
    "id": 3,
    "title": "Задача №2",
    "type": "zadacha2",
    "clazz": "test_class",
    "script": "",
    "enabled": true
  },
  "config": "",
  "scheduledTime": 1689002617000,
  "executedTime": null,
  "status": "CANCELLED",
  "retries": 0,
  "result": null,
  "maxRetries": 1,
  "cancellable": true
}

Поиск задач процесса

метод: searchProcessTasks

url: /user/processTask.do?action=searchProcessTasks&pageIndex=:pageIndex&pageSize=:pageSize&processId=:processId&taskId=:taskId&statuses=:statuses&scheduledTime=:scheduledTime&executedTime=:executedTime&cancellable=:cancellable

Входные параметры
Название Обязателен Описание

processId

Нет

ID процесса

taskId

Нет

ID задачи

statuses

Нет

Статусы

scheduledTime

Нет

Период времени планирования

executedTime

Нет

Период времени выполнения

cancellable

Нет

Отменяемая задача

Ответ
{
  "tasks": [
    {
      "id": 1,
      "processId": 123456,
      "task": {
        "id": 3,
        "title": "Задача №2",
        "type": "zadacha2",
        "clazz": "test_class",
        "script": "",
        "enabled": true
      },
      "config": "12213",
      "scheduledTime": 1689002617000,
      "executedTime": null,
      "status": "PENDING",
      "retries": 0,
      "result": null,
      "maxRetries": 1,
      "cancellable": true
    }
  ]
}