DataObjectSearchIndexConf

Represents the source Data Cloud data model object (DMO) for Search Answers and holds the search index that Search Answers uses when searching DMO records.

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

DataObjectSearchIndexConf components have the suffix .dataObjectSearchIndexConf and are stored in the dataObjectSearchIndexConfs folder.

Version

DataObjectSearchIndexConf components are available in API version 63.0 and later.

Special Access Rules

To access this metadata type, you must have the Customize Application user permission. The Salesforce org must have a Data Cloud license.

Fields

Field Name Description
application
Field Type
string
Description
Required.

The name of the app that the Search Answers index is associated with.

channel
Field Type
string
Description
The search channel that the Search Answers configuration applies to.
masterLabel
Field Type
string
Description
Required.

The name of the Search Answers configuration.

nameFieldReference
Field Type
string
Description
Required.

The name field of the DMO selected as a source for Search Answers.

objectReference
Field Type
string
Description
Required.

The DMO that the Search Answers configuration applies to.

retriever
Field Type
string
Description
The retriever that accesses the Search Answers indexed data.
searchIndex
Field Type
string
Description
Required.

The name of the search index mapped to the DMO.

Declarative Metadata Sample Definition

The following is an example of a DataObjectSearchIndexConf component.

<?xml version="1.0" encoding="UTF-8"?>
<DataObjectSearchIndexConf xmlns="http://soap.sforce.com/2006/04/metadata">
	<application>SearchAnswers</application>
	<channel>SharedIndex</channel>
	<masterLabel>SearchAnswers</masterLabel>
	<nameFieldReference>Name__c</nameFieldReference>
	<objectReference>Account__dlm</objectReference>
	<searchIndex>searchAnswersIndex</searchIndex>
</DataObjectSearchIndexConf>

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>DataObjectSearchIndexConf</name>
   </types>
   <version>63.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.