SearchableObjDataSyncInfo | Public Sector Solutions 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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<SearchableObjDataSyncInfo xmlns="http://soap.sforce.com/2006/04/metadata">
3    <dataSyncActive>false</dataSyncActive>
4    <displayFieldSet>
5        <fullName>DisplayAssetSearch</fullName>
6        <availableFields>
7            <alternativeDisplayFormat>Picklist</alternativeDisplayFormat>
8            <field>Country</field>
9            <isRequired>false</isRequired>
10        </availableFields>
11        <availableFields>
12            <alternativeDisplayFormat>Picklist</alternativeDisplayFormat>
13            <field>City</field>
14            <isRequired>false</isRequired>
15        </availableFields>
16        <description>DisplayTypes</description>
17        <displayedFields>
18            <alternativeDisplayFormat>Picklist</alternativeDisplayFormat>
19            <field>Country</field>
20            <isRequired>false</isRequired>
21        </displayedFields>
22        <displayedFields>
23            <alternativeDisplayFormat>Picklist</alternativeDisplayFormat>
24            <field>City</field>
25            <isRequired>false</isRequired>
26        </displayedFields>
27        <label>DisplayTypes</label>
28    </displayFieldSet>
29    <lookupMappings>
30        <inputObject>Asset</inputObject>
31        <mappingFields>
32            <inputField>RootAssetId</inputField>
33            <outputField>SerialNumber</outputField>
34        </mappingFields>
35        <outputObject>Asset</outputObject>
36    </lookupMappings>
37    <masterLabel>AssetSearch</masterLabel>
38    <picklistMappings>
39        <inputObject>Account</inputObject>
40        <mappingFields>
41            <inputField>AccountSource</inputField>
42            <outputField>Name</outputField>
43        </mappingFields>
44        <outputObject>Asset</outputObject>
45    </picklistMappings>
46    <searchableObject>Asset</searchableObject>
47</SearchableObjDataSyncInfo>

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>SearchableObjDataSyncInfo</name>
6    </types>
7    <version>61.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.