メタデータ API 開発者ガイド
jCustomApplication
CustomApplication はカスタムアプリケーションまたは標準アプリケーションを表します。API バージョン 29.0 以前では、CustomApplication はカスタムアプリケーションのみを表します。アプリケーションは、説明とロゴを使用したタブ参照のリストです。Metadata メタデータ型を拡張し、その fullName 項目を���承します。
バージョン
カスタムアプリケーションは API バージョン 10.0 以降で使用できます。標準アプリケーションは API バージョン 30.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| customApplicationComponents | CustomApplicationComponents | Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネント (Visualforce ページ) を表します。 |
| defaultLandingTab | string | このアプリケーションが選択されたときに開く標準タブまたはカスタムタブの fullName。 |
| description | string | アプリケーションの説明テキスト (省略可能)。 |
| detailPageRefreshMethod | string |
Salesforce コンソールアプリケーションにおける詳細ページの更新方法を決定します。isServiceCloudConsole が true である場合は必須です。有効な値は、次のとおりです。
この項目は API バージョン 25.0 以降で使用できます。 |
| domainWhitelist | DomainWhitelist | Salesforce コンソールアプリケーション内からユーザがアクセスできる外部ドメイン。たとえば、www.yourdomain.com のように指定します。この項目は API バージョン 25.0 以降で使用できます。 |
| enableCustomizeMyTabs | boolean |
Salesforce コンソールアプリケーションで [タブのカスタマイズ] が有効になっているかどうかを示します。有効になっている場合、ユーザはナビゲーションタブの項目を非表示、表示、および整理できます。 この項目は API バージョン 34.0 以降で使用できます。 |
| enableKeyboardShortcuts | boolean |
Salesforce コンソールアプリケーションでキーボードショートカットが有効化されており、ユーザがマウスを使用せずにキーの組み合わせを押してアクションを実行できるかどうかを示します。キーボードショートカットを有効化すると、デフォルトのいくつかのショートカットをカスタマイズできます。カスタムショートカットを作成するには、事前に開発者が addEventListener() メソッドを使用してショートカットのアクションを Salesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から実行されるアクションのキーボードショートカットを作成することはできません。isServiceCloudConsole が true である場合は必須です。
この項目は API バージョン 28.0 以降で使用できます。 |
| enableMultiMonitorComponents | boolean |
Salesforce コンソールアプリケーションで、マルチモニターコンポーネントが有効かどうかを示します。マルチモニターコンポーネントを使用すると、ユーザがコンソールの各部分をブラウザから画面上の場所に移動できます。isServiceCloudConsole が true である場合は必須です。
この項目は API バージョン 30.0 以降で使用できます。 |
| enablePinTabs | boolean |
Salesforce コンソールアプリケーションで、ユーザが主タブをすぐにアクセスできるようにタブバーに固定できる、タブの固定が有効かどうかを示します。 この項目は API バージョン 34.0 以降で使用できます。 |
| enableTabHover | boolean |
Salesforce コンソールアプリケーションでタブのフロート表示が有効かどうかを示します。この機能では、ユーザがタブにマウスポインタを置くとオーバーレイにレコードに関するサマリー情報が表示されます。 この項目は、API バージョン 36.0 以降で使用できます。 |
| enableTabLimits | boolean |
Salesforce コンソールセッションで開ける主タブとサブタブの数に対する制限が有効かどうかを示します。true の場合、tabLimitConfig の値が必要です。 この項目は、API バージョン 36.0 以降で使用できます。 |
| string | 色を 16 進コードで指定します (たとえば、青の場合は #0000FF)。 | |
| headerColor | string | Salesforce コンソールアプリケーションのヘッダーの色を決定します。色を 16 進コードで指定します (たとえば、青の場合は #0000FF)。 |
| isServiceCloudConsole | boolean | アプリケーションが Salesforce コンソールアプリケーションであるかを示します。詳細は、Salesforce オンラインヘルプの「Salesforce コンソール」を参照してください。 |
| keyboardShortcuts | KeyboardShortcuts |
Salesforce コンソールアプリケーションのキーボードショートカットを表します。キーボードショートカットにより、ユーザはマウスを使用せずにキーの組み合わせを押してアクションを実行できます。 この項目は API バージョン 28.0 以降で使用できます。 |
| fullName | string | アプリケーションの内部名。label に基づきますが、有効性のために空白と特殊文字はエスケープ処理されます。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。 |
| label | string | アプリケーションの名前。 |
| listPlacement | ListPlacement | Salesforce コンソールアプリケーションにおけるリストの表示方法を表します。isServiceCloudConsole が true である場合は必須です。 |
| listRefreshMethod | string |
Salesforce コンソールアプリケーションにおけるリストの更新方法を決定します。isServiceCloudConsole が true である場合は必須です。有効な値は、次のとおりです。
この項目は API バージョン 25.0 以降で使用できます。 |
| liveAgentConfig | LiveAgentConfig | Salesforce コンソールで Live Agent を使用するための設定を表します。 |
| logo | string | アプリケーションの画像ドキュメントへの参照 (省略可能)。 |
| primaryTabColor | string | Salesforce コンソールアプリケーションの主タブの色を決定します。色を 16 進コードで指定します (たとえば、青の場合は #0000FF)。 |
| pushNotifications | PushNotifications |
Salesforce コンソールアプリケーションの転送通知を表します。転送通知とは、リストおよび詳細ページにあるビジュアルインジケータであり、ユーザのセッション中にレコードまたは項目が変更されると表示されます。たとえば、2 人のサポートエージェントが同じケースで作業しているとします。一方のエージェントが Priority を変更すると、もう一方のエージェントに転送通知が表示されるため、そのエージェントは変更を認識でき、同じ作業を行わなくて済みます。 この項目は、API バージョン 28.0 以降で使用できます。 |
| saveUserSessions | boolean |
Salesforce コンソールアプリケーションでユーザセッションが自動的に保存されるかどうかを示します。有効になっている場合、コンソールのユーザがブラウザを閉じたり、Salesforce からログアウトしたりしても、再度ログインしたときに以前に開いていたタブが表示されます。isServiceCloudConsole が true である場合は必須です。
この項目は、API バージョン 28.0 以降で使用できます。 |
| tab | string | このアプリケーションに含まれるタブのリスト。API バージョン 12.0 では、[ホーム]、[取引先]、および [レポート] などの組み込みタブの fullName がタブの名前になります (Home など)。API バージョン 13.0 以降では、組み込みタブには standard- というプレフィックスが追加されます。たとえば、[取引先] タブを参照するには、standard-Account を使用します。 |
| tabLimitConfig | TabLimitConfig |
1 つの Salesforce コンソールセッションで許可される主タブとサブタブの最大数を表します。enableTabLimits が true である場合は必須です。 この項目は、API バージョン 36.0 以降で使用できます。 |
| workspaceMappings | WorkspaceMappings | Salesforce コンソールアプリケーションでレコードをどのように開くかを表します。isServiceCloudConsole が true である場合は必須です。この項目は API バージョン 25.0 以降で使用できます。 |
CustomApplicationComponents
Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネント (Visualforce ページ) を表します。API バージョン 25.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| alignment | string | Salesforce コンソールアプリケーションのフッターにおけるカスタムコンソールコンポーネントの整列方法を決定します。 |
| customApplicationComponent | string | Salesforce コンソールアプリケーションに割り当てられたカスタムコンソールコンポーネントの名前。 |
CustomShortcut
Salesforce コンソールアプリケーションに割り当てられたカスタムキーボードショートカットを表します。カスタムショートカットを作成するには、事前に開発者が addEventListener() メソッドを使用してショートカットのアクションを Salesforce コンソール統合ツールキットに定義しておく必要があります。コンソールの外部から実行されるアクションのキーボードショートカットを作成することはできません。API バージョン 28.0 以降で利用できます。
DefaultShortcut
Salesforce コンソールアプリケーションにデフォルトで割り当てられたキーボードショートカットを表します。コンソールのキーボードショートカットを有効にすると、タブの開閉、タブ間の移動、およびレコードの保存など、いくつかのデフォルトショートカットをカスタマイズに使用できるようになります。API バージョン 28.0 以降で利用できます。
DomainWhitelist
Salesforce コンソールアプリケーション内からユーザがアクセスできる外部ドメインを表します。たとえば、www.yourdomain.com です。API バージョン 25.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| domain | string | この Salesforce コンソールアプリケーション内からユーザがアクセスできる外部ドメイン。 |
KeyboardShortcuts
Salesforce コンソールアプリケーションに割り当てられたキーボードショートカットを表します。isServiceCloudConsole が true である場合は必須です。API バージョン 28.0 以降で利用できます。
ListPlacement
Salesforce コンソールアプリケーションにおけるリストの表示方法を表します。isServiceCloudConsole が true である場合は必須です。API バージョン 25.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| height | int | リストの高さ (ピクセルまたはパーセント単位)。location が top の場合は必須です。 |
| location | string | 必須。画面上のリストの位置。有効な値は、次のとおりです。
|
| units | string | 必須。height または width がピクセル単位かパーセント単位かを表します。 |
| width | int | リストの幅 (ピクセルまたはパーセント単位)。location が left の場合は必須です。 |
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) を指定します。 |
| pagesToOpen | PagesToOpen | エージェントがチャットを受け入れたときに Salesforce コンソールのサブタブで Visualforce ページを開くことを指定します。 |
| showKnowledgeArticles | boolean | Salesforce コンソールで Live Agent を使用するときにナレッジコンポーネントを表示するか (true)、否か (false) を指定します。 |
PagesToOpen
エージェントがチャット要求を受け入れたときに Salesforce コンソールのサブタブで開く Visualforce ページを表します。API バージョン 28.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| pagesToOpen | string | エージェントがチャットを受け入れたときに Salesforce コンソールのサブタブで開く Visualforce ページの名前。 |
PushNotifications
ユーザのセッション中にレコードまたは項目が変更されると表示される、リストおよび詳細ページにあるビジュアルインジケータである転送通知のセットを表します。isServiceCloudConsole が true の場合に使用できます。API バージョン 28.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| pushNotification | PushNotification[] | 転送通知のセット。 |
PushNotification
ユーザのセッション中にレコードまたは項目が変更された場合に、リストおよび詳細ページにあるビジュアルインジケータを Salesforce コンソールアプリケーションに表示するかどうかを表します。isServiceCloudConsole が true の場合に使用できます。API バージョン 28.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| fieldNames | string | 必須。選択されたオブジェクトに対して転送通知をトリガする 1 つまたは複数の項目の名前。 |
| objectName | string | 必須。転送通知をトリガするオブジェクトの名前。 |
TabLimitConfig
1 つの Salesforce コンソールセッションで許可される主タブとサブタブの最大数を表します。enableTabLimits が true である場合は必須です。API バージョン 36.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| maxNumberOfPrimaryTabs | string | 1 つのコンソールセッションで許可される主タブの最大数。有効な値は、次のとおりです。
|
| maxNumberOfSubTabs | string | 1 つのコンソールセッションで許可されるサブタブの最大数。有効な値は、次のとおりです。
|
WorkspaceMappings
Salesforce コンソールアプリケーションでレコードをどのように開くかを表します。isServiceCloudConsole が true である場合は必須です。API バージョン 25.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| mapping | WorkspaceMapping | Salesforce コンソールアプリケーションで特定のタブのレコードをどのように開くかを表します。CustomApplication に指定された各タブで必須です。 |
WorkspaceMapping
Salesforce コンソールアプリケーションで特定のタブのレコードをどのように開くかを表します。CustomApplication に指定された各タブで必須です。API バージョン 25.0 以降で利用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| fieldName | string | tab をサブタブとして表示する主タブを指定する項目の名前。指定されていない場合、tab は主タブとして開きます。 |
| tab | string | 必須。タブの名前。 |
アプリケーションの取得
組織のアプリケーションを取得するには、package.xml マニフェストファイルで CustomApplication 型の名前を使用します。すべてのアプリケーションを取得することも、package.xml の types セクションに取得するアプリケーションを指定することもできます。
組織のすべてのアプリケーション (カスタムアプリケーションおよび標準アプリケーション) を取得するには、ワイルドカード文字 (*) を次のように指定します。
カスタムアプリケーションを取得するには、アプリケーション名を指定します。
標準アプリケーションを取得するには、アプリケーション名に standard__ プレフィックスを追加します。たとえば、Chatter 標準アプリケーションを取得するには、standard__Chatter と指定します。
インストール済みパッケージに含まれるアプリケーションを取得するには、アプリケーション名の前にパッケージ名前空間プレフィックスとアンダースコア 2 個を続けて追加します。たとえば、パッケージ名前空間が myInstalledPackageNS で、アプリケーション名が PackageApp の場合、次のように myInstalledPackageNS__PackageApp と指定します。