The Builder provides a visual, drag-and-drop interface for constructing integrations within Cyclr. Steps can be added, configured, and connected to define the logic and data flow of an integration, whether that’s created as a Template or a Cycle.
You can access the Builder in a few ways:
- In the Partner Console, to work on Templates:
- From the Console Dashboard, select “Design New Template”
- From the Template Library, select “Create New Template”, or “Edit Template”
- Inside Accounts, to work on a Cycle:
- In Cycles, select “Design New Cycle” or “Edit Cycle”
Builder Canvas #
The Builder canvas serves as the primary workspace in Cyclr, where you can build integration Templates and Cycles.
“Steps” are added to the Builder’s canvas by dragging in Tools or Connector Methods from the sidebar. Those Steps are then connected to other Steps to construct your integration logic and flow.
A Step may be a Tool – such as a Decision or Delay – or a Method from an installed Connector, e.g. a Salesforce Connector’s “List New Contacts” Method.
Builder Sidebar #
The sidebar contains all the available items you can build an integration with, including Tools, Utility Connectors, and Application Connectors. They can be dragged and dropped from the sidebar onto the canvas to build integrations that connect to external systems or perform automated logic.
Whilst Tools and Connectivity Tools are immediately available in the sidebar, in order to use Utility Connectors and Application Connectors, they must first be installed.
You can see whether you already have an instance of a particular Connector installed by expanding that section in the sidebar. You can also choose to install another instance of it, perhaps for a different purpose, or to access different data.
Add a Connector #
To add a new Connector from within the Builder, select the “+” button next to the Utility Connectors or Application Connectors area, depending on what you wish to install. You’ll then be taken to the list of Connectors you can choose from. You can search the Connector list or scroll through it to locate the desired one.
When installing a Connector, you’ll be guided through providing any credentials or values needed to make that Connector ready for use; or you can choose to install it without setting it up straightaway and return to it later.
Once Connector installation is complete, you will be returned to the Builder, and the Connector will be shown in the appropriate Connectors area in the sidebar.
Our connector guides give details on how to install specific Application Connectors, such as how to setup or obtain credentials from the systems they work with.
Each of the Connector areas can be expanded or collapsed, and you can search what has already been installed within the Application Connectors area, which typically contains more Connectors than the Utility area.
Connector Methods #
Connectors contain predefined “Methods” representing the actions you can perform with them, such as retrieving contact data or creating invoices, depending on the application or system the Connector works with.
To see the Methods available on a Connector, having already installed it so it appears in the sidebar, select the Connector to expand it.
Methods related to each other are often grouped together inside “Method Categories” which are opened and closed by selecting them.
In the screenshot on the right, the 1st Connect Connector has been expanded, showing its “Contacts”, “Opportunities” and “Organisation” Method Categories. The “Contacts” Category has been expanded to view its 6 Methods: “Contact Updated”, “Create Contact”, etc.
When you find a Method you wish to use, drag it onto a blank area of the Builder’s canvas. That will create a “Step” that references that particular Method.
Note: Connectors can have more than one way to install and authenticate them, referred to as “Authentication Types“, enabling you to perhaps choose between using an API Key or an OAuth 2.0 flow.
Some Library Connectors have Methods that are tied to specific Authentication Types so you may not see all the available Methods in the Builder’s sidebar, depending on the Authentication Type selected when that Connector was installed.
Steps #
Steps are functional blocks within an integration that use Connector Methods or Tools.
To add a Step to your integration, select the Connector Method or Tool from the Builder’s sidebar on the right, and drag it onto a blank area of the canvas.
Steps are connected to define the sequence of actions in an integration. This is done by selecting the “exit point” on one Step and dragging from it to create a path to the “entry point” of another Step to link them together.
Entry points are on the left of Steps, exit points on the right.
Decision Steps have 2 exit points, allowing you to separate data and send it down different paths of your integrations:
- Green “True Exit” points are followed when the criteria set on a Decision Step is met.
- Red “False Exit” points are followed when the criteria is not met.
Steps using certain Connector Methods may also have True and False Exit points when dragged onto the canvas. This is a convenience, to avoid the need to use a Decision Step immediately after them to confirm what happened.
Green “True Exits” are followed when a successful or positive result is received, for example an object is successfully created, or searching for data returns some results.
Red “False Exits” are followed when an operation fails, or no results for a search are found.
As well a Decision Steps, Switch Steps also enable you to channel your data down different paths of your integrations.
Below is a simple example of an integration containing 3 Steps using Methods from the 1st Connect Connector, with a Decision Step between them to decide which path to take:
Step Setup #
After dragging a Step onto the canvas, if it requires any setup before it can run, it will appear slightly grayed out, as shown by the Step on the right in this screenshot:
To configure a Step, select the “Step Setup” cog button as shown above to open the “Step Setup popup”.
The Step Setup popup can be used to edit the name and description of a Step, to map fields between different Steps, and access Advanced Settings, such as adding Script.
When editing a Template, you can additionally decide whether particular fields are shown to your customers – when they install the integration through one of Cyclr’s Embedding features – by toggling the User Configurable setting for that field:
More Step Options #
Steps on the Builder’s canvas have a number of options available from their “More Actions” button:
Depending on the type of Step – and whether the integration is currently running – these options will vary.
More Actions
| Action | Description |
|---|---|
| Step Test | Executes that single Step as a way to test what will happen when the integration runs. You’ll be prompted to provide any values that have been mapped from other Steps. Warning: Cyclr will send an HTTP request or perform the action defined by that Method as if it were being run within an integration, which may modify or delete data. |
| Copy Step | Enables copying of Steps that use Connector Methods or Tools. The new Step includes the Field Mappings and settings of the original Step. Depending on where you place the new Step within your integration, some Field Mappings may be automatically removed if the source Step isn’t accessible. Steps using Connectivity Tools cannot currently be copied. |
| Delete Step | Deletes the Step. A confirmation is shown first. Warning: Once a Step has been deleted, it cannot be restored. |
| Field Discovery | Present on some Webhook Steps. Provides a way to send an HTTP POST request and have Cyclr automatically use the structure of the request body received to add Request Fields to the underlying Webhook Connector Method. |
Once an integration has run, more buttons and icons will be shown on Steps where Transactions have reached them:
| Button | Description |
|---|---|
 | Unread Step Warning count Shows the number of unread Step Warnings recorded on a Step. Click to view them and choose to mark them as “read”. |
 | Unread Step Error count Shows the number of unread Step Errors recorded on a Step. Click to view them and choose to mark them as “read”. |
 | Step Data Click to view the 10 most recent calls on a Step. |
Settings Bar #
The Settings bar above the Builder canvas provides configuration tools that can be used to determine Template or Cycle specific settings.
| Button | Setting | Description |
|---|---|---|
 | Setup | The Setup button notifies you of any potentially missing elements in your Template. For example, if you don’t map a required field in a step, or combine incompatible steps, the Setup button shows a number of issues. |
 | Settings | To configure runtime settings and other advanced performance options, select the Settings button. |
 | Description | A custom description may be added to help identify the integration’s purpose. This can be set using the Description button. |
 | Publish | Templates only Once your Template is ready, it can be published for customer use. Before publishing, configure the template’s execution behavior from the Publish button, including whether Custom Fields are copied as part of the installation. |
 | Share | Cycles only – when the Console’s “Enable Cycle Sharing” option is enabled. Allows copying of Cycles within Accounts back up to the Console as Templates. See the Copy Cycles as Templates page for more. |
 | Transactions | To see a full view of the data that flows through your integration, select the Transactions button. You can use the transaction data to debug your templates and ensure that data moves as you expect. |
Canvas Controls #
Located in the top right of the Builder’s Canvas:
| Button | Description |
|---|---|
 | Instantly places Steps on the Builder’s canvas into a logical, tabular layout – left to right, top to bottom – and saves their new positions. |
 | Restores the previous Step layout if Arrange has been used. Only available until you leave the Builder or reload the page. |
 | Zoom control so you can zoom in and out of the canvas to view more of large integrations. Can be controlled by mousewheel and touchpad gestures. |
You can also click and drag on the Canvas to move around within the Builder:
Template Releases #
Cyclr supports version control for Templates, enabling teams to iterate and manage different versions over time. Template Release information can be accessed directly from the Builder from the “Back to Template Releases” button at the top of the canvas.
We have a full tutorial course on the Builder available for on the Community Site.