This article explains some of the terminology used within the Cyclr application.
Account #
You can give each of your customers an account in Cyclr. The account stores all of the cycles, connectors and authentication details for the customer. This allows you to keep information and data for each customer separate. For more information, see the User accounts overview.
Account Connector #
An Account Connector is an “instance” of a Connector that is installed into an Account and authenticated by to access a specific account of that application’s.
Builder #
The Builder is an area of the Cyclr application that allows you to create and edit Templates as well as Cycles.
It provides a Tools and Connectors area, as well as the main “canvas” where Steps can be dragged in and linked together to create an integration.
Connector #
A Connector tells Cyclr how to interact with a system, performing various operations against it. Most Connectors use an external application’s API, but some also work with databases and files. For more information, see the Connector introduction page.
Console #
The console is your control panel and allows you to set up and manage your application and integrations. Your customers can’t access the console. See the section on Console configuration in the Cyclr documentation.
Custom Connector #
A custom connector is a connector that you can make within Cyclr to connect with an application of your choice.
Cycle #
Cycles are integrations that run in an Account. You can build custom Cycles for a specific customer in an Account, or create a Template that you can use for multiple customers that’s installed in each of their Accounts.
For more information, see the Template introduction page.
Cycle Step #
Cycles are composed of a number of Steps that are linked together.
A Step may be a Tool such as a Decision or Delay, or it can be a Method form an installed Connector, e.g. a Salesforce “List New Contacts” Method.
Cycle Transaction #
When an integration runs (whether that’s a Template or a Cycle) the movement of data through the Steps of your integration is recorded in a Transaction.
This contains details of both API Requests and Responses that relate to each step in an integration, allowing each integration to have multiple Transactions in progress simultaneously.
Embedding #
Embedding is the term Cyclr uses to refer to the process of providing Cyclr integrations to your customer base.
Integration #
A term used when referring to both Templates and Cycles as both share the same functionality and Settings and use the same Bulider.
Where you see “integration” that means something refers to Templates as well as Cycles, e.g. “go to your integration’s Settings button” or “when you run your integration”.
LAUNCH #
LAUNCH is one of Cyclr’s tools that you can use to embed your Cyclr integrations into your application. You can use LAUNCH to offer a list of cycles to your customers for them to select and self-install into their account.
Marketplace #
A Marketplace allows you to set up a store of integrations that you offer to your customers. The Marketplace is a flexible method of providing cycles to your customers as you can offer packages of cycles in a tree-like browsable structure.
Sub Account #
You can add sub accounts to accounts within your Cyclr application. Sub accounts allow you to organize multiple related accounts.
Task #
Usage within Cyclr is recorded as Tasks. A task is logged when an API call is made to external systems or data is processed on a Step within an integration.
- If an action is successful, a “Successful Task” is recorded. This is typically indicated by Cyclr receiving an HTTP 2xx Status Code when making an API call.
- If an action is unsuccessful or results in an error, an “Incident Task” is recorded. This is typically identified by an HTTP 4xx or 5xx Status Code.
- Steps categorized as “Tools,” such as Decisions and Delays, do not utilize Tasks.
Templates #
Templates are definitions of cycles that you can create and add to any number of accounts. You can run templates for testing but they aren’t usually live. For more information on templates, see the section on Cycle templates in the Cyclr documentation.
Tools #
Cyclr provides tools as steps that you can add to a cycle in order to process data.
