Links

Canvas

Learn about Canvas, the Digibee Integration Platform building environment which allows for quick development of simple or complex integrations.
Canvas is the pipeline development environment of the Digibee Integration Platform. Using Canvas, you can build integration flows by dragging and dropping preconfigured components.

Pipeline configuration

To create your pipeline, go to the Build page, click Create, and then select the option Pipeline.
Before you start creating your integration flow, you need to configure the pipeline. To do this, click the Settings button represented by the gear icon in the upper right corner of Canvas.
At the Pipeline configuration form, if necessary, configure the following fields:
  • Description: pipeline description.
  • “Is it multi-instance?”: activate this option if the pipeline to be created is multi-instance. To learn more about this feature, read the article Multi-Instance.
  • Sensitive field: data fields that should be hidden during the execution of the flow.
  • InSpec: pipeline input.
  • OutSpec: pipeline output.
Pipeline configuration form with specific configurations for the pipeline.
Once the pipeline is configured, you can start building the flow.

Create a flow

Each pipeline consists of a trigger connected to at least one component. On Canvas, you can organize and configure the trigger and components of your pipeline according to your business needs.

Trigger

To create a flow, first select a trigger. The trigger defines what starts the execution of the pipeline, for example, an event, or scheduling.
To set up the trigger, hover over the basic trigger available on the screen and click on the Configurations button represented by a gear icon. Choose the trigger you want from the listed options and configure it.
List of available triggers to configure.
After you configure the trigger, click Confirm to save your changes.
If you close the window before clicking Confirm, all data will be lost.

Components

The components represent steps in the integration flow. You should use them according to your business needs. A list of components is available on the right side of the Canvas.
Components dragged and dropped into the flow and connected to each other.
To delete a connection or a specific component of the flow, click the Delete button represented by a trash can icon and then confirm clicking on the X icon one more time.
Connection between components being deleted in the flow.
To configure the component to be used, click the Configurations button represented by the gear icon to see the configuration form.
In the example below, you can see the form for the Google Drive component.
The form for configuring the Google Drive component.
After configuring the component, click Confirm to save your changes.
If you close the window before clicking Confirm, all data will be lost.
To learn more about each component available on our list, visit our Components documentation.

Components and triggers documentation

Components and triggers contain a field named Documentation at the end of their configuration form. You can use this field to explain the purpose of the component or trigger, or add any other information that might be helpful to the project. The Documentation field helps with troubleshooting and team collaboration.

Pipeline navigation

In addition to the features presented in this article, Canvas also offers other features that are related to the pipeline navigation experience. To learn more about this, read the article Pipeline navigation.

Pipeline building validation

The Canvas displays alerts when you’re building a pipeline. These alerts help developers identify and fix common issues faster. To learn more about this, read the article Pipeline building validation.

Test the pipeline

Using the Execution panel, you can run and test your pipeline directly from the development area. Use this feature to evaluate, debug, and troubleshoot the integration flow. To learn more about this feature, read the article Execution panel.

Save the pipeline

After you have created your integration flow, click Save in the upper right corner of the screen and specify a name, description (optional) and the project in which the pipeline will be allocated.
Pipeline information form to be filled out before saving.
If your pipeline is showing Error alerts, the Save button will be blocked, so you cannot save it.