メタデータ API 開発者ガイド
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
CaseSettings
デフォルトのケース所有者、有効化されるケース関連機能、各種ケース活動に使用されるメールテンプレートなど、組織のケース設定を表します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
CaseSettings の値は、settings ディレクトリの Case.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
CaseSettings は、API バージョン 27.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| caseAssignNotificationTemplate | string | ケース割り当て通知に使用するメールテンプレートを指定します。folderName/emailTemplateName の形式を使用する必要があります。 |
| caseCloseNotificationTemplate | string | ケースクローズ通知に使用するメールテンプレートを指定します。folderName/emailTemplateName の形式を使用する必要があります。 |
| caseCommentNotificationTemplate | string | ケースコメント通知に使用するメールテンプレートを指定します。folderName/emailTemplateName の形式を使用する必要があります。 |
| caseCreateNotificationTemplate | string | ケース作成通知に使用するメールテンプレートを指定します。folderName/emailTemplateName の形式を使用する必要があります。 |
| caseFeedItemSettings | FeedItemSettings[] | フィードベースのケースページレイアウトに含まれるフィード項目の設定を指定します。この項目は、API バージョン 32.0 以降で使用できます。 |
| closeCaseThroughStatusChange | boolean | ケース編集ページの [ケース 状況] 項目に Closed を表示するか (true)、否か (false) を示します。 |
| defaultCaseOwner | string | 割り当てルールで所有者を見つけられなかった場合に、ケースのデフォルトの所有者を指定します。 |
| defaultCaseOwnerType | string | デフォルトのケース所有者がユーザか、キューかを指定します。 |
| defaultCaseUser | string | 自動ケース更新の [ケース履歴] 関連リストに表示されるユーザを指定します。
|
| emailToCase | EmailToCaseSettings | 組織のメール-to-ケース設定。 |
| enableCaseFeed | boolean | ケースフィードが有効化されているか (true)、否か (false) を示します。 |
| enableDraftEmails | boolean | ドラフトメールが有効化されているか (true)、否か (false) を示します。メールドラフトを有効にすると、ケースフィードとメール-to-ケースも有効にする必要があります。 |
| enableEarlyEscalationRuleTriggers | boolean | エスカレーションルールの早期トリガが有効化されているか (true)、否か (false) を示します。 |
| enableNewEmailDefaultTemplate | boolean | デフォルトのメールテンプレートが有効化されているか (true)、否か (false) を示します。デフォルトのメールテンプレートは、ドラフトメールが有効になっている場合にのみ使用できます。 |
| enableSuggestedArticlesApplication | boolean | ケースのページに [推奨記事] リストを表示するか (true)、否か (false) を示します。enableSuggestedSolutions=false の場合にのみ使用できます。 |
| enableSuggestedArticlesCustomerPortal | boolean | カスタマーポータルのページに [推奨記事] リストを表示するか (true)、否か (false) を示します。enableSuggestedSolutions=false の場合にのみ使用できます。 |
| enableSuggestedArticlesPartnerPortal | boolean | パートナーポータルのページに [推奨記事] リストを表示するか (true)、否か (false) を示します。enableSuggestedSolutions=false の場合にのみ使用できます。 |
| enableSuggestedSolutions | boolean | ケースの詳細ページに [推奨ソリューションの参照] ボタンまたは [記事の検索] ボタンを表示するか (true)、否か (false) を示します。enableSuggestedArticlesApplication、enableSuggestedArticlesCustomerPortal、および enableSuggestedArticlesPartnerPortal=false の場合にのみ使用できます。 |
| keepRecordTypeOnAssignmentRule | boolean | 割り当てルールを手動作成したレコードに適用するときに、既存のレコードタイプを使用するか (true)、既存のレコードタイプを割り当て先のデフォルトレコードタイプで上書きするか (false) を示します。 |
| newEmailDefaultTemplateClass | string | ケースフィードで新規メールメッセージに使用されるデフォルトのメールテンプレートを定義する Apex クラスを指定します。この項目は enableNewEmailDefaultTemplate=true の場合にのみ表示されます。 |
| notifyContactOnCaseComment | boolean | 新しいコメントがケースに追加された場合に、セルフサービスポータルのメンバーではない取引先責任者に通知できるようにするか (true)、否か (false) を示します。 |
| notifyDefaultCaseOwner | boolean | 新規ケースが割り当てられた場合に、デフォルトのケース所有者に通知するか (true)、否か (false) を示します。 |
| notifyOwnerOnCaseComment | boolean | コメントがケースに追加された場合に、ケース所有者に通知するか (true)、否か (false) を示します。 |
| notifyOwnerOnCaseOwnerChange | boolean | ユーザがケースの所有者を別のユーザに変更する場合に、ケースの [メールで通知する] チェックボックスを自動的に選択されるようにするか (true) どうかを示します。 |
| showFewerCloseActions | boolean | ケースの編集ページの [保存して閉じる] ボタンと [ケース] 関連リストの [完了] リンクを非表示にするか (true)、表示するか (false) を示します。 |
| useSystemEmailAddress | boolean | ケースコメント、ケース添付ファイル、およびケース割り当てのメール通知がシステムアドレスから送信されるか (true)、またはケース通知がケースを更新するユーザまたは取引先責任者から送信されるように表示するのか (false) を示します。 |
| webToCase | WebToCaseSettings | 組織のWeb-to-ケース設定。 |
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| enableEmailToCase | boolean | メール-to-ケースが有効化されているか (true)、否か (false) を示します。メール-to-ケースを有効にした後に無効にすることはできません。 |
| enableHtmlEmail | boolean | HTML メールが有効化されているか (true)、否か (false) を示します。 |
| enableOnDemandEmailToCase | boolean | オンデマンドメール-to-ケースが有効化されているか (true)、否か (false) を示します。 |
| enableThreadIDInBody | boolean | ケースのスレッド ID がメールの本文に��入されるか (true)、否か (false) を示します。 |
| enableThreadIDInSubject | boolean | ケースのスレッド ID がメールの件名に挿入されるか (true)、否か (false) を示します。 |
| notifyOwnerOnNewCaseEmail | boolean | ケースに関連する新規メールを受信したときに、ケースの所有者に通知が送信されるか (true)、否か (false) を示します。 |
| overEmailLimitAction | EmailToCaseOnFailureActionType (string 型の列挙) | 組織のメール-to-ケースの 1 日の上限を超えた後に受信したメールメッセージの処理方法を指定します。有効な値は、次のとおりです。 |
| routingAddresses | EmailToCaseRoutingAddress[] | 組織のメール-to-ケースのルーティングアドレス設定。 |
| unauthorizedSenderAction | EmailToCaseOnFailureActionType (string 型の列挙) | 無効な送信者から受信したメールメッセージの処理方法を指定します。有効な値は、次のとおりです。
|
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| addressType | EmailToCaseRoutingAddressType (string 型の列挙) | メール-to-ケースのルーティングアドレスの種類を指定します。有効な値は、次のとおりです。
|
| authorizedSenders | string | オンデマンドメール-to-ケースにメールを送信できるメールアドレスまたはドメインを指定します。カンマ区切りのリストで複数のエントリを指定できます。 |
| caseOrigin | string | このルーティングアドレスから作成されたケースのデフォルトのケース発生源を指定します。 |
| caseOwner | string | このルーティングアドレスから作成されたケースのデフォルトの所有者を指定します。所有者は Salesforce ユーザ名で指定します。 |
| caseOwnerType | string | デフォルトのケース所有者がユーザか、キューかを指定します。 |
| casePriority | string | このルーティングアドレスから作成されたケースのデフォルトのケース優先度を指定します。 |
| createTask | boolean | ケースがメールから作成されるときに、ケース所有者に ToDo が自動的に割り当てられるか (true)、否か (false) を示します。 |
| emailAddress | string | ケースとして送信されるメールメッセージを転送するために使用されるメールアドレスを指定します。 |
| routingName | string | メール-to-ケースのルーティングアドレスの名前を指定します。 |
| saveEmailHeaders | boolean | メールルーティングおよび封筒情報が保存されるか (true)、否か (false) を示します。 |
| taskStatus | string | メールがケースとして送信されるときにケース所有者に自動的に割り当てられる ToDo のデフォルト状況を指定します。createTask が true に設定されている場合のみ適用されます。 |
| 項目名 | データ型 | 説明 |
|---|---|---|
| characterLimit | int | フィード項目ごとの最大表示文字数を指定します。 |
| collapseThread | boolean | メールスレッド内の以前のメッセージがメールフィード項目から削除され���か (true)、否か (false) を示します。 |
| displayFormat | FeedItemDisplayFormat (string 型の列挙) | メールフィード項目の表示方法を示します。有効な値は、次のとおりです。
|
| feedItemType | FeedItemType (string 型の列挙) | 設定を適用するフィード項目の種別。FeedItemSettings の場合、有効な feedItemType 値は EmailMessageEvent のみです。 |
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| caseOrigin | string | この Web フォームから作成されたケースのデフォルトのケース発生源を指定します。enableWebToCase が true に設定されている場合のみ適用されます。 |
| defaultResponseTemplate | string | セルフサービスポータルから送信されたケースへのメールレスポンスに使用されるデフォルトのテンプレートを指定します。enableWebToCase が true に設定されている場合のみ適用されます。 |
| enableWebToCase | boolean | Web-to-ケースが有効化されているか (true)、否か (false) を示します。 |
宣言的なメタデータの定義のサンプル
これは、ケース設定ファイルのサンプルです。
1<?xml version="1.0" encoding="UTF-8"?>
2<CaseSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <caseAssignNotificationTemplate>
4 unfiled$public/SupportCaseAssignmentNotification
5 </caseAssignNotificationTemplate>
6 <caseCloseNotificationTemplate>
7 unfiled$public/SupportCaseCloseNotification
8 </caseCloseNotificationTemplate>
9 <caseCommentNotificationTemplate>
10 unfiled$public/SupportCaseCommentNotification
11 </caseCommentNotificationTemplate>
12 <caseCreateNotificationTemplate>
13 unfiled$public/SupportCaseCreateNotification
14 </caseCreateNotificationTemplate>
15 <closeCaseThroughStatusChange>true</closeCaseThroughStatusChange>
16 <defaultCaseOwner>admin@acme.com</defaultCaseOwner>
17 <defaultCaseOwnerType>User</defaultCaseOwnerType>
18 <defaultCaseUser>admin@acme.com</defaultCaseUser>
19 <emailToCase>
20 <enableEmailToCase>true</enableEmailToCase>
21 <enableHtmlEmail>false</enableHtmlEmail>
22 <enableOnDemandEmailToCase>true</enableOnDemandEmailToCase>
23 <enableThreadIDInBody>true</enableThreadIDInBody>
24 <enableThreadIDInSubject>true</enableThreadIDInSubject>
25 <notifyOwnerOnNewCaseEmail>false</notifyOwnerOnNewCaseEmail>
26 <overEmailLimitAction>Bounce</overEmailLimitAction>
27 <routingAddresses>
28 <addressType>EmailToCase</addressType>
29 <authorizedSenders>user@acme.com</authorizedSenders>
30 <caseOrigin>Email</caseOrigin>
31 <casePriority>Medium</casePriority>
32 <createTask>true</createTask>
33 <emailAddress>support@acme.com</emailAddress>
34 <routingName>EmailToCaseRoutingAddress1</routingName>
35 <saveEmailHeaders>true</saveEmailHeaders>
36 <taskStatus>Not Started</taskStatus>
37 </routingAddresses>
38 <routingAddresses>
39 <addressType>Outlook</addressType>
40 <authorizedSenders>user@acme.com</authorizedSenders>
41 <caseOrigin>Email</caseOrigin>
42 <caseOwner>admin@acme.com</caseOwner>
43 <caseOwnerType>User</caseOwnerType>
44 <casePriority>High</casePriority>
45 <routingName>OutlookRoutingAddress1</routingName>
46 </routingAddresses>
47 <unauthorizedSenderAction>Discard</unauthorizedSenderAction>
48 </emailToCase>
49 <enableCaseFeed>true</enableCaseFeed>
50 <enableDraftEmails>true</enableDraftEmails>
51 <enableEarlyEscalationRuleTriggers>true</enableEarlyEscalationRuleTriggers>
52 <enableNewEmailDefaultTemplate>true</enableNewEmailDefaultTemplate>
53 <enableSuggestedArticlesApplication>true</enableSuggestedArticlesApplication>
54 <enableSuggestedArticlesCustomerPortal>true</enableSuggestedArticlesCustomerPortal>
55 <enableSuggestedArticlesPartnerPortal>false</enableSuggestedArticlesPartnerPortal>
56 <enableSuggestedSolutions>false</enableSuggestedSolutions>
57 <keepRecordTypeOnAssignmentRule>true</keepRecordTypeOnAssignmentRule>
58 <newEmailDefaultTemplateClass>CaseTemplateController</newEmailDefaultTemplateClass>
59 <notifyContactOnCaseComment>true</notifyContactOnCaseComment>
60 <notifyDefaultCaseOwner>true</notifyDefaultCaseOwner>
61 <notifyOwnerOnCaseComment>true</notifyOwnerOnCaseComment>
62 <notifyOwnerOnCaseOwnerChange>false</notifyOwnerOnCaseOwnerChange>
63 <showFewerCloseActions>false</showFewerCloseActions>
64 <useSystemEmailAddress>true</useSystemEmailAddress>
65 <webToCase>
66 <caseOrigin>Web</caseOrigin>
67 <defaultResponseTemplate>unfiled$public/SupportCaseResponse</defaultResponseTemplate>
68 <enableWebToCase>true</enableWebToCase>
69 </webToCase>
70</CaseSettings>