Функции
Введение
На странице «Функции» можно настроить свойства функций, созданных в предыдущих версиях Comindware Platform.
Функции предназначены для использования в действии «Задача-вызов сервиса».
Примечание
Создание новых функций в Comindware Platform версии 4 не предусмотрено, возможно только редактировать имеющиеся функции.
Вместо функций рекомендуется использовать сценарии.
Просмотр полного списка функций
- На странице «Администрирование» в разделе «Архитектура» выберите пункт «Функции» .
- Отобразится список функций в составе всех приложений.
Просмотр списка функций для приложения
- В разделе «Администрирование» приложения выберите пункт «Функции» .
- Отобразится список функций в составе данного приложения.
Настройка функции
- Дважды щелкните строку в списке функций.
-
Настройте свойства функции:
-
Нажмите кнопку «Сохранить».
Основные настройки
На этой вкладке настраиваются основные параметры функции:
- Имя— наименование глобальной функции;
- Системное имя— уникальное текстовое имя глобальной функции. Не должно начинаться с цифры. Рекомендуется использовать буквы латинского алфавита, цифры и символ «_». Заполняется автоматически по названию.
- Бизнес-приложение — бизнес-приложение, в котором применяется глобальная функция;
- Описание— дополнительный комментарий к назначению глобальной функции;
- Тип — выбор вида глобальной функции:
- Абстрактная функция— используется для отладки сигнатуры;
- Скрипт C#— для вызова скрипта C#;
- Вызов веб-службы— для настройки API запросов к внешней веб-службе.
Сигнатура
На этой вкладке настраиваются параметры передачи данных на входе в функцию и на выходе из неё:
- Шаблон сообщения на входе — создайте или выберите уже существующий Шаблон сообщения для передачи параметров на вход глобальной функции;
- Настройка соответствия — таблица для определения соответствия атрибутов шаблона сообщения с переменными, прописанными во вкладке «Описание».
- Шаблон сообщения на выходе — создайте или выберите уже существующий Шаблон сообщения для передачи параметров на выходе из глобальной функции;
- Настройка соответствия — таблица для определения соответствия атрибутов шаблона сообщения с переменными, прописанными во вкладке «Описание».
Описание
На этой вкладке задаётся определение глобальной функции в зависимости от выбранного типа:
Скрипт C
- Напишите скрипт. Входные параметры являются параметрами функции. Используйте класс
Dictionary<TKey,TValue>
для передачи параметров ключа и значения. Ключевые параметры соответствуют выходным параметрам сигнатуры. - Настройте соответствие между результатом выполнения скрипта и атрибутами выходного шаблона сообщения. Для этого используйте ключи скрипта. Установите флажок «Использовать для вывода результата скрипта», если скрипт возвращает единственное значение без ключа, и вы хотите записать это значение в определенный выходной атрибут.
Вызов веб-службы
- Зарегистрируйте Comindware Platform во внешней веб-службе в качестве клиента.
- Настройте аутентификацию Comindware Platform во внешней веб-службе.
-
Введите параметры описания глобальной функции:
- Адрес URI веб-службы — полный адрес URI веб-службы. В адресе обязательно используйте префикс
http
илиhttps
. - Аутентификация — выбор метода аутентификации в веб-службе:
- Без аутентификации;
- Базовая аутентификация.
- Логин — логин для доступа к веб-службе. Доступно при выборе «Базовая аутентификация» в поле «Аутентификация».
- Пароль — пароль для доступа к веб-службе. Доступно при выборе «Базовая аутентификация» в поле «Аутентификация».
- Заголовки — таблица настройки заголовков данных, которые будут использоваться в API запросах к веб-службе. Синтаксис заголовков предоставляется веб-службой. Заголовок
Content-Type
является обязательным и может принимать значенияapplication/json
илиapplication/xml
. - Метод запроса — выбор способа запроса веб-службы:
- GET — получить данные из веб-службы;
- POST— отправить данные в веб-службу;
- PUT— отправить и изменить данные в веб-службе;
- DELETE — удалить данные из веб-службы.
- Текст запроса — данные, которые должны быть отправлены в веб-службу.
- Метод парсинга — выбор способа парсинга данных, содержащихся в ответе веб-службы:
- Как есть;
- XML;
- JSON.
- Настройка соответствия — таблица для настройки соответствия между атрибутами шаблона сообщения на выходе из функции и данными из ответа веб-службы.
- Адрес URI веб-службы — полный адрес URI веб-службы. В адресе обязательно используйте префикс