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

CustomApplication

CustomApplication はカスタムアプリケーションまたは標準アプリケーションを表します。API バージョン 29.0 以前では、CustomApplication はカスタムアプリケーションのみを表します。アプリケーションは、説明とロゴを使用したタブ参照のリストです。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

カスタムアプリケーションおよび標準アプリケーションのサフィックスは .app で、applications フォルダに保存されます。

プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになります。

メモ

バージョン

カスタムアプリケーションは API バージョン 10.0 以降で使用できます。標準アプリケーションは API バージョン 30.0 以降で使用できます。

項目

項目名 データ型 説明
actionOverrides AppActionOverride[] アプリケーションの override アクションを表します。これを使用して、override アクションを作成、更新、編集、または削除します。

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

brand AppBrand アプリケーションで使用される配色とロゴ。

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

consoleConfig ServiceCloudConsoleConfig Salesforce コンソールアプリケーションの構成設定を表します。

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

defaultLandingTab string このアプリケーションが選択されたときに開く標準タブまたはカスタムタブの fullName
description string アプリケーションの説明テキスト (省略可能)。
formFactors FormFactor (string 型の列挙) アプリケーションが Lightning Experience に表示されるフォーム要素を示します。有効な値は、次のとおりです。
  • Null (値なし) — Salesforce Classic を使用するデスクトップの場合
  • Small — 将来の使用のために��約
  • Medium — 将来の使用のために予約
  • Large - Lightning Experience を使用するデスクトップの場合

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

バージョン 38.0 の時点で、Salesforce Classic コンソールを除いて、既存の Salesforce Classic アプリケーションでは、formFactorsLarge に設定されます。バージョン 38.0 以前に作成されたパッケージからインストールされた Salesforce Classic アプリケーションでも、formFactorsLarge に設定されます。38.0 以降で作成されたパッケージの Salesforce Classic アプリケーションでは、Lightning Experience デスクトップに表示される Salesforce Classic アプリケーションで formFactorsLarge に設定する必要があります。

メモ

isNavAutoTempTabsDisabled boolean ナビゲーションで一時タブの設定が自動的に作成されるかどうかを示します。API バージョン 43.0 以降で利用できます。
isNavPersonalizationDisabled boolean ナビゲーションのパーソナライズが無効になっているかどうかを示します。API バージョン 43.0 以降で利用できます。
isServiceCloudConsole boolean アプリケーションが Salesforce Classic コンソールアプリケーションであるかを示します。Lightning Experience コンソールアプリケーションの場合、この項目は null になり、navType 項目は Console に設定されます。
label string アプリケーションの名前。
logo string Salesforce アプリケーションまたは Salesforce コンソールの画像ドキュメントへの参照 (省略可能)。
navType NavType (string 型の列挙) 更新できません。アプリケーションで使用されるナビゲーションの種別を示します。値が Standard の場合、Lightning Experience です。値が Console の場合、Salesforce コンソールです。null 値の場合、Salesforce Classic です。

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

preferences AppPreferences Salesforce コンソールアプリケーションの設定を表します。

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

profileActionOverrides AppProfileActionOverride[] このカスタムアプリケーションに割り当てられた、Lightning Experience レコードページの ProfileActionOverrides のリスト。ユーザがカスタムアプリケーションを呼び出すと、一致する ProfileActionOverride の割り当てが、ActionOverride で指定されたレコードページの既存の上書きよりも優先されます。これにより、レコードタイプとプロファイルによってカスタムアプリケーションのレコードページを上書きできます。
subscriberTabs string[] 登録者が管理パッケージからインストールされた Lightning アプリケーションに追加したタブのリストを表します。登録者タブのレコードは、常に���タブとして開きます。

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

tabs string このアプリケーションに含まれるタブのリスト。API バージョン 12.0 では、[ホーム]、[取引先]、および [レポート] などの組み込みタブの fullName がタブの名前になります (Home など)。API バージョン 13.0 以降では、組み込みタブには standard- というプレフィックスが追加されます。たとえば、[取引先] タブを参照するには、standard-Account を使用します。

API バージョン 42.0 で、この項目は tab から tabs に名前変更されました。

uiType UiType (string 型の列挙) 更新できません。カスタムアプリケーションの種別を示します。値は次のとおりです。
  • Salesforce Classic の Aloha
  • Lightning Experience の Lightning

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

utilityBar string このアプリケーションに関連付けられた UtilityBar の開発者名。

UtilityBar は共有されているため、UtilityBar は 1 つの Lightning アプリケーションにのみ割り当てることをお勧めします。共有とは、1 つのアプリケーションで UtilityBar を変更すると、そのアプリケーションが含まれるすべてのアプリケーションで自動的に変更されるという意味です。

メモ

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

workspaceConfig AppWorkspaceConfig Salesforce コンソールアプリケーションでレコードをどのように開くかを表します。isServiceCloudConsoletrue である場合は必須です。API バージョン 42.0 で、この項目は workspaceMappings から workspaceConfig に名前変更されました。

AppActionOverride

アプリケーションの override アクションを表します。これを使用して、override アクションを作成、更新、編集、または削除します。AppActionOverride は、ActionOverride から継承し、1 つの項目 pageOrSobjectType で拡張します。Lightning Experience で API バージョン 38.0 以降で使用できます。

項目名 データ型 説明
actionName string 有効な値は view のみです。
comment string override に関連付けるすべてのコメント。
content string typeflexipage に設定されている場合は、この項目を設定します。override として使用するページの名前を参照します。インストールされたコンポーネントを参照するには、Component_namespace__Component_name の形式を使用します。
formFactor FormFactor (string 型の列挙) 上書きするページのサイズ。

type 項目が flexipage に設定されている場合、この項目を Large に設定して [表示] アクションを Lightning Experience の Lightning ページで上書きします。

Large 値は Lightning Experience デスクトップ環境を表し、flexipage 型と lightningcomponent 型でのみ有効です。Small 値は、電話またはタブレットの Salesforce モバイルアプリケーションを表します。Medium 値は、将来の使用のために予約されています。

この項目は、API バージョン 37.0 以降で使用でき、Lightning Experience でのレコードページの作成と編集のための機能の一部です。

pageOrSobjectType string 上書きする sObject 型の名前。有効な値は、standard および custom です。
skipRecordTypeSelect boolean この override アクションによって作成された新しいレコードをレコードタイプ選択ページに転送されないようにするには、この項目を true に設定します。この項目は、actionName が "create" 種別 (new など) で、typevisualforce に設定されている場合にのみ有効です。
type ActionOverrideType (string 型の列挙) 必須。override アクションの種別を表します。有効な値は Flexipage および Default です。

AppBrand

アプリケーションで使用される配色とロゴ。Lightning アプリケーションで API バージョン 38.0 以降で使用できます。

項目名 データ型 説明
footerColor string 省略可能。アプリケーションのフッターの色を決定します。色を 16 進コードで指定します (たとえば、青の場合は #0000FF)。
headerColor string 省略可能。アプリケーションのヘッダーの色を決定します。色を 16 進コードで指定します (たとえば、青の場合は #0000FF)。
logo string アプリケーションの画像ドキュメントへの参照 (省略可能)。
logoVersion int ロゴのバージョン番号 (省略可能)。
shouldOverrideOrgTheme boolean 組織のグローバルテーマを上書きするかどうかを示します。true の場合、ユーザが設定した配色とロゴが使用されます。false の場合、ユーザが配色とロゴを設定していても、組織のグローバルテーマが使用されます。

AppComponentList

Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネント (Visualforce ページ) を表します。API バージョン 42.0 で、この型は CustomApplicationComponents から AppComponentList に名前変更されました。

項目名 データ型 説明
alignment string 必須。Salesforce コンソールアプリケーションのフッターにおけるカスタムコンソールコンポーネントの整列方法を決定します。
components string[] Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネントの名前。API バージョン 42.0 で、この項目は customApplicationComponent から components に名前変更されました。

AppPreferences

Salesforce コンソールアプリケーションの設定を表します。API バージョン 42.0 以降で利用できます。

項目名 データ型 説明
enableCustomizeMyTabs boolean Salesforce コンソールアプリケーションで [タブのカスタマイズ] が有効になっているかどうかを示します。有効になっている場合、ユーザはナビゲーションタブの項目を非表示、表示、および整理できます。
enableKeyboardShortcuts boolean Salesforce コンソールアプリケーションでキーボードショートカットが有効になっているかどうかを示します。ショートカットにより、ユーザはマウスを使用せずにキーの組み合わせを押してアクションを実行できます。キーボードショートカットを有効化すると、デフォルトのいくつかのショートカットをカスタマイズできます。カスタムショートカットを作成するには、事前に開発者が addEventListener() メソッドを使用してショートカットのアクションを Salesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から実行されるアクションのキーボードショートカットを作成することはできません。isServiceCloudConsoletrue である場合は必須です。
enableListViewHover boolean Salesforce コンソールアプリケーションでリストビューのフロート表示が有効になっているかどうかを示します。true に設定されている場合、ユーザがレコード名にマウスポインタを置くと、反応型リストにレコードに関するサマリー情報が表示されます。ケースの場合は、件名項目にマウスポインタを置きます。
enableListViewReskin boolean Salesforce コンソールアプリケーションで、Salesforce Classic リストビューではなく、反応型リストビューが使用されているかどうかを示します。
enableMultiMonitorComponents boolean Salesforce コンソールアプリケーションで、マルチモニターコンポーネントが有効かどうかを示します。マルチモニターコンポーネントを使用すると、ユーザがコンソールの各部分をブラウザから画面上の場所に移動できます。isServiceCloudConsoletrue である場合は必須です。
enablePinTabs boolean Salesforce コンソールアプリケーションで、ユーザが主タブをすぐにアクセスできるようにタブバーに固定できる、タブの固定が有効かどうかを示します。
enableTabHover boolean Salesforce コンソールアプリケーションでタブのフロート表示が有効になっているかどうかを示します。有効になっている場合、ユーザがタブにマウスポインタを置くと、レコードのサマリー情報がフロート表示で表示されます。
enableTabLimits boolean Salesforce コンソールセッションで開ける主タブとサブタブの数に対する制限が有効かどうかを示します。true の場合、tabLimitConfig の値が必要です。
saveUserSessions boolean Salesforce コンソールアプリケーションでユーザセッションが自動的に保存されるかどうかを示します。有効になっている場合、コンソールのユーザがブラウザを閉じたり、Salesforce からログアウトしたりしても、再度ログインしたときに以前に開いていたタブが表示されます。isServiceCloudConsoletrue である場合は必須です。

AppProfileActionOverride

カスタムアプリケーションの ProfileActionOverride を表します。この型は ProfileActionOverride から継承し、1 つの項目 profile で拡張します。Lightning Experience で API バージョン 39.0 以降で使用できます。

項目名 データ型 説明
actionName string アクションの名前。有効な値は TabView のみです。

pageOrSobjectTyperecord-home の場合、この項目は View になります。View アクションは、ProfileActionOverride が CustomApplication の一部として指定されている場合のみサポートされます。

content string 参照のみ。override として使用されている Lightning ページの名前を表します。
formFactor FormFactor (string 型の列挙) 上書きするページのサイズ。Large 値は Lightning Experience デスクトップ環境を表します。
pageOrSobjectType string 上書きするページの名前。有効な値は record-homestandard-home のみです。
profile string ProfileActionOverride に関連付けられているプロファイル。
recordType string override に関連付けられているレコードタイプ。pageOrSobjectTypestandard-home の場合、この項目は null である必要があります。この項目は、actionNameView に設定されている場合は必須です。
type ActionOverrideType(string 型の列挙) 参照のみ。override アクションの種別。有効な値は flexipage のみです。

AppWorkspaceConfig

Salesforce コンソールアプリケーションでレコードをどのように開くかを表します。isServiceCloudConsoletrue である場合は必須です。Salesforce Classic コンソールアプリケーションで API バージョン 25.0 以降で使用できます。Lightning コンソールアプリケーションで API バージョン 41.0 以降で使用できます。API バージョン 42.0 で、この型は WorkspaceMappings から AppWorkspaceConfig に名前変更されました。

項目名 データ型 説明
mappings WorkspaceMapping[] Salesforce コンソールアプリケーションで特定のタブのレコードをどのように開くかを表します。CustomApplication に指定された��タブで必須です。API バージョン 42.0 で、この項目は workspaceMapping から mappings に名前変更されました。

CustomShortcut

Salesforce コンソールアプリケーションに割り当てられたカスタムキーボードショートカットを表します。カスタムショートカットを作成するには、事前に開発者が addEventListener() メソッドを使用してショートカットのアクションを Salesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から実行されるアクションのキーボードショートカットを作成することはできません。API バージョン 28.0 以降で利用できます。

項目名 データ型 説明
action string 必須。ユーザがキーボードショートカットを押したときにコンソールで実行されるアクション。
active boolean 必須。キーボードショートカットが有効であるか (true)、否か (false) を示します。
keyCommand string 必須。キーボードショートカットをトリガするためにユーザが押すキーの組み合わせ。キーボードショートカットでは大文字と小文字が区別されませんが、見やすくするため Salesforce ユーザインターフェースの設定ページには大文字で表示されます。

各キーコマンドには、修飾子キーを最大 4 つ、その後に非修飾子キーを 1 つ含めることができます。修飾子キーと非修飾子キーは、+ キーで区切られます。修飾子キーの順序は任意ですが、キーコマンドシーケンスの最後に非修飾子キーを指定する必要があります。たとえば、SHIFT+CTRL+ALT+META +A です。

有効な修飾子キーは、次のとおりです。
  • SHIFT
  • CTRL
  • ALT
  • META (Mac での COMMAND キーを表す)
有効な非修飾子キーは、A ~ Z の文字と 0 ~ 9 の数字です。その他の有効なキーは、次のとおりです。
  • TAB
  • ENTER
  • PAUSE/BREAK
  • CAPS LOCK
  • ESC
  • SPACE
  • PAGE UP
  • PAGE DOWN
  • END
  • HOME
  • LEFT ARROW
  • UP ARROW
  • RIGHT ARROW
  • DOWN ARROW
  • PRINT SCREEN
  • INSERT
  • DELETE
  • RIGHT WINDOW
  • NUMPAD 0
  • NUMPAD 1
  • NUMPAD 2
  • NUMPAD 3
  • NUMPAD 4
  • NUMPAD 5
  • NUMPAD 6
  • NUMPAD 7
  • NUMPAD 8
  • NUMPAD 9
  • MULTIPLY
  • ADD
  • SUBTRACT
  • DECIMAL POINT
  • DIVIDE
  • F1
  • F2
  • F3
  • F4
  • F5
  • F6
  • F7
  • F8
  • F9
  • F10
  • F11
  • F12
  • NUM LOCK
  • SCROLL LOCK
  • ;
  • =
  • ,
  • .
  • /
  • [
  • ]
  • \
  • '
description string キーボードショートカットの説明テキスト (省略可能)。
eventName string 必須。Salesforce コンソールインテグレーションツールキットを使用して、開発者がカスタムショートカット関数をコンソールに追加するときに使用できるコード。

DefaultShortcut

Salesforce コンソールアプリケーションにデフォルトで割り当てられたキーボードショートカットを表します。コンソールのキーボードショートカットを有効にすると、いくつかのデフォルトショートカットをカスタマイズに使用できるようになります。これには、タブの開閉、タブ間の移動、レコードの保存などが含まれます。API バージョン 28.0 以降で利用できます。

項目名 データ型 説明
action string 必須。ユーザがキーボードショートカットを押したときにコンソールで実行されるアクション。有効な値は、次のとおりです。
  • FOCUS_CONSOLE
  • FOCUS_NAVIGATOR_TAB
  • FOCUS_DETAIL_VIEW
  • FOCUS_PRIMARY_TAB_PANEL
  • FOCUS_SUBTAB_PANEL
  • FOCUS_LIST_VIEW
  • FOCUS_FIRST_LIST_VIEW
  • FOCUS_SEARCH_INPUT
  • MOVE_LEFT
  • MOVE_RIGHT
  • UP_ARROW
  • DOWN_ARROW
  • OPEN_TAB_SCROLLER_MENU
  • OPEN_TAB
  • CLOSE_TAB
  • ENTER
  • EDIT
  • SAVE

デフォルトのキーボードショートカットの一覧および説明は、Salesforce ヘルプの「Salesforce Classic での Salesforce コンソールのデフォルトのキーボードショートカット」を参照してください。

active boolean 必須。キーボードショートカットが有効であるか (true)、否か (false) を示します。
keyCommand string 必須。キーボードショートカットをトリガするためにユーザが押すキーの組み合わせ。キーボードショートカットでは大文字と小文字が区別されませんが、見やすくするため Salesforce ユーザインターフェースの設定ページには大文字で表示されます。

各キーコマンドには、修飾子キーを最大 4 つ、その後に非修飾子キーを 1 つ含めることができます。修飾子キーと非修飾子キーは、+ キーで区切られます。修飾子キーの順序は任意ですが、キーコマンドシーケンスの最後に非修飾子キーを指定する必要があります。たとえば、SHIFT+CTRL+ALT+META +A です。

有効な修飾子キーは、次のとおりです。
  • SHIFT
  • CTRL
  • ALT
  • META (Mac での COMMAND キーを表す)
有効な非修飾子キーは、A ~ Z の文字と 0 ~ 9 の数字です。その他の有効なキーは、次のとおりです。
  • TAB
  • ENTER
  • PAUSE/BREAK
  • CAPS LOCK
  • ESC
  • SPACE
  • PAGE UP
  • PAGE DOWN
  • END
  • HOME
  • LEFT ARROW
  • UP ARROW
  • RIGHT ARROW
  • DOWN ARROW
  • PRINT SCREEN
  • INSERT
  • DELETE
  • RIGHT WINDOW
  • NUMPAD 0
  • NUMPAD 1
  • NUMPAD 2
  • NUMPAD 3
  • NUMPAD 4
  • NUMPAD 5
  • NUMPAD 6
  • NUMPAD 7
  • NUMPAD 8
  • NUMPAD 9
  • MULTIPLY
  • ADD
  • SUBTRACT
  • DECIMAL POINT
  • DIVIDE
  • F1
  • F2
  • F3
  • F4
  • F5
  • F6
  • F7
  • F8
  • F9
  • F10
  • F11
  • F12
  • NUM LOCK
  • SCROLL LOCK
  • ;
  • =
  • ,
  • .
  • /
  • [
  • ]
  • \
  • '

KeyboardShortcuts

Salesforce コンソールアプリケーションに割り当てられたキーボードショートカットを表します。isServiceCloudConsoletrue である場合は必須です。API バージョン 28.0 以降で利用できます。

項目名 データ型 説明
customShortcuts CustomShortcut[] Salesforce コンソールアプリケーションに割り当てられたカスタムキーボードショートカットを表します。カスタムショートカットを作成するには、事前に開発者が addEventListener() メソッドを使用してショートカットのアクションを Salesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から実行されるアクションのキーボードショートカットを作成することはできません。

API バージョン 42.0 で、この項目は customShortcut から customShortcuts に名前変更されました。

defaultShortcuts DefaultShortcut[] Salesforce コンソールアプリケーションにデフォルトで割り当てられたキーボードショートカットを表します。コンソールのキーボードショートカットを有効にすると、いくつかのデフォルトショートカットをカスタマイズに使用できるようになります。これには、タブの開閉、タブ間の移動、レコードの保存などが含まれます。

デフォルトのキーボードショートカットの一覧および説明は、Salesforce ヘルプの「Salesforce Classic での Salesforce コンソールのデフォルトのキーボードショートカット」を参照してください。

API バージョン 42.0 で、この項目は defaultShortcut から defaultShortcuts に名前変更されました。

ListPlacement

Salesforce コンソールアプリケーションにおけるリストの表示方法を表します。isServiceCloudConsoletrue である場合は必須です。API バージョン 25.0 以降で利用できます。

項目名 データ型 説明
height int リストの高さ (ピクセルまたはパーセント単位)。location が top の場合は必須です。
location string 必須。画面上のリストの位置。有効な値は、次のとおりです。
  • full
  • top
  • left
units string 必須。height または width がピクセル単位かパーセント単位かを表します。
width int リストの幅 (ピクセルまたはパーセント単位)。location が left の場合は必須です。

LiveAgentConfig

Salesforce コンソールで Live Agent を使用するための組織の設定を表します。

項目名 データ型 説明
enableLiveChat boolean 組織で Live Agent が有効化されているか (true)、否か (false) を指定します。
openNewAccountSubtab boolean エージェントがチャットを受け入れたときに Salesforce コンソールアプリケーションで新しい [取引先] サブタブを自動的に開くか (true)、否か (false) を指定します。
openNewCaseSubtab boolean エージェントがチャットを受け入れたときに Salesforce コンソールアプリケーションで新しい [ケース] サブタブを自動的に開くか (true)、否か (false) を指定します。
openNewContactSubtab boolean エージェントがチャットを受け入れたときに Salesforce コンソールアプリケーションで新しい [取引先責任者] サブタブを自動的に開くか (true)、否か (false) を指定します。
openNewLeadSubtab boolean エージェントがチャットを受け入れたときに Salesforce コンソールアプリケーションで新しい [リード] サブタブを自動的に開くか (true)、否か (false) を指定します。
openNewVFPageSubtab boolean エージェントがチャットを受け入れたときに Salesforce コンソールアプリケーションで新しい Visualforce ページをサブタブとして自動的に開くか (true)、否か (false) を指定します。
pageNamesToOpen string] エージェントがチャットを受け入れたときに Salesforce コンソールアプリケーションのサブタブで Visualforce ページを開くことを指定します。

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

showKnowledgeArticles boolean Salesforce コンソールアプリケーションで Live Agent を使用するときにナレッジコンポーネントを表示するか (true)、否か (false) を指定します。

PushNotification

ユーザのセッション中にレコードまたは項目が変更されると表示される、リストおよび詳細ページにあるビジュアルインジケータである転送通知のセットを表します。isServiceCloudConsoletrue の場合に使用できます。API バージョン 28.0 以降で利用できます。

項目名 データ型 説明
fieldNames string] 必須。選択されたオブジェクトに対して転送通知をトリガする 1 つまたは複数の項目の名前。
objectName string 必須。転送通知をトリガするオブジェクトの名前。

ServiceCloudConsoleConfig

Salesforce コンソールアプリケーションの構成設定を表します。API バージョン 42.0 以降で利用できます。

項目名 データ型 説明
componentList AppComponentList Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネント (Visualforce ページ) を表します。
detailPageRefreshMethod string Salesforce コンソールアプリケーションにおける詳細ページの更新方法を決定します。isServiceCloudConsoletrue である場合は必須です。有効な値は、次のとおりです。
  • none
  • autoRefresh
  • flag
footerColor string Salesforce コンソールアプリケーションのフッターの色を決定します。色を 16 進コードで指定します (たとえば、青の場合は #0000FF)。
headerColor string Salesforce コンソールアプリケーションのヘッダーの色を決定します。色を 16 進コードで指定します (たとえば、青の場合は #0000FF)。
keyboardShortcuts KeyboardShortcuts Salesforce コンソールアプリケーションのキーボードショートカットを表します。キーボードショートカットにより、ユーザはマウスを使用せずにキーの組み合わせを押してアクションを実行できます。
listPlacement ListPlacement Salesforce コンソールアプリケーションにおけるリストの表示方法を表します。isServiceCloudConsoletrue である場合は必須です。
listRefreshMethod string Salesforce コンソールアプリケーションにおけるリストの更新方法を決定します。isServiceCloudConsoletrue である場合は必須です。有効な値は、次のとおりです。
  • none
  • refreshList
  • refreshListRows
liveAgentConfig LiveAgentConfig Salesforce コンソールで Live Agent を使用するための設定を表します。
primaryTabColor string Salesforce コンソールアプリケーションの主タブの色を決定します。色を 16 進コードで指定します (たとえば、青の場合は #0000FF)。
pushNotifications PushNotification[] Salesforce コンソールアプリケーションの転送通知を表します。転送通知とは、リストおよび詳細ページにあるビジュアルインジケータであり、ユーザのセッション中にレコードまたは項目が変更されると表示されます。たとえば、2 人のサポートエージェントが同じケースで作業しているとします。一方のエージェントが Priority を変更すると、もう一方のエージェントに転送通知が表示されるため、そのエージェントは変更を認識でき、同じ作業を行わなくて済みます。
tabLimitConfig TabLimitConfig 1 つの Salesforce コンソールセッションで���可される主タブとサブタブの最大数を表します。enableTabLimitstrue である場合は必須です。
whiteListedDomains string[] Salesforce コンソールアプリケーション内からユーザがアクセスできる外部ドメイン。たとえば、www.yourdomain.com のように指定します。

TabLimitConfig

1 つの Salesforce コンソールセッションで許可される主タブとサブタブの最大数を表します。enableTabLimitstrue である場合は必須です。API バージョン 36.0 以降で利用できます。

項目名 データ型 説明
maxNumberOfPrimaryTabs string 1 つのコンソールセッションで許可される主タブの最大数。有効な値は、次のとおりです。
  • 5
  • 10
  • 20
  • 30
maxNumberOfSubTabs string 1 つのコンソールセッションで許可されるサブタブの最大数。有効な値は、次のとおりです。
  • 5
  • 10
  • 15

WorkspaceMapping

Salesforce コンソールアプリケーションで特定のタブのレコードをどのように開くかを表します。CustomApplication に指定された各タブで必須です。Salesforce Classic コンソールアプリケーションで API バージョン 25.0 以降で使用できます。Lightning コンソールアプリケーションで API バージョン 41.0 以降で使用できます。

項目名 データ型 説明
fieldName string tab をサブタブとして表示する主タブを指定する項目の名前。指定されていない場合、tab は主タブとして開きます。
tab string 必須。タブの名前。

アプリケーションの取得

組織のアプリケーションを取得するには、package.xml マニフェストファイルで CustomApplication 型の名前を使用します。すべてのアプリケーションを取得することも、package.xml の types セクションに取得するアプリケーションを指定することもできます。

組織のすべてのアプリケーション (カスタムアプリケーションおよび標準アプリケーション) を取得するには、ワイルドカード文字 (*) を次のように指定します。

1<types>
2    <members>*</members>
3    <name>CustomApplication</name>
4</types>

API バージョン 29.0 以前では、ワイルドカードを使用するとすべてのカスタムアプリケーションのみが返され、標準アプリケーションは返されません。

メモ

カスタムアプリケーションを取得するには、アプリケーション名を指定します。

1<types>
2    <members>MyCustomApp</members>
3    <name>CustomApplication</name>
4</types>

標準アプリケーションを取得するには、アプリケーション名に standard__ プレフィックスを追加します。たとえば、Chatter 標準アプリケーションを取得するには、standard__Chatter と指定します。

1<types>
2    <members>standard__Chatter</members>
3    <name>CustomApplication</name>
4</types>

インストール済みパッケージに含まれるアプリケーションを取得するには、アプリケーション名の前にパッケージ名前空間プレフィックスとアンダースコア 2 個を続けて追加します。たとえば、パッケージ名前空間が myInstalledPackageNS で、アプリケーション名が PackageApp の場合、次のように myInstalledPackageNS__PackageApp と指定します。

1<types>
2    <members>myInstalledPackageNS__PackageApp</members>
3    <name>CustomApplication</name>
4</types>

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

カスタムアプリケーションの定義を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
3    <defaultLandingTab>Myriad_Publishing__c</defaultLandingTab>
4    <description>App to manage Myriad Publishing</description>
5    <label>Myriad</label>
6    <logo>MyriadFolder/Myriad_Logo.jpg</logo>
7    <tab>standard-Chatter</tab>
8    <tab>standard-File</tab>
9    <tab>Myriad_Publishing__c</tab>
10    <tab>standard-report</tab>
11    <tab>standard-Dashboard</tab>
12</CustomApplication>

標準アプリケーション (Chatter) の定義を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
3    <defaultLandingTab>standard-home</defaultLandingTab>
4    <label>Collaboration</label>
5    <tab>standard-Chatter</tab>
6    <tab>standard-UserProfile</tab>
7    <tab>standard-OtherUserProfile</tab>
8    <tab>standard-CollaborationGroup</tab>
9    <tab>standard-File</tab>
10</CustomApplication>

宣言的なメタデータの定義のサンプル — Salesforce コンソール

isServiceCloudConsoletrue であるカスタムアプリケーションの定義を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
3    <consoleConfig>
4        <componentList>
5            <alignment>left</alignment>
6            <components>MyComponent</components>
7        </componentList>
8        <detailPageRefreshMethod>autoRefresh</detailPageRefreshMethod>
9        <keyboardShortcuts>
10            <customShortcuts>
11                <action>MyCustomShortcutAction</action>
12                <active>true</active>
13                <keyCommand>X</keyCommand>
14                <description>Custom Shortcut example</description>
15                <eventName>myCustomShortcutExample</eventName>
16            </customShortcuts>
17            <defaultShortcuts>
18                <action>FOCUS_CONSOLE</action>
19                <active>true</active>
20                <keyCommand>ESC</keyCommand>
21            </defaultShortcuts>
22            <defaultShortcuts>
23                <action>FOCUS_NAVIGATOR_TAB</action>
24                <active>true</active>
25                <keyCommand>V</keyCommand>
26            </defaultShortcuts>
27            <defaultShortcuts>
28                <action>FOCUS_DETAIL_VIEW</action>
29                <active>true</active>
30                <keyCommand>SHIFT+S</keyCommand>
31            </defaultShortcuts>
32            <defaultShortcuts>
33                <action>FOCUS_PRIMARY_TAB_PANEL</action>
34                <active>true</active>
35                <keyCommand>P</keyCommand>
36            </defaultShortcuts>
37            <defaultShortcuts>
38                <action>FOCUS_SUBTAB_PANEL</action>
39                <active>true</active>
40                <keyCommand>S</keyCommand>
41            </defaultShortcuts>
42            <defaultShortcuts>
43                <action>FOCUS_LIST_VIEW</action>
44                <active>true</active>
45                <keyCommand>N</keyCommand>
46            </defaultShortcuts>
47            <defaultShortcuts>
48                <action>FOCUS_FIRST_LIST_VIEW</action>
49                <active>true</active>
50                <keyCommand>SHIFT+F</keyCommand>
51            </defaultShortcuts>
52            <defaultShortcuts>
53                <action>FOCUS_SEARCH_INPUT</action>
54                <active>true</active>
55                <keyCommand>R</keyCommand>
56            </defaultShortcuts>
57            <defaultShortcuts>
58                <action>MOVE_LEFT</action>
59                <active>true</active>
60                <keyCommand>LEFT ARROW</keyCommand>
61            </defaultShortcuts>
62            <defaultShortcuts>
63                <action>MOVE_RIGHT</action>
64                <active>true</active>
65                <keyCommand>RIGHT ARROW</keyCommand>
66            </defaultShortcuts>
67            <defaultShortcuts>
68                <action>UP_ARROW</action>
69                <active>true</active>
70                <keyCommand>UP ARROW</keyCommand>
71            </defaultShortcuts>
72            <defaultShortcuts>
73                <action>DOWN_ARROW</action>
74                <active>true</active>
75                <keyCommand>DOWN ARROW</keyCommand>
76            </defaultShortcuts>
77            <defaultShortcuts>
78                <action>OPEN_TAB_SCROLLER_MENU</action>
79                <active>true</active>
80                <keyCommand>D</keyCommand>
81            </defaultShortcuts>
82            <defaultShortcuts>
83                <action>OPEN_TAB</action>
84                <active>true</active>
85                <keyCommand>T</keyCommand>
86            </defaultShortcuts>
87            <defaultShortcuts>
88                <action>CLOSE_TAB</action>
89                <active>true</active>
90                <keyCommand>C</keyCommand>
91            </defaultShortcuts>
92            <defaultShortcuts>
93                <action>ENTER</action>
94                <active>true</active>
95                <keyCommand>ENTER</keyCommand>
96            </defaultShortcuts>
97            <defaultShortcuts>
98                <action>EDIT</action>
99                <active>true</active>
100                <keyCommand>E</keyCommand>
101            </defaultShortcuts>
102            <defaultShortcuts>
103                <action>SAVE</action>
104                <active>true</active>
105                <keyCommand>CTRL+S</keyCommand>
106            </defaultShortcuts>
107        </keyboardShortcuts>
108        <listPlacement>
109            <location>left</location>
110            <units>percent</units>
111            <width>20</width>
112        </listPlacement>
113        <listRefreshMethod>refreshList</listRefreshMethod>
114        <pushNotifications>
115            <fieldNames>CreatedBy</fieldNames>
116            <objectName>Campaign</objectName>
117        </pushNotifications>
118        <pushNotifications>
119            <fieldNames>CustomField1__c</fieldNames>
120            <objectName>CustomObject1__c</objectName>
121        </pushNotifications>
122    </consoleConfig>
123    <defaultLandingTab>standard-home</defaultLandingTab>
124    <isServiceCloudConsole>true</isServiceCloudConsole>
125    <label>MyConsole</label>
126    <preferences>
127        <enableCustomizeMyTabs>false</enableCustomizeMyTabs>
128        <enableKeyboardShortcuts>true</enableKeyboardShortcuts>
129        <enableListViewHover>true</enableListViewHover>
130        <enableListViewReskin>true</enableListViewReskin>
131        <enableMultiMonitorComponents>true</enableMultiMonitorComponents>
132        <enablePinTabs>true</enablePinTabs>
133        <enableTabHover>false</enableTabHover>
134        <enableTabLimits>false</enableTabLimits>
135        <saveUserSessions>false</saveUserSessions>
136    </preferences>
137    <tabs>standard-Case</tabs>
138    <tabs>standard-Account</tabs>
139    <tabs>standard-Contact</tabs>
140    <tabs>standard-Contract</tabs>
141    <workspaceConfig>
142        <mappings>
143            <tab>standard-Case</tab>
144        </mappings>
145        <mappings>
146            <fieldName>ParentId</fieldName>
147            <tab>standard-Account</tab>
148        </mappings>
149        <mappings>
150            <fieldName>AccountId</fieldName>
151            <tab>standard-Contact</tab>
152        </mappings>
153        <mappings>
154            <tab>standard-Contract</tab>
155        </mappings>
156    </workspaceConfig>
157</CustomApplication>