Documentation >
Glossary

Glossary¶

ACID¶

ACID stands for atomicity, consistency, isolation, and durability. These four properties guarantee database accuracy and stability during transactions. See this article for more information.

Ibexa Connect marks this functionality with a badge. Note that the ACID badge indicates the use of these properties and does not indicate whether the module is an instant or polling trigger.

Action module¶

You can create, read, update, or delete data with an action module. Action modules are the most common type of module and can be at the beginning, middle, or end of a scenario. There is no limit to the number of action modules in your scenario.

Active and inactive scenarios¶

There are two ways you can use scenarios in Ibexa Connect depending on how you want your scenario to function:

Active scenarios run according to a defined schedule or webhook.
- For example: to watch a spreadsheet or webhook.
Inactive scenarios execute manually whenever you wish to run them.
- For example: limited, one-time results such as retrieving data for a specific time.

You can change between active and inactive whenever you like on the Scenarios tab.

Aggregator¶

An aggregator is a type of module that allows you to merge multiple bundles into one single bundle. Aggregators are useful in making data readable for certain modules or generating meaningful output. Ibexa Connect offers:

Array¶

Within a bundle, data items of the same type are sometimes in an array. You can find an array by looking at the details of a bundle.

Depending on the details of your scenario, you can map other modules to a specific item in an array or use iterators and aggregators to manipulate your data into other formats.

When mapping, Ibexa Connect marks arrays with [ ].

Array aggregator¶

When designing a scenario, use an array aggregator to merge multiple bundles into one single bundle. This may be necessary to format data properly for subsequent modules. The array aggregator also lets you define your target data structure.

Auto commit¶

The Auto commit option defines how Ibexa Connect process data transactions. Enabling Auto commit switches all operations to the commit phase. In the case of an error, data commits immediately and you cannot restore any lost data.

Note

If you disable Auto commit, no commit occurs until operations are executed for all modules. Only modules with the "ACID" tag support transactionality.

Blueprint¶

Ibexa Connect lets you import and export scenarios via a blueprint, a file in JSON format. Your blueprint contains all of your modules and settings except for connections. When importing from a blueprint, you must add your connections.

Note

Blueprints are not compatible between Integromat and Ibexa Connect.

Break error handling directive¶

Using a break directive lets you resolve errors manually and helps when you want more human oversight of errors. When an error occurs, the break directive stops execution of subsequent modules and stores the error in the queue of incomplete executions. Then, the break directive creates a separate record for each bundle that causes the error (available under the Incomplete executions tab > Details). Here, you can manually resolve the error and process all unprocessed bundles. The scenario execution history shows the status as Warning.

Note

You must enable storing of incomplete executions under Scenario settings.

Bundle¶

A bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items.

Clone module¶

When you need a quick duplicate of a module (for example when using data store modules on each branch of a router), use the clone module command to make an exact duplicate of your module. It appears instantly and has the same settings and variables as the original module. You can then drag it to wherever you need it and customize the settings. Changes in the original do not affect the clone and vice versa.

Note

You cannot clone the trigger module of your scenario.

Clone scenario¶

You can duplicate a scenario from the Scenario tab by using the Clone option on the drop down menu for the scenario. Possible uses include sales with multiple pipelines. Use Clone scenario to create a duplicate scenario and customize for each pipeline. Changes in the original do not affect the clone and vice versa.

Commit error handling directive¶

Use the commit error handling directive when you want to stop the execution of the scenario completely but still have the sent data. When there is an error, the commit directive:

stops execution immediately
does not process the subsequent modules
ignores all unprocessed bundles

The scenario execution history displays the status as Success.

Commit phase¶

Commit is the third phase of a scenario execution. If the operation phase is successful for all modules, the commit phase begins and makes all data changes permanent. This means that Ibexa Connect sends information to all the services involved in the operation phase about its success.

Connection¶

A connection allows Ibexa Connect to communicate with an app/service. When adding an app/service to a Ibexa Connect, you may have to create a connection between Ibexa Connect and that app/service to retrieve or send necessary data. Ibexa Connect asks for only the specific permissions required. As a result, some apps/services may ask for permission multiple times. For more information, see Connecting to services

Converger¶

A converger is the counterpart to the router module and merges several routes into one route. There is no converger module available in Ibexa Connect, but there is a workaround, allowing you to reduce the duplication of modules in different routes.

Copy module¶

When working with multiple scenarios, use the copy module command to create a duplicate of your module that you can paste to any scenario. It functions similar to cutting and pasting text on your computer. Although cloning a module is faster, copying allows you to paste the module in another scenario. Copying a module will also copy any filters before the original module. You can also box select (shift + drag) several modules and copy them with the ctrl + C shortcut. This is helpful when creating complex scenarios.

Cycle¶

A cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).

Data loss¶

The data loss option enables data to be lost if Ibexa Connect fails to save a bundle to the queue of incomplete executions (e.g. due to a lack of free space). Enable data loss to prevent interruptions in the overall scenario execution, e.g. a scenario where it is imperative the scenario keeps running and the incoming erroneous data is not that important.

Data store¶

A data store is a built-in database in Ibexa Connect .You can use data stores to store data from scenarios or transfer data between individual scenarios or scenario runs. Your account includes data stores, so you do not have to register at a third-party service.

Data structure¶

When you create a data store, you need to create a data structure that formats your data store in Ibexa Connect. Think of the data store as a spreadsheet and the data structure as the headers. The data structure defines the kind of data (i.e. text, numeric, etc.) that the data store records. You can view and manage your data structures from the data structures page. You can reuse your data structures.

Data Transfer¶

Data transfer is the amount of data transferred through your scenario.

Diagram¶

The diagram is a visual representation of your scenario and appears exactly the same way as you see your scenario in the Scenario editor. Use the diagram tab to quickly view:

the execution history of your scenario.
the amount of operations and data consumed.
the controls to manage the scenario.

Directive (error handling)¶

A directive allows you to control how Ibexa Connect handles errors. There are six error handling directives:

Explain flow¶

The Explain flow button allows you to see how the data will flow through from module to module before you run your scenario. Clicking the Explain flow button starts an animated visualization of how your bundles flow through your scenario.

Filter¶

A filter helps you select bundles that fit specific criteria. You can add a filter between two modules to be sure that bundles received from the preceding modules fulfill specific conditions. Ibexa Connect offers:

Basic operator filters
Text filters
Numeric filters
Date-time filters
Time filters
Boolean filters
Array filters

Finalization phase¶

Finalization is the fourth and final phase of scenario execution. The finalization phase closes open connections (e.g. FTP connections, database connections, etc.) and marks the scenario as completed.

Functions¶

Functions allow you to create complex formulas when mapping items. The functions available in Ibexa Connect are similar to functions in Google Sheets and those in other programming languages. The functions let you perform various transformations of item values, such as converting a text to uppercase, trimming a text, converting a date into a different format, and many others. Hovering over a function gives you a brief explanation and usage example.

History¶

Ibexa Connect maintains a history of your scenario and records:

Date that scenario execution started
Status (success, warning, or error)
Execution duration
Number of operations spent during the scenario run
Size of transferred data
Link to detailed information, where you can inspect all data in that particular execution received and how the data was processed

You can view this information by clicking on history in Scenario detail or in the Diagram. Viewing from the diagram allows you to see currently running executions and stop them if necessary.

Ignore error handling directive¶

Use the ignore error handling directive when you want a scenario to continue processing the next bundles if an error occurs. The ignore directive does not process the bundle where the error occurred through subsequent modules. The scenario execution status is marked as Success.

The ignore directive is the default when you use a module instead of an error handling directive.

Incomplete executions¶

Sometimes Ibexa Connect cannot successfully finalize a scenario execution due to an error.

Ibexa Connect stores incomplete executions in a folder named Incomplete Executions. Each stored incomplete execution can be resolved either manually or automatically.

Initialization phase¶

Initialization is the first phase of scenario execution. During the initialization phase, Ibexa Connect creates all necessary connections (for example, to databases, email services, etc.). The initialization phase also checks if each module is capable of performing its intended operation(s).

Instant trigger¶

See Webhook.

Item¶

An item is data that is part of a bundle. There are several different types of items: text, number, boolean (yes/no), date, time, buffer (binary data), collections, and arrays. You can find these details by clicking on the inspector at the upper-right of your module.

Iterator¶

When creating a scenario, use an iterator to divide one bundle into smaller separate bundles. Subsequent modules then process the bundles separately. One common use is when automatically uploading email attachments to a cloud drive.

You can find iterators under Flow control of the tools section.

Keychain¶

The keychain helps you to administer the keys you have stored in Ibexa Connect. Each key is a unique identifier used for encryption.

Key (data store)¶

When creating a new data store, you can assign unique identifiers to each record. Ibexa Connect will create a key for you if you leave the key field blank. You can also map the value of your key to make it easier to find information in your data store.

Mapping¶

Mapping links the modules in your scenario. When you map an item, you connected the data retrieved by one module to another module to perform the desired action. For example, you can map the email address and subject lines from the Email > Watch emails module to Google Sheets > Add a row and create a spreadsheet of email addresses and subjects.

Module¶

Modules are the main building blocks of automation in Ibexa Connect. Modules represent actions that Ibexa Connect performs with an app. Each app typically contains several modules that read, create, update, and delete data.

Notes¶

Clicking the notes button lets you add notes to your modules in your scenario. The notes feature is very useful for keeping track of webhook links. You can also use notes to explain scenario routes, which is useful for teams working on complex scenarios.

Numerical aggregator¶

A numerical aggregator lets you to apply functions like SUM or AVG to numerical values. Numerical aggregator then return the results in one bundle.

Operation¶

Every time a module in a scenario performs an action, it counts as an operation. For example, when your scenario reads a record from Pipedrive, writes a row into a Google sheet, or posts a tweet, each counts as one operation.

More examples that count as operations:

Read data from an app or webhook
Search for data in an app
Create data in an app
Update data in an app
Delete data from an app
Transform data using the built-in tools
Aggregate a row of data into an array or text
Iterate a row of data

Depending on the complexity of the process you’re automating, your scenario can perform anywhere from two operations to thousands of operations in a single run.

Operation phase¶

Operation is the second phase of scenario execution. During the operation phase read and/or write operations are performed:

The read operation obtains the data needed by the modules in your scenario.
The write operation sends data to apps/services for further processing.

Repeater¶

When you need a module to perform a task multiple times, for example make an API call, use a repeater. Placing a repeater module before another module makes the subsequent module repeat its task. You can confirm by inspecting the bundles output by the subsequent module.

Resume error handling¶

Use the Resume directive when you want scenario execution to continue even though an error occurs. The Resume directive allows subsequent modules continuing processing as if no error took place. The Scenario execution history displays the status as Success.

Retry¶

Ibexa Connect does not feature a retry error handling directive, though there are two workarounds that mimic its functionality.

Rollback error handling¶

Use the Rollback directive when you want to mark the error and return modules to how they were before the scenario ran. The Rollback Directive stops the scenario execution immediately. Then a rollback phase starts on all modules to revert each module back to its initial state. The Rollback directive marks the scenario execution status as Error.

Note

This is the default behavior if there is no error handler route and the Allow Storing Incomplete Executions setting under Scenario settings is not checked.

Rollback phase¶

Rollback is a phase that occurs when there is an error during the operation or commit phase on any module. The scenario execution stops the operation or commit phase and starts the rollback phase, reversing all changes in data.

Note

Some modules do not support rollback and operations performed by these modules are irreversible.

Router¶

A router allows you to add new routes to a scenario so you can branch your flow into several routes and process the data within each route differently.

Run Once¶

Once a scenario is configured, you can execute it by clicking the play icon.

This way, you can verify that the scenario runs as you expect.

If everything is working properly, you can activate the scenario. Once activated, thescenario execute according to its schedule.

If everything does not run as expected, you can visit our error handling article to learn how to handle errors.

Scenario A scenario is a series of modules that users create to automate apps/services. Creating a scenario allows you to transfer and transform selected data between apps/services via modules.

Scenario execution¶

Whenever your scenario runs, it constitutes one scenario execution. Ibexa Connect marks the scenario execution as either success, warning, or error. You can find this information on the right hand side of the Diagram or on the History tab.

In technical terms, scenario execution refers to a sequence of phases. Execution starts with the initialization phase, continues with at least one cycle composed of the operation and commit/rollback phases and ends with the finalization phase.

It is possible to receive emails when errors occur by enabling email notifications from the email notification options tab of the dashboard.

Scheduling¶

Ibexa Connect allows you to define when and how often an active scenario runs. Use the Schedule setting panel under the Options tab and choose Scheduling to set your preferred schedule.

Sequential processing¶

Using the Sequential processing options allows you to monitor and resolve errors in greater detail. If you enable sequential processing, Ibexa Connect stops processing the task sequence until you resolve all incomplete executions. With sequential processing enabled, you can address all incomplete executions in the order in which they occurred.

If you disable Sequential processing, the scenario continues to run according to its schedule with repeated attempts to rerun the incomplete executions.

Table Aggregator¶

You can use a table aggregator to create a table from multiple bundles. The table aggregator merges values based on your specified column and row parameters and outputs into a single bundle. One possible use is compiling blog posts or emails into a single email summary.

Teams¶

Use teams to control and separate access to scenarios and other Ibexa Connect data. You can assign users to multiple teams and specific roles on each team. Members of a team have access only to scenarios and data that belong to their team and role.

Template¶

A template is a pre-developed scenario that you can customize to your specific needs. Ibexa Connect has made many templates for you to quickly create useful scenarios.

Ibexa Connect also allows you to submit your own templates for sharing with the Ibexa Connect community.

Text aggregator¶

When a module requires text in a single bundle, use a text aggregator to merge values into a single bundle. You can map text aggregators the same way as modules or other tools to create the bundle you need.

Text Parser¶

The text parser tool allows you to add these modules:

Match pattern - allows you to find and extract text matching a search pattern. Match pattern uses regular expressions, a sequence of characters that specifies a search pattern. One example use is extracting email addresses from a document or the body of emails.
Replace - searches for a specified value or regular expression, and replaces the result with the new value.
Get elements from HTML - retrieves the desired elements from an HTML code.
HTML to Text -allows you to convert HTML to plain text.
Get elements from text - retrieves desired elements from text.

Transaction processing¶

Ibexa Connect uses transactional processing to describe the scenario execution cycle. A transaction consists of four phases during which Ibexa Connect creates or updates data in a way that ensures data integrity across apps and services. There are 4 phases:

Initialization - creates all necessary connections and checks that all modules are ready.
Operation - performs the reading and writing of data, retrieving and sending data from one service or module to another.
Commit/rollback
1. Commit - verifies all changes across modules and services and makes them permanent.
2. Rollback - when changes cannot be verified, the scenario ‘rolls back’ all changes, returning all data, modules, and services to their original states. The rollback phase protects data integrity in the event of an error.
Finalization - closes all open connections (e.g. FTP connections, database connections, etc.) and completes the scenario.

Trigger¶

Every scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the clock/lightning icon to another module.

There are two types of triggers:

Polling - routinely monitors a connected app/service
Instant - also called webhooks that immediately execute the scenario

Webhook¶

When integrating with third party apps/services, webhooks are a way for those apps to let Ibexa Connect know when something happens. A webhook is a notification containing data about an event, sent by one app to another app or site.

Ibexa Connect uses webhooks as instant triggers to immediately execute the scenario. Webhooks create a URL that you can call from an external app or service, or from another Ibexa Connect scenario.