To further enhance our Searchable Custom Fields feature, customers now have the ability to query an external data source. Data sources are used to create a link between third party software and Cutover.

To set up a data source, you will need the Custom Fields Admin role in Cutover.

To set up a searchable custom field, you will already need to have created a data source. Please see the Related Articles section for further information on searchable custom fields.

To add a datasource, click on the cog icon on the bottom of the Settings panel and choose Data Sources.

The Data Sources page displays. Click + Add Data Sources.

The Set up Data Source window displays. Further information about completing the fields is listed below.

Name: Add a name for your data source.

Authorization Type: Select an authorization type from the dropdown list. The options available are shown below.

No Auth: Using this option means there is no authorization required by requests.

Token Auth: This option defines if there is an authorization token to be sent with the request.

OAuth: If you use this option, you must first provide authorization by signing into a third party service with a user’s credentials. Cutover will then obtain and store an access token used to perform API calls on your behalf.

AWS STS SigV4: This option uses AWS STS (Secure Token Service) to perform authorization.

Depending on the authorization type chosen there are various fields that will need to be completed. Please see the Authorization pages on our Developer Portal for further information on how to complete the fields.

Endpoint URL: Add your endpoint URL in here. Using the image below, the endpoint URL would be https://www.example.com/widgets.

HTTP Method: This will either be GET or POST.

Query Parameter: This field holds the optional key-value pairs that appear after the question mark in the URL. They are an extension of the URL that determines specific content or action based on the data being delivered. In the example used below, the query parameter here would be colour.

Convert XML Response to JSON: Use this checkbox if the expected response from the third party service is provided in XML format. The response will be converted to JSON format so it can be used in response mappings.

Once all the information has been added, click Next. You can now test your data source by adding in a parameter value.

If the connection is successful you will see a Status 200 message. An example of this is shown below.

The Root Node is the top level result returned in the JSON, so in the example shown above result is the root node. Enter this into the Root Node field to see the attributes found. All attributes are brought in at datasources level, but are defined at custom field creation. These will be displayed when you create a searchable custom field. See the Related Articles section for further information.

The Primary key is the unique identifier for this dataset which, in this example, would be postcode.

Click Add Data Source and your new data source will be displayed in the Data Sources list.

Set up Searchable Custom Fields - see our article here.

Searchable Custom Fields Overview - see our article here.