メタデータ API 開発者ガイド
jCustomTab
カスタムタブを表します。カスタムタブでは、カスタムオブジェクトデータまたはその他の Web コンテンツを Salesforce に表示できます。Salesforce Classic のアプリケーションにカスタムタブを追加すると、タブとして表示されます。Lightning Experience でカスタムタブをアプリケーションに追加すると、アプリケーションのナビゲーションバーの項目としてカスタムタブが表示されます。タブにカスタムオブジェクトが表示されているとき、タブ名はカスタムオブジェクト名と同じになります。ページ、Sコントロール、または URL タブの場合は任意の名前です。
詳細は、Salesforce ヘルプの「ユーザへのカスタムオブジェクトのデータの表示」を参照してください。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ファイルのサフィックスは、.tab です。タブごとに 1 つのファイルがあり、対応するパッケージディレクトリの tabs フォルダに保存されます。
バージョン
タブは、API バージョン 10.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| actionOverrides | ActionOverride[] |
アクションのリストが、タブに割り当てられているアクションを上書きします。特定のタブの formFactor 1 つにつき許可される上書きは 1 つのみです。 この項目は、API バージョン 37.0 以降で使用できます。 |
| auraComponent | string |
これが Lightning コンポーネントのタブか (true)、否か (false) を示します。true に設定されている場合、タブの名前は Lightning コンポーネントの名前と一致します。 次の項目のいずれか 1 つのみに値が設定されている必要があります。
|
| customObject | boolean | このタブがカスタムオブジェクトを表示するか (true)、否か (false) を示します。true に設定されている場合、タブの名前はカスタムオブジェクトの名前と一致します。 次の項目のいずれか 1 つのみに値が設定されている必要があります。
|
| description | string | タブの説明テキスト (省略可能)。 |
| flexiPage | string |
このタブに表示する Lightning ページの名前。 次の項目のいずれか 1 つのみに値が設定されている必要があります。
|
| frameHeight | int | タブフレームの高さ (ピクセル単位)。Sコントロールおよびページタブでは必須です。 |
| fullName | string | タブの名前。この項目の値は、タブの種類と API バージョンに応じて異なります。
fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。 |
| hasSidebar | boolean | タブにサイドバーパネルが表示されるかを示します。 |
| icon | string | タブがどの標準タブスタイルも使用していない場合における、タブの画像ドキュメントへの参照 (省略可能)。これは、API バージョン 14.0 の新項目です。 |
| label | string | タブの表示ラベルです (Web タブのみ)。 |
| motif | string | 必須。カスタムタブの配色とアイコンのタブスタイル。たとえば、"'Custom70: Handsaw," は、のこぎりアイコンです。 |
| page | string | このタブに表示する Visualforce ページの名前。 次の項目のいずれか 1 つのみに値が設定されている必要があります。
|
| scontrol | string | このタブに表示する Sコントロールの名前。 次の項目のいずれか 1 つのみに値が設定されている必要があります。
|
| splashPageLink | string | ユーザがタブをクリックしたときに内容を紹介するスプラッシュページとして使用されるカスタムリンク。HomePageComponent を参照します。 |
| url | string | このタブに埋め込む外部 Web ページの URL。 次の項目のいずれか 1 つのみに値が設定されている必要があります。
|
| urlEncodingKey | Encoding (string 型の列挙) | デフォルトの文字コード設定は Unicode (UTF-8) です。情報を渡す URL が別形式のデータを必要とする場合は、この設定を変更します。このオプションは、タブの種類で値 URL が選択されている場合に使用できます。 |
宣言的なメタデータの定義のサンプル
タブの定義を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomTab xmlns="http://soap.sforce.com/2006/04/metadata">
3 <description>Myriad Publishing</description>
4 <frameHeight>600</frameHeight>
5 <mobileReady>true</mobileReady>
6 <motif>Custom53: Bell</motif>
7 <url>http://www.myriadpubs.com</url>
8 <urlEncodingKey>UTF-8</urlEncodingKey>
9</CustomTab>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。