Checkpoints

Introduction

qibb’s Checkpoint Nodes act as control points within your flow, allowing you to observe and manipulate jobs as they progress. They provide a robust framework for managing the lifecycle of your jobs, from initiation to completion or termination.

You can find more details about using these nodes in the Add job management capabilities to your flow with checkpoint nodes guide.

How to get started with the Checkpoint Nodes

Minimum Version Requirements

Checkpoint Nodes require your app to be running on flow v4.0.0 or higher. Please ensure your app is up-to-date before installing these nodes.

Job management features in the Portal require the platform to be running on qibb v1.42.0 or higher.

1. Go to qibb Workflow Editor, open Node Catalog in the right sidebar, and install the Checkpoints node by clicking on the + button.

2. Drag and drop the Checkpoint node from the left sidebar to your flow. Repeat the process to place multiple checkpoints along your flow.

3. Open each placed Checkpoint node by double-clicking it. Configure it’s type as either Start, Update, Wait, Failed or Success to indicate the state of a job. The first checkpoint of a job shall always have type Start, whereas the last checkpoint shall be either Success or Failed to ensure a complete job lifecycle.

When designing your flows, you can strategically place different types of checkpoint nodes to implement the desired control mechanisms:

• Start Checkpoint: Typically placed at the beginning of a job's flow. It can handle automatic retries for failed jobs.

• Update Checkpoint: Used to mark progress or intermediate stages of a job. Supports pausing and resuming the queue.

• Wait Checkpoint: Holds incoming jobs until they are manually or programmatically released.

• Success Checkpoint: Indicates the successful completion of a job.

• Fail Checkpoint: Indicates the failed completion of a job.

To track progress of jobs, open the “Jobs” page in qibb’s Portal of the according app.

Importing flow examples of a node

Once you've successfully installed a node from the qibb catalog, you can easily import example flows that showcase how the nodes can be used. These example flows are directly accessible within the Flow Editor and are designed to guide users with helpful hints, including how to configure mandatory parameters and credentials.

Here's how to import examples:

1. In the top right corner of the Flow Editor, click on the menu icon.

2. Select Import to open the Import Dialog.

3. Click on the Examples tab.

4. Choose an example from the list.

5. Confirm your selection by clicking on the Import button.

By following these steps, you are now ready to make basic API calls using the provided examples. For further exploration of what’s possible, you can find more complex examples in the Flow Catalog.