メタデータ API 開発者ガイド
jEntitlementProcess
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 | ケースの���スタム日付/時間項目に基づいてケースのプロセスが開始されるマイルストンプロセスの場合、使用される日付と時間を指定します。有効な値は、次のとおりです。
|
| 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 以降で使用できます。 |
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| 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)。 |
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| actions | WorkflowActionReference[] | タイムトリガに達したときに、その時点でマイルストンが完了してない場合に実行されるアクション。 |
| timeLength | int | タイムトリガが有効になってから、マイルストンの目標完了日までの時間。これは、負または正の値になる場合があります。負の値は、目標完了日に達していないことを示し、警告のタイムトリガに相当します。正の値は、目標完了日が過ぎたことを示し、違反のタイムトリガに相当します。 |
| workflowTimeTriggerUnit | MilestoneTimeUnits (string 型の列挙) | ワークフローがトリガされるタイミングを判断するために使用される単位の種類を指定します。有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
これは、エンタイトルメントプロセスのサンプルです。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。