Template settings
To create a new template, select Design New Template from your Cyclr dashboard. You can then select the Settings button from the top bar on the template builder page. There are several tabs with different options to allow you to configure how that specific integration works.
Settings Tab
On Step Error
You can determine what happens when an integration flow encounters an error when making an API call.
Option | Description |
|---|---|
Ignore | No special action occurs if the cycle encounters an error. |
Retry After a Wait | If the cycle encounters an error, Cyclr retries the call after a delay. You can set how many times that the cycle retries the call, and each attempt has an increasing delay.For example, the first retry occurs after 5 minutes, the second after a further 35 minutes, the third afters a further 1 hour and 35 minutes, then 4 hours 35 minutes, and the final call after 10 hours and 35 minutes. Note: You can only select this option for a step that sends a single request. |
Stop The Integration | If the cycle encounters an error, the entire integration stops. |
Stop the Transaction | If the cycle encounters an error, only the specific transaction that caused the error stops and other transactions continue. |
Log Step Requests
Log Step Requests is the default setting. When active, this setting means that your integration logs both the requests and the responses in the step data.
Collection Splitting
Setting | Behavior |
|---|---|
First (Trigger) Step | Splits a collection of data on the first step in a cycle. |
All Steps | Splits collections of data on all steps. |
None | Doesn’t perform any collection splitting. |
For more information, see the documentation page on Collection Splitting.
Variables
You can define variables in the Variables tab and then use them in your integration. Once you define a variable, it’s available for you to map to any fields of the Steps in your integration.
Variables and the User Configurable flag
When a Variable is set in a Template as “User Configurable”, changing its value in a new Template Release and pushing that live to upgrade existing Cycles won’t change the value of the Variable in the Cycles.
It will change and update Variables not set as User Configurable as they are considered part of the Template.
Data Retention
In the Data Retention tab, you can use the two toggles to set a specific period of time to retain data on a step. You can set different time periods for data retention for Successful Transactions and Errored Transactions.
If you set a specific time in the cycle settings, this value overrides any global settings you have for your Cyclr application. Cyclr displays the current default value under the toggles.
For more information, see the Cyclr documentation on Data retention.
Audit Log
The Audit Log tab displays a log of key events that relate to the template integration. Each event records a Username, Comment, and Timestamp in relation to the event.
Connector Installation
The Connector Installation tab displays the connectors that you use in the integration. Each connector has a dropdown where you can select either Existing Installation or Fresh Installation. When you install the integration into an account, if the account already contains one of the connectors it needs, this setting determines whether the integration uses the existing version of the connector or installs a new version.
The default setting is to use existing connectors when possible.