この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

FlexiPage

Lightning ページに関連付けられたメタデータを表します。Lightning ページは、Lightning コンポーネントを含む領域で構成される、カスタマイズ可能な画面を表します。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

Lightning ページの領域には、最大 100 個のコンポーネントを配置できます。

メモ

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

これらのページは、API では FlexiPage と呼ばれますが、それ以外の Salesforce ドキュメントおよび UI では Lightning ページと呼ばれます。

メモ

API バージョン 49.0 以降の場合、FlexiPage の配列は valueList として表されます。各配列要素は valueListItem で表し、要素名は value で表します。API バージョン 48.0 以前では、配列は value で表し、配列要素はコンマ区切りリストの形式で記述します。API バージョン 49.0 以降を使用して取得された FlexiPage は、FlexiPage の作成に使用された API バージョンに関係なく、valueList を使用してコンポーネントプロパティの配列値を表します。

メモ

Lightning ページは、いくつかの場所で使用されます。
  • Salesforce モバイルアプリケーションでは、Lightning ページはナビゲーションメニューに表示されるアプリケーションのホームページです。
  • Lightning Experience では、Lightning ページを次の目的で使用できます。
    • レコードページ、Salesforce ホームページ、Outlook および Gmail インテグレーションのメールアプリケーションペインのレイアウトをカスタマイズする。
    • アプリケーションのホームページとして。
    • Lightning アプリケーションのユーティリティバーとして。

Lightning ページについての詳細は、Salesforce ヘルプを参照してください。

ファイルのサフィックスおよびディレクトリの場所

FlexiPage コンポーネントのサフィックスは .flexipage で、flexipages フォルダーに保存されます。

バージョン

FlexiPage コンポーネントは、API バージョン 29.0 以降で使用できます。

項目

項目名 項目の型 説明
description string Lightning ページの説明テキスト (省略可能)。
events FlexiPageEvent[] Lightning ページに関連付けられているイベントのリスト。

この項目は、API バージョン 53.0 以降で使用できます。

flexiPageRegions FlexiPageRegion[] ページの領域のリスト。
masterLabel string 必須。[設定] に表示される Lightning ページの表示ラベル。
pageTemplate string 非推奨。この項目は API バージョン 33.0 から 38.0 でのみ使用してください。それ以降のバージョンでは、template を使用してください。

必須。Lightning ページに関連付けられているテンプレート。

parentFlexiPage string このページが動作を継承する元となる Lightning ページの名前。

この項目は、API バージョン 37.0 以降で使用できます。

platformActionlist PlatformActionList Lightning アプリケーションページに表示されるすべてのアクションとその順序のリスト。Salesforce モバイルアプリケーションの場合、アクションはアクションバーに表示されます。

この項目は、API バージョン 34.0 以降で使用できます。

quickActionList QuickActionList Lightning ページに関連付けられたクイックアクションのリスト。
sobjectType string Lightning ページが関連付けられているオブジェクト。種別が AppPage または HomePage の Lightning ページでは、この項目は null です。

この項目の値を設定すると、変更はできません。

この項目は、API バージョン 37.0 以降で使用できます。

template FlexiPageTemplateInstance 必須。Lightning ページに関連付けられているテンプレート。

この項目は、API バージョン 39.0 以降で使用できます。

type FlexiPageType (string 型の列挙) 必須。ページの種別。API バージョン 32.0 ~ 36.0 では、この項目には値 AppPage しか設定できません。
有効な値は、次のとおりです。
  • CdpRecordPage — Lightning Experience の CDPNearCoreObject レコードページを上書きするために使用される Lightning ページ。組織で Data Cloud が有効である場合、この値は API バージョン 54.0 以降で使用できます。
  • AppPage — カスタムアプリケーションのホームページとして使用される Lightning ページ。
  • CommAppPage — エクスペリエンスビルダーで作成された、カスタムページを表すために使用される Lightning ページ。この値は API バージョン 37.0 以降で使用できます。
  • CommCheckoutPage — エクスペリエンスビルダーで作成された、B2B Commerce チェックアウトを作成するために使用される Lightning ページ。この値は API バージョン 46.0 以降で使用できます。
  • CommFlowPage — エクスペリエンスビルダーで作成された、フローページを上書きするために使用する Lightning ページ。この値は API バージョン 45.0 以降で使用できます。
  • CommForgotPasswordPage — エクスペリエンスビルダーで作成された、パスワードを忘れた場合のページを上書きするために使用する Lightning ページ。この値は API バージョン 39.0 以降で使用できます。
  • CommFlowPage — エクスペリエンスビルダーで作成された、標準フローページ。この値は API バージョン 45.0 以降で使用できます。
  • CommGlobalSearchResultPage — エクスペリエンスビルダーで作成された、グローバル検索結果ページを上書きするために使用する Lightning ページ。この値は API バージョン 41.0 以降で使用できます。
  • CommLoginPage — エクスペリエンスビルダーで作成された、ログインページを上書きするために使用する Lightning ページ。この値は API バージョン 39.0 以降で使用できます。
  • CommNoSearchResultsPage — 結果を返さない B2B 検索用のエクスペリエンスビルダーサイトページ。このページの URL は、no-results/:term になります。このページは、最初は空白になります。目的の「結果なし」エクスペリエンスを実現するには、パラメーターを受け入れる任意のコンポーネントを追加します。たとえば、おすすめ、バナー、ヘルプ、およびサポート用に HTML Editor コンポーネントまたは CMS コンポーネントを配置できます。この値は API バージョン 48.0 以降で使用できます。
  • CommObjectPage — エクスペリエンスビルダーで作成された、オブジェクトページを上書きするために使用する Lightning ページ。この値は API バージョン 38.0 以降で使用できます。
  • CommOrderComfirmationPage — エクスペリエンスビルダーで作成された、チェックアウトで B2B Commerce 注文確認ページを作成するために使用する Lightning ページ。この値は API バージョン 46.0 以降で使用できます。
  • CommQuickActionCreatePage — エクスペリエンスビルダーで作成された、レコードの作成ページを上書きするために使用する Lightning ページ。この値は API バージョン 38.0 以降で使用できます。
  • CommRecordPage — エクスペリエンスビルダーで作成された、レコードページを上書きするために使用する Lightning ページ。この値は API バージョン 38.0 以降で使用できます。
  • CommRelatedListPage — エクスペリエンスビルダーで作成された、関連リストのページを上書きするために使用する Lightning ページ。この値は API バージョン 38.0 以降で使用できます。
  • CommSearchResultPage — エクスペリエンスビルダーで作成された、検索結果ページを上書きするために使用する Lightning ページ。この値は API バージョン 38.0 以降で使用できます。
  • CommSelfRegisterPage — エクスペリエンスビルダーで作成された、セルフ登録ページを上書きするために使用する Lightning ページ。この値は API バージョン 39.0 以降で使用できます。
  • CommThemeLayoutPage — エクスペリエンスビルダーで作成された、テーマレイアウトページを上書きするために使用する Lightning ページ。この値は API バージョン 38.0 以降で使用できます。
  • EmbeddedServicePage — この値は、API バージョン 45.0 以降で使用できます。
  • EmailContentPage — メールの内容のビルダーマークアップを含むページ。ビルダーでメールの内容を編集するとき、FlexiPage オブジェクトによってコンポーネントを配置した場所が記憶されます。

    ビルダーマークアップが���まれているため、種別が EmailContentPage の場合、FlexiPages を取得またはリリースすることはできません。

  • EmailTemplatePage — メールテンプレートのビルダーマークアップを含むページ。ビルダーでメールテンプレートを編集するとき、FlexiPage オブジェクトによってコンポーネントを配置した場所が記憶されます。

    ビルダーマークアップが含まれているため、種別が EmailTemplatePage または EmailContentPage の場合、FlexiPages を取得またはリリースすることはできません。

  • ForecastingPage — Lightning Experience のデフォルトの売上予測ページを上書きするために使用する Lightning ページ。この値は、API バージョン 57.0 以降で使用できます。
  • HomePage — Lightning Experience のホームページを上書きするために使用される Lightning ページ。この値は API バージョン 37.0 以降で使用できます。
  • MailAppAppPage — Outlook および Gmail インテグレーションのデフォルトのレイアウトを上書きするために使用するメールアプリケーションペイン。この値は API バージョン 38.0 以降で使用できます。
  • OmniSupervisorPageType - オムニチャネルスーパーバイザーのページのユーザーインターフェースをカスタマイズするために使用される Lightning ページ。この値は API バージョン 60.0 以降で利用できます。
  • RecordPage — Lightning Experience のオブジェクトレコードページを上書きするために使用される Lightning ページ。この値は API バージョン 37.0 以降で使用できます。
  • RecordPreview — Lightning Experience でプレビュー可能なレコードにカーソルを置いたときに標準のルックアッププレビューを上書きするために使用する Lightning ページ。この値は API バージョン 45.0 以降で使用できます。
  • UtilityBar — Lightning Experience アプリケーションでユーティリティバーとして使用される Lightning ページ。この値は API バージョン 38.0 以降で使用できます。
  • VoiceExtension — Service Cloud Voice のオムニチャネルウィジェットでユーザーインターフェースやエージェントアクションをカスタマイズするために使用する Lightning ページ。この値は、API バージョン 57.0 以降で使用できます。

この項目は、API バージョン 32.0 以降で使用できます。

FlexiPageEvent

Lightning ページに関連付けられているイベント。API バージョン 53.0 以降で利用できます。

項目名 項目の型 説明
sourceName string 必須。イベント取得元項目の名前。取得元がカスタム Lightning Web コンポーネントである場合、この項目は、そのコンポーネントの名前です。

API 53.0 の場合、取得元として設定できるのは、Lightning Web コンポーネントのみです。

sourceProperties FlexiPageEventSourceProperty[] イベント取得元に関連付けられているプロパティのリスト。
sourceType FlexipageEventSourceTypeEnum (string 型の列挙) 必須。イベント取得元として割り当てられた項目の種別。

API バージョン 53.0 では、この項目には値 Component しか設定できません。

targets FlexiPageEventTarget[] イベント取得元に関連付けられている取得先のリスト。

FlexiPageEventSourceProperty

イベントに関連付けられているプロパティ。API バージョン 53.0 以降で利用できます。

項目名 項目の型 説明
name string 必須。API バージョン 53.0 以降、この項目の値として設定できるのは、eventName のみです。
value string 必須。name 項目の値が eventName の場合、この項目はイベントの名前です。

イベント取得元が Lightning Web コンポーネントである場合、この値は、取得元コンポーネントの js-meta.xml ファイルに定義されているイベント名と同じにする必要があります。

FlexiPageEventTarget

Lightning ページのイベント取得元に関連付けられている取得先。API バージョン 53.0 以降で利用できます。

項目名 項目の型 説明
mappings FlexiPageEventPropertyMapping[] イベントの取得元と取得先をバインドするためのキーと値のペアのリスト。
method string 必須。

有効な値は updateProperties のみです。

name string 必須。イベント取得先の名前。
有効な値は、次のとおりです。
  • flexipage:componentService
properties FlexiPageEventTargetProperty[] イベント取得先のプロパティのリスト。
type FlexiPageEventTargetTypeEnum (string 型の列挙) 必須。イベント取得先として割り当てられた項目の種別。
有効な値は、次のとおりです。
  • FlexipageServices — Lightning ページのコンポーネント。

FlexiPageEventPropertyMapping

イベントの取得元と取得先をバインドするためのキーと値のペア。API バージョン 53.0 以降で利用できます。

項目名 項目の型 説明
name string 必須。イベントがトリガーされたときに変化する取得先プロパティの名前。
value string イベントが発生したときの取得先プロパティの値。

文字列型、整数型、ブール型のプロパティでは、式を使用してその値を定義できます。有効な式の形式は、{!Event.eventPropertyName} です。イベントは、インタラクションの式でサポートされる唯一のコンテキストです。

FlexiPageEventTargetProperty

キーと値のペアとして表現されるイベント取得元の取得先のプロパティ。API バージョン 53.0 以降で利用できます。

項目名 項目の型 説明
name string 必須。API バージョン 53.0 以降、この項目の値として設定できるのは、componentIdentifier のみです。
value string 必須。コンポーネントの ComponentInstance identifier 値。

FlexiPageRegion

FlexiPageRegion は、ページ領域のプロパティを表します。範囲には、エンティティセットを範囲とすることができる、レコードリストコンポーネントまたは最近使ったデータコンポーネントを含めることができます。

項目名 項目の型 説明
appendable RegionFlagStatus (string 型の列挙) この値はデジタルエクスペリエンスにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。
有効な値は、次のとおりです。
  • disabled
  • enabled
この項目は、replaceable および prependable と組み合わせて評価されます。
  • すべてのプロパティが enabled に設定されている場合、この領域はロック解除されます。
  • すべてのプロパティが disabled に設定されている場合、この領域はロックされます。
  • プロパティがまったく指定されていないか、上記 3 つのプロパティがない場合、この領域はロック解除されます。

この項目は、API バージョン 35.0 以降で使用できます。

componentInstances ComponentInstance[] コンポーネントインスタンスのプロパティと名前。

この項目は API バージョン 49.0 で削除されました。API バージョン 49.0 以降では、itemInstances 項目を使用してください。

itemInstances ItemInstance[] コンポーネントと項目を格納できる項目のインスタンスの配列。

この項目は、API バージョン 49.0 以降で使用できます。

mode FlexiPageRegionMode (string 型の列挙) この項目は、将来の使用のために予約されています。
有効な値は、次のとおりです。
  • Append
  • Prepend
  • Replace

この項目は、API バージョン 35.0 以降で使用できます。

name string 必須。FlexiPage 範囲の一意の名前。
prependable RegionFlagStatus (string 型の列挙) この値はデジタルエクスペリエンスにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。
有効な値は、次のとおりです。
  • disabled
  • enabled
この項目は、appendable および replaceable と組み合わせて評価されます。
  • すべてのプロパティが enabled に設定されている場合、この領域はロック解除されます。
  • すべてのプロパティが disabled に設定されている場合、この領域はロックされます。
  • プロパティがまったく指定されていないか、上記 3 つのプロパティがない場合、この領域はロック解除されます。

この項目は、API バージョン 35.0 以降で使用できます。

replaceable RegionFlagStatus (string 型の列挙) この値はデジタルエクスペリエンスにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。
有効な値は、次のとおりです。
  • disabled
  • enabled
この項目は、appendable および prependable と組み合わせて評価されます。
  • すべてのプロパティが enabled に設定されている場合、この領域はロック解除されます。
  • すべてのプロパティが disabled に設定されている場合、この領域はロックされます。
  • プロパティがまったく指定されていないか、上記 3 つのプロパティがない場合、この領域はロック解除されます。

この項目は、API バージョン 35.0 以降で使用できます。

type FlexiPageRegionType (string 型の列挙) 必須。FlexiPage 範囲の種別。
有効な値は、次のとおりです。
  • Background — バックグラウンドユーティリティ項目の領域を表し、UI には表示されません。ユーティリティバーでのみサポートされます。
  • Facet
  • Region

この項目は、API バージョン 35.0 以降で使用できます。

ItemInstance

Lightning ページ上のコンポーネントまたは項目のインスタンス。API バージョン 49.0 以降で使用できます。

項目名 項目の型 説明
componentInstance ComponentInstance コンポーネントインスタンスのプロパティと名前。
fieldInstance FieldInstance 項目コンポーネントの API 参照名、表示ラベル、および表示ルール情報。この項目は、動的フォームを使用する Lightning ページでのみ使用できます。

ComponentInstance

フィルターリストなど、ページ内のコンポーネントのインスタンス。

項目名 項目の型 説明
componentInstanceProperties ComponentInstanceProperty[] コンポーネントインスタンスの単一プロパティの値。
componentName string 必須。コンポーネントの単一インスタンスの名前。
identifier string 必須。ComponentInstance の一意の名前。Lightning ページのコンポーネントの個々のインスタンスを一意に識別できます。この項目は、最大 120 文字に制限されています。

この項目は、API バージョン 53.0 以降で使用できます。

visibilityRule UiFormulaRule コンポーネントをページ上に表示する条件を定義する 1 つ以上の条件のセット。

ルールが true と評価されると、コンポーネントがページに表示されます。false の場合は表示されません。���の項目が null の場合、デフォルトではコンポーネントが表示されます。

この項目は、API バージョン 41.0 以降で使用できます。

ComponentInstanceProperty

コンポーネントインスタンスの単一プロパティの値。ComponentInstanceProperty は、最大 10,000 文字に制限されています。

項目名 項目の型 説明
name string コンポーネントインスタンス内で一意のプロパティ名。Lightning コンポーネントでは、この値は .cmp ファイルで定義される <aura:attribute> です。
type ComponentInstancePropertyTypeEnum (string 型の列挙) この項目値が null の場合、ComponentInstanceProperty の値が Lightning コンポーネントに適用されます。この項目値が decorator の場合、ComponentInstanceProperty の値が Lightning コンポーネントのコンポーネントデコレーターに適用されます。

コンポーネントデコレーターは、Lightning コンポーネントを囲むラッパーです。このデコレーターでは、Lightning Experience に特定のページを表示するときに、他の機能をコンポーネントに適用できます。たとえば、Lightning Experience ユーティリティバー上のコンポーネントを囲むコンポーネントデコレーターを設定して、開いたときのコンポーネントの高さや幅を設定できます。UtilityBar は、コンポーネントデコレーターをサポートする唯一のページ種別です。

有効な値は、次のとおりです。
  • decorator

この項目は、API バージョン 38.0 以降で使用できます。

value string プロパティの参照または値。

[関連リスト] コンポーネントを定義する場合、親レコードを使用するには、parentFieldApiName 値を object.field_name に設定します。親レコードを使用しない場合は、値を object.Id に設定します。

valueList ComponentInstancePropertyList コンポーネントインスタンスの値の配列。API バージョン 49.0 以降で利用できます。

タブ

タブコンポーネントに標準表示ラベル (活動、コラボレーション、詳細など) を付ける場合、name 項目が title に設定されていると、表示ラベルではなくシステム定義値が value 項目で使用されます。システム定義値の例として、次のようなものがあります。
  • Standard.Tab.activity
  • Standard.Tab.collaborate
  • Standard.Tab.detail
  • Standard.Tab.feed
  • Standard.Tab.preview
  • Standard.Tab.relatedLists
たとえば、Lightning ページに標準表示ラベル「活動」のあるタブが含まれているとします。そのページの定義を照会すると、value には表示ラベルではなく、タブのシステム定義名が表示されます。
1<componentInstances>
2  <componentInstanceProperties>
3    <name>title</name>
4    <value>Standard.Tab.activity</value>
5  </componentInstanceProperties>
6    <componentName>flexipage:tab</componentName>
7</componentInstances>

保存オプション

保存オプションは、RecordPage 種別のページのみで使用できます。ユーザーが取引先を編集する場合や、ケースやリードを作成、編集、またはコピーする場合に使用します。保存オプションは、FlexiPageTemplateInstance で ComponentInstanceProperty として設定されます。

ComponentInstanceProperty の name 項目を saveOptions に設定し、value を使用してチェックボックスの値を定義します。この場合の value 項目は、ComponentInstancePropertyList ではなく、各チェックボックスの名前とその値を表す、名前と値のペアの JSON 配列の文字列表現です。

API 参照名 使用可能なオブジェクト 選択可能な値 UI の表示ラベル
UseDefaultAssignmentRule Account
  • NONE
  • APPLY_OPTION_WITHOUT_CHECKBOX_DISPLAY
  • SHOW_CHECKBOX_WITH_DEFAULT_OFF
  • SHOW_CHECKBOX_WITH_DEFAULT_ON
保存時にこの取引先をテリトリールールに照らして評価する
UseDefaultAssignmentRule Lead
  • NONE
  • SHOW_CHECKBOX_WITH_DEFAULT_OFF
  • SHOW_CHECKBOX_WITH_DEFAULT_ON
有効な割り当てルールを使用して割り当てる
UseDefaultAssignmentRule Case
  • NONE
  • APPLY_OPTION_WITHOUT_CHECKBOX_DISPLAY
  • SHOW_CHECKBOX_WITH_DEFAULT_OFF
  • SHOW_CHECKBOX_WITH_DEFAULT_ON
有効な割り当てルールを使用して割り当てる
triggerOtherEmail Case
  • NONE
  • SHOW_CHECKBOX_WITH_DEFAULT_OFF
  • SHOW_CHECKBOX_WITH_DEFAULT_ON
メールで <取引先責任者> に通知する
UI の結果
NONE チェックボックスを表示せず、保存時に保存オプションを適用しません。
APPLY_OPTION_WITHOUT_CHECKBOX_DISPLAY チェックボックスは表示しませんが、保存時に保存オプションを適用します。
SHOW_CHECKBOX_WITH_DEFAULT_OFF チェックボックスを表示し、デフォルトでオフにします。
SHOW_CHECKBOX_WITH_DEFAULT_ON チェックボックスを表示し、デフォルトでオンにします。

たとえば��保存時に、チェックボックスを表示せずに [有効な割り当てルールを使用して割り当てる] を実行し、[メールで <取引先責任者> に通知する] チェックボックスを表示して、デフォルトでオンにするようにケースを設定できます。

1saveOptions = [{"name":"UseDefaultAssignmentRule","value":"APPLY_OPTION_WITHOUT_CHECKBOX_DISPLAY"}, {"name":"triggerOtherEmail","value":"SHOW_CHECKBOX_WITH_DEFAULT_ON"}]

これらを保存オプションとして設定する前に、割り当てルール、テリトリールール、およびメールテンプレートを設定します。

メモ

ComponentInstancePropertyList

コンポーネントインスタンスの配列内の要素の値。

項目名 項目の型 説明
valueListItems ComponentInstancePropertyListItem[] コンポーネントインスタンスの要素の配列。

ComponentInstancePropertyListItem

コンポーネントインスタンスの配列内の要素の名前。

項目名 項目の型 説明
value string コンポーネントインスタンスの配列内の要素の名前。

API バージョン 49.0 以降の場合、FlexiPage の配列は valueList として表されます。各配列要素は valueListItem で表し、要素名は value で表します。

たとえば、アクションの配列があり API 名の CloneEdit を含んでいる場合、この配列は 2 つの valueListItems を持つ valueList として表されます。1 つの valueListItemsClone で、もう 1 つの valueListItemsEdit です。
1<componentInstances>
2  <componentInstanceProperties> 
3    <name>actionApiName</name>
4    <valueList>
5      <valueListItems>
6        <value>Clone</value>
7      </valueListItems>
8      <valueListItems>
9        <value>Edit</value>
10      </valueListItems>
11    </valueList>
12  </componentInstanceProperties>
13</componentInstances>

UiFormulaRule

コンポーネントを Lightning ページ上に表示する条件を定義する 1 つ以上の条件のセット。たとえば、[金額] が $1,000,000 よりも大きいとき、商談ページにリッチテキストコンポーネントを表示する条件を作成できます。API バージョン 41.0 以降で利用できます。

項目名 項目の型 説明
booleanFilter string 高度な検索条件を指定します (1 AND 2 など)。
criteria UiFormulaCriterion[] 評価時にコンポーネントの表示を決定する 1 つ以上の条件のリスト。

UiFormulaCriterion

評価時に Lightning ページのコンポーネントの表示を定義する 1 つの条件。API バージョン 41.0 以降で利用できます。

項目名 項目の型 説明
leftValue string 必須。条件のベースとなる項目。たとえば、AMOUNT のようになります。
operator string 必須。データを絞り込むために使用される演算子を定義します。有効な値は、次のとおりです。
  • CONTAINS
  • EQUAL
  • NE — 等しくない
  • GT — より大きい
  • GE — 以上
  • LE — 以下
  • LT — より小さい
rightValue string コンポーネントの表示を評価する値。たとえば、1000000 です。
コンポーネントの表示に関する条件を設定する場合、leftValue 項目で次の式を使用できます。
  • {!$Client.FormFactor} — ページを表示するデバイスに基づいてコンポーネントの表示を制御するには、この式を使用します。有効な値は Small (電話)、Medium (タブレット)、Large (Lightning Experience デスクトップ) です。新しい Salesforce モバイルアプリケーションが有効になっている組織でのみ、この値をレコードページに対して Small に設定できます。この式は API バージョン 41.0 以降のアプリケーションページと API バージョン 47.0 以降のレコードページでサポートされます。
  • {!$Permission.CustomPermission.permissionName} — Lightning ページを参照しているユーザーのカスタム権限に基づいてコンポーネントの表示を制御するには、この式を使用します。アプリケーション、ホーム、およびレコードページでのみサポートされます。
  • {!$Permission.StandardPermission.permissionName} — Lightning ページを参照しているユーザーの標準権限に基づいてコンポーネントの表示を制御するには、この式を使用します。アプリケーション、ホーム、およびレコードページでのみサポートされます。
  • {!Record.field} — レコードページでのみサポートされます。
  • {!$User.field} — アプリケーション、ホーム、およびレコードページでのみサポートされます。

たとえば、電話に表示する場合にのみコンポーネントを表示するには、条件 {!$Client.FormFactor} EQUAL "SMALL" を追加します。また、システム管理者にのみコンポーネントを表示するには、{!$User.Profile.Name} EQUAL "System Administrator" を使用します。

コンポーネントの表示ルール内の式は 5 個の項目までまたがることができます。たとえば、{!Record.Account.Owner.Manager.Manager.Manager.LastName} は、6 個の項目にまたがっているためサポートされません。

FieldInstance

Lightning ページに存在する単一の項目コンポーネントを表します。API バージョン 49.0 以降で利用できます。このサブタイプは、動的フォームが有効になっている Lightning ページでのみ利用できます。

項目名 項目の型 説明
fieldInstanceProperties FieldInstanceProperty[] 項目インスタンスのプロパティ。項目に関連付けられている各プロパティの名前と値のペアが含まれます。
fieldItem string コンテキストのプレフィックスが付けられた項目の API 名。たとえば、レコードの項目は Record. の接頭辞が付けられます。
identifier string 必須。FieldInstance の一意の名前。動的フォーム対応 Lightning ページの項目の個々のインスタンスを一意に識別できます。この項目は、最大 120 文字に制限されています。

この項目は、API バージョン 53.0 以降で使用できます。

visibilityRule UiFormulaRule コンポーネントをページ上に表示する条件を定義する 1 つ以上の条件のセット。ルールが true と評価されると、コンポーネントがページに表示されます。false の場合は表示されません。この項目が null の場合、デフォルトではコンポーネントが表示されます。

FieldInstanceProperty

項目インスタンスの単一プロパティを表します。API バージョン 49.0 以降で利用できます。このサブタイプは、動的フォームが有効になっている Lightning ページでのみ利用できます。

項目名 項目の型 説明
name string 項目インスタンス内で一意のプロパティ名。

API バージョン 49.0 では、この項目の有効な値は uiBehavior のみです。

value string プロパティの参照または値。
API バージョン 49.0 でのこの項目の有効な値は次のとおりです。
  • None
  • Readonly
  • Required

FlexiPageTemplateInstance

FlexiPageTemplateInstance は Lightning ページテンプレートのインスタンスを表します。

項目名 項目の型 説明
name string 必須。テンプレートの単一インスタンスの名前。
properties ComponentInstanceProperty[] テンプレートインスタンスの単一プロパティの値。
次の場合のみ有効:
  • CommThemeLayoutPage
  • 取引先、ケース、リードオブジェクトに関連付けられた RecordPage 種別の動的フォーム対応ページ

ページテンプレートに関連付けられている各テーマレイアウトプロパティの名前と値のペアが含まれます。エクスペリエンスビルダーでは、テーマレイアウトとそのプロパティは [テーマ] 領域に表示されます。

PlatformActionList

Lightning アプリケーションページに表示されるアクションとその順序のリストを表す PlatformActionList。API バージョン 34.0 以降で利用できます。

項目名 項目の型 説明
actionListContext PlatformActionListContext (string 型の列挙) 必須。アクションリストのコンテキスト。有効な値は、次のとおりです。
  • Assistant
  • BannerPhoto
  • Chatter
  • Dockable
  • FeedElement
  • FlexiPage
  • Global
  • ListView
  • ListViewDefinition
  • ListViewRecord
  • Lookup
  • MruList
  • MruRow
  • ObjectHomeChart
  • Photo
  • Record
  • RecordEdit
  • RelatedList
  • RelatedListRecord
platformActionListItems PlatformActionListItem[] PlatformActionList のアクション。
relatedSourceEntity string ActionListContext が RelatedList または RelatedListRecord の場合、この項目はアクションが属する関連リストの API 名を表します。

PlatformActionListItem

PlatformActionListItem は PlatformActionList のアクションを表します。API バージョン 34.0 以降で利用できます。

項目名 項目の型 説明
actionName string 必須。リストのアクションの API 参照名。
actionType PlatformActionType (string 型の列挙) 必須。アクションの種別。有効な値は、次のとおりです。
  • ActionLink — API、Web ページ、またはファイルを指す、フィード要素上のインジケーターで、Salesforce Chatter フィード UI のボタンによって表されます。
  • CustomButton — クリックすると、ウィンドウ内で URL または Visualforce ページが開くか、JavaScript が実行されます。
  • InvocableAction
  • ProductivityAction — 生産性アクションは事前定義され、限られたオブジェクトのセットに適用されます。生産性アクションには、[メールを送信]、[電話]、[地図]、[Web サイトを表示]、[ニュースを閲覧] が含まれます。[電話] アクション以外の生産性アクションを編集することはできません。
  • QuickAction — グローバルアクションまたはオブジェクト固有のアクション。
  • StandardButton — 事前定義された Salesforce ボタン ([新規]、[編集]、[削除] など)。
sortOrder int 必須。リスト内のアクションの位置。
subtype string アクションのサブタイプ。クイックアクションの場合、サブタイプは QuickActionType になります。カスタムボタンの場合、サブタイプは WebLinkTypeEnum になります。アクションリンクの場合、サブタイプは ApiApiAsyncDownloadUi になります。標準ボタンおよび生産性アクションには、サブタイプはありません。

宣言的なメタデータの定義のサンプル

次に、カ���タム商談レコードページの XML FlexiPage コンポーネント定義の例を示します。これにはタブセットとリッチテキストコンポーネントが含まれ、リッチテキストコンポーネントには表示ルールが割り当てられています。

エクスペリエンスビルダーサイトページとして、定義内の 3 つの初期領域では、header 領域がロック済み、content 領域がロック解除済み、footer 領域がロック解除済みとして表示されます。

メモ

1<?xml version="1.0" encoding="UTF-8"?>
2<FlexiPage xmlns="http://soap.sforce.com/2006/04/metadata">
3    <flexiPageRegions>
4        <itemInstances>
5            <componentInstance>
6                <componentInstanceProperties>
7                    <name>collapsed</name>
8                    <value>false</value>
9                </componentInstanceProperties>
10                <componentInstanceProperties>
11                    <name>hideChatterActions</name>
12                    <value>false</value>
13                </componentInstanceProperties>
14                <componentInstanceProperties>
15                    <name>numVisibleActions</name>
16                    <value>3</value>
17                </componentInstanceProperties>
18                <componentName>force:highlightsPanel</componentName>
19            </componentInstance>
20        </itemInstances>
21        <name>header</name>
22        <type>Region</type>
23    </flexiPageRegions>
24    <flexiPageRegions>
25        <itemInstances>
26            <componentInstance>
27                <componentInstanceProperties>
28                    <name>hideUpdateButton</name>
29                    <value>false</value>
30                </componentInstanceProperties>
31                <componentInstanceProperties>
32                    <name>variant</name>
33                    <value>linear</value>
34                </componentInstanceProperties>
35                <componentName>runtime_sales_pathassistant:pathAssistant</componentName>
36            </componentInstance>
37        </itemInstances>
38        <name>subheader</name>
39        <type>Region</type>
40    </flexiPageRegions>
41    <flexiPageRegions>
42        <itemInstances>
43            <componentInstance>
44                <componentInstanceProperties>
45                    <name>entityNames</name>
46                    <valueList>
47                        <valueListItems>
48                            <value>Opportunity</value>
49                        </valueListItems>
50                    </valueList>
51                </componentInstanceProperties>
52                <componentInstanceProperties>
53                    <name>maxRecords</name>
54                    <value>3</value>
55                </componentInstanceProperties>
56                <componentName>flexipage:recentItems</componentName>
57            </componentInstance>
58        </itemInstances>
59        <name>Facet-afbed70e-277a-41f5-9919-34651ff97773</name>
60        <type>Facet</type>
61    </flexiPageRegions>
62    <flexiPageRegions>
63        <itemInstances>
64            <componentInstance>
65                <componentInstanceProperties>
66                    <name>relatedListComponentOverride</name>
67                    <value>NONE</value>
68                </componentInstanceProperties>
69                <componentName>force:relatedListContainer</componentName>
70            </componentInstance>
71        </itemInstances>
72        <name>facet-77f21b6f-ad73-4d79-838a-79e0df27cc63</name>
73        <type>Facet</type>
74    </flexiPageRegions>
75    <flexiPageRegions>
76        <itemInstances>
77            <componentInstance>
78                <componentName>force:detailPanel</componentName>
79            </componentInstance>
80        </itemInstances>
81        <name>facet-c22fcfa7-d6f2-46ab-ac03-6c92e7398da1</name>
82        <type>Facet</type>
83    </flexiPageRegions>
84    <flexiPageRegions>
85        <itemInstances>
86            <componentInstance>
87                <componentName>runtime_sales_activities:activityPanel</componentName>
88            </componentInstance>
89        </itemInstances>
90        <name>Facet-u9v2x6h8u4k</name>
91        <type>Facet</type>
92    </flexiPageRegions>
93    <flexiPageRegions>
94        <itemInstances>
95            <componentInstance>
96                <componentInstanceProperties>
97                    <name>body</name>
98                    <value>Facet-afbed70e-277a-41f5-9919-34651ff97773</value>
99                </componentInstanceProperties>
100                <componentInstanceProperties>
101                    <name>title</name>
102                    <value>Recent Items</value>
103                </componentInstanceProperties>
104                <componentName>flexipage:tab</componentName>
105            </componentInstance>
106        </itemInstances>
107        <itemInstances>
108            <componentInstance>
109                <componentInstanceProperties>
110                    <name>active</name>
111                    <value>true</value>
112                </componentInstanceProperties>
113                <componentInstanceProperties>
114                    <name>body</name>
115                    <value>facet-77f21b6f-ad73-4d79-838a-79e0df27cc63</value>
116                </componentInstanceProperties>
117                <componentInstanceProperties>
118                    <name>title</name>
119                    <value>Standard.Tab.relatedLists</value>
120                </componentInstanceProperties>
121                <componentName>flexipage:tab</componentName>
122            </componentInstance>
123        </itemInstances>
124        <itemInstances>
125            <componentInstance>
126                <componentInstanceProperties>
127                    <name>body</name>
128                    <value>facet-c22fcfa7-d6f2-46ab-ac03-6c92e7398da1</value>
129                </componentInstanceProperties>
130                <componentInstanceProperties>
131                    <name>title</name>
132                    <value>Standard.Tab.detail</value>
133                </componentInstanceProperties>
134                <componentName>flexipage:tab</componentName>
135            </componentInstance>
136        </itemInstances>
137        <itemInstances>
138            <componentInstance>
139                <componentInstanceProperties>
140                    <name>body</name>
141                    <value>Facet-u9v2x6h8u4k</value>
142                </componentInstanceProperties>
143                <componentInstanceProperties>
144                    <name>title</name>
145                    <value>Standard.Tab.activity</value>
146                </componentInstanceProperties>
147                <componentName>flexipage:tab</componentName>
148            </componentInstance>
149        </itemInstances>
150        <name>facet-27334405-c871-463f-bc20-b3713bbb4884</name>
151        <type>Facet</type>
152    </flexiPageRegions>
153    <flexiPageRegions>
154        <itemInstances>
155            <componentInstance>
156                <componentInstanceProperties>
157                    <name>tabs</name>
158                    <value>facet-27334405-c871-463f-bc20-b3713bbb4884</value>
159                </componentInstanceProperties>
160                <componentName>flexipage:tabset</componentName>
161            </componentInstance>
162        </itemInstances>
163        <name>main</name>
164        <type>Region</type>
165    </flexiPageRegions>
166    <flexiPageRegions>
167        <itemInstances>
168            <componentInstance>
169                <componentInstanceProperties>
170                    <name>decorate</name>
171                    <value>true</value>
172                </componentInstanceProperties>
173                <componentInstanceProperties>
174                    <name>richTextValue</name>
175                    <value>&lt;p style=&quot;text-align: center;&quot;&gt;&lt;span style=&quot;background-color: rgb(255, 255, 255); font-size: 18px; color: rgb(11, 11, 11);&quot;&gt;A million dollar opportunity closed! Oh yeah!&lt;/span&gt;&lt;/p&gt;</value>
176                </componentInstanceProperties>
177                <componentName>flexipage:richText</componentName>
178                <visibilityRule>
179                    <booleanFilter>1 AND 2</booleanFilter>
180                    <criteria>
181                        <leftValue>{!Record.Amount}</leftValue>
182                        <operator>GE</operator>
183                        <rightValue>1000000</rightValue>
184                    </criteria>
185                    <criteria>
186                        <leftValue>{!Record.StageName}</leftValue>
187                        <operator>EQUAL</operator>
188                        <rightValue>Closed Won</rightValue>
189                    </criteria>
190                </visibilityRule>
191            </componentInstance>
192        </itemInstances>
193        <itemInstances>
194            <componentInstance>
195                <componentInstanceProperties>
196                    <name>decorate</name>
197                    <value>true</value>
198                </componentInstanceProperties>
199                <componentInstanceProperties>
200                    <name>richTextValue</name>
201                    <value>&lt;p style=&quot;text-align: center;&quot;&gt;&lt;span style=&quot;background-color: rgb(255, 255, 255); font-size: 16px; color: rgb(244, 0, 0);&quot;&gt;This component is for mobile users only.&lt;/span&gt;&lt;/p&gt;</value>
202                </componentInstanceProperties>
203                <componentName>flexipage:richText</componentName>
204                <visibilityRule>
205                    <criteria>
206                        <leftValue>{!$Client.formFactor}</leftValue>
207                        <operator>EQUAL</operator>
208                        <rightValue>Small</rightValue>
209                    </criteria>
210                </visibilityRule>
211            </componentInstance>
212        </itemInstances>
213        <itemInstances>
214            <componentInstance>
215                <componentName>forceChatter:recordFeedContainer</componentName>
216            </componentInstance>
217        </itemInstances>
218        <name>sidebar</name>
219        <type>Region</type>
220    </flexiPageRegions>
221    <masterLabel>New Opportunity Page</masterLabel>
222    <sobjectType>Opportunity</sobjectType>
223    <template>
224        <name>flexipage:recordHomeWithSubheaderTemplateDesktop</name>
225    </template>
226    <type>RecordPage</type>
227</FlexiPage>

FlexiPage コンポーネント定義を参照するサンプルの package.xml ファイルを次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fullName>New Opportunity Page</fullName>
4    <types>
5        <members>New_Opportunity_Page</members>
6        <name>FlexiPage</name>
7    </types>
8    <version>49.0</version>
9</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。