Skip to content

Chains

Jump to bottom
namu0421 edited this page Jun 30, 2025 · 4 revisions

A chain is an integration workflow composed of modules, which can be based on Apache Camel or custom-built components. Every chain must start with a trigger (e.g., HTTP request, Kafka message, or scheduled task). After configuring a chain, it can be deployed to one or several Engine Domains.

Key Features:

  1. Integration Flexibility:
    Since Apache Camel supports most Enterprise Integration Patterns (EIP), QIP inherits this capability. For example, routing, filtering, or messaging patterns can be implemented using Camel’s extensive component library. For more details on EIPs, visit: EIP.
  2. Organizational Convenience:
    Chains can be grouped into folders for better organization. This simplifies management of complex workflows.
  3. Reusable Workflows:
    A powerful feature allows one chain to call another. This avoids redundancy when the same logic (e.g., authentication or data validation) is needed across multiple workflows. Simply create a reusable chain and reference it in other configurations.
  4. Lifecycle Management:
    Users can perform the following actions on chains:
    • Export: Save configurations for backup or sharing.
    • Import: Reuse or migrate existing chain setups.
    • Redeployment: Update deployed chains without rebuilding from scratch.

User Interface Overview

After setting up and managing chains through these features, users interact with the system via its intuitive web interface. The main screen displays all available chains, serving as the central hub for viewing and managing integrations.

At the top of the page, there is a navigation bar that includes a tab labeled "Admin" , which provides access to advanced settings and system-level controls (described in detail later).

Below the navigation bar is a search bar , enabling users to quickly locate specific chains by name or other criteria. On the right-hand side, users can choose to display additional details about each chain, offering deeper insights into their current status and properties.

Default Chain Parameters

By default, each chain displays the following parameters:

  • Name : The user-defined identifier for the chain.
  • Status : Indicates the current stage of the chain:
    • Draft : Initial state before deployment.
    • Processing : Chain is being deployed.
    • Deployed : Chain is active and running in the environment.
  • Labels : Tags used for categorization or filtering.
  • Created By : The user who created the chain.
  • Created At : Date and time of creation.
  • Modified By : The user who last edited the chain.
  • Actions : A set of operations that can be performed on chains or folders.

Available Actions

  • For Folders :

    • Create New Folder
    • Create New Chain
    • Expand All / Collapse All
    • Copy Link
    • Edit
    • Export
    • Cut / Paste
    • Delete

  • For Chains :

    • Copy Link
    • Edit
    • Export
    • Generate DDS
    • Cut / Copy
    • Duplicate
    • Delete

Users can also add optional fields to the view, such as:

  • ID
  • Description
  • Business Description
  • Assumptions
  • Out of Scope

Creating a New Chain

To create a new chain, users click on the action menu at the bottom of the screen and select the appropriate option. Two tabs appear: General Info and Extended Description .

In the General Info tab:

  • Entering a chain name is mandatory.
  • Labels and a short description are optional.

In the Extended Description tab:

  • Optional fields include Business Description , Assumptions , and Out of Scope .
  • At the bottom, users can choose to open the newly created chain immediately after submitting it by selecting Open chain . Alternatively, they can opt to open it in a new tab . If neither option is selected, the system simply returns to the list of chains.

Clicking on any existing chain opens it in a detailed view for further editing or inspection.

Building the Chain Workflow

Once inside the chain editor, users see a panel on the left containing various elements categorized into groups:

  • Routing : Elements for logical flow control, such as conditions and loops.
  • Files : Tools for handling file-based operations.
  • Composite Triggers : Includes checkpoints for marking progress in a workflow.
  • Transformation : Used to modify headers, payloads, or other data structures.
  • Triggers : Initiates the chain, e.g., an HTTP-trigger.
  • Senders : Sends data to external systems, such as Kafka or REST APIs.
  • Grouping : Allows structuring the workflow visually using swimlanes.

These elements are dragged into the graph view and connected to form the desired workflow. Each element can be customized to meet specific requirements—for example, setting the URL for an HTTP-trigger.

Deploying the Chain

Before deploying a chain, you must create a snapshot to save its current configuration. This ensures version consistency and allows rollback to a stable state if issues arise during deployment.

For detailed instructions on snapshot creation and management, navigate to the Snapshot page. This section provides tools for generating and restoring snapshots, ensuring reliable chain lifecycle management.

Clone this wiki locally