Функции модуля (__call)


НАЧАЛО >> Оглавление >> Сервер приложений ИРБИС 64/128 >> Описание модулей системы >> WorkflowCalendar - Календари Workflow >> Функции модуля (__call)📄 Скачать в DOCX


Функции могут быть вызваны как UseModule("WorkflowCalendar")->function(parameter1,parameter2,...);

Имя функцииОписаниеПараметры
ApplyRecordIndexesОбновить индексы календаря Workflow
Подробнее... 
Нормализует запись календаря Workflow и обновляет служебные 1288-префиксы, по которым календарь можно искать в АРМ Администратор и системной диагностике.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$record''Запись календаря Workflow
BuildCalendarModelПостроить модель календаря Workflow
Подробнее... 
Строит DTO календарной страницы из описания календаря и уже отобранных записей. Функция не ищет записи сама, не проверяет права и не исполняет переходы; эти обязанности остаются у WorkflowFilter, Security, WorkflowTransition и вызывающего модуля.
ТипПараметрПо умолчаниюОписание
array$calendar'array()'Описание календарного профиля
array$items'array()'Уже отобранные элементы календаря
array$options'array()'Параметры построения DTO: mode, rangeStart, rangeEnd
DryRunCalendarActionПроверить действие календаря Workflow
Подробнее... 
Проверяет доступность действия календаря и возвращает intent без фактического изменения записи, запуска перехода или сохранения данных. Исполнение intent остается у Workflow, WorkflowScreen или доменного модуля.
ТипПараметрПо умолчаниюОписание
array$calendar'array()'Описание календарного профиля
array$item'array()'Элемент календаря
string$actionKey'\'\''Ключ действия календаря
array$targetData'array()'Целевые данные действия, например новая дата или новый ресурс
ExplainCalendarActionОбъяснить действие календаря Workflow
Подробнее... 
Возвращает человекочитаемое объяснение результата dry-run действия календаря: почему действие доступно или почему оно заблокировано настройками календаря.
ТипПараметрПо умолчаниюОписание
array$calendar'array()'Описание календарного профиля
array$item'array()'Элемент календаря
string$actionKey'\'\''Ключ действия календаря
array$targetData'array()'Целевые данные действия
GetCalendarsПолучить записи календарей WorkflowCalendar
Подробнее... 
Возвращает пользовательские записи WORKFLOWCALENDAR из системной БД с фильтрацией по workflow, типу записи v920 и признаку активности. Системные JSON-профили этой функцией не подмешиваются.
ТипПараметрПо умолчаниюОписание
string$workflowKey'\'\''Ключ Workflow для фильтрации календарей. Если пусто, возвращаются календари всех Workflow.
string$recordType'\'\''Тип записи v920 для фильтрации календарей. Если пусто, фильтр по типу записи не применяется.
bool$activeOnly'true'Возвращать только активные календари.
GetSystemDefinitionsПолучить системные определения WorkflowCalendar
Подробнее... 
Читает JSON-файл системных определений WorkflowCalendar и возвращает его как массив. Функция не изменяет БД и используется для setup, HealthCheck и TestA.
Отсутствуют
HealthCheckDefinitionОписание HealthCheck для WorkflowCalendar
Подробнее... 
Возвращает контракт provider-а HealthCheck для модуля WorkflowCalendar: какие проверки должны подтверждать готовность календарных профилей, связей и runtime policy.
Отсутствуют
ListCalendarProfilesПолучить список календарей Workflow
Подробнее... 
Возвращает нормализованный список календарных профилей Workflow из пользовательских записей и системных определений. Пользовательская запись имеет приоритет над JSON-профилем с тем же ключом.
ТипПараметрПо умолчаниюОписание
string$workflowKey'\'\''Фильтр по ключу Workflow
string$recordType'\'\''Фильтр по типу записи v920
bool$activeOnly'true'Возвращать только активные календари
NormalizeActionНормализовать действие WorkflowCalendar
Подробнее... 
Приводит описание действия календаря к контрактному виду. Действие формирует intent для Workflow, WorkflowScreen, WorkflowView или доменного сохранения поля, но не исполняет его напрямую.
ТипПараметрПо умолчаниюОписание
array$action'array()'Описание действия календаря
int$order'10'Порядок действия, если sort не задан
NormalizeCalendarНормализовать календарь Workflow
Подробнее... 
Приводит описание календаря Workflow к единому контрактному виду. Функция не читает и не изменяет БД, поэтому может использоваться setup, HealthCheck, TestA и UI-renderer-ами.
ТипПараметрПо умолчаниюОписание
array$calendar'array()'Описание календарного профиля Workflow
NormalizeCapacityProfileНормализовать capacity-профиль WorkflowCalendar
Подробнее... 
Приводит настройки capacity к контрактному виду: флаг включения, workload/resource field keys, единица измерения, режим скрытой нагрузки и лимиты.
ТипПараметрПо умолчаниюОписание
array$profile'array()'Описание capacity-профиля календаря
NormalizeDateSourceНормализовать источник даты WorkflowCalendar
Подробнее... 
Приводит описание источника даты календаря к устойчивому контрактному виду: ключ, роль даты, field keys, required-флаг, цвет, сортировка, timezone и resolver key.
ТипПараметрПо умолчаниюОписание
array$source'array()'Описание источника даты
int$order'10'Порядок источника, если sort не задан
NormalizeLaneНормализовать дорожку WorkflowCalendar
Подробнее... 
Приводит описание ресурсной или логической дорожки календаря к контрактному виду: key, title, type, fieldKey, expression, sort и collapsed.
ТипПараметрПо умолчаниюОписание
array$lane'array()'Описание дорожки календаря
int$order'10'Порядок дорожки, если sort не задан
NormalizeModeНормализовать режим WorkflowCalendar
Подробнее... 
Приводит описание календарного режима к контрактному виду: key, title, enabled, sort и defaultRange.
ТипПараметрПо умолчаниюОписание
array$mode'array()'Описание режима календаря
int$order'10'Порядок режима, если sort не задан
RecordToCalendarDefinitionПреобразовать запись в календарь Workflow
Подробнее... 
Преобразует запись типа WORKFLOWCALENDAR в массив контрактного описания календаря. Используется интерфейсами, диагностикой и тестами без знания физической структуры полей записи.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$record''Запись календаря Workflow
ResolveCalendarProfileНайти календарь Workflow
Подробнее... 
Находит пользовательский или системный календарный профиль по ключу, Workflow и типу записи. Возвращает нормализованное описание или null, если подходящий профиль не найден.
ТипПараметрПо умолчаниюОписание
string$key'\'\''Ключ календарного профиля
string$workflowKey'\'DEFAULT\''Ключ Workflow
string$recordType'\'WORKFLOWRECORD\''Тип записи v920