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

エンタイトルメントプロセスの設定を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

EntitlementProcess の値は、entitlementProcesses ディレクトリ内のファイルに保存されます。各ファイルの名前には、プロセスの名前とサフィックス .entitlementProcess が使用されます。各ファイルには、1 つのエンタイトルメントプロセス、またはエンタイトルメントのバージョニングが有効化されている場合はエンタイトルメントプロセスの 1 つのバージョンが含まれます。

ファイル名は、エンタイトルメントプロセス名の最後にバージョンを付加した名前になります (該当する場合)。たとえば、「gold_support」という名前のエンタイトルメントプロセスの場合は、「gold_support_v2.entitlementProcess」のようになります。このファイル名は、SOAP API を使用して公開される slaProcess.NameNorm 項目に対応します。このファイル名は、ユーザインターフェースの表示内容を表す name 項目とは異なり、バージョニングが有効化されている場合は、同じエンタイトルメントプロセスの複数のバージョンで共有されます。slaProcess.NameNorm 項目には、ユーザインターフェースに表示する name 項目の小文字バージョンが含まれます。

バージョン

エンタイトルメントプロセスは、API バージョン 27.0 以降で使用できます。

項目

項目名	項目の型	説明
active	boolean	エンタイトルメントプロセスが有効であるか (`true`)、有効でないか (`false`) を示します。
businessHours	string	エンタイトルメントプロセスに適用される営業時間。この項目は、API バージョン 30.0 以降で使用できます。
description	string	エンタイトルメントプロセスの説明。
entryStartDateField	string	ケースのカスタム日付/時間項目に基づいてケースのプロセスが開始されるマイルストンプロセスの場合、使用される日付と時間を指定します。有効な値は、次のとおりです。 SlaStartDate (エンタイトルメントプロセスの開始日) CreatedDate (ケースのオープン日) ClosedDate (ケースのクローズ日) LastModifiedDate (ケースの最終更新日) StopStartDate (ケースの停止日)
exitCriteriaBooleanFilter	string	カスタム条件が一致したときにケースのプロセスが終了するマイルストンプロセスに条件ロジックを追加する場合、その条件ロジックを指定します。
exitCriteriaFilterItems	FilterItem[]	カスタム条件が一致したときにケースのプロセスが終了するマイルストンプロセスの場合、その条件を指定します。
exitCriteriaFormula	string	カスタム数式の評価が true になったときにケースのプロセスが終了するマイルストンプロセスの場合、その数式を指定します。
isVersionDefault	boolean	エンタイトルメントプロセスがデフォルトのバージョンであるか (`true`)、否か (`false`) を示します。この項目は、API バージョン 28.0 以降で使用できます。
milestones	EntitlementProcessMilestoneItem[]	エンタイトルメントプロセスのマイルストンを表します。
name	string	ユーザインターフェースに表示されるエン��イトルメントプロセスの名前。
SObjectType	string	エンタイトルメントプロセスの実行対象となるレコードのタイプを示します。
versionMaster	string	このエンタイトルメントプロセスに属するバージョンの順序を示します。この項目の内容は、エンタイトルメントプロセスのすべてのバージョンで同じであれば、任意の値が有効です。この項目は、API バージョン 28.0 以降で使用できます。
versionNotes	string	エンタイトルメントプロセスバージョンの説明。この項目は、API バージョン 28.0 以降で使用できます。
versionNumber	int	エンタイトルメントプロセスのバージョン番号。1 以上である必要があります。この項目は、API バージョン 28.0 以降で使用できます。

EntitlementProcessMilestoneItem

エンタイトルメントプロセスのマイルストン項目を表します。

項目

項目名	項目の型	説明
businessHours	string	マイルストンに適用される営業時間。この項目は、API バージョン 30.0 以降で使用できます。
criteriaBooleanFilter	string	条件が一致したときにのみ適用されるマイルストンに条件ロジックを追加する場合、その条件ロジックを指定します。
milestoneCriteriaFilterItems	FilterItem[]	条件が一致したときにのみ適用されるマイルストンの場合、その条件を指定します。
milestoneCriteriaFormula	string	数式の評価が true になったときにのみ適用されるマイルストンの場合、その数式を指定します。
milestoneName	string	マイルストンの名前。
minutesCustomClass	string	トリガ時間の計算に使用する Apex クラスの名前。この項目は、API バージョン 30.0 以降で使用できます。
minutesToComplete	int	ケースのエンタイトルメントプロセスが開始してから、マイルストンが発生するまでの分数。
successActions	WorkflowActionReference[]	マイルストンが完了するとトリガされるアクション。
timeTriggers	EntitlementProcessMilestoneTimeTrigger[]	エンタイトルメントプロセスのマイルストンのタイムトリガ。
useCriteriaStartTime	boolean	マイルストンが開始されるタイミング。マイルストン条件が一致したとき (true)、またはケースのエンタイトルメントプロセスが開始されたとき (false)。

EntitlementProcessMilestoneTimeTrigger

エンタイトルメントプロセスのマイルストンのタイムトリガを表します。

項目

項目名	項目の型	説明
actions	WorkflowActionReference[]	タイムトリガに達したときに、その時点でマイルストンが完了してない場合に実行されるアクション。
timeLength	int	タイムトリガが有効になってから、マイルストンの目標完了日までの時間。これは、負または正の値になる場合があります。負の値は、目標完了日に達していないことを示し、警告のタイムトリガに相当します。正の値は、目標完了日が過ぎたことを示し、違反のタイムトリガに相当します。
workflowTimeTriggerUnit	MilestoneTimeUnits (string 型の列挙)	ワークフローがトリガされるタイミングを判断するために使用される単位の種類を指定します。有効な値は、次のとおりです。 `Minutes` `Hours` `Days`

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

これは、エンタイトルメントプロセスのサンプルです。

1<?xml version="1.0" encoding="UTF-8"?>
2<EntitlementProcess xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>true</active>
4    <description>eppersone</description>
5    <entryStartDateField>SlaStartDate</entryStartDateField>
6    <exitCriteriaBooleanFilter>1 OR 2</exitCriteriaBooleanFilter>
7    <exitCriteriaFilterItems>
8        <field>Case.IsClosed</field>
9        <operation>equals</operation>
10        <value>true</value>
11    </exitCriteriaFilterItems>
12    <exitCriteriaFilterItems>
13        <field>Case.Description</field>
14        <operation>startsWith</operation>
15        <value>foo</value>
16    </exitCriteriaFilterItems>
17    <milestones>
18        <milestoneName>m1</milestoneName>
19        <minutesToComplete>1</minutesToComplete>
20        <successActions>
21            <name>emailBob</name>
22            <type>Alert</type>
23        </successActions>
24        <timeTriggers>
25            <actions>
26                <name>emailAlice</name>
27                <type>Alert</type>
28            </actions>
29            <actions>
30                <name>setEscalateToTrue</name>
31                <type>FieldUpdate</type>
32            </actions>
33            <timeLength>1</timeLength>
34            <workflowTimeTriggerUnit>Minutes</workflowTimeTriggerUnit>
35        </timeTriggers>
36        <timeTriggers>
37            <actions>
38                <name>setStopToTrue</name>
39                <type>FieldUpdate</type>
40            </actions>
41            <timeLength>2</timeLength>
42            <workflowTimeTriggerUnit>Minutes</workflowTimeTriggerUnit>
43        </timeTriggers>
44        <useCriteriaStartTime>false</useCriteriaStartTime>
45    </milestones>
46    <milestones>
47        <milestoneCriteriaFilterItems>
48            <field>Case.Priority</field>
49            <operation>equals</operation>
50            <value>High</value>
51        </milestoneCriteriaFilterItems>
52        <milestoneName>m2</milestoneName>
53        <minutesToComplete>120</minutesToComplete>
54        <useCriteriaStartTime>true</useCriteriaStartTime>
55        <successActions>
56            <name>emailBob</name>
57            <type>Alert</type>
58        </successActions>
59    </milestones>
60</EntitlementProcess>

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

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。