DataObjectSearchIndexConf

Represents the source 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 Metadata and inherits its fields.

File Suffix and Directory Location 

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

Version 

Introduced in API version 63.0.

Special Access Rules 

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

Fields 

application 

  • Type: string

  • Required: Yes

  • Description: Required.

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

channel 

  • Type: string
  • Required: No
  • Description: The search channel that the Search Answers configuration applies to.

masterLabel 

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the Search Answers configuration.

nameFieldReference 

  • Type: string

  • Required: Yes

  • Description: Required.

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

objectReference 

  • Type: string

  • Required: Yes

  • Description: Required.

    The DMO that the Search Answers configuration applies to.

retriever 

  • Type: string
  • Required: No
  • Description: The retriever that accesses the Search Answers indexed data.

searchIndex 

  • Type: string

  • Required: Yes

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

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

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