Industries Common Resources Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Industries Common Resources
AI Accelerator and Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Collections and Recovery
Context Service
Criteria-Based Search and Filter
Metadata API Types
SearchableObjDataSyncInfo
SearchCriteriaConfiguration
SearchResultActionConfig
Tooling API Objects
Business APIs
Data Processing Engine, Batch Management, and Monitor Workflow Services
Digital Lending
Discovery Framework
Decision Explainer
Einstein Relationship Insights
Einstein Standard Invocable Actions
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Process Compliance Navigator
Record Alerts
Record Rollup Definitions
Scheduled Reminders
Sentiment Insights
Service Process Studio
Timeline
Virtual Calls
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

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

Field Name Description
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.
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.

Valid values are:

  • 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.

Valid values are:

  • GROUPING_AND_AGGREGATION
  • MULTIPLE_FIELDS
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.
resultDisplayFormat
Field Type
SearchCriteriaConfigurationResultDisplayFormat (enumeration of type string)
Description
Specifies the display format of search results.

Valid values are:

  • 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.

<?xml version="1.0" encoding="UTF-8"?>
<SearchCriteriaConfiguration xmlns="http://soap.sforce.com/2006/04/metadata">
    <aggrCriteriaFieldset>
        <fullName>AggregCriteriaSearchCriteriaConfig</fullName>
        <availableFields>
            <field>Name</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>SerialNumber</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>StockKeepingUnit</field>
            <isRequired>false</isRequired>
        </availableFields>
        <description>SelectedGroupByColumns</description>
        <displayedFields>
            <field>Name</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>SerialNumber</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>StockKeepingUnit</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <label>SelectedGroupByColumns</label>
    </aggrCriteriaFieldset>
    <configurationType>DefaultSearch</configurationType>
    <description>This configuration is for the search criteria settings.</description>
    <filterType>GROUPING_AND_AGGREGATION</filterType>
    <isActive>true</isActive>
    <masterLabel>SearchCriteriaConfig</masterLabel>
    <resultDisplayFormat>CARD</resultDisplayFormat>
    <resultFlexCard>ReviewNotes</resultFlexCard>
    <searchCriteriaFieldset>
        <fullName>SearchCriteriaSearchCriteriaConfig</fullName>
        <availableFields>
            <field>RootAssetId</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>AccountId</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>Id</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>Product2Id</field>
            <isRequired>false</isRequired>
        </availableFields>
        <description>SelectedSearchFields</description>
        <displayedFields>
            <field>RootAssetId</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>AccountId</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>Id</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>Product2Id</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <label>SelectedSearchFields</label>
    </searchCriteriaFieldset>
    <searchableObjDataSyncInfo>AssetSearch</searchableObjDataSyncInfo>
    <searchableObject>Asset</searchableObject>
    <sortingCriteriaFieldset>
        <fullName>SortinCriteriaSearchCriteriaConfig</fullName>
        <availableFields>
            <field>AccountId</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>Id</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>Name</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>Product2Id</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <field>StockKeepingUnit</field>
            <isRequired>false</isRequired>
        </availableFields>
        <description>SelectedSortByColumns</description>
        <displayedFields>
            <field>AccountId</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>Id</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>Name</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>Product2Id</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <field>StockKeepingUnit</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <label>SelectedSortByColumns</label>
    </sortingCriteriaFieldset>
</SearchCriteriaConfiguration>

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>SearchCriteriaConfiguration</name>
    </types>
    <version>64.0</version>
</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.