Once a Connector has been installed, you can access its settings from one of two ways:
- From the Builder: If you’re in the Builder, you can find the Connector under the appropriate Utility or Application Connectors section in the bottom right. Clicking on the Connector’s name will expand it to view its Methods, but also a “Settings” button.
- For Template Connectors: In the Console, navigate to Templates > Template Connectors. Locate the connector you want to edit and select the “Edit Connector” button (pencil icon) next to it.
- For Account Connectors: Within an Account, select “Connectors” on the left followed by the “Edit Connector” button (pencil icon) next to it.
From here, you can manage certain Connector-specific details, including authentication and customizations, as well as upgrading it.
Connector Settings Page Options #
The Connector Settings page presents a selection of buttons along the top.
Some of these buttons are only shown for Template Connectors, others are only shown for Account Connectors, while most are shown for both.
| Button name | Description | Image |
|---|---|---|
| Setup | View and manage the authentication and setup details of that instance of the Connector. |  |
| De-Authenticate | Remove the current authentication details held on that instance of the Connector. Warning: Any running integrations using that instance of the Connector will be stopped. |  |
| Upgrade | When this button is available, it indicates that a newer Connector Release is available. Note: You are not required to upgrade a connector when this is available. |  |
| Generate Setup Token | Account Connectors only. You can use this feature to have your customer authenticate a Connector directly within Cyclr, without sharing their credentials by email, etc. |  |
| Customise | Template Connectors only. Allows you to manage and customize the installation user experience of the connector. This will affect how your end-users see the installation options so you can use this to guide them towards the correct options. |  |
| Rate Limits | View any Rate Limits defined on the Connector and its Methods. |  |
Connector Details #
The Connector Details area at the top of the page allows you to specify a unique name for an instance of a Connector and to add a description.
This is helpful especially in cases where you’ve installed the same Connector more than once, perhaps for different use cases.
Using unique names and setting a description helps differentiate between them.
Connector Methods and Fields #
All of a Connector’s Method Categories, Methods, and the fields that define the structure of the data they send or receive can be viewed in the Methods and Fields area.
Connector Methods can also be executed directly for testing purposes.
You can add custom fields to Connector Methods here, as well as add custom object method categories for Connectors that support them.
Testing Connector Methods #
Once a Connector has been installed and authenticated, you can test its Methods on the Connector Settings page. This allows you to confirm the behaviour of a Method, as well as to run it to view the external data it retrieves.
Warning: Take care when testing any Methods that may alter your or your customers’ data. When testing a Method, Cyclr will send an HTTP Request or perform the action defined by that Method as if it were being run within an integration. This can therefore result in data in external systems being modified or deleted, depending on the Method being used.
How to test Methods:
- Navigate to the Connector’s Settings page.
- Scroll down the page to the “Methods and Fields” area:
- Locate the Method by selecting any Method Categories to open them, then select the Method itself to open it.
- Accessing the “Test” tab:
- There are two tabs on each Method: “Fields” and “Test”.
- To test the Method, select the “Test” tab.
- Enter any Required values:
- Within the Test tab, you may find a selection of fields that are available for the Method you’ve selected.
- Some Methods don’t provide any fields, but others may allow you to provide search options and other parameters.
- As these Methods are not mapped in a cycle or template, depending on the method in question, you may need to input some data to the method’s mandatory fields manually to fully test them.
- Any optional fields will have an Ignore “” button after them.
- “Run” the Method:
- Selecting the “Run” button in the bottom right of the Method will execute the Method with the parameter you have provided.
- Review the Response:
- After the Method has been executed, the page will display the Response received or perhaps an error.
- Any Response values that match the Method’s defined Response Fields will be displayed below the Method.
- Beneath that tabs for the Method Response and HTTP Response will be shown where you can view the data that Cycle received.
Methods not returning all expected data
Whether you are testing a method on the connector Settings page or testing a step in the Builder, you may find that Cyclr doesn’t retrieve all of the data you were expecting.
This is due to Cyclr only making a single API request during testing.
While many APIs provide data in “pages” (e.g. 50 items per page), Cyclr retrieves only the first page in tests to help you confirm the setup is working.
Only when executing a Method as part of an integration running will Cyclr make all the necessary calls to retrieve all pages of data.
Storage #
The Storage area on the Connector Settings page allows you to store data in key/value pairs on each instance of a Connector.
The number of items currently in use on a Connector instance is indicated at the top. You can also get, set, delete and list storage keys here.
The primary purpose of this storage is to persist small pieces of data, such as tokens or IDs, to allow you to reference them later in integrations that use that connector instance.
As you can install the same connector multiple times, it’s important to note that each connector instance has its own isolated storage area. Values saved to one instance are not shared with other instances of the same connector.
You can also work with this stored data within Script by using storage functions on your integration Steps.
Managing Storage Keys #
From the Connector Settings page you can view and manage what’s stored:
- Get: Check the value of a specific key by entering the key into the input field and pressing Get.
- Set: Store a new key/value pair by entering them in the respective fields and clicking Set.
- Delete: Delete a key you no longer need by entering it in the key field and clicking Delete.
- List: View all the keys currently stored in the connector instance by clicking List. Note: This only shows the keys, not the values.
