Схема коннектора

JSON схема типового коннектора

JSON

{
    "id" : "5c7654ac0dec1f9f4f2687ba",
    "name" : "Expression",
    "description" : "Expression designed to execute arbitrary code in JavaScript",
    "information" : "<p>Expression</p>",
    "image" : "5bc479270dec1f9f4f182cbb.png",
    "type": "custom"
    "version": "1.0.4",
    "owner": "mixapp",
    "npm" : [],
    "isPublish" : true,
    "installHandler" : "return Promise.resolve();",
    "methods" : [],
    "dataMapping" : {
        "input" : {},
        "output" : {}
    },
    "code": "return Promise.resolve();",
    "method": "",
}

Внимание. Коннектор имеет дополнительные параметры когда является частью процесса.

Основные свойства коннектора

Название	Тип	Описание
id	string	Идентификатор коннектора
name	string	Название коннектора
description	string	Краткое описание коннектора, отображается в визуальном редакторе процессов
information	string	Подробное описание коннектора, описание установки, настройки и другой информации. Доступно для отображения в библиотеке коннекторов
image	string	Название файла изображения на серверах Mixapp (устанавливается автоматически)
type	string	Тип коннектора, доступны custom и webservice
version	string	Версия коннектора
owner	string	Workplace, который является владельцем коннектора (устанавливается автоматически)
npm	array	Массив NPM модулей, необходимых для работы коннектора, пример ["mixapp", "[email protected]"]
isPublish	boolean	Флаг, указывающий на доступность коннектора в библиотеке
installHandler	string	JavaScript код, который будет выполнен при инициализации процесса, обычно используется например для того, чтобы инициализировать данные для коннектора, либо подписаться на события в сторонних системах и т.д.
methods	array	Массив поддерживаемых методов коннектора. Методы предназначены для того чтобы разделить логику коннектора в зависимости от функционала. Подробнее
dataMapping	Object	Объект описывающий схему входящих и исходящих данных в зависимости от выбранного метода коннектора. Подробнее
code	string	Основной JavaScript код коннектора. Свойство доступно только владельцу коннектора (owner).

Дополнительные свойства коннектора, доступные в процессе

Название	Тип	Описание
method	string	Выбранный метод из секции methods
before	string	JavaScript код, который будет выполнен до выполнения основного кода коннектора. Данный предобработчик полезен например если необходимо подготовить поступившие данные коннектору в необходимый формат.
nextConnectors	array	Массив идентификаторов коннекторов, которые будут выполнены после выполнения текущего
params	object	Объект содержащий входные данные, установленные пользователем согласно входящей схемы данных.
parentId	string	Идентификатор родительского коннектора в библиотеке коннекторов
transformRules	object	Объект описывающий трансформацию данных между коннекторами
positionX	integer	Позиция коннектора в визуальном редакторе процесса по горизонтали
positionY	integer	Позиция коннектора в визуальном редакторе процесса по вертикали