Overview
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.
In addition to using available connectors from the Connectors Xchange, you can create your own connectors either by modifying any of the existing ones, or by creating it from scratch.
To install or customize a connector already available, refer to Connectors Xchange.
Types of connectors
There are two types of connectors you can create:
1. Easy REST connectors
This type of connectors require no code (does not require expert programming skills) since these use a proprietary REST framework (Bizagi Ltd), which connects to those APIs providing standard authentication mechanisms and most common authentication methods.
When possible, you should always create Easy REST connectors because they will rely on Bizagi features, and therefore make use of best performance and concurrency practices already implemented by Bizagi.
2. Custom connectors
This type of connectors let you to include any third-party libraries and write your own code (and for instance connect to anything in particular, such as MS Excel).
Should be the choice when the external system's API does not offer a standard or supported authentication mechanism as provided by Bizagi's proprietary framework.
When to create a Custom connector?
Refer to the following table to help you plan if you need to create an Easy REST connector, or if some of your requirements already demand a Custom connector.
Question |
Easy REST |
Custom |
|---|---|---|
Will my connector consume services other than those based on a RESTful architecture? |
✖ |
✔ |
Will my connector use OAuth 2.0 with other sub-types than 'Client Credentials Grant', 'Resource Owner Password' or 'Authorization Code Grant'? |
✖ |
✔ |
Will my connector require the use of external libraries? |
✖ |
✔ |
Will my connector require different actions than POST/GET/PUT/DELETE ? |
✖ |
✔ |
Do I need to execute logic operations within the connector? |
✖ |
✔ |
To learn more how to create connectors, refer to Connector Editor user interface explained.
To start creating your own connectors, it is strongly recommended that you first go through the considerations described at Connectors concepts and guidelines.
|
You will not always necessarily need to have a technically-skilled expert profile in order to create connectors. Though for most scenarios and as a preferred recommendation, it is best to meet with a programmer profile, having: •Basic understanding of XML and JSON structures. •Experience with JavaScript and web application development. It is optimal and best if you have worked with asynchronous/event-driven coding practices before (e.g jQuery and AJAX). |
Last Updated 1/3/2024 9:10:17 AM