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

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

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

バージョン

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

項目

項目名	項目の型	説明
bypassMeteringBlock	boolean	トランザクションセキュリティポリシーのサービス保護の測定動作を決定します。`true` に設定されている場合、測定は実施されますが、ポリシーをトリガしたユーザの操作はブロックされません。`false` に設定されており、ポリシーを 3 秒以内に処理できない場合、測定は実施され、ユーザのアクションはブロックされます。デフォルト値は `false` です。
enableDeleteMonitoringData	boolean	イベントログファイルと LoginEvent データをユーザが削除できるようにするか (`true`)、否か (`false`)。ユーザには、この設定を有効にすると使用できる「イベント監視レコードを削除」ユーザ権限が必要です。デフォルト値は `false` です。
enableDynamicStreamingChannel	boolean	汎用ストリーミングに登録した場合、ストリーミングチャネルの動的作成を有効化するか (`true`)、無効化するか (`false`)。デフォルト値は `false` です。
enableEventLogGeneration	boolean	イベント監視ログファイルの生成を有効化するか (`true`)、無効化するか (`false`)。デフォルト値は `false` です。
enableEventLogWaveIntegration	boolean	イベント監視のログファイルと Analytics アプリケーションの統合を有効化するか (`true`)、無効化するか (`false`)。Analytics アプリケーションは、ユーザの活動を視覚化するのに役立ちます。デフォルト値は `false` です。
enableLoginForensics	boolean	ログインフォレンジック機能を有効化するか (`true`)、無効化するか (`false`)。ログインフォレンジックを使用すると、組織のユーザのログイン活動を追跡および監査しやすくなります。デフォルト値は `false` です。API バージョン 47.0 ～ 49.0 で使用可能です。バージョン 50.0 以降では、イベントマネージャの設定ページで LoginEvent を有効にします。ヒント
enableStreamingApi	boolean	組織でストリーミング API を有効化するか (`true`)、無効化するか (`false`)。デフォルト値は `true` です。
enableTerminateOldestSession	boolean	API ベースのログイン (UI を介さないログイン) 中にセッション終了アクションをトリガする従来のトランザクションセキュリティポリシーの動作を決定します。セッション終了アクションは、ユーザが Salesforce セッションの最大許容数を超えた場合に実行されます。 `true` の場合、ユーザがセッション終了アクションをトリガすると、Salesforce は、ユーザが準拠するまで、ユーザの最も古いセッションを終了します。`false` に設定すると、Salesforce はユーザの最新のログイン試行をブロックし、新しいユーザセッションを許可しません。デフォルト値は `false` です。API バージョン 47.0 ～ 49.0 で使用可能です。 Summer '20 以降、すべての Salesforce 組織で従来のトランザクションセキュリティが廃止されます。メモ
enableTransactionSecurityPolicies	boolean	Salesforce UI でトランザクションセキュリティポリシーを作成および使用する機能を有効化するか (`true`)、無効化するか (`false`)。デフォルト値は `false` です。
enableApexLimitEvents	boolean	Apex 制限イベント (パイロット) 機能を有効化するか (`true`)、無効化するか (`false`)。デフォルト値は `false` です。 Apex 制限イベント (パイロット) 機能は終了したため、この項目を使用しないでください。メモ

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

EventSettings.settings ファイルの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<EventSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableDeleteMonitoringData>true</enableDeleteMonitoringData>
4    <enableDynamicStreamingChannel>false</enableDynamicStreamingChannel>
5    <enableEventLogWaveIntegration>true</enableEventLogWaveIntegration>
6    <enableLoginForensics>true</enableLoginForensics>
7    <enableStreamingApi>true</enableStreamingApi>
8    <enableTerminateOldestSession>true</enableTerminateOldestSession>
9    <enableTransactionSecurityPolicies>true</enableTransactionSecurityPolicies>
10</EventSettings>

パッケージマニフェストの例

イベント設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。

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

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

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