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

SearchableObjDataSyncInfo

Retrieve, deploy, update , create, and view searchable object data sync information 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

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

Version

SearchableObjDataSyncInfo 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
dataSyncActive
Field Type
boolean
Description
Indicates whether the data synchronization operation for the search object is active (true) or not (false). This value does not indicate the status of a Data Processing Engine (DPE) definition, but instead indicates the system job that executes that DPE definition.
dataSyncJob
Field Type
string
Description
The data synchronization job that updates data in the searchable object at regular intervals.
description
Field Type
string
Description
The description of a searchable object data sync information record.

Description length should not exceed 255 characters.

Note
displayFieldSet
Field Type
FieldSet
Description
The fieldset that determines how fields are displayed in the filter panel.
lastDataSyncRunDate
Field Type
string
Description
The last date and time at which the data synchronization job ran. This field does not indicate the date and time when the Data Processing Engine (DPE) last ran, but rather it indicates when the system job that executes the DPE definition last ran.
lookupMappings
Field Type
Object Mapping
Description
The mappings for inputObject to outputObject for lookup type fields.
masterLabel
Field Type
string
Description

Required.

A user-friendly name for the use case definition, which is defined when the use case definition is created.
parsingFieldSet
Field Type
FieldSet
Description
The fieldset that determines how fields are parsed for criteria-based search and filter.
picklistMappings
Field Type
Object Mapping
Description
The mappings for inputObject to outputObject for picklist type fields.
scheduleFrequencyInHours
Field Type
string
Description
The frequency at which the data synchronization job is run to refresh data in the searchable object.
searchableObject
Field Type
string
Description

Required.

The object that's used for criteria-based search and filter.

Declarative Metadata Sample Definition

The following is an example of a SearchableObjDataSyncInfo component.

<?xml version="1.0" encoding="UTF-8"?>
<SearchableObjDataSyncInfo xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataSyncActive>false</dataSyncActive>
    <displayFieldSet>
        <fullName>DisplayAssetSearch</fullName>
        <availableFields>
            <alternativeDisplayFormat>Picklist</alternativeDisplayFormat>
            <field>Country</field>
            <isRequired>false</isRequired>
        </availableFields>
        <availableFields>
            <alternativeDisplayFormat>Picklist</alternativeDisplayFormat>
            <field>City</field>
            <isRequired>false</isRequired>
        </availableFields>
        <description>DisplayTypes</description>
        <displayedFields>
            <alternativeDisplayFormat>Picklist</alternativeDisplayFormat>
            <field>Country</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <displayedFields>
            <alternativeDisplayFormat>Picklist</alternativeDisplayFormat>
            <field>City</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <label>DisplayTypes</label>
    </displayFieldSet>
.   <parsingFieldSet>
        <fullName>ParsingAssetSearch</fullName>
        <availableFields>
            <field>SerialNumber</field>
            <isRequired>false</isRequired>
        </availableFields>
        <description>ParsingTypes</description>
        <displayedFields>
            <field>SerialNumber</field>
            <isRequired>false</isRequired>
        </displayedFields>
        <label>ParsingTypes</label>
    </parsingFieldSet>
    <lookupMappings>
        <inputObject>Asset</inputObject>
        <mappingFields>
            <inputField>RootAssetId</inputField>
            <outputField>SerialNumber</outputField>
        </mappingFields>
        <outputObject>Asset</outputObject>
    </lookupMappings>
    <masterLabel>AssetSearch</masterLabel>
    <picklistMappings>
        <inputObject>Account</inputObject>
        <mappingFields>
            <inputField>AccountSource</inputField>
            <outputField>Name</outputField>
        </mappingFields>
        <outputObject>Asset</outputObject>
    </picklistMappings>
    <searchableObject>Asset</searchableObject>
</SearchableObjDataSyncInfo>

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>SearchableObjDataSyncInfo</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.