メタデータ API 開発者ガイド
jSearchLayouts
詳細は、Salesforce ヘルプの「Customize Layouts for Search Results (検索結果のレイアウトのカスタマイズ)」および「カスタムオブジェクト用の検索レイアウトのカスタマイズ」を参照してください。
バージョン
カスタムオブジェクト用の検索レイアウトは、API バージョン 14.0 以降で使用できます。標準オブジェクト (行動と ToDo を除く) の検索レイアウトを変更する機能は、API バージョン 27.0 以降で使用できます。
項目
- テキスト型として定義される名前項目は必須であり、検索結果ページで常に最初の列として表示されます。項目のリストを照会した場合、名前項目は返されませんが他のすべての項目は返されます。名前項目を自動採番型として定義した場合、必須ではなくなり、リストから削除できます。これらのルールは customTabListAdditionalFields、lookupDialogsAdditionalFields、lookupPhoneDialogsAdditionalFields、searchResultsAdditionalFields に適用されます。
- カスタムオブジェクトの場合、これらのレイアウトでは API 参照名を使用します。たとえば、項目名 My Custom Field の代わりに MyCustomField__c を使用します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| customTabListAdditionalFields | string[] | オブジェクトの最近の [オブジェクト名] リストビューに表示される項目のリスト。 |
| excludedStandardButtons | string[] | 検索レイアウトから除外される標準ボタンのリスト。 |
| listViewButtons | string[] | オブジェクトのリストビューで使用できるボタンのリスト。 この項目は、UI のオブジェクト詳細ページに表示される関連リストの [オブジェクト名] リストビューに含まれる [表示されるボタン] の値に相当します。詳細は、Salesforce ヘルプの「Salesforce Classic での標準および高度なルックアップ」を参照してください。 |
| lookupDialogsAdditionalFields | string[] | オブジェクトのルックアップダイアログに表示される項目のリスト。 Salesforce オブジェクトには、多くの場合、リレーションで 2 つのレコードを互いに関連付けるルックアップ項目が 1 つ以上含まれます。たとえば、取引先責任者レコードには、その取引先責任者とその取引先責任者が関連付けられた組織との間のリレーションを表す [取引先] ルックアップ項目があります。ルックアップ検索ダイアログを使用すると、編集中のレコードに関連付けられたレコードを検索しやすくなります。ルックアップ検索条件項目を使用すると、オブジェクト内のカスタマイズさ��た項目のリストによってルックアップ検索を絞り込むことができます。 この項目は、UI のオブジェクト詳細ページに表示される関連リストの [ルックアップダイアログ] に相当します。詳細は、Salesforce ヘルプの「Salesforce Classic での標準および高度なルックアップ」を参照してください。 |
| lookupFilterFields | string[] | オブジェクトの高度なルックアップの絞り込みに使用できる項目のリスト。高度なルックアップは、必要に応じてシステム管理者が有効にできます。 この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される関連リストの [ルックアップ検索条件項目] に相当します。詳細は、Salesforce ヘルプの「Salesforce Classic での標準および高度なルックアップ」を参照してください。 |
| lookupPhoneDialogsAdditionalFields | string[] | オブジェクトのルックアップダイアログに表示される電話関連項目のリスト。 このリストにより、項目をソフトフォンダイアルパッドと統合できます。 この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される関連リストの [ルックアップ電話ダイアログ] に相当します。 |
| massQuickActions | string[] | レコードで一括クイックアクションを実行するために使用できるアクションのリスト。既存の作成または更新アクションを追加するにはこの項目を使用します。 一括クイックアクションは、クイックアクションをサポートし、Lightning Experience に検索レイアウトがあるカスタムオブジェクトおよびすべての標準オブジェクトで実行できます。これには、ケース、リード、取引先、キャンペーン、取引先責任者、商談、作業指示などが含まれます。 |
| searchFilterFields | string[] | オブジェクトの検索の絞り込みに使用できる項目のリスト。 この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される関連リストの [検索条件項目] に相当します。 |
| searchResultsAdditionalFields | string[] | オブジェクトの検索結果に表示される項目のリスト。 この項目は、アプリケーションユーザインターフェースのオブジェクト詳細ページに表示される関連リストの [検索結果] に相当します。 |
| searchResultsCustomButtons | string[] | オブジェクトの検索結果で使用できるカスタムボタンのリスト。ボタンに関連付けられたアクションは、検索結果で返される任意のレコードに適用できます。 |
宣言的なメタデータの定義のサンプル
オブジェクトの検索レイアウトの定義のサンプルを示します。
1<?xml version="1.0" encoding="UTF-8"?>
2 <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3 . . .
4 <searchLayouts>
5 <listViewButtons>New</listViewButtons>
6 <listViewButtons>Accept</listViewButtons>
7 <listViewButtons>ChangeOwner</listViewButtons>
8 <lookupDialogsAdditionalFields>firstQuote__c</lookupDialogsAdditionalFields>
9 <lookupDialogsAdditionalFields>finalQuote__c</lookupDialogsAdditionalFields>
10 <massQuickActions>Create_MQA_Contact</massQuickActions>
11 <searchResultsAdditionalFields>CREATEDBY_USER</searchResultsAdditionalFields>
12 </searchLayouts>
13 . . .
14 </CustomObject>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。