Linter: Error detection and quality checks

Learn how Linter validates pipelines and capsules, preventing structural errors and guiding you with best practice recommendations.

Linter is a built-in tool on the Canvas that identifies potential configuration issues and displays alerts to help you detect and fix them faster. Most alerts don’t require immediate correction and don’t block the creation of your flows.

How alerts work

While building a pipeline or capsule, Linter provides recommendations based on best practices to help you improve the flow and identify potential issues in your integration.

These issues can range from critical problems that prevent the integration from running or being deployed to minor alerts that guide you toward a more robust configuration.

Where alerts appear

Alerts are displayed in two locations:

  • Directly on the connector with an issue (hover over the connector for details), or

  • In the Problems tab of the Execution Panel.

Each alert includes a short description of the issue and a link to the documentation. When viewing alerts in the Problems tab, you can click Configure step to navigate directly to the connector and open its configuration form, regardless of the flow level.

Types of alerts

Alerts are divided into Errors and Warnings.

Errors

Error alerts indicate serious failures in pipeline or capsule creation. They must be corrected before you save the project.

Errors are categorized as follows:

  • Structure: Structural issues that prevent the integration flow from being processed.

Warnings

Warning alerts indicate improvement opportunities in pipeline or capsule creation.

Warnings are categorized as follows:

  • Best practices: Building habits that improve pipeline or capsule performance and make future maintenance easier.

List of alerts

Trigger

Trigger not configured. To deploy the pipeline, configure the trigger (Best practices).

The trigger defines how the pipeline execution starts. To configure it, select one of the available options and connect it to the beginning of the flow. This configuration is required for deployment. For more details, see the Triggers overview documentation.

You can save the pipeline without configuring the trigger, but you can’t deploy it.

Choice

The Choice connector must have at least one "when" configured (Structure).

Choice enables conditional branching within a pipeline or capsule. To use it correctly, configure at least one when condition. Each condition defines a specific path for the flow. Learn more.

The Choice connector must have an "otherwise" configured (Structure).

The otherwise condition is executed when none of the when conditions apply. Configure at least one otherwise condition to ensure uninterrupted flow execution. Learn more.

Subflow connectors

The following alerts apply to connectors that structure subflows:

The OnProcess must have at least one connector (Structure).

OnProcess defines one of the subflows in a pipeline or capsule. Add and connect at least one connector so the flow is not interrupted.

The OnException must have at least one connector (Best practices).

OnException handles exceptions that occur during OnProcess execution. Add and connect at least one connector to ensure proper error handling.

This rule doesn’t apply to the Block Execution connector.

There is at least one issue inside OnProcess (Structure).

Review and resolve issues within the OnProcess subflow to continue building your pipeline or capsule.

There is at least one issue inside OnException (Structure).

Review and resolve issues within the OnException subflow to continue building your pipeline or capsule.

Parallel Execution

Parallel connector must have at least one execution configured (Structure).

Parallel Execution allows configuring multiple executions simultaneously. Connect it to at least one other connector to prevent flow interruption. Learn more.

Parallel Execution must always be followed by another connector for the flow to run.

Parallel connector should have at least two executions configured (Best practices).

As a best practice, configure Parallel Execution only when two or more executions must run at the same time. Learn more.

Session Management

The field wasn’t declared previously (Best practices).

A field cannot be used (GET) if it was not previously declared (PUT). Learn more.

The field was declared but is not being used (Best practices).

A field previously declared (PUT) is not being used. Configure a new Session Management connector to use (GET) or delete (DELETE) the field. Learn more.

Deprecated versions

Deprecated connector version. A newer version is available (Best practices).

You are using a deprecated version of a connector. A newer, improved version is available.

Deprecated versions can still be used, but only the latest version receives updates and improvements.

Capsules

This capsule can’t be used here because it doesn’t exist in this realm (Structure).

The capsule you are trying to use does not exist in the current realm. Delete it or replace it with another connector or capsule available in your realm.

Last updated

Was this helpful?