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 Template or 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”
The Builder Canvas #
The Builder canvas serves as the primary workspace in Cyclr, where you can build integration templates and cycles.
Integration steps are dragged from the sidebar and placed within the canvas area, to connect them to other steps and construct the integration logic. 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.
Builder Sidebar #
The sidebar contains all available connectors, including Tools, Utility Connectors, and Application Connectors. These can be dragged and dropped from the sidebar onto the canvas to build integrations that connect to external systems or perform automated logic.
Note that whilst Tools and Connectivity Tools are immediately available in the sidebar, in order to use Utility Connectors and Application Connectors, they need to be installed on the console first.
Add a Connector #
To add a new connector via the Builder, select the + button. You can find one next to both the Utility Connectors area as well as the Application Connectors area to add the respective types of connectors.
Use the search bar or scroll through the list to locate the desired connector from our library and follow the instructions to install it. Once the installation is complete, you will be returned to the Builder.
Follow our connector guides for details on how to install specific Application Connectors.
Connector Methods #
Connectors contain predefined Methods, referred to as “Steps” when dragged onto the Builder’s canvas, which represent specific actions or data queries. These methods can be expanded by selecting the connector from the sidebar.
Methods related to each other are often grouped together under a Method Category.
Select the connector to expand its Method Categories, and select a Method Category to expand its available methods.
Steps #
Steps are functional blocks used to interact with specific areas and datasets within a third-party application.
To add a Step to your integration, select the Connector Method or Tool from the right of the Builder, and drag it onto the canvas.
Steps can be connected to define the sequence of actions in an integration. This is done by selecting the output dot on one step and dragging a line to the input dot of the next step.
Step Setup
To configure individual steps, select the Step Setup cog icon on the step.
The Step Setup popup can be used to edit the name and description, map fields between different steps, and access the Advanced Settings, such as adding script.
When editing a Template, you can decide whether to allow your customers to map a field themselves when they install the integration through Cyclr’s Embedding features by toggling the User Configurable setting for that field.
Settings Bar #
The Settings bar above the builder canvas provides configuration tools that can be used to determine Template or Cycle specific settings.
| Icon | 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. |
 | 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. |
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.
