SearchCriteriaConfiguration
Retrieve, deploy, update , create, and view search criteria configurations for criteria-based search and filter.
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.
This type extends the Metadata metadata type and inherits its fullName field.
SearchCriteriaConfiguration components have the suffix SearchCriteriaConfiguration settings and are stored in the SearchCriteriaConfiguration folder.
SearchCriteriaConfiguration components are available in API version 58.0 and later.
There are no additional access requirements that are specific to this type.
-
Field Type: string
-
Description: The list of actions that can be launched for a search result.
Available in API version 59.0 and later.
-
Field Type: string
-
Description: The additional configuration attributes used in criteria-based search.
Available in API version 63.0 and later.
- Field Type: FieldSet
- Description: The set of fields in the searchable object that can be used as aggregation criteria.
-
Field Type: SearchCriteriaConfigurationConfigurationType (enumeration of type string)
-
Description: Specifies the configuration type for criteria-based search and filter.
-
Possible values:
Default SearchClinical Trial Search
- Field Type: string
- Description: The description of a search criteria configuration record.
-
Field Type: string
-
Description: A JSON string that stores the distance configuration attributes used in criteria-based search.
The string includes these attributes:
mapEnabled—Indicates whether to show a map of search results (true) or not (false).mapMarkerTitleField—The field value to use for the map marker title.mapMarkerDescriptionField—The field value to use for the map marker description.options—The higher limit for a distance range.referenceFieldApiName—A location-type of field to calculate the distance from.sortByDistance—Indicates whether to include distance criteria in sorting (true) or not (false) for search results displayed as cards.unit—KilometersorMiles.
-
Field Type: SearchCriteriaConfigurationFilterType (enumeration of type string)
-
Description: Specifies the type of filter criteria to use for criteria-based search and filter.
-
Possible values:
GROUPING_AND_AGGREGATIONMULTIPLE_FIELDS
- Field Type: boolean
- Description: Specifies if the search criteria configuration is active (
true) or not (false).
- Field Type: boolean
- Description: Indicates whether the search results are sorted based on a single field (
true) or not (false). Available in API version 63.0 and later. - Default value:
false
- Field Type: string
- Description: Required. A user-friendly name for the search criteria configuration, which is defined when the search criteria configuration is created.
-
Field Type: SearchCriteriaConfigurationResultDisplayFormat (enumeration of type string)
-
Description: Specifies the display format of search results.
-
Possible values:
LISTCARD
- Field Type: FieldSet
- Description: The set of fields in the searchable object that can be used as search result columns.
- Field Type: string
- Description: The name of the OmniStudio FlexCard used to display search results as cards.
- Field Type: FieldSet
- Description: The set of fields in the searchable object that can be used for querying data.
- Field Type: string
- Description: The object that stores data sync information about the searchable object. Information such as whether the data sync job is active or not, and when the last data sync job was run.
- Field Type: string
- Description: Required. The object that can be used for criteria-based search and filter.
- Field Type: FieldSet
- Description: The set of fields in the searchable object that can be used as sort criteria for search results.
The following is an example of a SearchCriteriaConfiguration component.
The following is an example package.xml that references the previous definition.
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.