ApprovalProcess
承認プロセスに関連付けられたメタデータを表します。承認プロセスは、Salesforce でレコードを承認する場合に、組織で使用できる自動化されたプロセスです。承認プロセスでは、承認するレコードの条件と各承認ステップの承認者を指定します。各承認ステップは、その承認プロセスの対象レコードすべてに適用することも、システム管理者が定義した特定の条件を満たすレコードのみに適用することもできます。承認プロセスでは、レコードの承認、却下、取り消しまたは最初の承認申請時に実施するアクションも指定します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ApprovalProcess コンポーネントのサフィックスは .approvalProcess で、approvalProcesses フォルダに保存されます。
バージョン
ApprovalProcess コンポーネントは、API バージョン 28.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| active | boolean | 必須。承認プロセスがアクティブかどうか。 承認プロセスを有効にした後に、その承認プロセスのステップの追加、削除、または順序の変更や、プロセスの却下またはスキップの動作の変更はできません (プロセスを無効にしてもこれらの操作を行うことはできません)。 |
| allowRecall | boolean | 申請者に承認申請の取り消しを許可するかどうか。 false に設定されている場合、システム管理者のみが承認申請を取り消すことができます。 |
| allowedSubmitters | ApprovalSubmitter[] | 必須。レコードの承認申請が許可されているユーザの配列。 |
| approvalPageFields | ApprovalPageField | 承認者がレコードを承認または却下する承認ページに表示する項目を指定します。デフォルトでは、次の項目が表示されます。
Salesforce1 で通知を有効にしている場合、承認者がモバイルデバイスでこの項目のリストを参照可能になります。ユーザがレコードの承認または却下を決定する必要がある項目のみを選択してください。 |
| approvalStep | ApprovalStep[] | 承認ステップ定義の配列。 |
| description | string | 承認プロセスを説明します。 |
| emailTemplate | string | 承認申請に使用するメールテンプレートを指定します。指定されていない場合は、デフォルトのメールテンプレートが使用されます。 承認プロセスによってユーザへ承認申請が割り当てられると、Salesforce からそのユーザに対して承認申請メールが送信されます。メールには Salesforce の承認ページへのリンクが記載されています。このリンクでは、ユーザが申請を承認または却下し、コメントを追加できます。 |
| enableMobileDeviceAccess | boolean | ユーザは Salesforce にログインせずに、モバイルデバイスのブラウザを含む任意のブラウザから承認ページの外部バージョンにアクセスできるかどうか。ユーザインターフェースの [セキュリティ設定] に対応します。 true に設定されている場合、承認ステップに type adhoc の承認者を含めることはできません。 false に設定されている場合、承認者は Salesforce にログインして承認ページにアクセスする必要があります。 |
| entryCriteria | ApprovalEntryCriteria | 承認プロセスの対象となるレコードを決定します。承認プロセスをすべてのレコードに許可する場合は、この項目を除外します。 |
| finalApprovalActions | ApprovalAction | レコードに対するすべての承認申請が終了したときに実行するワークフローアクションを指定します。 |
| finalApprovalRecordLock | boolean | 必要なすべての承認が終了した後でレコードをロックしたままにするかどうか。デフォルト: false。 |
| finalRejectionActions | ApprovalAction | レコードが最終却下状態に移行した後で実行するワークフローアクションを指定します。 |
| finalRejectionRecordLock | boolean | 最終的に却下された後でレコードをロックしたままにするかどうか。デフォルト: false。 |
| initialSubmissionActions | ApprovalAction | レコードの最初の承認申請時に実行するワークフローアクションを指定します。 |
| label | string | 必須。承認プロセスの名前。 |
| nextAutomatedApprover | NextAutomatedApprover | 承認ステップに承認者を自動割り当てするために使用できる、標準またはカスタムユーザ階層項目を指定します。 この項目を除外すると、承認ステップでユーザ階層項目を使用して承認者の自動割り当てができなくなります。 |
| postTemplate | string |
Chatter での承認に使用する投稿テンプレート。 Chatter 投稿承認通知は、フィード追跡が有効になっているオブジェクトに関連付けられている承認プロセスでのみ使用可能です。 |
| recallActions | ApprovalAction | 未承認の申請を取り下げたときに実行するワークフローアクションを指定します。 |
| recordEditability | RecordEditabilityType (string 型の列挙) | 未承認のレコードを編集できるユーザを指定します。レコードは承認申請されると自動的にロックされ、承認プロセス中に他のユーザがそのレコードを編集するのを防ぎます。有効な値は、次のとおりです。
|
| showApprovalHistory | boolean | 承認申請の詳細を承認者が表示できレコードを承認または却下できる承認ページに、[承認履歴] 関連リストを追加するかどうか。[承認履歴] 関連リストは、レコードの承認プロセスを追跡します。 [承認履歴] 関連リストをレコード詳細ページおよび編集ページにも追加する場合は、Salesforce ユーザインターフェースを使用して指定のオブジェクトのページレイアウトをカスタマイズします。 |
ApprovalSubmitter
レコードの承認を申請できるユーザまたはユーザセットを表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| submitter | string | レコードの承認を申請できる特定のユーザまたはユーザセットを識別します。次のタイプが指定され submitter 項目が無視される場合を除き、この項目は必須です。
例:
|
| type | ProcessSubmitterType (string 型の列挙) | 必須。レコードの承認を申請できるユーザまたはユーザセットの種別。有効な値は、次のとおりです。
|
ApprovalPageField
承認申請の詳細を承認者が表示できレコードを承認または却下できる承認ページに表示するために選択された項目を表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| field | string[] | 承認者がレコードを承認または却下する承認ページに表示する項目の配列。 |
ApprovalStep
承認プロセスのステップを表します。承認ステップでは、承認申請をさまざまなユーザに割り当て、承認プロセスにおける承認のつながりを定義します。各承認ステップでは、その承認ステップに進むために必要なレコードの条件、そのレコードの申請を承認できるユーザ、および代理承認者による承認を許可するかどうかを指定します。承認プロセスの最初の承認ステップでは、レコードがこのステップの条件を満たさない場合に実施するアクションを指定します。その後のステップでは、却下時のアクションを指定することができます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| allowDelegate | boolean | 承認プロセスのこのステップで代理承認者を許可するかどうか。代理承認者は、割り当てられた承認者により承認申請の承認代理として任命されたユーザです。 |
| approvalActions | ApprovalAction | 承認プロセスのこのステップでレコードが承認されたときに実行するワークフローアクションを指定します。 |
| assignedApprover | ApprovalStepApprover | 承認プロセスのこのステップに割り当てられた承認者を指定します。 |
| description | string | 承認ステップを説明します。 |
| entryCriteria | ApprovalEntryCriteria | 承認プロセスのこのステップの対象となるレコードを決定します。 |
| ifCriteriaNotMet | StepCriteriaNotMetType (string 型の列挙) | 開始条件を満たさないレコードに対する処理を指定します。有効な値は、次のとおりです。
|
| label | string | 必須。承認ステップの名前。 |
| name | string | 必須。承認ステップの一意の名前。アンダースコアと英数字のみを含むこと、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。一意性は、特定の承認プロセス内でのみ必要です。 |
| rejectBehavior | ApprovalStepRejectBehavior | 承認プロセスの最初のステップを除き必須。承認プロセスの最初のステップでない場合に、承認者がこの承認ステップで申請を却下したときの処理を指定します。 承認プロセスの最初のステップで承認者が申請を却下した場合、却下時の処理は finalRejectionActions によって決まります。 |
| rejectionActions | ApprovalAction | 承認プロセスのこのステップでレコードが却下されたときに実行するワークフローアクションを指定します。 |
ApprovalAction
承認プロセスの結果として発生するアクションを表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| action | WorkflowActionReference[] | 実行するワークフローアクションの配列。 |
ApprovalStepApprover
承認ステップに割り当てられた承認者を表します。承認者は、ステップごとに最大 25 人に制限されています。
| 項目名 | データ型 | 説明 |
|---|---|---|
| approver | Approver[] | 承認プロセスのこのステップに割り当てられた承認者の配列。 |
| whenMultipleApprovers | RoutingType (string 型の列挙) | ステップに複数の承認者が割り当てられている場合の、承認または却下の処理方法を指定します。有効な値は、次のとおりです。
|
Approver
承認ステップに割り当てられた承認者を表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| name | string | 割り当てられた承認者を特定します。type が次のいずれかで name が無視される場合を除き、この項目は必須です。
|
| type | NextOwnerType (string 型の列挙) | 指定された name と組み合わせて、割り当てられた承認者を特定します。有効な値は、次のとおりです。
|
ApprovalEntryCriteria
レコードが承認プロセスまたは承認ステップに進むための条件を表します。検索条件または数式のいずれかを指定します。両方は指定できません。
| 項目名 | データ型 | 説明 |
|---|---|---|
| booleanFilter | string | criteriaItems の検索条件ロジック。formula を入力する場合は、この項目を除外します。 |
| criteriaItems | FilterItem[] | レコードが承認プロセスまたは承認ステップに進むための検索条件。 承認プロセスでは、検索条件の valueField エントリをサポートしていません。 |
| formula | string | レコードが承認プロセスまたは承認ステップに進むためにレコードを true と評価する数式。 |
ApprovalStepRejectBehavior
承認プロセスの最初のステップでない場合に、承認者がこの承認ステップで申請を却下したときの処理を表します。承認プロセスの最初のステップの場合、却下時の処理は承認プロセスの最終却下時のアクションによって決まります。
| 項目名 | データ型 | 説明 |
|---|---|---|
| type | StepRejectBehaviorType (string 型の列挙) | 有効な値は、次のとおりです。
|
NextAutomatedApprover
承認プロセスの次の承認者として使用するユーザ階層項目を表します。定義されていると、階層項目で指定されたユーザを、1 つ以上の承認ステップで承認者として自動的に割り当てることができます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| useApproverFieldOfRecordOwner | boolean | 必須。申請者のユーザレコードではなく、レコード所有者のユーザレコードで指定された userHierarchyField を承認者として最初に実行される承認ステップで使用すべきかどうか。残りのすべてのステップでは、前のステップの承認者のユーザレコードで指定された userHierarchyField が使用されます。 |
| userHierarchyField | string | 必須。承認者として割り当てるユーザを指定する値を持つ、標準またはカスタムユーザ階層項目。たとえば、標準 [マネージャ] 階層項目を使用して、従業員の有給休暇申請の承認者を割り当てることができます。 割り当てられる承認者に、承認申請対象レコードの参照アクセス権を必ず付与してください。たとえば、経費カスタムオブジェクトの参照アクセス権がないユーザは、経費承認申請を参照できません。 |