search string side menu

Модули расширения системы > Пользовательские модули > Действия в бизнес-процессах / Биндинг переменных для действий в бизнес-процессах

Биндинг переменных для действий в бизнес-процессах

После создания действия в пользовательском модуле оно добавляется в дизайнер бизнес-процессов в виде исполняемого блока.

Чтобы блок работал корректно, нужно передать в него входные данные и сохранить полученный результат. Для этого используются переменные действия:

  • входные переменные — в них передаются данные из контекста бизнес-процесса, необходимые для работы блока. Значения, которые в них записываются, определяются в ходе процесса до выполнения действия;
  • выходные переменные — в них записывается результат выполнения действия. Их значения можно передать:
    • в контекст бизнес-процесса, например, чтобы отобразить их в задаче пользователя;
    • в поля приложения из контекста процесса, чтобы сохранить информацию в карточке элемента.

Передача данных настраивается с помощью биндинга — сопоставления переменных действия с контекстом процесса или приложения. Биндинг выполняется при моделировании процесса в настройках блока.

Чтобы настроить передачу данных:

  1. Добавьте входные и выходные переменные при создании или редактировании действия в модуле.
  2. Создайте пользовательскую форму биндинга, если при сопоставлении для пользователя нужно отображать дополнительную информацию.
  3. Добавьте блок действия на схему бизнес-процесса и сопоставьте переменные действия со свойствами процесса или приложения.

Добавление переменных для настройки действия

Переменные действия можно создать двумя способами:

Создать переменные для биндинга вручную

Чтобы задать фиксированный набор переменных:

  1. Перейдите в настройки модуля на вкладку Действия в БП. Добавьте новое действие или откройте уже созданное, нажав на его название.
  2. В настройках действия на вкладке Контекст создайте переменные, нажав в правом верхнем углу + Добавить. Подробнее о типах переменных читайте в статье «Типы данных в системе».
  3. В списке переменных отметьте флажками, какие из них являются входными и выходными, а также укажите обязательность их заполнения.
  4. Сохраните и опубликуйте действие.

После этого можно добавить блок на схему бизнес-процесса и выполнить сопоставление переменных.

Настроить добавление переменных для биндинга с помощью скрипта

Для действия типа Скрипт можно создавать набор переменных автоматически во время настройки блока в процессе. Например, при интеграции с внешним сервисом можно получить из него актуальный список полей и на его основе создать переменные для биндинга.

Обратите внимание, чтобы запросить данные из внешнего сервиса, он должен предоставлять метод для получения описания его API. Например, могут использоваться OpenAPI, WADL или SOAP.

Основные этапы настройки динамического добавления переменных:

  1. Создать для действия пользовательскую форму сопоставления.
  2. В настройках формы сопоставления добавить скрипт, в котором по данным из внешнего сервиса формируются переменные действия. Они записываются в свойство типа Произвольный тип.
  3. Разместить на форме сопоставления виджет Динамический биндинг для отображения созданных переменных.
  4. Настроить запуск скрипта создания переменных, например, привязать его к нажатию кнопки.
  5. Предусмотреть сообщение об ошибке при неуспешном запросе на внешний сервис.
  6. Написать скрипт действия. Например, в нём может происходить запрос данных из внешней системы и их передача в выходные переменные.

Рассмотрим настройку на примере.

Допустим, вам нужно создать действие для получения данных о компаниях из внешнего сервиса. Переменные действия для сопоставления должны автоматически добавляться на основе описания полей, полученного из сервиса. Для этого:

  1. На вкладке Действия в БП пользовательского модуля перейдите в настройки действия типа Скрипт или добавьте новое.
  2. Откройте вкладку Контекст и нажмите Создать форму.
  3. В открывшихся настройках формы сопоставления перейдите на вкладку Контекст. Добавьте переменные следующих типов:
    • Произвольный тип — для хранения созданных переменных действия;
    • Выбор «да/нет» — чтобы указать наличие ошибки;
    • Строка — для записи текста ошибки.
  4. На вкладке Шаблон вынесите на форму виджет Динамический биндинг. В его настройках в опции Динамические поля* выберите созданное свойство типа Произвольный тип и нажмите Сохранить.
  5. Перейдите на вкладку Скрипты и напишите клиентский или серверный скрипт, в котором на основе данных из внешнего сервиса создаются переменные действия. Они должны сохраняться в свойство типа Произвольный тип. Также настройте запись информации об ошибке при выполнении скрипта.

Подробнее об описании переменных для сопоставления в скрипте читайте в справке ELMA365 TS SDK.

Пример скрипта для создания переменных

// Промежуточная структура для передачи списка полей и их типов из внешнего сервиса
interface FieldDescription {
   code?: string;
   type?: string;
}
 
// Структура для сопоставления типов данных между внешним сервисом и ELMA365
const TypeMapping = new Map<string, DynamicFieldType>([
   ["STRING", DynamicFieldType.String],
   ["FLOAT", DynamicFieldType.Float],
   ["BOOLEAN", DynamicFieldType.Boolean],
   ["DATETIME", DynamicFieldType.Datetime]
]);
 
// Функция для получения данных из внешнего сервиса
async function getFields(): Promise<FieldDescription[] | undefined> {
   // Получение данных о нужных полях
   ...
}
 
// Функция для создания переменных действия
async function FillBindings(): Promise<void> {
   ViewContext.data.is_error = false;
   ViewContext.data.error_text = '';
   // Вызов функции для получения данных из внешнего сервиса
   const fields = await getFields();
   if (fields) {
       const bindings = {} as any;
       // Добавление переменной, по которой будем получать данные контрагента
       bindings["__name"] = { name: '__name', type: DynamicFieldType.String, input: true } as DynamicBindingField;
       for (var item of fields!) {
           if (TypeMapping.has(item.type!)) {
               // Проверка на выходные переменные, которые называются так же, как входные
               // Они помечаются как входные и выходные
               if (bindings[item.code!]) {
                   if ((bindings[item.code!] as DynamicBindingField).type == TypeMapping.get(item.type!)) {
                       (bindings[item.code!] as DynamicBindingField).output = true;
                   }
               } else {
                   bindings[item.code!] = { name: item.code!, type: TypeMapping.get(item.type!), output: true } as DynamicBindingField;
               }
           }
       }
       ViewContext.data.bindings = bindings;
   } else {
       ViewContext.data.is_error = true;
       ViewContext.data.error_text = "При получении данных из внешнего сервиса произошла ошибка";
   }
}
  1. Привяжите запуск скрипта к нажатию кнопки. Для этого разместите на форме виджет Кнопка, выберите в её настройках тип действия Скрипт и укажите функцию, в которой добавляются переменные.
  2. Чтобы в случае ошибки при выполнении скрипта пользователь видел оповещение, добавьте на форму виджет Информационный блок. На вкладке Основное для поля Текст установите связь с переменной типа Строка, в которую записывается текст ошибки.
  3. Настройте видимость информационного блока, чтобы он отображался только в случае ошибки при выполнении скрипта. Для этого перейдите на вкладку Системные и выберите опцию Показать по условию. Нажмите <Не установлено> и привяжите отображение виджета к переменной типа Выбор «да/нет», в которую записывается наличие ошибки.
  4. Сохраните и опубликуйте форму сопоставления.
  5. Теперь к переменным, которые создаются динамически, можно обратиться в скрипте действия. Это позволяет использовать информацию из входных переменных при выполнении действия и присвоить значения выходным переменным.

Для этого вернитесь к настройкам действия и перейдите на вкладку Скрипт. В нашем примере на основе входных данных формируется запрос для получения информации о компании.

Пример скрипта действия

// Функция для получения данных о компаниях из внешнего сервиса
async function getContractorData(name: string): Promise<Map<string, any> | undefined>
{
   // Получение из внешнего сервиса данных о контрагентах
   // и их запись в массив для передачи в выходные параметры действия
   // ...
}
 
// Функция для получения данных из входных переменных действия,
// их использования для запроса во внешний сервис
// и сохранения данных в выходных переменных
async function action(): Promise<void>
{
    // Запись названия контрагента из входной переменной действия в свойство `name`
    const name = Context.data['bindings.__name'];
    // Обращение к внешнему сервису для получения данных о контрагенте
    const contractor:Map<string, any> | undefined = await getContractorData(name);
    // Если данные получены, они записываются в выходные переменные действия
    if (contractor)
    {
       for (var item of contractor.keys())
       {
          Context.data['bindings.' + item] = contractor.get(item);
       }
    }
}
  1. Сохраните и опубликуйте действие.

Теперь блок можно добавить на схему бизнес-процесса. В его настройках вкладке Настройки действия пользователь нажмёт кнопку, чтобы выполнить запрос во внешнюю систему. После этого он увидит автоматически сформированные переменные и сможет выполнить сопоставление.

Настройка пользовательской формы сопоставления

Вы можете создать свою форму сопоставления переменных. Она отобразится для пользователя при моделировании бизнес‑процесса в настройках блока действия. Для этого:

  1. В настройках действия на вкладке Контекст нажмите кнопку Создать форму.
  2. В открывшемся дизайнере интерфейсов разместите на форме поля и виджеты, например, добавьте информационный блок с подсказками.
  3. Сохраните и опубликуйте форму.

После этого в настройках блока вместо вкладки Входные и выходные атрибуты появится вкладка Настройки действия с созданной формой.

Сопоставление переменных в бизнес-процессе

Чтобы использовать блок действия из включённого модуля в бизнес‑процессе:

  1. На правой панели откройте вкладку Интеграции и добавьте блок на схему. Откроются его настройки.
  2. На вкладке Основное в поле Присвоить выходные атрибуты в укажите, куда записать результат исполнения блока:
    • в контекстные переменные бизнес-процесса;
    • в поля приложения, добавленного в контекст бизнес-процесса.

Подробнее про настройку блока в дизайнере бизнес-процессов читайте в статье «Блок „Действие в БП“».

  1. Перейдите на вкладку Входные и выходные атрибуты. Если настроена пользовательская форма сопоставления, вкладка называется Настройки действия.

Откроется форма сопоставления. Выберите:

    • для входных переменных действия — свойства процесса, из которых нужно получить данные для работы блока;
    • для выходных переменных действия — свойства процесса или приложения, в которые запишется результат исполнения действия.

Обратите внимание, сопоставить можно только переменные одинакового типа.

Для завершения настройки нажмите Сохранить.

delegated-activities.html extention-processes.html