Key Concepts

The Integration Hub platform enables seamless integration between Applications, Systems, and Data Sources using key components such as Jobs, Connections, Triggers, Phases, and Actions.

• Triggers initiate a workflow based on predefined conditions.

• Steps and Actions define the tasks performed within a workflow, enabling the execution of complex processes across connected systems.

• Connections serve as integration points between applications and data sources, enabling seamless data transfer across platforms.

These components work together to create a unified environment, facilitating communication between data and applications to support business processes.

Core Concepts and Terminology in Integration Hub

Recipes

Recipes are user-created automated workflows that integrate multiple applications. Each recipe consists of a trigger and one or more actions, which execute when a trigger event occurs.

• When a recipe is started, it runs in the background, continuously monitoring for trigger events and executing the associated actions.

• When a recipe is stopped, it pauses monitoring and action execution.

• Upon restart, the recipe processes all trigger events that occurred during the stop period, functioning as a pause rather than a reset.

Triggers

Triggers define the events that initiate a recipe’s actions. They monitor specific occurrences, such as a new data entry or a scheduled time, and execute the associated actions when these events are detected.

Triggers serve as the starting point for automated workflows in Integration Hub, ensuring that actions are executed at the right time.

Triggers initiate recipe actions in Integration Hub and ensure seamless workflow execution.

Key Features of Triggers:

• Follow in-sequence delivery: Ensures actions are executed in the correct order.

• Maintain records of processed jobs: Tracks completed executions.

• Prevent duplicate processing: Avoids re-executing the same event.

• Ensure job completion in order: Guarantees correct workflow execution.

Types of Trigger Mechanisms:

• Polling: Periodically checks for new events.

• Real-Time: Provides instant notifications, often via webhooks.

• Scheduled: Executes at predefined times or intervals.

Trigger Dispatch Types:

• Single Dispatch: Used for real-time data synchronization.

• Batch Dispatch: Processes large data volumes efficiently.

Steps and Actions

Each time a Trigger event occurs, the steps in a recipe are executed. A recipe must contain at least one step, with the simplest being an action, such as creating a Tenant or an Incident within SymphonyAI Integration Hub.

In Integration Hub, recipe steps include various actions such as standard actions, conditional actions, list actions, invoking other recipes, and try/catch mechanisms.

Types of Recipe Steps:

Actions: Perform tasks such as creating, updating, or searching in a target application.

Control Flow Statements: Manage and define the business logic within a recipe.

Connections

A connection authorizes a recipe to interact with applications through actions and triggers. Connections are not specific to a single recipe; a single connection can be reused across multiple recipes.

• Integration Hub connects to applications to build recipes, with each connection being reusable across multiple recipes.

• Establishing a connection requires the Create Connections privilege and utilizes the app’s authentication API, supporting methods such as OAuth or Basic Authentication.

• Data access is governed by the user’s permissions.

• Connections can be created within the recipe editor or using the connection wizard.

• Multiple instances of an application require separate connections.

Jobs

When a trigger event occurs, the recipe executes the defined actions. This execution process is called a job.

• If the job is successful, all actions complete without issues.

• If the job fails, an error occurs, and the remaining actions do not execute.

Tasks 

A Task is a unit of work that occurs every time a recipe performs an action that requires compute resources. Every time a recipe invokes an action provided by a connector counts as one task. This includes actions done with all connectors, including Integration Hub tools (eg. Lookup tables, Variables).

A recipe job may consist of multiple tasks. The number of tasks executed in a job depends on the data of the specific trigger event and the recipe logic.

Task Rules

Successfully executed actions within a job are considered tasks, while failed actions are not included.

• Successfully completed actions in a 'called' recipe are counted.

• Actions that succeed during job reruns (such as through the UI, API, or recipe operations) are counted.

• Actions completed successfully in a job that fails are also counted; for instance, if a job fails at step 5, steps 1 through 4 are still counted.

Task Counting

The table below provides a detailed breakdown of how tasks are counted across various recipe steps:

Called Recipes

When a Recipe is successfully invoked, the invocation is counted as a task. In the resulting child job, the actions executed within the called recipe are also counted as tasks.

Rerunning Jobs

All tasks done in rerun jobs are counted as tasks.

The examples for how tasks may be counted in recipes are as follows:

Example 1

Figure: Simple recipe with three actions 

Total Tasks per job = 3 (Step 2 + Step 3 + Step 4)

Example 2

Figure: Recipe with four actions

Total Tasks per job = 2 or 3, depending on whether the condition in the recipe is met.

• Conditional statements do not incur any cost.

• The "Search customers in NetSuite" step counts as 1 task, regardless of the number of customers returned.

• Aside from conditional actions, other control statements such as Conditional action with else, Action with error monitor, Call recipe, Stop, and Repeat action will not be counted as tasks.

Example 3

Figure: Recipe with repeated actions

Total Tasks per job = 1 + (2 x no. of rows)

Actions within a Repeat action are executed multiple times based on the number of items or rows in the list, resulting in the total number of tasks being multiplied by that number.

For example, if there are 5 rows in the Repeat action, the total number of tasks would be 11.

Example 4

Figure: Recipe with a bulk action

1 task is done per bulk action, no matter how many rows are processed.

Total Tasks per job = 1