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

パッケージマニフェストでは、Settings の名前を使用してすべての組織設��メタデータ型にアクセスします。詳細は「設定」を参照してください。

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

CaseSettings の値は、settings ディレクトリの Case.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョン

CaseSettings は、API バージョン 27.0 以降で使用できます。

項目

項目名	項目の型	説明
caseAssignNotificationTemplate	string	ケース割り当て通知に使用するメールテンプレートを指定します。folderName/emailTemplateName の形式を使用する必要があります。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
caseAutoProcUser	boolean	顧客の最初のメールの後に自動レスポンスレコードを作成するか (`true`)、否か (`false`) を示します。
caseCloseNotificationTemplate	string	ケースクローズ通知に使用するメールテンプレートを指定します。folderName/emailTemplateName の形式を使用する必要があります。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
caseCommentNotificationTemplate	string	ケースコメント通知に使用するメールテンプレートを指定します。folderName/emailTemplateName の形式を使用する必要があります。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
caseCreateNotificationTemplate	string	ケース作成通知に使用するメールテンプレートを指定します。folderName/emailTemplateName の形式を使用する必要があります。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
caseFeedItemSettings	FeedItemSettings[]	フィードベースのケースページレイアウトに含まれるフィード項目の設定を指定します。この項目は、API バージョン 32.0 以降で使用できます。
caseFeedReadUnreadLtng	boolean	Lightning Experience で未読フィード項目を太字で表示するか (`true`)、否か (`false`) を示します。
caseMergeinLightning	boolean	Lightning Experience でケースの差し込みが有効化されているか (`true`)、否か (`false`) を示します。
closeCaseThroughStatusChange	boolean	ケース編集ページの [ケース状況] 項目に `Closed` を表示するか (`true`)、否か (`false`) を示します。
defaultCaseFeedLayoutOn	boolean	組織でデフォルトのケースフィードレイアウトを使用するか (`true`)、否か (`false`) を示します。
defaultCaseOwner	string	割り当てルールで所有者を見つけられなかった場合に、ケースのデフォルトの所有者を指定します。
defaultCaseOwnerType	string	デフォルトのケース所有者がユーザか、キューかを指定します。
defaultCaseUser	string	自動ケース更新の [ケース履歴] 関連リストに表示されるユーザを指定します。割り当てルールエスカレーションルールオンデマンドメール-to-ケースセルフサービスポータルでログインしたケース Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
emailActionDefaultsHandlerClass	string	この Apex クラス名を使用して、メールアクションのデフォルト値を指定します。
emailToCase	EmailToCaseSettings	組織のメール-to-ケース設定。
enableCaseFeed	boolean	ケースフィードが有効化されているか (`true`)、否か (`false`) を示します。
enableCollapseEmailThread	boolean	メールスレッド内の以前のメッセージがメールフィード項目から削除されたか (`true`)、否か (`false`) を示します。API バージョン 47.0 以降で利用できます。
enableDraftEmails	boolean	ドラフトメールが有効化されているか (`true`)、否か (`false`) を示します。メールドラフトを有効にすると、ケースフィードとメール-to-ケースも有効にする必要があります。
enableEarlyEscalationRuleTriggers	boolean	エスカレーションルールの早期トリガが有効化されているか (`true`)、否か (`false`) を示します。
enableEmailActionDefaultsHandler	boolean	メールアクションのデフォルトハンドラ設定が有効化されているか (`true`)、否か (`false`) を示します。この設定を使用して Apex クラスを選択し、デフォルトのテンプレートを読み込むか、メールアクションのデフォルト対象項目を指定します。
enableEmailContactOnCasePost	boolean	`true` の場合、ユーザがエクスペリエンスビルダーサイトのケースに対して投稿し、それが外部から参照可能な場合には、ケースの取引先責任者にメールで通知されます。
enableEscalateQfiToCaseInternal	boolean	`true` の場合、モデレータは組織の Chatter の [質問] フィード項目からケースを作成できます。
enableEscalateQfiToCaseNetworks	boolean	`true` の場合、モデレータは Chatter の質問が有効になっているすべてのエクスペリエンスビルダーサイトで、Chatter の [質問] フィード項目からケースを作成できます。
enableExtNetworksCaseFeedEnabled	boolean	`true` の場合、サイトメンバーはケースに関連するメール、コメント、更新をケースフィードで参照できます。
enableMultiLangSolnSrchCSS	boolean	セルフサービスポータルでソリューションのマルチ言語検索が有効化されているか (`true`)、否か (`false`) を示します。
enableMultiLangSolnSrchPKB	boolean	公開ソリューションのマルチ言語検索が有効化されているか (`true`)、否か (`false`) を示します。
enableMultiLangSolution	boolean	マルチ言語ソリューションが有効化されているか (`true`)、否か (`false`) を示します。
enableNewEmailDefaultTemplate	boolean	デフォルトのメールテンプレートが有効化されているか (`true`)、否か (`false`) を示します。デフォルトのメールテンプレートは、ドラフトメールが有効になっている場合にのみ使用できます。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
enableSolutionCategory	boolean	ソリューションの参照が有効化されているか (`true`)、否か (`false`) を示します。
enableSolutionInlineCategory	boolean	ソリューションカテゴリ階層 (ブレッドクラム) の表示を使用できるか (`true`)、否か (`false`) を示します。
enableSolutionShortSummary	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` の場合にのみ使用できます。
escalateCaseBefore	boolean	ケースをエスカレーションするためにアーリートリガが有効化されているか (`true`)、否か (`false`) を示します。
genericMessageEnabled	boolean	一般的なメッセージが有効化されているか (`true`)、否か (`false`) を示します。
keepCaseMergeRecords	boolean	`true` の場合、ケースのマージ後に重複するケースは削除されません。
keepRecordTypeOnAssignmentRule	boolean	割り当てルールを手動作成したレコードに適用するときに、既存のレコードタイプを使用するか (`true`)、既存のレコードタイプを割り当て先のデフォルトレコードタイプで上書きするか (`false`) を示します。
newEmailDefaultTemplateClass	string	ケースフィードで新規メールメッセージに使用されるデフォルトのメールテンプレートを定義する Apex クラスを指定します。この項目は enableNewEmailDefaultTemplate`=true` の場合のみ表示されます。Lightning メールテンプレートはパッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
notifyContactOnCaseComment	boolean	新しいコメントがケースに追加された場合に、セルフサービスポータルのメンバーではない取引先責任者に通知できるようにするか (`true`)、しないか (`false`) を示します。
notifyDefaultCaseOwner	boolean	新規ケースが割り当てられた場合に、デフォルトのケース所有者に通知するか (`true`)、否か (`false`) を示します。
notifyOwnerOnCaseComment	boolean	コメントがケースに追加された場合に、ケース所有者に通知するか (`true`)、否か (`false`) を示します。
notifyOwnerOnCaseOwnerChange	boolean	ユーザがケースの所有者を別のユーザに変更する場合に、ケースの [メールで通知する] チェックボックスを自動的に選択されるようにするか (`true`) どうかを示します。
predictiveSupportEnabled	boolean	予測サポートが有効化されているか (`true`)、否か (`false`) を示します。
showEmailAttachmentsInCaseAttachmentsRL	boolean	ケースの [添付ファイル] 関連リストにメールの添付ファイルを表示するかどうかを示します。`true` にすると、ページのケースの [添付ファイル] 関連リストで、メールの各添付ファイルの横にメールのアイコンが表示されます。関連リストのリストビューには参照元列も含まれ、添付ファイルの元の場所が特定されます。`false` にすると、メールの添付ファイルは、ケースの [添付ファイル] 関連リストに表示されません。この項目は、API バージョン 40.0 以降で使用できます。
showFewerCloseActions	boolean	ケースの編集ページの [保存して閉じる] ボタンと [ケース] 関連リストの [完了] リンクを非表示にするか (`true`)、表示するか (`false`) を示します。
systemUserEmail	string	デフォルトのケースユーザがシステムユーザの場合に使用するメールアドレスを指定します。
useSystemEmailAddress	boolean	ケースコメント、ケース添付ファイル、およびケース割り当てのメール通知が表示されるときの送信元を示します。システムアドレスから送信された通知として表示するには、`true` を使用します。ケースを更新するユーザまたは取引先責任者から送信された通知として表示するには、`false` を使用します。
useSystemUserAsDefaultCaseUser	boolean	システムユーザを自動ケース更新ユーザとして使用するかどうかを示します (`true`) または (`false`)。false の場合、defaultCaseUser 項目の値を指定する必要があります。
visibleInCssCheckbox	boolean	ケース編集ページの [CSS の表示] オプションの指定に従って、ケースのデフォルト表示を設定します。`false` の場合、ケースはデフォルトで CSS で表示されます。`true` の場合、CSS の表示は無効になります。
webToCase	WebToCaseSettings	組織の Web-to-ケース設定。

EmailToCaseSettings

組織のメール-to-ケース設定を表します。

項目

項目名	項目の型	説明
enableEmailToCase	boolean	メール-to-ケースが有効化されているか (`true`)、否か (`false`) を示します。注意: メール-to-ケースを有効にした後に無効にすることはできません。
enableE2CAttachmentAsFile	boolean	メール-to-ケースを Salesforce Files として使用して送信された添付ファイルを保存するか (`true`)、否か (`false`) を示します。
enableE2CSourceTracking	boolean	[ケースソースをメールに設定] が有効化されているか (`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 日の上限を超えた後に受信したメールメッセージの処理方法を指定します。有効な値は、次のとおりです。 `Bounce` `Discard` `Requeue`
preQuoteSignature	boolean	返信操作の後 (送信メールのメールスレッドの前) にユーザ署名が挿入されるか (`true`)、メールの最後に挿入されるか (`false`) を示します。
routingAddresses	EmailToCaseRoutingAddress[]	組織のメール-to-ケースのルーティングアドレス設定。
unauthorizedSenderAction	EmailToCaseOnFailureActionType (string 型の列挙)	無効な送信者から受信したメールメッセージの処理方法を指定します。有効な値は、次のとおりです。 `Bounce` `Discard`

EmailToCaseRoutingAddress

組織のメール-to-ケースのルーティングアドレスを表します。

項目

項目名	項目の型	説明
addressType	EmailToCaseRoutingAddressType (string 型の列挙)	メール-to-ケースのルーティングアドレスの種類を指定します。有効な値は、次のとおりです。 `EmailToCase` — メール-to-ケースまたはオンデマンドメール-to-ケースに使用されるルーティングアドレス。 `Outlook` — Outlook からケースを作成するために Salesforce for Outlook で使用されるルーティングアドレス。オンデマンドメール-to-ケースが有効になっている必要があります。
authorizedSenders	string	オンデマンドメール-to-ケースにメールを送信できるメールアドレスまたはドメインを指定します。カンマ区切りのリストで複数のエントリを指定できます。
caseOrigin	string	このルーティングアドレスから作成されたケースのデフォルトのケース発生源を指定します。
caseOwner	string	このルーティングアドレスから作成されたケースのデフォルトの所有者を指定します。ケース所有者には、ユーザまたはキューを指定できます。Salesforce ユーザ名を使用してケース所有者を指定します。ここで、ルーティングアドレスのケース所有者を指定すると、CaseSettings の defaultCaseOwner の値が設定されます。
caseOwnerType	string	デフォルトのケース所有者がユーザか、キューかを指定します。
casePriority	string	このルーティングアドレスから作成されたケースのデフォルトのケース優先度を指定します。
createTask	boolean	ケースがメールから作成されるときに、ケース所有者に ToDo が自動的に割り当てられるか (`true`)、否か (`false`) を示します。
emailAddress	string	ケースとして送信されるメールメッセージを転送するために使用されるメールアドレスを指定します。
emailServicesAddress	string	Salesforce によって生成され、メール-to-ケース転送の設定で使用されるルーティングアドレスを指定します。この項目値は参照のみで変更できません。
isVerified	boolean	顧客が (通常は確認メールをクリックして) ルーティングアドレスを確認したかどうかを示します。この項目値は参照のみで変更できません。
routingName	string	メール-to-ケースのルーティングアドレスの名前を指定します。
saveEmailHeaders	boolean	メールルーティングおよび封筒情報が保存されるか (`true`)、否か (`false`) を示します。
taskStatus	string	メールがケースとして送信されるときにケース所有者に自動的に割り当てられる ToDo のデフォルト状況を指定します。createTask が `true` に設定されている場合のみ適用されます。

FeedItemSettings

組織のフィード項目設定を表します。API バージョン 32.0 以降で利用できます。

項目名	項目の型	説明
characterLimit	int	フィード項目ごとの最大表示文字数を指定します。
collapseThread	boolean	削除済み。メールスレッド内の以前のメッセージがメールフィード項目から削除されたか (`true`)、否か (`false`) を示します。 API バージョン 27.0 ～ 46.0 で使用可能です。
displayFormat	FeedItemDisplayFormat (string 型の列挙)	メールフィード項目の表示方法を示します。有効な値は、次のとおりです。 Default — メールフィード項目の空白行が表示されます。 HideBlankLines — メールフィード項目の空白行は表示されません。
feedItemType	FeedItemType (string 型の列挙)	設定を適用するフィード項目の種��。FeedItemSettings の場合、有効な feedItemType 値は EmailMessageEvent のみです。

WebToCaseSettings

組織の Web-to-ケース設定を表します。

項目

項目名	項目の型	説明
caseOrigin	string	この Web フォームから作成されたケースのデフォルトのケース発生源を指定します。enableWebToCase が `true` に設定されている場合のみ適用されます。
defaultResponseTemplate	string	セルフサービスポータルから送信されたケースへのメールレスポンスに使用されるデフォルトのテンプレートを指定します。enableWebToCase が `true` に設定されている場合のみ適用されます。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
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        <preQuoteSignature>true</preQuoteSignature>
28        <routingAddresses>
29            <addressType>EmailToCase</addressType>
30            <authorizedSenders>user@acme.com</authorizedSenders>
31            <caseOrigin>Email</caseOrigin>
32            <casePriority>Medium</casePriority>
33            <createTask>true</createTask>
34            <emailAddress>support@acme.com</emailAddress>
35            <routingName>EmailToCaseRoutingAddress1</routingName>
36            <saveEmailHeaders>true</saveEmailHeaders>
37            <taskStatus>Not Started</taskStatus>
38        </routingAddresses>
39        <routingAddresses>
40            <addressType>Outlook</addressType>
41            <authorizedSenders>user@acme.com</authorizedSenders>
42            <caseOrigin>Email</caseOrigin>
43            <caseOwner>admin@acme.com</caseOwner>
44            <caseOwnerType>User</caseOwnerType>
45            <casePriority>High</casePriority>
46            <routingName>OutlookRoutingAddress1</routingName>
47        </routingAddresses>
48        <unauthorizedSenderAction>Discard</unauthorizedSenderAction>
49    </emailToCase>
50    <enableCaseFeed>true</enableCaseFeed>
51    <enableDraftEmails>true</enableDraftEmails>
52    <enableEarlyEscalationRuleTriggers>true</enableEarlyEscalationRuleTriggers>
53    <enableNewEmailDefaultTemplate>true</enableNewEmailDefaultTemplate>
54    <enableSuggestedArticlesApplication>true</enableSuggestedArticlesApplication>
55    <enableSuggestedArticlesCustomerPortal>true</enableSuggestedArticlesCustomerPortal>
56    <enableSuggestedArticlesPartnerPortal>false</enableSuggestedArticlesPartnerPortal>
57    <enableSuggestedSolutions>false</enableSuggestedSolutions>
58    <keepRecordTypeOnAssignmentRule>true</keepRecordTypeOnAssignmentRule>
59    <newEmailDefaultTemplateClass>CaseTemplateController</newEmailDefaultTemplateClass>
60    <notifyContactOnCaseComment>true</notifyContactOnCaseComment>
61    <notifyDefaultCaseOwner>true</notifyDefaultCaseOwner>
62    <notifyOwnerOnCaseComment>true</notifyOwnerOnCaseComment>
63    <notifyOwnerOnCaseOwnerChange>false</notifyOwnerOnCaseOwnerChange>
64    <showFewerCloseActions>false</showFewerCloseActions>
65    <useSystemEmailAddress>true</useSystemEmailAddress>
66    <webToCase>
67        <caseOrigin>Web</caseOrigin>
68        <defaultResponseTemplate>unfiled$public/SupportCaseResponse</defaultResponseTemplate>
69        <enableWebToCase>true</enableWebToCase>
70    </webToCase>
71</CaseSettings>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Case</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</Package>

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

package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。