メタデータ API 開発者ガイド
jSearchSettings
パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
SearchSettings の値は、settings フォルダの Search.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
SearchSettings は、API バージョン 37.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| documentContentSearchEnabled | boolean | ドキュメントの全文検索が実行されるかどうかを示します。 |
| enableAdvancedSearchInAlohaSidebar | boolean | 高度な検索が検索サイドバーで使用できるか (true)、否か (false) を示します。Salesforce Classic でのみ使用可能。API バージョン 46.0 以降で利用できます。 |
| enableEinsteinSearchPersonalization | boolean | 検索のパーソナライズが有効化されるか (true)、否か (false) を示します。Lightning Experience のみで使用可能です。API バージョン 47.0 以降で利用できます。 |
| enablePersonalTagging | boolean | ユーザが、さまざまなオブジェクトのレコードを共通のテーマによってグループ化できるか (true)、否か (false) を示します。個人タグは、そのユーザにのみ表示されます。Salesforce Classic でのみ使用可能。API バージョン 48.0 以降で利用できます。 |
| enablePublicTagging | boolean | ユーザが、さまざまなオブジェクトのレコードを共通のテーマによってグループ化できるか (true)、否か (false) を示します。個人タグは、すべてのユーザに表示されます。Salesforce Classic でのみ使用可能。API バージョン 48.0 以降で利用できます。 |
| enableSalesforceGeneratedSynonyms | boolean | 検索のシノニムが有効化されているか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableSearchTermHistory | boolean | ユーザが、さまざまなオブジェクトのレコードを共通のテーマによってグループ化できるか (true)、否か (false) を示します。公開タグは、組織内の全ユーザに表示されます。Salesforce Classic でのみ使用可能。API バージョン 48.0 以降で利用できます。 |
| enableSetupSearch | boolean | [設定] サイドバーの検索ボックスで、Enter キーを押したときに、一致するカスタム項目、カスタムオブジェクト、およびその他のサポートされている設定項目が返されるか (true)、否か (false) を示します。デフォルトは、Developer Edition、Performance Edition、Professional Edition、Enterprise Edition、Unlimited Edition の場合は true、それ以外の Edition の場合は false です。API バージョン 47.0 以降で利用できます。 |
| enableSuggestArticlesLinksOnly | boolean | 現在のケースに類似するケースからナレッジ記事にリンクが提供されるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableUseDefaultSearchEntity | boolean | システム管理者が指定したデフォルトのエンティティをサイドバー検索で使用するか (true)、否か (false) を示します。Salesforce Classic でのみ使用可能。API バージョン 48.0 以降で利用できます。 |
| optimizeSearchForCJKEnabled | boolean | 必須。日本語、中国語、および韓国語の検索が最適化されるか (true)、否か (false) を示します。この設定は、サイドバー検索に影響を及ぼします。また、サイドバー検索とグローバル検索でリードレコードに対して [重複の検索] 機能を使用して取引先検索を行う場合にも影響を及ぼします。ユーザが日本語、中国語、または韓国語で検索することが多い場合、および検索可能項目の入力文字のほとんどが日本語、中国語、または韓国語である場合には、このオプションを有効にします。 |
| recentlyViewedUsersForBlankLookupEnabled | boolean | 必須。ユーザのオートコンプリートルックアップおよび空白のユーザルックアップから返されたレコードのリストが、ユーザの最近参照したユーザレコードから取得されるかどうかを示します (true)。ルックアップで組織全体の最近アクセスしたユーザレコードのリストを表示する場合、この設定は false です (false)。ユーザオブジェクトの空白のルックアップ検索にのみ適用されます。 |
| searchSettingsByObject | SearchSettingsByObject | 必須。各オブジェクトの検索設定のリストを表します。 |
| sidebarAutoCompleteEnabled | boolean | 必須。サイドバー検索でオートコンプリートが有効化されているか (true)、否か (false) を示します。オートコンプリートはユーザが検索語の入力を開始するときに実行され、最近参照したレコードの該当リストがサイドバー検索に表示されます。 |
| sidebarDropDownListEnabled | boolean | 必須。サイドバーの [検索] セクションにドロップダウンリストが表示されるか (true)、否か (false) を示します。このリストから、タグ内を検索するか、特定のオブジェクト内を検索するか、すべてのオブジェクトから検索するかを選択できます。 |
| sidebarLimitToItemsIOwnCheckboxEnabled | boolean | 必須。[私の所有データ] チェックボックスが表示されるか (true)、否か (false) を示します。このチェックボックスにより、ユーザがサイドバーに検索クエリを入力するときに、自身がレコード所有者であるレコードのみを対象にすることができます。 |
| singleSearchResultShortcutEnabled | boolean | 必須。ショートカットが有効化されるか (true)、否か (false) を示します。ショートカットでは、検索結果が 1 つの項目だけを返した場合、検索結果ページをスキップし、レコードの詳細ページに移動します。この設定は、タグ、ケースコメント (高度な検索の場合)、およびグローバル検索には適用されません。 |
| spellCorrectKnowledgeSearchEnabled | boolean | 必須。ナレッジ検索でスペルチェックが有効化されているか (true)、否か (false) を示します。 |
SearchSettingsByObject
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| searchSettingsByObject | ObjectSearchSetting | 各オブジェクトの検索設定のリストが含まれます。 |
ObjectSearchSetting
各オブジェクトの検索設定のリスト。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| enhancedLookupEnabled | boolean | 必須。オブジェクトで高度なルックアップが有効になっているか (true)、否か (false) を示します。 |
| lookupAutoCompleteEnabled | boolean | 必須。ルックアップ検索でオートコンプリートが有効になっているか (true)、否か (false) を示します。オートコンプリートはユーザが自動推奨を選択して参照項目をインラインで編集するときに実行されます。 |
| name | string | 必須。設定されるオブジェクトのエンティティ名。 |
| resultsPerPageCount | int | 必須。ページあたりの検索結果数。 |
パッケージマニフェストの例
組織の検索設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。
マニフェストファイル内のワイルドカードのサポート
package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。