CustomApplication

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

カスタムアプリケーションおよび標準アプリケーションのサフィックスは .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 アプリケーションでは、formFactors は `Large` に設定されます。バージョン 38.0 より前に作成されたパッケージからインストールされた Salesforce Classic アプリケーションでも、formFactors は `Large` に設定されます。38.0 以降で作成されたパッケージの Salesforce Classic アプリケーションでは、Lightning Experience デスクトップに表示される Salesforce Classic アプリケーションで formFactors を `Large` に設定する必要があります。メモ
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 Classic です。null 値の場合、Salesforce Classic です。この項目は、API バージョン 38.0 以降で使用できます。
preferences	AppPreferences	Salesforce コンソールアプリケーションの設定を表します。この項目は、API バージョン 42.0 以降で使用できます。
profileActionOverrides	AppProfileActionOverride[]	このカスタムアプリケーションに割り当てられた、Lightning Experience レコードページの ProfileActionOverrides のリスト。ユーザがカスタムアプリケーションを呼び出すと、一致する ProfileActionOverride の割り当てが、ActionOverride で指定されたレコードページの既存の上書きよりも優先されます。これにより、レコードタイプとプロファイルによってカスタムアプリケーションのレコードページを上書きできます。 API バージョン 45.0 以降では、プロファイルを使用してカスタムアプリケーションのホームページを上書きできます。
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 コンソールアプリケーションでレコードをどのように開くかを表します。isServiceCloudConsole が `true` である場合は必須です。API バージョン 42.0 で、この項目は workspaceMappings から workspaceConfig に名前変更されました。

AppActionOverride

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

項目名	項目の型	説明
actionName	string	API バージョン 43.0 以前では、有効な値は `view` のみです。`tab` 値は、API バージョン 44.0 以降でサポートされます。
comment	string	override に関連付けるすべてのコメント。
content	string	type が `flexipage` に設定されている場合は、この項目を設定します。override として使用するページの名前を参照します。インストールされたコンポーネントを参照するには、`Component_namespace__Component_name` の形式を使用します。
formFactor	FormFactor (string 型の列挙)	上書きするページのサイズ。 type 項目が `flexipage` に設定されている場合、この項目を `Large` に設定して [表示] アクションを Lightning Experience の Lightning ページで上書きします。 `Large` 値は Lightning Experience デスクトップ環境を表し、`flexipage` 型と `lightningcomponent` 型でのみ有効です。`Small` 値は、電話またはタブレットの Salesforce アプリケーションを表します。`Medium` 値は、将来の使用のために予約されています。`null` 値 (値を指定しないのと同じ) は Salesforce Classic を表します。この項目は、API バージョン 37.0 以降で使用でき、Lightning Experience でのレコードページの作成と編集のための機能の一部です。 Lightning コンポーネントの上書きでは、使用する API バージョンに応じて異なる FormFactor 値が返されます。 API バージョン 41.0 以前の場合、Lightning コンポーネントの上書きは、Salesforce Classic 環境を表す `null` 値 (値なし) のみを返します。 API バージョン 42.0 以降、Lightning Experience とモバイルで異なる Lightning コンポーネントの上書きを指定した場合、両方の上書きに対してランダムに 1 つのコンポーネントが選択され、その FormFactor 値が返されます。Lightning コンポーネント間で競合があり、Salesforce Classic に Visualforce ページの上書きも指定されている場合、Visualforce ページが優先されます。 API バージョン 43.0 以降は、予期したとおりに、Lightning Experience の Lightning コンポーネントの上書きでは `Large` 値が返され、モバイルの Lightning コンポーネントの上書きでは `Small` 値が返されます。メモ
pageOrSobjectType	string	上書きする sObject 型の名前。有効な値は、`standard` および `custom` です。 actionName が `tab` の場合、この値は `standard-home` である必要があります。
skipRecordTypeSelect	boolean	この override アクションによって作成された新しいレコードをレコードタイプ選択ページに転送されないようにするには、この項目を `true` に設定します。この項目は、actionName が "create" 種別 (`new` など) で、type が `visualforce` に設定されている場合にのみ有効です。
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 コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から実行されるアクションのキーボードショートカットを作成することはできません。isServiceCloudConsole が `true` である場合は必須です。
enableListViewHover	boolean	Salesforce コンソールアプリケーションでリストビューのフロート表示が有効になっているかどうかを示します。`true` に設定されている場合、ユーザがレコード名にマウスポインタを置くと、反応型リストにレコードに関するサマリー情報が表示されます。ケースの場合は、件名項目にマウスポインタを置きます。
enableListViewReskin	boolean	Salesforce コンソールアプリケーションで、Salesforce Classic リストビューではなく、反応型リストビューが使用されているかどうかを示します。
enableMultiMonitorComponents	boolean	Salesforce コンソールアプリケーションで、マルチモニターコンポーネントが有効かどうかを示します。マルチモニターコンポーネントを使用すると、ユーザがコンソールの各部分をブラウザから画面上の場所に移動できます。isServiceCloudConsole が `true` である場合は必須です。
enablePinTabs	boolean	Salesforce コンソールアプリケーションで、ユーザが主タブをすぐにアクセスできるようにタブバーに固定できる、タブの固定が有効かどうかを示します。
enableTabHover	boolean	Salesforce コンソールアプリケーションでタブのフロート表示が有効になっているかどうかを示します。有効になっている場合、ユーザがタブにマウスポインタを置くと、レコードのサマリー情報がフロート表示で表示されます。
enableTabLimits	boolean	Salesforce コンソールセッションで開ける主タブとサブタブの数に対する制限が有効かどうかを示します。`true` の場合、tabLimitConfig の値が必要です。
saveUserSessions	boolean	Salesforce コンソールアプリケーションでユーザセッションが自動的に保存されるかどうかを示します。有効になっている場合、コンソールのユーザがブラウザを閉じたり、Salesforce からログアウトしたりしても、��度ログインしたときに以前に開いていたタブが表示されます。isServiceCloudConsole が `true` である場合は必須です。

AppProfileActionOverride

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

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

AppWorkspaceConfig

Salesforce コンソールアプリケーションでレコードをどのように開くかを表します。isServiceCloudConsole が true である場合は必須です。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` `;` `=` `,` `—` `.` `/` `‘` `[` `]` `\` `'`

項目名

項目の型

説明

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 コンソールアプリケーションに割り当てられたキーボードショートカットを表します。isServiceCloudConsole が true である場合は必須です。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 に名前変更されました。

項目名

項目の型

説明

customShortcuts

CustomShortcut[]

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

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

defaultShortcuts

DefaultShortcut[]

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

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

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

ListPlacement

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

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

LiveAgentConfig

Salesforce コンソールでチャットを使用するための組織の設定を表します。

項目名	項目の型	説明
enableLiveChat	boolean	組織でチャットが有効化されているか (`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 [string の配列]	エージェントがチャットを受け入れたときに Salesforce コンソールアプリケーションのサブタブで Visualforce ページを開くことを指定します。この項目は、API バージョン 42.0 以降で使用できます。
showKnowledgeArticles	boolean	Salesforce コンソールアプリケーションでチャットを使用するときにナレッジコンポーネントを表示するか (`true`)、否か (`false`) を指定します。

PushNotification

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

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

ServiceCloudConsoleConfig

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

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

TabLimitConfig

1 つの Salesforce コンソールセッションで許可される主タブとサブタブの最大数を表します。enableTabLimits が true である場合は必須です。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 セクションに取得するアプリケーションを指定することもできます。

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

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

メモ

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

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

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

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

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

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

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

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

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

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

メタデータ API 開発者ガイド