SearchCriteriaConfiguration | Automotive Cloud Developer Guide

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

Field Name	Description
aggrCriteriaFieldset	Field Type FieldSet Description The set of fields in the searchable object that can be used as aggregation criteria.
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.
isActive	Field Type boolean Description Specifies if the search criteria configuration is active (`true`) or not (`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.
resultFieldset	Field Type FieldSet Description The set of fields in the searchable object that can be used as search result columns.
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    <aggrCriteriaFieldset>
4        <fullName>AggregCriteriaSearchCriteriaConfig</fullName>
5        <availableFields>
6            <field>Name</field>
7            <isRequired>false</isRequired>
8        </availableFields>
9        <description>SelectedGroupByColumns</description>
10        <displayedFields>
11            <field>Name</field>
12            <isRequired>false</isRequired>
13        </displayedFields>
14        <label>SelectedGroupByColumns</label>
15    </aggrCriteriaFieldset>
16    <isActive>true</isActive>
17    <masterLabel>SearchCriteriaConfig</masterLabel>
18    <resultFieldset>
19        <fullName>ResultCriteriaSearchCriteriaConfig</fullName>
20        <availableFields>
21            <field>Name</field>
22            <isRequired>false</isRequired>
23        </availableFields>
24        <description>SelectedResultColumns</description>
25        <displayedFields>
26            <field>Name</field>
27            <isRequired>false</isRequired>
28        </displayedFields>
29        <label>SelectedResultColumns</label>
30    </resultFieldset>
31    <searchCriteriaFieldset>
32        <fullName>SearchCriteriaSearchCriteriaConfig</fullName>
33        <availableFields>
34            <field>Name</field>
35            <isRequired>false</isRequired>
36        </availableFields>
37        <description>SelectedSearchFields</description>
38        <displayedFields>
39            <field>Name</field>
40            <isRequired>false</isRequired>
41        </displayedFields>
42        <label>SelectedSearchFields</label>
43    </searchCriteriaFieldset>
44    <searchableObjDataSyncInfo>searchableObjectConfig</searchableObjDataSyncInfo>
45    <searchableObject>VehicleSearchableField</searchableObject>
46    <sortingCriteriaFieldset>
47        <fullName>SortinCriteriaSearchCriteriaConfig</fullName>
48        <availableFields>
49            <field>Name</field>
50            <isRequired>false</isRequired>
51        </availableFields>
52        <description>SelectedSortByColumns</description>
53        <displayedFields>
54            <field>Name</field>
55            <isRequired>false</isRequired>
56        </displayedFields>
57        <label>SelectedSortByColumns</label>
58    </sortingCriteriaFieldset>
59</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>58.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.