IMPORTANT: this documentation has been discontinued. Read the updated Canvas documentation on our new documentation portal.
Canvas is the pipeline development environment of the Digibee Platform. It allows you to quickly and accurately develop simple or complex integrations by dragging and dropping preconfigured components.
Each pipeline consists of a trigger and at least one component that must be connected to create an integration flow. In Canvas, you can organize and configure the trigger and components of your pipeline according to your business needs.
To create your pipeline, go to the Build page and click + CREATE, and then select the option Pipeline.
Before you start creating the flow, you need to configure the pipeline. To do this, click the gear in the upper right corner of the Canvas.
At the pipeline settings, if necessary, configure the following fields:
Description: describe the pipeline.
"Is it multi-instance?": check it if the pipeline to be created is multi-instance. To learn more about this feature, read the article Multi-Instance.
Sensitive field: specify which data should be masked during the execution of the flow.
InSpec: specificy the pipeline input.
OutSpec: specify the pipeline output.
Create a flow
Once the pipeline is configured, you can start building the flow. To learn more about the elements that make up a pipeline, read on.
To create a flow, first select a trigger. The trigger defines how the execution of the pipeline is started - for example, by an external call in response to an event, or via scheduling. Currently, several types of triggers are available:
scheduler (custom, midnight, 30min, 5min)
To set the trigger, click the gear on the trigger and choose from the listed options, as shown in the example below:
The components represent steps in the flow and are selected according to your business needs. Combine all the steps of the integration process that you want to perform using the component list to the right of the Canvas.
To delete a connection or a specific component of the flow, click the trash can and the X.
To configure the component to be used, click the gear to bring up the configuration form. In the example below you can see the form for the Google Drive component.
To learn more about each component available on our list, visit our Component Documentation.
Canvas control buttons
You can easily navigate the pipeline with the Rearrange, Zoom In and Zoom Out buttons. The first one reorganizes the components so as to make it easier to visualize each step of the flow; the other two zoom in and out.
Test mode is a feature of the Digibee Platform that allows you to 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 Test Mode.
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.
If you want to learn even more about pipelines, read the article Pipeline.