Celigo Integrator.io Study Guide | Level 1: Platform Fundamentals
This study guide is compiled directly from Celigo's integrator.io level 1 training course and contains all the necessary information for passing the first exam.
Definitions:
Flow: moving data from one point to another.
A flow has at least two endpoints:
The endpoint providing the data (which is called the source)
The endpoint receiving the data (which is called the destination)
Integration: a folder that holds one or more flows.
Endpoint: a system (applications, databases, or other data sources) involved in a flow.
A flow can include more than two endpoints.
A flow can do more than just move data. It can transform, remove, filter, and process data in other ways.
The endpoints refer to the application or data source, not the data itself.
An endpoint can include an abundance of data and not all of it is needed for a flow. You determine what data the Celigo Platform gets from or transfers into an endpoint.
- This is done by setting the criteria for the data involved in a flow.
Connection: how the Celigo platform communicates with the endpoints.
Import: the criteria for bringing data into a destination
Export: the criteria for pulling data from a source
- The data moving through a flow is data that meets the criteria specified in the export and import settings.
Lookup: attaches complementary information to an existing data record. This allows the record with the additional data to proceed through the flow as one item.
- A lookup can use the same endpoint as a source. Or it could use a different one. It can also use the same endpoint as a destination. Like exports and imports, there can be multiple lookups in a flow.
Resource Object: any item used in Celigo. Imports, exports, connections, and lookups are all resource objects.
- When reusing a standalone resource object, it's still one object. It's not being duplicated. If you make a change to that object in any of its uses, that change is made everywhere the object is used.
Platform Navigation:
Status: You'll see either a green dot with the word "Success" or a red dot with the number of errors for the last 30 days.
Connection Down: A broken link icon will appear if a connection within the integration is not working.
Permissions: If you have permissions, this icon will appear. Its appearance depends on what type of permissions you have.
Number of Active Flows: shows the number of active flows.
You can switch between tile and list view on this screen.
Introduction to Application Programming Interfaces (APIs):
The application's developer - not Celigo - determines which API will work with an application.
Types of API Methods:
GET: Signals a need to retrieve information from the server and return it in a response
POST: Usually creates a new resource/record on a server; some systems use this as a way to retrieve data
PUT: Updates a resource/record on a server
PATCH: Modifies an existing resource/record; unlike PUT, this doesn't replace the whole entry
DELETE: Removes a resource/record
Hypertext transfer protocol (HTTP/HTTPS) is one of the commonly used protocols for web APIs.
Tools & Resources Menus:
The four options available in the Tools menu are:
Flow builder: The flow builder is where you build flows. It provides a visual mode of how data is processed.
Data loader: This option allows you to import certain file types into a REST + JSON application, such as NetSuite and Salesforce. The file types accepted are:
CSV (or any delimited text file)
JSON
XLSX
XML
Reports: This option allows you to produce a list of all the events that have run through one or more flows for a specified period. Selecting the menu option also allows you to see the results of previous reports. Each report is available to download for 30 days.
Playground: The tools found here allow you to edit and test integration data with advanced field editors. These editors don't save the information into an integration. Copy the data you want to save and paste it into an integration field or an external file.
The ten options available in the resources menu are:
Connections
Imports
Exports
Scripts*
Agents
iClients
Stacks*
My APIs*
API tokens
Recycle Bin
*Scripts, Stacks, and My APIs only appear when Developer mode is enabled on your account/profile.
Resources in the Recycle Bin are deleted after 30 days.
Flow Builder:
The Flow Builder tool provides a visual way to create these data flows. In general, there are four overall steps when building a flow:
Add a source.
Add a destination.
Map fields.
Run the flow.
Types of sources:
Databases: are database management systems, which access and manage a collection of organized information.
Universal Connectors: are connectors that interact with several systems and provide custom control when connecting with an application. If an application isn't listed by its name, you can use a universal connector to connect to nearly any endpoint.
Connectors: are applications that already have key settings configured. This simplifies the flow-building process. You may hear these referred to as "pre-built connectors" or "application-specific connectors.”
Data Loader: allows you to upload a source file. The file types accepted are: CSV (or any delimited text file), JSON, XLSX, XML
After you select a source or a destination, you'll need to identify two things:
What would you like to do?
How are you going to connect?
Mapping Types:
Four field mapping types:
Standard Mapping: Simple destination-to-source mapping.
Destination field is date field allows you to specify the date format and time zone for the source field and destination field being mapped.
Source data type identifies what type of value is in a field.
Action to take if field has no value
Do nothing
Use a custom value
Use an empty string (basically an empty field)
Use null (which represents no value or object)
Settings description lets you add notes about the configuration.
Hard-Coded Mapping: think of hard coding as chiseling something into stone. The value you enter for the destination field isn't going to change, no matter what's in the source field.
Hard-coded types:
Use custom default value
Use empty string as default value
Use null as the default value
Also has a settings description field for notes.
First, the value you entered appears in double quotes. Double quotes indicate this is a hard-coded value. Without them, the value in this field is treated as an expression, not text.
Next, a circled H appears next to the gear icon on the row. This icon is another indicator that the mapping type for the row is hard-coded.
Lookup Mapping: This pulls information from another location (such as a table) to determine the value that flows into the destination field. There are two types of lookup mapping - static and dynamic. These will be covered in later courses.
Static: searches a table you create for the source field value and then maps the corresponding destination field value.
Dynamic: is an advanced feature for most new users. It involves searching the destination’s records to retrieve the value to populate the destination field. As such, it requires entering values for fields that won’t be covered in this introductory course.
Handlebar Expressions This type of mapping allows you to combine multiple fields into a single destination field. Note: Mapper 2.0, which is the default setting for new mapping, lists this option as a handlebars expression. If you switch to Mapper 1.0, you will see this option listed as Multi-Field Mapping.
Handlebars expressions are a templating language placed within double curly brackets. Think of them as placeholders. Example: {{handlebarsName}}
In mapping, you can use a single set of handlebars, combine them, or use them with a handlebars helper, which allows you to add functions to the value. When a handlebars expression is used by a system, the expression is replaced with values of the record or context it's referencing.
Like hard-coded mapping, when either the lookup or handlebars expression field mapping type is selected, you'll see an indicator at the end of a mapping row.
A circled E represents handlebars expression mapping. (In Mapper 1.0, you'll see a circle M for multi-field mapping.)
A circled SL represents static lookup mapping.
A circled DL represents dynamic lookup mapping. (In Mapper 1.0, you'll see a circle L for both static and dynamic lookup mapping.)
Marketplaces:
There are two types of these prebuilt solutions found under the marketplace tab.
Quickstart integration templates
Free to install
Includes all of the components necessary to integrate two or more endpoints (connections, exports, imports, flows, and field mappings)
Can be modified after installation to fit your integration requirements
Counts against the endpoints included in your Celigo Platform subscription
Integration apps (IAs)
Requires subscription outside of the Celigo Platform subscription
Includes prebuilt integrations
Managed by app developer (so flow components are locked)
Modified with bug fixes and new functionality and settings
Account Overview:
Three types of accounts:
Account Owner
Highest permission level available
Only one is allowed per account
Often the creator of the account
Abilities include:
Creating and editing flows and flow components
Inviting users
Configuring user permissions
Transferring account ownership
Administrator
Second-highest permission level available
Same abilities as account owner but can NOT:
Change permissions of an account owner
Transfer account ownership
User
Accepted an invitation to an account
Has access levels set by the account owner or admin
A quick way to identify the account owner is to select the Account menu option on the top-right corner. At the bottom of the Account menu, you'll see your name and email address. Under that, you'll see an "Account owner" label. If another user owns the account, you'll see that user's email address under "Account Owner."
It's possible to access more than one account. If you have access to multiple accounts, you can switch by selecting the account name at the top of the screen. A drop-down menu will appear. Select the account to view.
When you select Account, you'll see the following options:
Profile
company
role
phone number
time zone and
preferred date and time formats.
Developer mode (which will be reviewed next)
Field Help paths: Selecting the tooltip for an integration setting now includes the internal JSON path to the resource.
More resources: Scripts, Stacks, and My APIs now appear in the Resources menu..
Custom Settings: You'll now be able to add custom settings to integrations. A Settings tab appears when you open an integration.
Enable AI chatbot
Users
More user options:
Status
Enable User
Require MFA
Actions
Subscription
Audit log
Transfers
Security
Data retention
Each Celigo Platform account is allowed a certain number of entitlements, which are endpoints, trading partners, active integration flows, and on-premise agents.
Note: Multiple connections to a single endpoint only count as a single endpoint. And endpoints are counted only if they're used in an active flow.
The Audit log table shows a record of certain activities in your flows. You can filter by:
resource type (integration, flow, export, connection, etc.)
user
source (UI, API, integration, SSO, etc.)
action (create, update, delete, view, sign in, and sign out)
You can also download the audit log. On the right, there's a Download menu. You can choose from multiple date ranges or a custom date range.
You can transfer ownership of an integration.
Security
SSO must be purchased
MFA
- Can’t enable SSO and MFA simultaneously.
Page Last Updated: 5/28/24