4.4 KiB
Capability: Оркестрация workflow
Purpose
Выполнять workflow из шагов приложения по явным переходам и сохранять состояние выполнения.
Границы
- В capability входят именованные шаги приложения, явные допустимые переходы и сохранение состояния запуска через переданный persistence-контракт. Бизнес-правила и подключение к БД задаёт приложение.
Requirements
Requirement: Workflow engine
ID: WF.OR-01
Workflow engine SHALL выполнять определение из именованных шагов, применять их переходы и сохранять ход запуска через persistence-контракт.
Scenario: Выполнение workflow
Участники
- Приложение, workflow engine, шаги приложения и persistence adapter.
Предусловия
- Приложение передало определение workflow, начальный шаг, контекст и адаптер сохранения.
Основной поток
- Запускаем workflow — engine сохраняет начало запуска и вызывает объект текущего шага по WF.OR-01.FR-01.
- Применяем результат шага — engine выбирает только объявленный переход и сохраняет checkpoint по WF.OR-01.FR-02.
- Достигаем конечного шага и завершаем с
WORKFLOW_COMPLETED.
Альтернативы и ошибки
- Шаг выбрасывает исключение — engine сохраняет ошибку запуска, прекращает дальнейшие шаги и передаёт исходное исключение с
WORKFLOW_STEP_FAILEDпо WF.OR-01.FR-02.
Результат
Приложение получает результат запуска и актуальный контекст workflow.
Коды завершения
| Код | Смысл | Связанные FR |
|---|---|---|
WORKFLOW_COMPLETED |
Workflow достиг конечного шага | WF.OR-01.FR-02 |
WORKFLOW_STEP_FAILED |
Шаг завершился исключением | WF.OR-01.FR-02 |
Функциональные требования
WF.OR-01.FR-01: Определение и выполнение
Приложение задаёт WorkflowDefinition с именем, начальным шагом и именованными узлами. Узел содержит WorkflowStep и карту переходов; шаг получает WorkflowContext и возвращает StepResult с переходом, обновлениями состояния и статусом. Engine исполняет только объявленные переходы и не содержит бизнес-правил приложения.
WF.OR-01.FR-02: Сохранение и ошибки
Engine сохраняет начало и итог workflow, старт и завершение каждого шага, snapshot контекста и ошибки через переданный WorkflowPersistence. Ошибка шага сохраняется и передаётся вызывающему коду; скрытые повторы и выполнение следующих шагов не допускаются. Подключение к БД для сохранения задаёт приложение.
| Код | Текст сообщения | Дальнейшее поведение |
|---|---|---|
WORKFLOW_COMPLETED |
Сообщение отсутствует | Engine возвращает итоговый context и run id |
WORKFLOW_STEP_FAILED |
Сообщение отсутствует; исходное исключение передаётся вызывающему коду | Engine сохраняет ошибку, прекращает workflow и не повторяет шаг |