メタデータ API 開発者ガイド
jPortal
Metadata を拡張し、その fullName 項目を継承します。このメタデータ型を使用するには、組織でパートナーポータルまたはカスタマーポータルが有効になっている必要があります。詳細は、Salesforce オンラインヘルプの「パートナーポータルの概要」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
Lightning プラットフォームの Portal コンポーネントは、対応するパッケージディレクトリの portals ディレクトリに保存されます。ファイル名はポータル名に一致し、拡張子は .portal です。
バージョン
Lightning プラットフォームの Portal コンポーネントは、API バージョン 15.0 以降で使用できます。
特別なアクセスルール
認証されていないゲストユーザを含め、すべてのユーザが API を介してポータルを参照できます。
項目
| 項目 | 項目の型 | 説明 |
|---|---|---|
| active | boolean | 必須。このポータルが有効であるかどうかを示します。 |
| admin | string | ポータルの管理者として指定するユーザの氏名。 |
| defaultLanguage | string | ポータルの HTML メッセージのデフォルト言語。米国英語では en_US など、言語の略語を使用します。 |
| description | string | ポータルの説明。 |
| emailSenderAddress | string | 必須。設定済みのテンプレートを使用してポータルからメールを送信するときに使用されるメールアドレス (パスワードをリセットする場合など)。 |
| emailSenderName | string | 必須。設定済みのテンプレートを使用してポータルからメールを送信するときに表示する名前 (パスワードをリセットする場合など)。 |
| enableSelfCloseCase | boolean | カスタマーポータルで、ポータルユーザが自分のケースをクローズすることを許可します。 |
| footerDocument | string | このポータルのフッターとして使用されるファイル。 |
| forgotPassTemplate | string | ユーザが [パスワードを忘れた場合] リンクをクリックしたときに使用するメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。 |
| fullName | string | 必須。ポータルの名前。 Metadata から継承されるこの項目は、このメタデータ型の WSDL で定義されます。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「createMetadata()」を参照してください。 |
| headerDocument | string | このポータルのヘッダーとして使用されるファイル。 |
| isSelfRegistrationActivated | boolean | このポータルでセルフ登録が有効かどうかを決定します。 |
| loginHeaderDocument | string | このポータルのログインページのヘッダーとして使用されるファイル。 |
| logoDocument | string | このポータルのロゴとして使用されるファイル。 |
| logoutUrl | string | ログアウト時のユーザのリダイレクト先の URL。 |
| newCommentTemplate | string | 新規ケースコメントの自動通知に使用されるメールテンプレート。 |
| newPassTemplate | string | パスワードリセットの自動通知に使用されるメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。 |
| newUserTemplate | string | 新規ユーザ作成時の自動通知に使用されるメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。 |
| ownerNotifyTemplate | string | 所有者変更時の自動通知に使用されるメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。 |
| selfRegNewUserUrl | string | セルフ登録ページの URL。 |
| selfRegUserDefaultProfile | string | セルフ登録したユーザのデフォルトのプロファイル。 |
| selfRegUserDefaultRole | PortalRoles (string 型の列挙) | セルフ登録したユーザのデフォルトのロール。有効な値は、次のとおりです。
|
| selfRegUserTemplate | string | セルフ登録の自動通知に使用されるメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。 |
| showActionConfirmation | boolean | このポータルでアクションに対する確認メッセージを表示するか、否かを決定します。 |
| stylesheetDocument | string | このポータルの CSS スタイルシートとして使用される Document オブジェクト。 |
| type | PortalType (string 型の列挙) | 必須。このポータルのタイプ。有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
ポータルの XML 定義のサンプルを以下に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Portal xmlns="http://soap.sforce.com/2006/04/metadata">
3 <active>true</active>
4 <description>Customer Portal</description>
5 <emailSenderName>rguest@albany.com</emailSenderName>
6 <enableSelfCloseCase>false</enableSelfCloseCase>
7 <forgotPassTemplate>unfiled$public/ChangePwdEmail</forgotPassTemplate>
8 <isSelfRegistrationActivated>false</isSelfRegistrationActivated>
9 <newPassTemplate>unfiled$public/ChangePwdEmail</newPassTemplate>
10 <newUserTemplate>unfiled$public/NewUserEmail</newUserTemplate>
11 <selfRegUserTemplate>unfiled$public/SelfRegUserEmail</selfRegUserTemplate>
12 <showActionConfirmation>false</showActionConfirmation>
13 <type>CustomerSuccess</type>
14</Portal>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。