Руководство администратора Workflow

НАЧАЛО >> Workflow >> Руководство администратора Workflow📄 Скачать в DOCX

1. Где настраивать

Настройки Workflow доступны в АРМ Администратор:

Проекты Workflow - проектная область и привязка к типам записей;
Workflow - рабочие процессы;
из карточки workflow открываются статусы, переходы, экраны, фильтры, представления и схемы.

Системные записи можно просматривать, но обычно нельзя изменять. Для изменения поставляемого сценария сначала создайте копию проекта.

2. Рекомендуемый порядок настройки

Создайте или выберите Workflow.
Создайте статусы в WorkflowStatus.
Создайте переходы в WorkflowTransition.
Назначьте право ALLOWAPPLY на каждый переход тем группам, которые должны видеть и выполнять соответствующую кнопку.
Если переход должен запросить данные, создайте WorkflowScreen и укажите схему he3: .ws для полного набора полей или .wss для нескольких подполей одного поля.
При необходимости настройте WorkflowScreenScheme.
Создайте фильтры списков в WorkflowFilter.
Свяжите страницы и фильтры в WorkflowFilterScheme.
Создайте представления списков и карточек в WorkflowView.
Свяжите страницы и представления в WorkflowViewScheme.
Создайте или настройте WorkflowProject: укажите проектные типы объектов, workflow, начальный статус, схемы и fallback-соответствия v920.

3. Проект

В проекте задаются:

ключ и название проекта;
начальный статус для записей без поля 113;
workflow по умолчанию;
схемы экранов, фильтров и представлений по умолчанию;
проектные типы объектов;
таблица v920 -> workflow;
поле, подполе и поисковый префикс идентификатора записи;
переопределения схем для отдельных типов записей.

Для каждого физического типа записи важно указать стабильный v920: он определяет модуль-владелец и ObjectData-класс записи. Если внутри проекта нужны разные процессные типы одного v920, заведите строки в таблице Типы объектов проекта; выбранный тип будет храниться в 113^I.

4. Статусы

Статусы должны иметь числовой код, понятное название и порядок сортировки. Один статус обычно помечается как начальный, финальные статусы помечаются признаком Финальный статус.

Поле Статус для API объединяет внутренние статусы в укрупненные внешние состояния. Например, несколько внутренних завершенных статусов можно показывать наружу как Выполнено.

Координаты карты заполняются автоматически при перемещении прямоугольников на карте workflow.

5. Переходы

Для перехода обязательно задаются:

workflow;
ключ перехода;
название кнопки;
исходные статусы;
целевой статус или признак Оставлять текущий статус;
право ALLOWAPPLY на запись перехода.

Название кнопки должно описывать действие пользователя: Редактировать ответ, Отправить ответ, Взять в работу, а не только название целевого статуса.

Если переход не меняет статус, включите Оставлять текущий статус. Такие переходы используются для вспомогательных действий: назначить ответственного, добавить наблюдателя, обновить данные записи.

6. Condition

Condition задается именем формата. Формат должен вернуть разрешающее значение. Если формат возвращает пусто, 0, false или нет, переход не показывается и не выполняется.

Используйте condition для логической доступности действия, например:

показывать кнопку только автору записи;
скрывать действие, если уже нет подготовленных данных;
показывать действие только при заполненных обязательных полях.

7. Экраны

Экран Workflow нужен, если перед переходом пользователь должен заполнить данные. В записи WorkflowScreen указывается схема he3. В переходе выбирается ключ экрана.

Используйте тип WS, если экран должен редактировать одно или несколько полей записи целиком. Используйте тип WSS, если действие должно изменить только отдельные подполя одного поля: в этом случае дополнительно укажите номер поля записи. При сохранении WSS-экран не удаляет остальные подполя этого поля.

Если экран не указан, переход выполняется сразу после подтверждения или нажатия кнопки.

8. Фильтры и представления

Фильтр отвечает за выборку записей, представление - за внешний вид списка или карточки.

Для страницы списка обычно нужны:

WorkflowFilter с базовым поиском и статусами;
WorkflowFilterScheme, где pageKey связан с фильтром;
WorkflowView типа list с колонками;
WorkflowViewScheme, где тот же pageKey связан с представлением.

Для страницы карточки обычно нужен WorkflowView типа detail и строка в WorkflowViewScheme.

Состав верхней навигации задается в WorkflowViewScheme: каждая строка схемы связывает pageKey с представлением. В WorkflowView настраиваются только параметры показа этого пункта: группа навигации, порядок, признак показа, тип страницы, canonical route и badge-фильтр. Если рядом с пунктом нужен счетчик, выберите Фильтр badge навигации; количество будет считаться по этому WorkflowFilter.

Для внешней страницы, которая не является списком или карточкой, но должна быть в той же навигации, создайте WorkflowView типа Страница навигации. Такая запись используется только как пункт меню, а сама прикладная .page может вызвать WorkflowView::RenderConfiguredNavigation().

9. Карта Workflow

Карта открывается из редактора workflow. На ней можно просматривать статусы и переходы, перемещать статусы, открывать редакторы статусов и переходов, добавлять и удалять элементы, если есть права на редактирование.

Цвет статуса определяется укрупненным статусом для API:

Статус для API	Цветовой смысл
`0` - новое	серый
`1` - в работе	синий
`2` - выполнено	зеленый
`3` - отклонено	красный

10. Проверка настройки

После настройки проверьте:

у проекта выбран workflow и начальный статус;
проектные типы объектов ссылаются на существующие workflow и схемы;
для каждого v920 выбраны нужные схемы;
у workflow есть активные статусы;
у переходов корректные исходные и целевые статусы;
права ALLOWAPPLY назначены на записи переходов;
condition-форматы возвращают ожидаемые значения;
рабочие листы экранов существуют;
фильтры возвращают записи;
pageKey совпадает в схемах фильтров и представлений;
нужные страницы добавлены в WorkflowViewScheme, а у связанных представлений заполнена группа навигации, если требуется верхнее меню;
карточка содержит секцию действий Workflow.

Меню