Функции могут быть вызваны как UseModule("WorkflowApproval")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| CancelRequest | Отмена запроса согласования
 Подробнее...
Переводит WorkflowApprovalRequest в состояние cancelled, отменяет ожидание продолжения перехода и пишет запись в историю 907. Доменная запись при этом не изменяется. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalRequest | $request | '' | Запрос согласования | | string | $reason | '' | Причина отмены | | array | $options | 'array()' | Контекст пользователя и сохранения |
|
| CreateGate | Создание правила согласования
Подробнее...
Создает несохраненный объект ObjectDataWorkflowApprovalGate по переданным параметрам. Сохранение выполняется отдельной функцией SaveGateDefinition. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow | | string | $key | '' | Ключ правила согласования | | string | $title | '' | Название правила согласования | | string | $active | '1' | Флаг активности | | string | $mode | 'required' | Режим правила: required, conditional, informational или disabled | | string | $policyKey | '' | Ключ политики согласования | | array | $settings | 'array()' | Дополнительные параметры правила согласования |
|
| CreatePolicy | Создание политики согласования
Подробнее...
Создает несохраненный объект ObjectDataWorkflowApprovalPolicy: тип согласования, участников, кворум, шаги и правила повторных решений. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow | | string | $key | '' | Ключ политики согласования | | string | $title | '' | Название политики согласования | | string | $active | '1' | Флаг активности | | string | $policyType | 'anyOne' | Тип политики: anyOne, allParticipants, quorum или sequence | | array | $participants | 'array()' | Описание источников участников | | array | $settings | 'array()' | Дополнительные параметры политики согласования |
|
| CreateRequestDraft | Создание черновика запроса согласования
Подробнее...
Создает несохраненный WorkflowApprovalRequest для конкретного workflow-перехода: фиксирует безопасный снимок данных экрана, участников, идентификатор записи, ключ идемпотентности и параметры продолжения перехода. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalGate | $gate | '' | Правило согласования перехода | | ObjectDataWorkflowApprovalPolicy | $policy | '' | Политика согласования правила | | ObjectDataDatabase | $db | '' | БД доменной записи | | ObjectDataRecord | $record | '' | Доменная запись, над которой выполняется переход | | array | $owner | 'array()' | Контекст владельца workflow-состояния | | ObjectDataWorkflowTransition | $transition | '' | Переход Workflow | | array | $options | 'array()' | Параметры запуска перехода и данные экрана |
|
| DelegateDecision | Делегирование решения согласования
Подробнее...
Переносит право решения по запросу согласования от одного участника к другому, фиксирует делегирование во вложенной секции запроса и пишет историю 907. Проверка прав и определение получателя остаются контрактами Security/Users. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalRequest | $request | '' | Запрос согласования | | string | $fromParticipantKey | '' | Исходный участник | | string | $toParticipantKey | '' | Новый участник в формате user:key, group:key или role:key | | string | $reason | '' | Причина делегирования | | array | $options | 'array()' | Контекст политики, пользователя и сохранения |
|
| ExplainGate | Объяснение правила согласования перехода
Подробнее...
Возвращает диагностическое объяснение: найдено ли правило согласования, какая политика используется, требуется ли согласование, кто будет участником и почему переход может продолжиться без запроса согласования. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataDatabase | $db | '' | БД доменной записи | | ObjectDataRecord | $record | '' | Доменная запись | | ObjectDataWorkflowTransition | $transition | '' | Переход Workflow | | array | $options | 'array()' | Контекст запуска перехода |
|
| GetGateByKey | Получение правила согласования по ключу
Подробнее...
Находит запись WorkflowApprovalGate по паре workflowKey + gateKey и возвращает объектную обертку ObjectDataWorkflowApprovalGate. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow | | string | $gateKey | '' | Ключ правила согласования внутри workflow | | bool | $activeOnly | 'true' | Не возвращать отключенное правило согласования |
|
| GetGateSelectList | Список правил согласования для редактора
Подробнее...
Формирует список выбора правила согласования для редактора перехода Workflow с вариантом Без согласования. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow | | string | $selectedKey | '' | Текущее выбранное значение |
|
| GetGates | Получение правил согласования Workflow
Подробнее...
Возвращает записи WorkflowApprovalGate для указанного workflow. Функция используется редакторами, импортом и проверкой переходов во время выполнения. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow. Если пусто, возвращаются правила согласования всех workflow | | bool | $activeOnly | 'true' | Возвращать только активные правила согласования |
|
| GetPolicies | Получение политик согласования Workflow
Подробнее...
Возвращает записи WorkflowApprovalPolicy для указанного workflow. Политика определяет участников, кворум, последовательность шагов и правила принятия решений. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow. Если пусто, возвращаются политики согласования всех workflow | | bool | $activeOnly | 'true' | Возвращать только активные политики согласования |
|
| GetPolicyByKey | Получение политики согласования по ключу
Подробнее...
Находит запись WorkflowApprovalPolicy по паре workflowKey + policyKey и возвращает объектную обертку ObjectDataWorkflowApprovalPolicy. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow | | string | $policyKey | '' | Ключ политики согласования внутри workflow | | bool | $activeOnly | 'true' | Не возвращать отключенную политику согласования |
|
| GetPolicySelectList | Список политик согласования для редактора
Подробнее...
Формирует список выбора политики согласования для редактора правила согласования. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow | | string | $selectedKey | '' | Текущее выбранное значение |
|
| GetRequestByKey | Получение запроса согласования по ключу
Подробнее...
Находит запрос согласования WorkflowApprovalRequest по его стабильному ключу и возвращает объектную обертку. | | Тип | Параметр | По умолчанию | Описание | | string | $requestKey | '' | Ключ запроса согласования |
|
| GetRequestDiagnostics | Безопасная диагностика запроса согласования
Подробнее...
Возвращает безопасное представление WorkflowApprovalRequest: статус, прогресс решений, состояние продолжения перехода и ссылки на workflow-сущности без раскрытия скрытой полезной нагрузки. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalRequest | $request | '' | Запрос согласования |
|
| GetSystemDefinitions | Чтение системных определений WorkflowApproval
Подробнее...
Возвращает системный JSON-контракт WorkflowApproval: политики, правила согласования, определения участников, профили событий и тестовые наборы. Функция используется HealthCheck, TestA и setup-сценариями. | Отсутствуют |
| GetWhereUsed | Поиск использования WorkflowApproval
Подробнее...
Ищет использование правила или политики согласования в переходах WorkflowTransition и активных WorkflowApprovalRequest. Используется перед удалением, деактивацией и публикацией конфигурации. | | Тип | Параметр | По умолчанию | Описание | | string | $workflowKey | '' | Ключ workflow | | string | $key | '' | Ключ правила или политики согласования | | string | $kind | 'gate' | Тип проверки: правило или политика согласования |
|
| HealthCheckDefinitions | HealthCheck определений WorkflowApproval
Подробнее...
Проверяет системный JSON WorkflowApproval: наличие файла, валидность разделов, уникальность ключей политик и правил согласования, корректность ссылок правил на политики и базовые ссылки на экраны. | | Тип | Параметр | По умолчанию | Описание | | array|null | $definition | 'null' | Определение WorkflowApproval. Если не передано, читается системный JSON модуля |
|
| PrepareTransitionApproval | Подготовка согласования перехода Workflow
Подробнее...
Проверяет правило согласования перехода. Если согласование не требуется, разрешает Workflow продолжить переход. Если требуется, создает или находит ожидающий запрос согласования и возвращает approvalRequired без изменения доменной записи. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataDatabase | $db | '' | БД доменной записи | | ObjectDataRecord | $record | '' | Доменная запись | | array | $owner | 'array()' | Контекст владельца workflow-состояния | | ObjectDataWorkflowTransition | $transition | '' | Переход Workflow | | array | $options | 'array()' | Контекст запуска перехода |
|
| RecordDecision | Запись решения согласующего
Подробнее...
Добавляет решение участника в WorkflowApprovalRequest, пересчитывает результат политики и переводит запрос в waiting, approved или rejected. Фактическое продолжение workflow выполняется отдельным механизмом продолжения перехода. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalRequest | $request | '' | Запрос согласования | | string | $participantKey | '' | Ключ участника из снимка | | string | $decision | '' | Решение: approve, reject, abstain или clarification | | string | $comment | '' | Комментарий к решению | | array | $options | 'array()' | Контекст пользователя и сохранения |
|
| RequestClarification | Запрос уточнения по согласованию
Подробнее...
Фиксирует запрос уточнения как решение clarification внутри WorkflowApprovalRequest и оставляет запрос в состоянии ожидания. Обсуждение и доставка сообщения принадлежат Collaboration/EventBus. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalRequest | $request | '' | Запрос согласования | | string | $participantKey | '' | Участник, запросивший уточнение | | string | $comment | '' | Текст запроса уточнения или ссылка на комментарий | | array | $options | 'array()' | Контекст пользователя и сохранения |
|
| RetryContinuation | Повтор продолжения согласования
Подробнее...
Помечает запрос согласования в состоянии approved или continuationError как готовый к повторному продолжению перехода. Фактический запуск, повтор и проверка состояния выполняются Workflow/Queue. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalRequest | $request | '' | Запрос согласования | | string | $reason | '' | Причина ручного повторения | | array | $options | 'array()' | Контекст пользователя и сохранения |
|
| SaveGateDefinition | Сохранение правила согласования
Подробнее...
Создает или обновляет запись WorkflowApprovalGate по ключу workflow и ключу правила согласования. Владелец записи определяется через запись Workflow. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalGate | $gate | '' | Сохраняемое определение правила согласования |
|
| SavePolicyDefinition | Сохранение политики согласования
Подробнее...
Создает или обновляет запись WorkflowApprovalPolicy по ключу workflow и ключу политики согласования. Политика остается самостоятельной workflow-сущностью и не хранится внутри перехода. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalPolicy | $policy | '' | Сохраняемое определение политики согласования |
|
| SaveRequest | Сохранение запроса согласования
Подробнее...
Создает или обновляет запрос согласования WorkflowApprovalRequest, включая снимок участников, решения, состояние продолжения перехода и историю 907. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataWorkflowApprovalRequest | $request | '' | Запрос согласования |
|