This page explains some of the terminology used within the Cyclr application, and provides links to pages with further details.
Account #
An Account stores all of the Cycles, Connectors and authentication details for a single customer. You can give each of your customers an Account beneath your Cyclr Partner Console. This allows you to keep information and data for each separate.
For more information, see the Accounts overview.
Account Connector #
An Account Connector is an “instance” of a Connector installed into an Account. It would then typically be authenticated to work with a particular customer’s data in an external system, e.g. an FTP server or a Salesforce account.
Builder #
The Builder is an area of the Cyclr application that allows you to create and edit your integrations so your Templates or 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 and how to perform operations against it. Most Connectors use an external application’s API, but some work with databases and files.
You might install a Connector from Cyclr’s Utility Connector Library or Application Connector Library, or create one yourself as a Custom Connector.
For more information, see the Introduction to Connectors page.
Console #
The Cyclr partner Console is your main control panel and allows you to set up and manage Cyclr, your Accounts for your customers, as well as Templates.
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 within an Account. You can build Cycles for a specific customer in their Account, or create a Template that you can use for multiple customers that’s installed into each of their Accounts.
For more information, see the Cycles introduction page.
Embedding #
Embedding is the term Cyclr uses to refer to the process of providing Cyclr integrations directly to your customers. It includes features such as LAUNCH and Marketplaces.
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. Cyclr Marketplaces are flexible ways of providing integrations to your customers, as you can offer packages of Templates in a ready-made browsable interface.
Method #
Connectors have one or more “actions” they can perform, such as creating a contact or retrieving a list of items. Those actions are called Methods.
You typically add Methods to your integrations (your Templates or Cycles) by dragging them into the Builder to create a new Step, then link it to other Steps.
It’s also possible to call a Method on an installed Connector directly through Cyclr’s API using what we call Data on Demand.
If you’re creating your own Custom Connector, you would add Methods for any endpoints/features of an external API you wished to make available within your integrations.
Step #
Templates and Cycles are composed of a number of Steps that are linked together.
A Step may use a Tool such as a Decision or Delay, or it can be a Method from an installed Connector, e.g. a Salesforce “List New Contacts” Method.
Sub Account #
You can add sub accounts to accounts within your Cyclr application. Sub accounts allow you to organize multiple related accounts.
Task #
Cyclr records a “Task” when making an API call to an external system, or executing certain types of Steps within your integrations (your Templates and Cycles).
For more information, see this article on Tasks.
Template #
Templates allow you to create common integrations which may be used several times, whether by the same customer multiple times, or by multiple separate customers. They are created within your Console within the Template Library. They are then installed into Accounts as Cycles to be used by your customers.
You can run your Templates from within the Template Library, to test them against Template Connectors you’ve installed using your own credentials for any external systems they work with.
For more information, see this article on Templates.
Tools #
Cyclr provides Tools as Steps that you can add to your Templates and Cycles to process data.
Transaction #
When an integration runs (so Templates or Cycles) the movement of data through its Steps is recorded in a Transaction.
Transactions contain details of the API Requests and Responses of every Step they passed through. This allows you to view a Transaction to see which Steps it reached, and what happened on each.
Integrations can have multiple Transactions moving through them simultaneously.
The overall number of Transactions that can be processed at a time within a single Account is defined in the Account’s settings.
Webhook #
Webhooks provide a way for external systems to send data to Cyclr, for that data to then be processed within your integrations.