Manually add custom fields #
By default, connectors only include the standard fields that an application uses. If you need to work with additional fields in the application, you can add custom fields to the connector.
Access connector settings #
There are multiple ways to access a connector’s settings:
- From the template builder, select the application connector to expand it and then select Settings.
- From the Cyclr console, select Templates > Template Connectors from the menu, and then select the Edit button next to the Connector you want to edit.
Add/update fields #
- In the section named Methods and Fields, select the category you want to use to expand it, and then select the method you want to add fields to.
- Under Request Fields or Response Fields (depending on whether you’re sending or receiving the field), select the + button to add a field.
- Specify the following values:
| Property | Description |
|---|---|
| Field Location | This is the field name as used by the API. Often this is just a case of copying the syntax of the existing fields. |
| Display Name | This is the “friendly” name as it will be shown in the user interface. |
| Description | You can optionally describe the field and provide documentation, for example how it is used. |
| Data Type | You can optionally define a data type for your field. If it is datetime then add the subtype to allow for type conversions between different standards. Read more about data types |
Example field locations #
If you only have a few fields, such as in the example response below, you can add the fields manually.
{
"customfields":[
{
"first_name":"John",
"last_name":"Smith"
"address":{
"city": "London"
}
}
],
"total_records": 23
}
For this example, the field locations for those properties are as follows:[customfields].first_name[customfields].last_name[customfields].address.citytotal_records
If you have a large number of fields to add, you can automate the process using a sample of the data, as described below.
Use example data to add fields #
If you have a JSON example of the request or response, you can use the JSON to auto-add additional or custom fields:
- Select the magnifying glass icon from either the request or response area, dependent on where you want to add the fields.
- Paste the JSON example into the popup window that opens.
This adds any fields that don’t already exist, but you might still need to check over the field names and data types that are automatically generated.
Note: Before you paste in a large example, ensure that it only contains properties that you plan to use as Cyclr will add every property it contains as a new Field.
Mapping the entire Request or Response Body #
While you would typically work with individual Request or Response Fields on Methods for each property you wished to map between 2 Steps, you’re also able to map from the entire Response Body of one Step, as well as to the entire Request Body of another.
This can be useful if you have complex structures of data to pass and don’t need to map property by property, or you just want to pass all the Response Body’s data from one Step to another. You may also have Script on the destination Step to perhaps restructure it in some way, to make it suitable for that Step to send on within its own Request Body.
To access the entire Request Body or Response Body, you add a Field to the Method you’re working with that just has a “.” (a period) as its Field Location and specify a Data Type of “Undefined” (to prevent Cyclr performing any conversion on that data), as shown below:
That Field would then appear on Steps using that Method and would be mappable, just as other Request and Response Fields are.
To map the entire Response Body from one Step to the entire Request Body of another, you would add a “.” Response Field to one Method and a “.” Request Field to the other, then in the Builder, you’d map those Fields together.
