Configuration and Validation

Once you have added steps to the integration, you must configure and validate them.

To do this, open the step configuration form by clicking the three-dot icon in the right corner of the step (More options) and select the Edit option.

More options (available options may vary depending on the step type):

• Edit: opens the step configuration form.

• Replace: replaces the trigger with another. All settings of the original trigger will be lost.

• Go to Subflow: accesses the subflow generated by an EIP, such as Split, allowing you to view and edit the subflow steps.

• Delete: deletes the step and all its settings. If the step has branches or subflows, they will also be deleted. It is not possible to delete the trigger.

• Copy: copies the step with all its settings, allowing you to paste it elsewhere on the canvas within the same flow. Steps with subflows or branches will be copied with the subflows and branches. It is not possible to copy steps in batch.

• Cut: cuts a step with all its settings, moving it within the same flow. It is not possible to cut a trigger. Steps with subflows or branches will be cut with the subflows and branches. It is not possible to cut steps in batch.

• Paste: pastes the previously copied step within the same flow, maintaining all its settings.

Configuring component and EIP parameters

Parameters (also known as options) are the form fields you must fill in to configure each step of the integration. The form can be filled in when adding the step to the canvas or later.

They are organized into "sections" or "tabs" that can be expanded/minimized, facilitating navigation and configuration.

Components

Here are the most common sections:

• Basic: usually contains information such as the identification (id) and description of the component.

• Common: gathers the standard and most widely used options, applicable to most scenarios.

• Consumer: focused on specific settings for using the component as a trigger, allowing it to consume messages or events.

• Producer: includes parameters aimed at using the component as a connector, to send messages or data to other systems.

• Advanced: offers more advanced configuration options, with detailed adjustments that can be applied as needed.

• Health: provides settings that allow you to monitor the health and performance of the component.

• Security: includes security-related settings, such as authentication and encryption.

• Scheduler: covers settings related to intervals, delays, and cron expressions.

EIPs

EIPs only have the Basic and Advanced sections.

TIP

If you prefer, you can configure components and EIPs directly in the Source Code tab, editing the main.yaml file. Use Ctrl+F to find the desired parameters in the code editor.

Viewing subflows

Some EIPs, such as Split, generate subflows.

To access a subflow:

The first step of the subflow will be automatically filled with the step that started the subflow in the main route. In the example case, the Split.

Next, you will see the icon and you can continue adding steps in the same way as in the main route.

The following EIPs have subflows:

• Aggregate
• Circuit Breaker
• Filter
• Idempotent Consumer
• Loop
• Pipeline
• Policy
• Resequence
• Saga
• Split
• Step
• Transacted
• When Skip Send To Endpoint

The animation below demonstrates how to access a subflow:

WARNING

If you delete the first step of the subflow, that is, the one that originated the subflow in the main route, all steps of the subflow will be automatically removed.

Validating the route in the Source Code tab

NOTE

The validation functionality is only available in the Source Code tab.

• (Full Validation): checks the structure of your script before deploying the integration flow. Any errors in the flow structure or in the use of components or EIPs will be identified and listed at the bottom of the page in Errors. Validation only applies to the main.yaml file script. Resources file scripts are not validated.

Additionally, the main.yaml file will be automatically checked and inconsistencies will be displayed when clicking the SAVE button in the upper right corner of the screen.

NOTE

You can save an integration with inconsistencies, but you will not be able to deploy it until all errors are resolved.