承認タスク

承認タスクでは、承認ベースのインテグレーションを構成できます。また、インテグレーションのフローも管理できます。

承認タスクを使用すると、1 人以上のインテグレーション ユーザーに承認リクエスト メールを送信できます。メールには、ユーザーがリクエストを手動で承認または拒否できるインテグレーションへのリンクが含まれます。

インテグレーションの実行時、コントロールが承認タスクに到達すると、実行は一時停止され、承認タスクより後のすべてのタスクが一時停止されます。ユーザーが手動で承認リクエストを承認または拒否した場合にのみ、インテグレーションは実行を再開します。

承認タスクは、次の目的で使用できます。

  • ユーザーの承認または拒否に基づいてインレグレーションを一時停止し、分岐させる。
  • 指定した期間までインテグレーションを一時停止する。
  • インテグレーションをデバッグするためにブレークポイントとして使用する。

承認タスク、一時停止タスク、タイマータスクを比較する

3 つのタスク(承認一時停止タイマー)はすべてインテグレーションの一時停止と再開と同様の機能を実行します。ただし、それらにはわずかな違いがあります。次の表に、3 つのタスクの違いを示します。

承認タスク 一時停止タスク タイマータスク
インテグレーションの自動再開はサポートされていません。インテグレーションを再開するには手動での操作が必要です。 インテグレーションの手動再開と自動再開の両方をサポートしています。一時停止を取り消すための手動操作がない場合、インテグレーションは一時停止期限の経過後に実行を自動的に再開します。 インテグレーションの自動再開のみをサポートしています。インテグレーションの実行は、一時停止の期限を経過すると自動的に再開されます。
API 呼び出しではインテグレーションを再開できません。インテグレーション UI を使用して手動で一時停止を解決する必要があります。 インテグレーション用の Suspensions API を使用してインテグレーションを再開できます。 インテグレーションの自動再開のみをサポートしています。
インテグレーションが停止(一時停止)すると、ユーザーが通知を受け取ります。 インテグレーションが停止(一時停止)しても、ユーザーは通知を受け取りません。 インテグレーションが停止(一時停止)しても、ユーザーは通知を受け取りません。
出力変数(ブール値)がサポートされます。これにより、インテグレーションを再開する前に条件付きチェックを実行できます。ただし、出力変数の値は true または false のいずれかに限られます。 出力変数(文字列)がサポートされます。これにより、インテグレーションを再開する前に条件付きチェックを実行できます。出力変数には任意の値を設定できます。 出力変数はサポートしていません。

承認タスクを構成する

承認タスクを構成するには:

  1. Apigee UI で、Apigee 組織を選択します。
  2. [Develop] > [Integrations] の順にクリックします。
  3. 既存のインテグレーションを選択するか、[Create Integration] をクリックして新しいインテグレーションを作成します。

    新しいインテグレーションを作成する場合:

    1. [Create Integration] ダイアログで名前と説明を入力します。
    2. サポートされているリージョンのリストから、インテグレーションのリージョンを選択します。
    3. [Create] をクリックします。

    インテグレーション デザイナーでインテグレーションが開きます。

  4. インテグレーション デザイナーのナビゲーション バーで、[+ Add a task/trigger] > [Tasks] の順にクリックして、使用可能なタスクのリストを表示します。
  5. 統合エディタで [承認] タスク要素をクリックして配置します。
  6. デザイナーの [承認] タスク要素をクリックして、承認タスク構成ペインを開きます。
  7. 次の表に示すように、表示された項目はタスクの構成プロパティを使用して設定します。

    プロパティへの変更は自動的に保存されます。

構成プロパティ

次の表は、承認タスクの構成プロパティを示しています。

プロパティ データ型 説明
Recipients 文字列配列 タスクが一時停止されたときに送信されるメールアドレス。複数のメールアドレスはカンマで区切って入力します。
Custom notification message 文字列 タスクが一時停止されたときにメール通知に含めるカスタム メッセージ。値は、リテラル値または変数です。変数にカスタム メッセージを利用できる場合は、VAR をクリックして、変数を選択します。
Reminder frequency (in minutes) 整数 リマインダー通知の頻度。

一時停止状態が解消されていない場合は、承認されたユーザーに解決を依頼するリマインダー通知を送信できます。

Time until expiration (in minutes) 整数 一時停止の期間。

時間内に一時停止が解決されない場合、デフォルトでは一時停止が拒否されます。

On expiration ブール値 一時停止期間の終了後に実行される操作です。

一時停止を拒否するか、一時停止を解除するかを選択できます。デフォルトでは、一時停止は拒否されます。

isApproved (Approval) ブール値 解決後の一時停止のステータスを持つ出力変数。

一時停止が承認された場合、isApproved 変数は True に設定され、一時停止が拒否された場合は False に設定されます。

エラー処理方式

タスクのエラー処理方法では、一時的なエラーによってタスクが失敗した場合のアクションを指定します。エラー処理方式と、さまざまな種類のエラー処理方式の詳細については、エラー処理方法をご覧ください。