Installing and managing connectors

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Integrating external applications from Bizagi > Bizagi connectors > Integration Hub >

Installing and managing connectors


Connectors in Bizagi are portable modules that allow you to extend the functionality in terms of integrating to another systems or application, as described at Bizagi Connectors.

This section illustrates how to manually install a connector in your Bizagi project.

Recall that automatic installation of a connector can be done by opening the Connector Xchange from Bizagi Studio.

For more information about automatic installation, refer to Connector Xchange.



To install and set up basic configuration for your connectors, make sure you already have downloaded a connector from Connector Xchange, or have created one by using the Connector Editor.

This means that at this point, it is required that you have a valid .bizc connector file in a local folder of your computer.

For more information about the latter option, refer to Creating Connectors.


Manual installation

To install a connector manually (having a .bizc file), open your Bizagi project with Bizagi Studio and carry out the following:


1.Complete the steps described at Opening a connector from a file.


2. Once your connector has been uploaded, it will be listed under API Connectors with its corresponding icon and given name (as defined during its creation in the Connector Editor).

In the right frame, a list with all versions of this connector will be shown: the first time you upload a connector, the list will show only one version (1.x.x).


On the other hand, if this is not the first time you upload a connector with a same name and different major version, the list will show more than one version.





If you are installing a modified instance (a major version) of an existing connector, then it will be listed as a new version ( 2.x.x, 3.x.x,...).

Otherwise, will just replace the same version installed (it is strongly suggested to be fully aware of how versioning works for connectors in order to avoid overwriting them when not intending to).




To learn more about multiple versions in connectors, refer to Connectors versioning.


Connectors configuration

To configure a connector, once it has been installed either manually or via the Connector Xchange, carry out the following:


1. Create a new configuration instance by selecting the version of you connector and click New system configuration.




2. A new window will be displayed prompting for basic details of your connector's configuration.

Enter details as described in the table below.

Notice that most of these fields you need to enter, are tightly bound to parameters as defined during the creation of the connector (i.e when specifying the properties or authentication parameters in the Connector Editor).






1- Display name

Name given to a particular connector version configuration

2- Description

Description given to a particular connector version configuration.

3- Icon

Icon given to the connector when created or edited in the Connector Editor.

4- Development/Test/Production

This tab specifies which values the connector will use for each separate environment:




It is not necessary to specify all the environments information the first time, can be updated when necessary.

5- Connector parameters

Parameters used by the connector.

When using Easy REST Connectors, this list will only show the Base URI parameter*.

This parameters are send in the header of the REST message.

6- Name

Name of the predefined connector's parameter.

This name is assigned when creating the connector in the Connector editor and can not be changed here.

When required, an asterisk character will appear before the Name of said parameter.

7- Value

Value of the connector's parameter.

This information has to be fixed (not dynamic) and can not be changed during a workflow.

8- Authentication parameters


Parameters used by the connector to successfully authenticate, as usually demanded to execute actions in an external system.

These parameters are defined when creating the connector from the Connector editor and can not be changed here.


Available authentication methods are:



OAuth 2.0


Learn about the workings and considerations for authentication methods at How authentication works in Connectors.

9- Name

Name of the predefined authentication parameter.

This name is assigned when creating the connector in the Connector Editor and can not be changed here.

When required, an asterisk character will appear before the Name of said parameter.

10- Value

Value of the authentication parameter. This information has to be fixed (not dynamic) and can not be changed during a workflow.

When required, an asterisk character will appear before the Name of said parameter.

11- Enable Impersonation

When impersonation is enabled, the connector will be authenticated using the authentication token of the user executing the case. This option is exclusive for OAuth 2.0 authentication method.

12- Help

A link to this online documentation.

13- OK/Cancel

Options when finished editing:

Pressing OK will save changes.

Pressing Cancel will discard changes.



*The Base URI parameter is only available for the Easy REST connectors.


3. Once configuration is saved, a new configuration item will be listed for that version of your connector.




At this point your connector has been installed and it is ready to be used in any process of your Bizagi project.

For information about how to use the connector, refer to Using Connectors.


You can create as many system configurations as you need. In fact, when your connector includes actions with different authentication methods, you must create different system configurations for each authentication method.




Managing connectors

At any time, you may right-click a configuration instance of a specific version of connector in order to edit its parameters by selecting properties.




Additionally and in case you want to retrieve an original .bizc connector file set in Bizagi (e.g, if you lost your local file), you may do so by using the Export connector package option found at the version of a given connector:




Deleting connectors

If needed, you can delete a connector's configuration that was previously created. Bear in mind that a connector may have more than one configuration; for that reason, the delete action is independent for each version.

To do so, right-click the configuration that you want to delete and then, select delete connector. You can also select the delete connector option from the ribbon.





Before deleting the connector's configuration, make sure that it is not being used by your processes, otherwise you will not be able to delete it.