SearchOrgWideObjectConfig

Represents an object in the search index. The search index contains org-wide search settings created in Search Manager. Each object in the search index includes searchable fields and fields protected by field-level security in search.

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

SearchOrgWideObjectConfig components have the suffix .searchOrgWideObjectConfig and are stored in the searchOrgWideConfiguration folder.

Version

SearchOrgWideObjectConfig components are available in API version 61.0 and later.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

Field Name	Description
masterLabel	Field Type string Description Required. The name of the configuration.
objectReference	Field Type string Description Required. The API name of the object.
searchOrgWideFieldConfig	Field Type SearchOrgWideFieldConfig[] Description A list of field configurations.

SearchOrgWideFieldConfig

Represents the configuration in the search index for a field in an object.

Field Name	Description
fieldReference	Field Type string Description Required. The API name of the field.
isSearchable	Field Type boolean Description Indicates if the field is searchable (`true`) or not (`false`). If `true`, the field is shown in search results and used to match results.
isSecure	Field Type boolean Description Indicates if the field is protected by field-level security in search (`true`) or not (`false`). If `true`, the search engine uses this field to match results only for users with permissions. If `false`, the search engine uses this field to match results even if the user doesn’t have permissions to view this field.

Declarative Metadata Sample Definition

The following is an example of a SearchOrgWideObjectConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SearchOrgWideObjectConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>CustomerLabel</masterLabel>
4    <objectReference>Customer</objectReference>
5    <searchOrgWideFieldConfig>
6        <fieldReference>Custom_Field_1__c</fieldReference>
7        <isSearchable>false</isSearchable>
8        <isSecure>false</isSecure>
9    </searchOrgWideFieldConfig>
10    <searchOrgWideFieldConfig>
11        <fieldReference>Custom_Field_2__c</fieldReference>
12        <isSearchable>true</isSearchable>
13        <isSecure>true</isSecure>
14    </searchOrgWideFieldConfig>
15</SearchOrgWideObjectConfig>

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>SearchOrgWideObjectConfig</name>
6    </types>
7    <version>61.0</version>
8</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide