Tools: Search

The Search API provides the ability to search web version of Encompass for forms containing a given field ID and to retrieve fields within a given form.

Using Search

The form/field search supports use cases such as:

• Governance –
  • Return a list of all the custom forms that contain a given custom field.
  • Return a list of all the fields in a given custom form.
• Custom Navigation – Return all forms (standard, custom, standard tools) that contain the given field. This will come in handy if you are building a custom workflow for validating fields for running AUS or sending disclosures; this API in conjunction with the navigation methods in the ICE Secure Scripting Framework is useful to direct your users to the appropriate form that has the field.

Usage Notes

• The Field Search API is not for searching for forms or fields independently. When performing a field search, the search returns all the forms where the specified field exists. When performing a form search, the search returns a list of fields within the form.
• Search results can provide insight into how your custom fields are leveraged in custom forms and which fields are used in a custom form, but should not be used to take an entire inventory of custom fields or custom forms.
• Fields and forms NOT included in search results are:
  • Custom forms and custom fields that only exist in the desktop version of Encompass.
  • A custom field used only in a calculation or in business rules and not in custom forms in the web version of Encompass.
  • Custom Tools and Global Tools.

Filtering and Sorting

The Field Search API enables Encompass users to filter search results by a given property, such as a form name, form type, field id, field type, etc. The filter criteria for the results is passed in the query object of the search request. This API supports both full and partial text searches for standard and custom forms, and full text search on standard and custom fields.

📘

For custom workflows, the Field Search API is used to open forms from Loan Audit results for Send Disclosures and feedback from AU submissions.

Filtering and Sorting

The Field Search API allows Encompass users to filter search results by a given property, such as a form name, field type, modified date, etc. The filter criteria for the results is passed in the query object of the search request.

The search contract is based on the boolean query syntax in Elastic Search. The following are some examples:

{
  "query": {
    "bool": {
      "must": [
        {
          "term": {
            "fieldId": "CUST03FV"
          }
        }
      ],
      "filter": [
        {
          "match": {
            "type": "Custom"
          }
        }
      ]
    }
  }
}

{
  "from": "0",
  "size": "10000",
  "query": {
    "bool": {
      "must": [
        {
          "match": {
            "formName": "Flood Certificate"
          }
        }
      ]
    }
  }
}