EventSubscription
ファイルのサフィックスおよびディレクトリの場所
EventSubscription コンポーネントのサフィックスファイルパスは .subscription で、eventSubscriptions フォルダに保存されます。
バージョン
イベント登録コンポーネントは、API バージョン 41.0 から 45.0 で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| active | boolean | 登録が有効でない場合、イベントを受信しません。 |
| eventParameters | EventParameterMap[] | 公開済みイベントでは true になっている必要があるパラメータの配列。 |
| eventType | string | 必須。プラットフォームイベントの名前。 |
| referenceData | string | 必須。登録者が CustomEvent 種別のフローである場合、referenceData は flowName_versionNumber になります。たとえば、Printer_Management_2 のようになります。 |
EventParameterMap
公開済みイベントでは true になっている必要があるパラメータの配列。たとえば、Status__c が Shipped の場合にのみ [Vendor Response (ベンダー応答)] イベントに登録します。
各イベント登録には、最大 10 個のパラメータを含めることができます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| parameterName | string | 必須。公開済みイベントの項目名。 |
| parameterValue | string | true になっている必要がある値。 |
宣言的なメタデータの定義のサンプル
次に、有効なイベント登録の例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<EventSubscription xmlns="http://soap.sforce.com/2006/04/metadata">
3 <active>true</active>
4 <eventType>Printer_Status__e</eventType>
5 <referenceData>Printer_Management</referenceData>
6</EventSubscription>次に、イベントパラメータを設定する無効なイベント登録の例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<EventSubscription xmlns="http://soap.sforce.com/2006/04/metadata">
3 <name>MySubscription</name>
4 <active>false</active>
5 <eventParameters>
6 <parameterName>Ink_Status__c</parameterName>
7 <parameterValue>low</parameterValue>
8 </eventParameters>
9 <eventParameters>
10 <parameterName>Serial_Number__c</parameterName>
11 <parameterValue>00123456789</parameterValue>
12 </eventParameters>
13 <eventType>Printer_Status__e</eventType>
14 <referenceData>My_Event_Based_Process_1</referenceData>
15</EventSubscription>次に、組織の使用可能なすべてのイベント登録メタデータをリリースまたは取得する package.xml の例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>*</members>
5 <name>EventSubscription</name>
6 </types>
7 <version>41.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。