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

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

UserEngagementSettings コンポーネントのサフィックスは .settings で、settings フォルダに保存されます。

バージョン

Prompt コンポーネントは、API バージョン 47.0 以降で使用できます。

特別なアクセスルール

権限およびエディション要件については、各機能の関連する Salesforce ヘルプを参照してください。

項目

項目名	項目の型	説明
canGovCloudUseAdoptionApps	boolean	政府機関を使用する組織が Lightning Experience 移行ツール外部アプリケーションにアクセスできるか (`true`)、否か (`false`) を示します。これらのアプリケーションの例として、Salesforce Optimizer、Lightning Experience 移行アシスタント、Lightning Experience 準備状況レポートなどが挙げられます。[設定] の [セキュリティ] の [外部アプリケーション設定] を確認してください。デフォルトは `false` です。
doesScheduledSwitcherRunDaily	boolean	Salesforce Classic から Lightning Experience に自動的に毎日切り替わるか (`true`)、否か (`false`) を示します。`false` の場合、毎週切り替わります。デフォルトは `false` です。Salesforce ヘルプの「Lightning Experience にとどまるようにユーザを促す」を参照してください。
enableCustomHelpGlobalSection	boolean	カスタムセクションが Lightning Experience ヘルプメニューに追加されるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableHelpMenuShowFeedback	boolean	Lightning Experience ヘルプメニューの [Salesforce にフィードバックを送信] リンクがユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。`false` の場合でも、システム管理者にはヘルプメニューのすべてのリンクが常に表示されます。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableHelpMenuShowHelp	boolean	Lightning Experience ヘルプメニューの [このページのヘルプ] セクションがユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。`false` の場合でも、システム管理者にはヘルプメニューのすべてのリンクが常に表示されます。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableHelpMenuShowNewUser	boolean	Lightning Experience ヘルプメニューの [使用開始] セクションがユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。`false` の場合でも、システム管理者にはヘルプメニューのすべてのリンクが常に表示されます。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableHelpMenuShowSearch	boolean	Lightning Experience ヘルプメニューの [ドキュメントを検索] リンクがユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。`false` の場合でも、システム管理者にはヘルプメニューのすべてのリンクが常に表示されます。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableHelpMenuShowSfdcContent	boolean	Lightning Experience ヘルプメニューの Salesforce によって作成されたヘルプリソースがユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。`false` の場合でも、システム管理者にはヘルプメニューのすべてのリンクが常に表示されます。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableHelpMenuShowShortcut	boolean	Lightning Experience ヘルプメニューの [キーボードショートカットを表示] リンクがユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。`false` の場合でも、システム管理者にはヘルプメニューのすべてのリンクが常に表示されます。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableHelpMenuShowSupport	boolean	Lightning Experience ヘルプメニューの [サポートの利用] リンクがユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。`false` の場合でも、システム管理者にはヘルプメニューのすべてのリンクが常に表示されます。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableHelpMenuShowTrailhead	boolean	Lightning Experience ヘルプメニューの [Trailhead に移動] リンクがユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。`false` の場合でも、システム管理者にはヘルプメニューのすべてのリンクが常に表示されます。詳細は、Salesforce ヘルプの「Lightning Experience ヘルプメニューのカスタムヘルプの定義」を参照してください。
enableIBILOptOutDashboards	boolean	ダッシュボードに関する [使いなれた機能が Lightning でさらに便利に] 応答画面がユーザに非表示であるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。API バージョン 51.0 以降では使用できなくなりました。
enableIBILOptOutEvents	boolean	行動/カレンダーに関する [使いなれた機能が Lightning でさらに便利に] 応答画面がユーザに非表示であるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。API バージョン 51.0 以降では使用できなくなりました。
enableIBILOptOutReports	boolean	レポートに関する [使いなれた機能が Lightning でさらに便利に] 応答画面がユーザに非表示であるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。API バージョン 51.0 以降では使用できなくなりました。
enableIBILOptOutTasks	boolean	ToDo に関する [使いなれた機能が Lightning でさらに便利に] 応答画面がユーザに非表示であるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。API バージョン 51.0 以降では使用できなくなりました。
enableLexToClassicFeedbackEnable	boolean	[Salesforce Classic に切り替えるユーザのフィードバックフォーム] がユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。詳細は、Salesforce ヘルプの「Salesforce Classic に切り替えるユーザのフィードバックフォーム」を参照してください。
enableOrchestrationInSandbox	boolean	採用アシスタンスや他のアプリケーション内ガイダンスが Sandbox 組織のユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。詳細は、Salesforce ヘルプの「Lightning Experience でのプロンプトの定義」を参照してください。
enableOrgUserAssistEnabled	boolean	組織で作成されたすべてのカスタムアプリケーション内ガイダンスがユーザに表示されるか (`true`)、否か (`false`) を示します。有効な状況には影響しません。デフォルトは `true` です。詳細は、Salesforce ヘルプの「Lightning Experience でのプロンプトの定義」を参照してください。
enableScheduledSwitcher	boolean	Salesforce Classic から Lightning Experience に自動的に切り替わるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。Salesforce ヘルプの「Lightning Experience にとどまるようにユーザを促す」を参照してください。
enableSfdcProductFeedbackSurvey	boolean	[Salesforce 製品のフィードバックフォーム] がユーザに表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。詳細は、Salesforce ヘルプの「Salesforce 製品のフィードバックフォーム」を参照してください。
enableShowSalesforceUserAssist	boolean	Salesforce によって作成されたすべての標準アプリケーション内ガイダンスがユーザに表示されるか (`true`)、否か (`false`) を示します。有効な状況には影響しません。デフォルトは `true` です。詳細は、Salesforce ヘルプの「Lightning Experience でのプロンプトの定義」を参照してください。
isCrucNotificationDisabled	boolean	Winter '20 の重要な更新「Lightning Experience の有効化」に関するすべての通知がシステム管理者に非表示であるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。
isLEXWelcomeMatDisabled	boolean	ユーザがユーザインターフェースに初めてログインするときに Lightning Experience の歓迎メッセージが非表示であるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。詳細は、Salesforce ヘルプの「Lightning Experience の歓迎メッセージ」を参照してください。
isMeetTheAssistantDisabledInClassic	boolean	Lightning Experience 移行アシスタントが Salesforce Classic のシステム管理者に非表示であるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。
isMeetTheAssistantDisabledInLightning	boolean	Lightning Experience 移行アシスタントが Lightning Experience のシステム管理者に非表示であるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。
optimizerAppEnabled	boolean	組織で Salesforce Optimizer が有効化されるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。Salesforce ヘルプの「Salesforce Optimizer を使用した実装の改善」を参照してください。

宣言的なメタデータの定義のサンプル

UserEngagementSettings コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<UserEngagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <canGovCloudUseAdoptionApps>false</canGovCloudUseAdoptionApps>
4   <doesScheduledSwitcherRunDaily>true</doesScheduledSwitcherRunDaily>
5   <enableCustomHelpGlobalSection>true</enableCustomHelpGlobalSection>
6   <enableHelpMenuShowFeedback>true</enableHelpMenuShowFeedback>
7   <enableHelpMenuShowHelp>true</enableHelpMenuShowHelp>
8   <enableHelpMenuShowNewUser>true</enableHelpMenuShowNewUser>
9   <enableHelpMenuShowSearch>true</enableHelpMenuShowSearch>
10   <enableHelpMenuShowSfdcContent>true</enableHelpMenuShowSfdcContent>
11   <enableHelpMenuShowShortcut>true</enableHelpMenuShowShortcut>
12   <enableHelpMenuShowSupport>true</enableHelpMenuShowSupport>
13   <enableHelpMenuShowTrailhead>true</enableHelpMenuShowTrailhead>
14   <enableIBILOptOutDashboards>true</enableIBILOptOutDashboards>
15   <enableIBILOptOutEvents>true</enableIBILOptOutEvents>
16   <enableIBILOptOutReports>true</enableIBILOptOutReports>
17   <enableIBILOptOutTasks>true</enableIBILOptOutTasks>
18   <enableLexToClassicFeedbackEnable>true</enableLexToClassicFeedbackEnable>
19   <enableOrgUserAssistEnabled>true</enableOrgUserAssistEnabled>
20   <enableScheduledSwitcher>true</enableScheduledSwitcher>
21   <enableSfdcProductFeedbackSurvey>true</enableSfdcProductFeedbackSurvey>
22   <enableOrchestrationInSandbox>true</enableOrchestrationInSandbox>
23   <enableShowSalesforceUserAssist>true</enableShowSalesforceUserAssist>
24   <isCrucNotificationDisabled>false</isCrucNotificationDisabled>
25   <isLEXWelcomeMatDisabled>false</isLEXWelcomeMatDisabled>
26   <isMeetTheAssistantDisabledInClassic>false</isMeetTheAssistantDisabledInClassic>
27   <isMeetTheAssistantDisabledInLightning>false</isMeetTheAssistantDisabledInLightning>
28   <optimizerAppEnabled>true</optimizerAppEnabled>
29</UserEngagementSettings>

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

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

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

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