Контекст процесса — это все данные, которые создаются, изменяются и сохраняются во время выполнения конкретного процесса. Например, информация об участниках, файлы, комментарии исполнителей, контрагенты и т. д. Эти данные хранятся в переменных, значения которых либо задаются сотрудниками в ходе выполнения процессных задач, либо определяются системой автоматически.
Контекстные переменные могут быть пользовательскими и системными.
Пользовательские переменные
Чтобы посмотреть список всех пользовательских переменных, в разделе Администрирование > Бизнес-процессы нажмите на название процесса, а затем перейдите на вкладку Контекст.
- Отображаемое имя — название переменной, которое используется на форме задачи, стартового события и т. д.;
- Имя свойства — название переменной, которое используется при работе с API, формами и т. д;
- Тип — какого типа данные хранятся в переменной;
- Подтип — дополнительный параметр выбранного типа данных;
- Поиск и сортировка — если опция активна, значение переменной используется в качестве параметра поиска процесса;
- Полнотекстовый поиск — если опция активна, значение переменной участвует в полнотекстовом поиске.
Если процесс создан на уровне приложения, в его контекст всегда добавляется переменная, ссылающаяся на это приложение.
При моделировании процесса вы можете добавлять переменные из его контекста в различные задачи и оповещения.
Для отображения переменных в элементе приложения, по которому запущен экземпляр процесса, используется специальный блок Изменение элемента. При этом в приложении нужно создать свойства таких же типов и присвоить им значения процессных переменных.
Используемые в процессе переменные и их значения отображаются в карточке запущенного экземпляра на вкладке Контекст.
Добавить пользовательскую переменную
Существует несколько способов создать новую переменную:
- На вкладке Контекст в правом верхнем углу нажмите на кнопку + Добавить;
- В настройках Задачи или Стартового события. Перейдите на вкладку Форма и в левом верхнем углу нажмите на кнопку + Добавить. Переменные, добавленные таким образом, тоже будут отображаться на вкладке Контекст.
- Кроме того, контекстные переменные можно создавать в настройках некоторых графических элементов. Например, в зонах ответственности или статусах, где переменная определяет параметры этих элементов.
После того как вы нажмете на кнопку + Добавить, откроется окно создания переменной:
- Отображаемое имя* — укажите название переменной, которое будет отображаться на формах задач, событий и т. д.;
- Имя свойства* — задайте название переменной, которое будет использоваться при работе с API, скриптами и т. д.;
- Подсказка — здесь можно указать дополнительную информацию о переменной, например, каким образом задаётся её значение;
- Тип* — определите, какого типа данные будут храниться в переменной. Для каждого типа данных можно задать дополнительные параметры, поэтому набор полей в нижней части окна может меняться.
начало внимание
После создания переменной её тип нельзя изменить.
конец внимание
Действия с пользовательской переменной на вкладке «Контекст»
Вы можете выбрать переменную, а затем применить к ней доступные действия:
- отредактировать — нажмите название и измените его;
- удалить — можно удалить сразу несколько переменных свойств, зажав клавишу Ctrl на клавиатуре и выделив их;
- восстановить удалённую переменную — включите опцию Показывать удалённые переменные, выберите нужную строку в появившемся списке и нажмите Восстановить. Также из этого списка переменную можно удалить окончательно без возможности восстановления;
- скопировать в буфер — перенесите созданную переменную в контекст другого бизнес-процесса, например, чтобы использовать повторно свойство со сложными настройками такое, как Таблица. Для этого выберите переменную и нажмите появившуюся кнопку Скопировать в буфер. Затем откройте другой процесс в режиме моделирования и добавьте в его контекст переменную, нажав кнопку Вставить из буфера. Для перенесённой переменной нельзя изменить имя свойства, используемое в скриптах, и тип. Поскольку в процессе не могут присутствовать свойства с одинаковым кодом, нельзя скопировать переменную и вставить её в контекст этого же процесса.
Системные переменные
В каждый бизнес-процесс по умолчанию добавлены системные контекстные переменные. Они не отображаются в списке переменных на вкладке Контекст, но их можно использовать при моделировании процесса, например, в скриптах, шаблонах или на формах задач.
Переменная «Инициатор»
Переменная Инициатор с кодом __createdBy
содержится в динамической зоне ответственности, добавленной на схему бизнес‑процесса по умолчанию. В неё записывается пользователь, запустивший процесс. Переменную можно использовать в дальнейшем, например, на формах задач или в скриптах.
Переменная «Название»
В переменную Название с кодом __name
записывается наименование каждого экземпляра процесса. Подробнее о том, каким образом можно задавать название экземпляров читайте в статье «Вкладка „Настройки“».
Переменную можно использовать при написании скриптов, а также в блоках процесса. Например, при создании темы сообщения в Оповещении. Кроме того, данные из этого свойства будут отображаться в разделе Администрирование > Монитор процессов.
Переменная «Дата запуска»
В переменную Дата запуска с кодом __createdAt
записывается дата создания экземпляра процесса. Свойство можно использовать только в скриптах. Кроме того, данные переменной отображаются в разделе Администрирование > Монитор процессов.
Переменная «Комментарий»
Переменную Комментарий с кодом __comment
можно использовать в скриптах и в блоках бизнес-процесса, например, на формах переходов по разным веткам. В переменную можно записать только одно значение. Оно не сохраняется в контексте процесса и не будет отображаться на формах других задач. Отобразить значение переменной можно в ленте процесса или связанного объекта с помощью элемента Оповещение.
Рассмотрим, как можно использовать свойство на примере бизнес-процесса Согласование договора.
После того как исполнитель подготовит договор, его руководитель получит задачу рассмотрения. Отсюда процесс может пойти по двум веткам: Согласовать и Доработать.
Настроим переходы процесса. В поле Вид перехода включим опцию Форма. Нажав на кнопку Настроить форму, добавим на форму системную переменную Комментарий и сделаем её обязательной для заполнения. Теперь руководителю нужно оставить свой комментарий, чтобы закрыть задачу рассмотрения.
Чтобы передать комментарий руководителя в ленту договора, разместим на схеме элемент Оповещение. В поле Текст сообщения добавим переменную Комментарий, нажав на значок {+} в правом углу.
В поле Ассоциированный объект включим опцию Контекстная переменная и выберем приложение Договоры. Теперь, когда руководитель оставит свой комментарий при выполнении задачи, сообщение сохранится в ленте элемента. Вы сможете посмотреть комментарий в любой момент на боковой панели карточки договора, направленного на согласование.
Руководитель может направлять договор на доработку несколько раз, оставляя свой комментарий. Каждый раз значение переменной будет перезаписываться и отображаться в оповещении исполнителя, а также в карточке рассматриваемого договора.
Обратите внимание, если договор рассматривают несколько сотрудников, в переменную будет записываться комментарий последнего из них. Чтобы передавать комментарии каждого согласующего и отображать их на форме задач, создайте пользовательские свойства с типом данных Строка и вариантом отображения Текст для всех сотрудников.