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.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

SearchCriteriaConfiguration components have the suffix SearchCriteriaConfiguration settings and are stored in the SearchCriteriaConfiguration folder.

Version

SearchCriteriaConfiguration components are available in API version 58.0 and later.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

actionList

Field Type: string
Description: The list of actions that can be launched for a search result.

Available in API version 59.0 and later.

additionalSearchCriteria

Field Type: string
Description: The additional configuration attributes used in criteria-based search.

Available in API version 63.0 and later.

aggrCriteriaFieldset

Field Type: FieldSet
Description: The set of fields in the searchable object that can be used as aggregation criteria.

configurationType

Field Type: SearchCriteriaConfigurationConfigurationType (enumeration of type string)
Description: Specifies the configuration type for criteria-based search and filter.
Possible values:
- Default Search
- Clinical Trial Search

description

Field Type: string
Description: The description of a search criteria configuration record.

distanceCriteria

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—Kilometers or Miles.

filterType

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_AGGREGATION
- MULTIPLE_FIELDS

isActive

Field Type: boolean
Description: Specifies if the search criteria configuration is active (true) or not (false).

IsSingleFieldSort

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

masterLabel

Field Type: string
Description: Required. A user-friendly name for the search criteria configuration, which is defined when the search criteria configuration is created.

resultDisplayFormat

Field Type: SearchCriteriaConfigurationResultDisplayFormat (enumeration of type string)
Description: Specifies the display format of search results.
Possible values:
- LIST
- CARD

resultFieldset

Field Type: FieldSet
Description: The set of fields in the searchable object that can be used as search result columns.

resultFlexCard

Field Type: string
Description: The name of the OmniStudio FlexCard used to display search results as cards.

searchCriteriaFieldset

Field Type: FieldSet
Description: The set of fields in the searchable object that can be used for querying data.

searchableObjDataSyncInfo

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.

searchableObject

Field Type: string
Description: Required. The object that can be used for criteria-based search and filter.

sortingCriteriaFieldset

Field Type: FieldSet
Description: The set of fields in the searchable object that can be used as sort criteria for search results.

Declarative Metadata Sample Definition

The following is an example of a SearchCriteriaConfiguration component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SearchCriteriaConfiguration xmlns="http://soap.sforce.com/2006/04/metadata">
3    <actionList>Create_Product_Request</actionList>
4    <additionalSearchCriteria>{&quot;rangeWithinFilters&quot;:[{&quot;field&quot;:&quot;ManufactureDate&quot;}]}</additionalSearchCriteria>
5    <aggrCriteriaFieldset>
6        <fullName>AggregCriteriaSearchCriteriaConfig</fullName>
7        <availableFields>
8            <field>Name</field>
9            <isRequired>false</isRequired>
10        </availableFields>
11        <availableFields>
12            <field>SerialNumber</field>
13            <isRequired>false</isRequired>
14        </availableFields>
15        <availableFields>
16            <field>StockKeepingUnit</field>
17            <isRequired>false</isRequired>
18        </availableFields>
19        <description>SelectedGroupByColumns</description>
20        <displayedFields>
21            <field>Name</field>
22            <isRequired>false</isRequired>
23        </displayedFields>
24        <displayedFields>
25            <field>SerialNumber</field>
26            <isRequired>false</isRequired>
27        </displayedFields>
28        <displayedFields>
29            <field>StockKeepingUnit</field>
30            <isRequired>false</isRequired>
31        </displayedFields>
32        <label>SelectedGroupByColumns</label>
33    </aggrCriteriaFieldset>
34    <configurationType>DefaultSearch</configurationType>
35    <description>This configuration is for the search criteria settings.</description>
36    <filterType>GROUPING_AND_AGGREGATION</filterType>
37    <isActive>true</isActive>
38    <isSingleFieldSort>true</isSingleFieldSort>
39    <masterLabel>SearchCriteriaConfig</masterLabel>
40    <resultDisplayFormat>CARD</resultDisplayFormat>
41    <resultFlexCard>ReviewNotes</resultFlexCard>
42    <searchCriteriaFieldset>
43        <fullName>SearchCriteriaSearchCriteriaConfig</fullName>
44        <availableFields>
45            <field>RootAssetId</field>
46            <isRequired>false</isRequired>
47        </availableFields>
48        <availableFields>
49            <field>AccountId</field>
50            <isRequired>false</isRequired>
51        </availableFields>
52        <availableFields>
53            <field>Id</field>
54            <isRequired>false</isRequired>
55        </availableFields>
56        <availableFields>
57            <field>Product2Id</field>
58            <isRequired>false</isRequired>
59        </availableFields>
60        <description>SelectedSearchFields</description>
61        <displayedFields>
62            <field>RootAssetId</field>
63            <isRequired>false</isRequired>
64        </displayedFields>
65        <displayedFields>
66            <field>AccountId</field>
67            <isRequired>false</isRequired>
68        </displayedFields>
69        <displayedFields>
70            <field>Id</field>
71            <isRequired>false</isRequired>
72        </displayedFields>
73        <displayedFields>
74            <field>Product2Id</field>
75            <isRequired>false</isRequired>
76        </displayedFields>
77        <label>SelectedSearchFields</label>
78    </searchCriteriaFieldset>
79    <searchableObjDataSyncInfo>AssetSearch</searchableObjDataSyncInfo>
80    <searchableObject>Asset</searchableObject>
81    <sortingCriteriaFieldset>
82        <fullName>SortinCriteriaSearchCriteriaConfig</fullName>
83        <availableFields>
84            <field>AccountId</field>
85            <isRequired>false</isRequired>
86        </availableFields>
87        <availableFields>
88            <field>Id</field>
89            <isRequired>false</isRequired>
90        </availableFields>
91        <availableFields>
92            <field>Name</field>
93            <isRequired>false</isRequired>
94        </availableFields>
95        <availableFields>
96            <field>Product2Id</field>
97            <isRequired>false</isRequired>
98        </availableFields>
99        <availableFields>
100            <field>StockKeepingUnit</field>
101            <isRequired>false</isRequired>
102        </availableFields>
103        <description>SelectedSortByColumns</description>
104        <displayedFields>
105            <field>AccountId</field>
106            <isRequired>false</isRequired>
107        </displayedFields>
108        <displayedFields>
109            <field>Id</field>
110            <isRequired>false</isRequired>
111        </displayedFields>
112        <displayedFields>
113            <field>Name</field>
114            <isRequired>false</isRequired>
115        </displayedFields>
116        <displayedFields>
117            <field>Product2Id</field>
118            <isRequired>false</isRequired>
119        </displayedFields>
120        <displayedFields>
121            <field>StockKeepingUnit</field>
122            <isRequired>false</isRequired>
123        </displayedFields>
124        <label>SelectedSortByColumns</label>
125    </sortingCriteriaFieldset>
126</SearchCriteriaConfiguration>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>SearchCriteriaConfiguration</name>
6    </types>
7    <version>68.0</version>
8</Package>

Wildcard Support in the Manifest File

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.