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


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


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

Имя функцииОписаниеПараметры
AppendRecordHistoryДобавить запись в историю Workflow
Подробнее... 
Добавляет в стандартное поле 907 запись истории Workflow с датой, временем, исполнителем, действием, исходным и новым статусом, проектом, workflow и переходом.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$record''Запись, в которую добавляется история
string$action''Ключ действия или перехода
string$fromStatus''Исходный статус
string$toStatus''Новый статус
string$comment''Комментарий к действию
ObjectDataWorkflowProject|null$project'null'Проект Workflow
ObjectDataWorkflowTransition|null$transition'null'Переход Workflow
ObjectDataWorkflow|null$workflow'null'Рабочий процесс Workflow
string$userLogin''Логин исполнителя
string$userSid''SID исполнителя
string$recordType''Тип записи
ApplyDraftContentToRecordПрименить черновик workflow к записи
Подробнее... 
Переносит данные полей workflow-формы из черновика в запись. Поля без WSS-описания заменяются целиком, а WSS-экран или WS-поле с вложенной WSS-секцией меняет только подполя, описанные экраном.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$record''Запись
array$content''Содержимое workflow-формы
array$screenTags''Поля workflow-формы
array$screenSubfields'array()'Карта редактируемых подполей WSS-экрана по полям записи
BuildProjectStatusCodesSrcПостроить фильтр по статусам проекта Workflow
Подробнее... 
Строит часть поискового выражения по общим индексам WFSTATEOWNERSTATUS или WFSTATESIDSTATUS для отбора записей конкретного проекта Workflow по набору статусов.
ТипПараметрПо умолчаниюОписание
ObjectDataWorkflowProject$project''Проект Workflow
array$codes''Коды статусов Workflow
string$recordType''Тип записи
string$projectObjectTypeKey''Ключ типа объекта проекта Workflow
BuildStatusCodesSrcПостроить фильтр по кодам статусов Workflow
Подробнее... 
Строит часть поискового выражения по общему индексу WFSTATESTATUS для отбора записей, находящихся в одном из указанных статусов Workflow.
ТипПараметрПо умолчаниюОписание
array$codes''Коды статусов Workflow
CreateRecordFromScreenСоздать запись по экрану Workflow
Подробнее... 
Создает новую запись указанного типа в контексте проекта Workflow, применяет к ней публичную форму экрана WS/WSS, устанавливает начальное состояние, выполняет настроенные post-create действия представления, добавляет историю в поле 907 и сохраняет запись.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase$db''База данных для сохранения записи
ObjectDataWorkflowProject$project''Проект Workflow, в котором создается запись
string$recordType''Тип создаваемой записи из поля 920
ObjectDataWorkflowScreen$screen''Экран Workflow со схемой WS/WSS
array$formConfig'array()'Настройки формы создания
array$effects'array()'Post-create действия
array$request'array()'Данные POST-запроса
array$files'array()'Загруженные файлы POST-запроса
FindCommandНайти workflow-команду
Подробнее... 
Ищет workflow-команду по ключу вида Модуль.Команда среди команд, найденных в __call/Workflow прикладного модуля.
ТипПараметрПо умолчаниюОписание
string$commandKey''Ключ команды
FindRecordTransitionНайти переход Workflow для записи
Подробнее... 
Ищет переход Workflow в контексте переданного проекта и текущего статуса записи по идентификатору перехода или целевому статусу.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$record''Запись
ObjectDataWorkflowProject$project''Проект Workflow
int|string$targetStatus''Целевой статус
string$transitionId''Идентификатор перехода
FormatHistoryTimeОтформатировать время истории Workflow
Подробнее... 
Преобразует время из внутреннего формата ИРБИС HHMMSS в человекочитаемый вид HH:MM:SS.
ТипПараметрПо умолчаниюОписание
string$time''Время в формате HHMMSS
FormatHistoryUserОтформатировать пользователя истории Workflow
Подробнее... 
Возвращает отображаемое имя пользователя истории Workflow по логину или идентификатору, если запись пользователя доступна.
ТипПараметрПо умолчаниюОписание
string$login''Логин или идентификатор пользователя
GetAvailableRecordTransitionsПолучить доступные переходы Workflow для записи
Подробнее... 
Возвращает переходы Workflow, доступные для записи в контексте переданного проекта, с учетом маршрута, активности, прав и condition-форматов.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase|null$db'null'База данных
ObjectDataRecord$record''Запись
ObjectDataWorkflowProject$project''Проект Workflow, в контексте которого обрабатывается запись
string$recordType''Тип записи
array$options'array()'Дополнительные параметры отбора переходов
GetAvailableTransitionsПолучить доступные переходы workflow
Подробнее... 
Отбирает переходы workflow, доступные для текущего статуса записи, с учетом активности перехода, маршрута, прав на выполнение и condition-формата.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase|null$db'null'База данных
ObjectDataRecord$record''Запись
array$owner''Владелец workflow-состояния
array$transitions''Список переходов workflow
array$options'array()'Дополнительные параметры
GetDraftContentПолучить содержимое черновика workflow
Подробнее... 
Извлекает массив Content из сохраненного черновика workflow-формы или возвращает данные черновика как есть.
ТипПараметрПо умолчаниюОписание
array$draft''Черновик workflow-формы
GetFirstScreenFieldTextПолучить текст первого поля workflow-формы
Подробнее... 
Извлекает текст основного подполя первого повторения указанного поля из данных workflow-формы.
ТипПараметрПо умолчаниюОписание
array$content''Содержимое workflow-формы
int|string$tag''Метка поля
GetHe3AssetVersionПолучить версию ресурсов he3
Подробнее... 
Вычисляет версию набора скриптов he3 по максимальному времени изменения файлов, чтобы обновлять клиентский кэш.
ТипПараметрПо умолчаниюОписание
array$scripts''Список скриптов
GetHe3ScriptListПолучить список скриптов he3 для workflow
Подробнее... 
Возвращает список JavaScript-файлов редактора he3, необходимых для открытия workflow-формы.
Отсутствуют
GetHistoryActionTitleПолучить название действия истории Workflow
Подробнее... 
Возвращает человекочитаемое название действия истории Workflow по ключу перехода, записи перехода или стандартному служебному действию.
ТипПараметрПо умолчаниюОписание
string$action''Ключ действия или перехода
ObjectDataWorkflowProject|null$project'null'Проект Workflow
string$recordType''Тип записи
string$workflowKey''Ключ Workflow
ObjectDataWorkflowTransition|null$transition'null'Переход Workflow
GetModuleCommandsПолучить workflow-команды модуля
Подробнее... 
Возвращает список workflow-команд, найденных в папке __call/Workflow указанного модуля. Описание команды берется из класса команды.
ТипПараметрПо умолчаниюОписание
string$moduleName''Имя модуля
GetOccurrencesПолучить повторения поля workflow
Подробнее... 
Возвращает повторения указанного поля из массива содержимого workflow-формы.
ТипПараметрПо умолчаниюОписание
array$content''Содержимое workflow-формы
int|string$tag''Метка поля
GetRecordWorkflowTitleПолучить заголовок записи Workflow
Подробнее... 
Возвращает отображаемый заголовок записи для Workflow-интерфейса. Сначала используется необязательный формат workflow_record_title управляющего модуля записи, затем идентификатор записи из проекта и SID.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase$db''База данных
ObjectDataRecord$record''Запись
ObjectDataWorkflowProject|null$project'null'Проект Workflow
ObjectDataWorkflowTransition|null$transition'null'Переход Workflow
GetShowPageTitleПолучить заголовок страницы проекта Workflow
Подробнее... 
Возвращает заголовок единой страницы Workflow/Show по текущему проекту, типу записи, pageKey и, для карточки, идентификатору записи.
ТипПараметрПо умолчаниюОписание
string$projectKey''Ключ проекта Workflow. Если не указан, читается параметр project.
string$recordType''Тип записи v920.
string$pageKey''Ключ страницы проекта.
string$dbn'I128F'Имя БД с рабочими записями.
array$options'array()'Дополнительный контекст заголовка: key, sid, projectObjectTypeKey.
GetTransitionScreenПолучить описание экрана перехода
Подробнее... 
Возвращает краткое описание формы, связанной с переходом workflow: наличие экрана, ключ экрана, название и идентификатор перехода.
ТипПараметрПо умолчаниюОписание
ObjectDataWorkflowTransition$transition''Переход workflow
GetTransitionWorkflowTitleПолучить название перехода Workflow
Подробнее... 
Возвращает отображаемое название перехода Workflow: название из записи перехода, его идентификатор или стандартную подпись действия.
ТипПараметрПо умолчаниюОписание
ObjectDataWorkflowTransition$transition''Переход Workflow
GetWorkflowScreenTagsПолучить поля workflow-формы
Подробнее... 
Загружает WS/WSS-схему workflow-формы и возвращает список полей, которые входят в этот экран.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase$db''База данных
string$wsName''Имя WS/WSS-схемы
string$schemaType'ws'Тип схемы: ws или wss
string$recordFieldTag''Поле записи для WSS-схемы
HasScreenFieldПроверить наличие поля в workflow-форме
Подробнее... 
Проверяет, входит ли указанное поле в набор полей рабочего листа workflow-формы.
ТипПараметрПо умолчаниюОписание
array$screenTags''Список полей рабочего листа
int|string$tag''Метка поля
NormalizeOccurrenceНормализовать повторение поля workflow
Подробнее... 
Приводит повторение поля из workflow-формы к массиву подполей с текстовыми значениями.
ТипПараметрПо умолчаниюОписание
array|string$occ''Повторение поля
ParseFieldStringРазобрать строку поля workflow
Подробнее... 
Разбирает строковое представление поля ИРБИС на основное значение и подполя для применения данных workflow-формы.
ТипПараметрПо умолчаниюОписание
string$value''Значение поля
RenderRecordHistoryСформировать историю Workflow записи
Подробнее... 
Формирует стандартное содержимое истории изменений записи по полю 907 с учетом проекта и Workflow текущего представления.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$record''Запись
ObjectDataWorkflowProject|null$project'null'Проект Workflow
string$recordType''Тип записи
string$workflowKey''Ключ Workflow
array$options'array()'Параметры вывода истории. contentOnly=1 возвращает только список истории без внешнего свернутого блока.
SaveDefinitionСохранение определения Workflow
Подробнее... 
Создает или обновляет запись Workflow по ключу рабочего процесса. На вход передается объект ObjectDataWorkflow, а не массив и не сырая запись.
ТипПараметрПо умолчаниюОписание
ObjectDataWorkflow$workflow''Определение Workflow
ShowПоказать страницу проекта Workflow
Подробнее... 
Единый пользовательский вход в страницы проекта Workflow. Функция находит WorkflowView по проекту, типу записи и pageKey, после чего выбирает нужный рендерер по viewType: список, карточка, форма создания, Kanban или timebox.
ТипПараметрПо умолчаниюОписание
string$projectKey''Ключ проекта Workflow. Если не указан, читается параметр project.
string$recordType''Тип записи v920. Если не указан, определяется по странице проекта.
string$pageKey''Ключ страницы проекта Workflow. Если не указан, используется defaultPageKey проекта.
string$dbn'I128F'Имя БД с рабочими записями.
array$options'array()'Дополнительный контекст рендера: projectObjectTypeKey, key, sid, from, variant.
SyncSystemDefinitionsСинхронизация системных определений Workflow
Подробнее... 
Загружает системные определения Workflow из JSON модуля-поставщика или из переданного массива, создает и обновляет проекты, workflow, экраны, схемы экранов, фильтры, схемы фильтров, представления, схемы представлений, статусы и переходы, удаляет отсутствующие определения и обновляет права системных записей.
ТипПараметрПо умолчаниюОписание
string$providerName''Имя модуля-поставщика системных определений Workflow
array|null$definition'null'Готовое описание системных определений Workflow. Если не указано, определения читаются из JSON-файлов модуля-поставщика