Searchable custom fields allow you to search for an external data source from a custom field located within the Edit Task or Runbook Edit panel. This feature is useful when needing to quickly surface and take action on data that is stored in other systems and is updated frequently in third-party apps. As a result, you can execute runbooks with up-to-date information, allowing you to perform tasks without jumping between tools.
Prerequisites
To create a searchable custom field, you will need to have the Custom Fields Admin roles 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.
Set up a Searchable Custom Field
To add a searchable custom field, click on the cog icon on the bottom of the Settings panel and choose Custom Fields.
Click the blue + button at the bottom of the page to add a new custom field.
The New Custom Field modal displays. Further information about completing the fields is listed below.
Name: Enter a name for your new custom field.
Custom Field Group: Choose a custom field group from the dropdown options. This is an optional field.
Visibility: This is the Cutover workspace that the custom field is restricted to or you can choose “Global” for general use.
Field Type: For searchable custom fields there are two options to choose from. You can choose Searchable (single-select) or Searchable (multi-select).
When you select one of the above two options, the Data Source field is then displayed in the modal.
Data Source: Select the appropriate data source relevant for this custom field.
Once you have selected your data source, a number of different data source attributes are displayed.
Select the attributes you would like to see data for. These will display on the runbook or task level. The primary key for your data source is always checked and this cannot be changed.
Note: You cannot rename attributes returned from the API.
Displays on: Select from the dropdown options when you would like the custom field to display.
Restrict to task type: Check any task types or integrations you want to restrict your custom field to.
Additional settings: Check any additional settings required.
Click +Create and your searchable custom field has now been created and added to the Custom Fields list.
You should then go to the appropriate runbook or task where your custom field is assigned. Your newly created custom field group will be visible in the edit panel and within here will be the searchable custom field. Type in a query to search for and the third party API will return the query response along with any attributes previously selected in the Data Source field.
An example of how this data would look in a runbook is shown below:
When you click on the data, it will then be stored in the panel. If you selected Searchable (single-select) as your Field Type you can only choose one option however, if you selected Searchable (multi-select) as your Field Type, you can select multiple options to display in your custom field.
Note: Data source content (apart from the Display Name) cannot be edited once created. If you need to make changes to the content displayed in your custom field, you will need to archive your data source and then add a new data source with the new information needed.
Click Save and the data will be stored in your runbook as a custom field. You can refresh the data at a later point to see if there has been any changes to the source data itself.
Related articles
To read an overview on searchable custom fields, please click here.
To find out how to set up a data source, please click here.