Connector Editor user interface explained

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Integrating external applications from Bizagi > Bizagi connectors > Creating connectors >

Connector Editor user interface explained

Overview

Bizagi presents a software development kit which easily lets you to create and modify connectors, called the Connector Editor.

The Connector Editor only requires a browser and internet connectivity (trusted access to http://www.bizagi.com).

 

note_pin

The Connector Editor is supported in the following browsers:

Google Chrome

Firefox

Edge

Opera

Safari**

 
*Other browsers are not supported.

**Safari works only in Apple devices. The Connector Editor is not supported when using Safari in Windows.

 

Recall that there are two types of connectors: Assisted REST connectors which require no code (preferred approach), and Custom connectors which allow you to include any third-party libraries and write your own code.

For more information about these above concepts, refer to Creating connectors.

 

ConnectorEditor_start

 

Main features

Through the Connector Editor you create connectors from scratch, from a starting template or using an API descriptor.

Main features available to speed up the implementation of your specific integration requirements are:

Rely on powerful options such as: the possibility to include third-party libraries, using Bizagi API right away, or package and download your final connector.

Make the most of an easy-to-use graphic user interface that helps you define the structure of inputs, outputs and error handling.

 

Connector Editor access

Use the browser of your choice to access the online Connector Editor, by accessing the following URL:

http://connector.bizagi.com/#/

 

Getting started with the Connector Editor

The Connector Editor allows you to easily start off by:

Creating an Assisted REST connector.

Creating a Custom connector.

Generating a connector from a RAML specification.

Generating a connector from an OpenAPI specification.

Creating a connector from a template

Opening an existing connector.

 

Creating an Assisted REST connector

Create a new connector by selecting the option labeled as Easy:
 

ConnectorEditor_REST00

 

This will prompt you to enter general information for this new connector.

 

ConnectorEditor_REST01

 

OPTION

DESCRIPTION

Icon

The icon shown by the connector (optional), which can be uploaded or modified at anytime by the user while creating the connector.

This image is shown when configuring the connector in Bizagi Studio.

Name

 

The name (mandatory) that identifies the connector when viewed by users.

It can modified at anytime by the user while creating the connector.

Author

 

The name of the author (optional), which can be modified at anytime by the user while creating the connector.

Website (Developer Site)

 

The URL of the author's website (optional), which can be modified at anytime by the user while creating the connector.

Description

 

A meaningful description about what the connector does (optional), which can be modified at anytime by the user while creating the connector.

Authentication Methods

The Authentication method or set of authentication methods enabled for the connector (optional), which can be modified at anytime by the user while creating the connector.

For detailed information about the authentication options at this point, refer to Authentication methods and REST connectors.

 

Once you have defined the basic properties of your new connector, click the Create button.

To know more about the available options and the interface shown when creating an assisted REST connector, click here.

 

Creating a Custom connector

Create a new connector by selecting the option labeled as Expert:

 

ConnectorEditor_Custom00

 

This will prompt you to enter general information for this new connector.

 

ConnectorEditor_Custom01

 

OPTION

DESCRIPTION

Icon

The icon shown by the connector (optional), which can be uploaded or modified at anytime by the user while creating the connector.

This image is shown when configuring the connector in Bizagi Studio.

Name

 

The name (mandatory) that identifies the connector when viewed by users.

It can modified at anytime by the user while creating the connector.

Author

 

The name of the author (optional), which can be modified at anytime by the user while creating the connector.

Website (Developer Site)

 

The URL of the author's website (optional), which can be modified at anytime by the user while creating the connector.

Description

 

A meaningful description about what the connector does (optional), which can be modified at anytime by the user while creating the connector.

 

Once you have defined the basic properties of your new connector, click the Create button.

To know more about the available options and the interface shown when creating a custom connector, click here.

 

Generating a connector from a RAML specification

Generate a connector from a RAML specification by clicking the option labeled as RAML:

 

ConnectorEditor_RAML

 

To upload the external system description, you can upload a .raml or .zip folder with the entire project. When choosing the file that contains the specification of your connector, you will be redirected to the user interface where the information of the connector will be shown. To learn more about generating connectors from a RAML specification go to Creating a connector using an api descriptor.

 

Generating a connector from an OpenAPI specification

Generate a connector from an OpenAPI specification by clicking the option labeled as OpenAPI:

 

ConnectorEditor_OpenAPI

 

To upload the external system description, you can upload a .json, .yaml, .yml or .zip filder with the entire project. When choosing the file that contains the specification of your connector, you will be redirected to the user interface where the information of the connector will be shown. To learn more about generating connectors from an OpenAPI specification go to Creating a connector using an api descriptor.

 

Creating a connector from a template

When creating a connector from a template, you will be able to start from a non-functional template to configure it according to the use case of your process. Click the Connector Template option and select the template from which you will configure your connector.

 

ConnectorEditor_Template

 

Opening an existing connector

When having downloaded a connector as a .bizc file (for instance, if you want to modify and customize an existing connector as made available at the Connector Xchange), you can open it and modify it.

When wanting to modify it  to include some changes or produce a new version, use the Open connector option as shown below:

 

ConnectorEditor_open

 

ConnectorEditor_open

 

When opening a connector, the Connector Editor will automatically identify if your connector is of the Assisted REST type or Custom, and load the appropriate user interface.

Note that this process may take a minute or so (depending on how large the file size of your connector is, along with its imported libraries).

Detail of that connector will show up and will be up for modifications.

 

note_pin

Consider:

Bizagi does not save your work in progress of any connector you are creating. Hence, remember to download it before closing the Connector Editor.

You can load a connector even though its implementation has not been completed yet.

If you create a new connector by parting from an existing one (by modifying it), then you will need to make sure you create new actions (reusing existing ones may generate issues).