ポーリング監視イベントフローを構築する

ポーリング監視イベントは、一定の間隔で自動的に実行され、前回の実行以降に変更されたレコードをAPIにクエリするように設計されています。仕組みは次のとおりです。

• 初期化と実行：ポーリング監視イベントがアクティブ化されると、APIを呼び出してレコードのコレクションを取得し、現在の時点をマークするためのカーソル（通常はタイムスタンプ）を設定します。後続の実行では、カーソルを使用してAPI呼び出しを変更し、前回の実行後に変更されたレコードのみを返すようにします。

• カーソル機能：カーソルは、反復する実行間でデータをフィルタリングするのに役立つ永続的なメタデータです。たとえば、各レコードにcreatedAtタイムスタンプが含まれている場合、カーソルは、前回記録されたカーソル値よりも後のタイムスタンプを持つレコードのみが処理されるようにします。各反復実行の後に、カーソルが最新の実行時間に更新します。

• ユースケース：ポーリング監視イベントは、リアルタイムWebhookをサポートしていないリモートサービスAPIに役立ちます。指定された時間範囲内のレコードをクエリすることで（startAtやendAtなどのパラメーターを使用して）、ユーザー作成などのイベントを定期的にチェックできます。

• 実際の応用例：Okta Workflowsでは、これらのイベントを使用して、レコードの作成、更新、削除などの新しいイベントをトリガーするコネクターのイベントカードを作成できます。ただし、カーソルには10 KBのデータ制限があり、更新または削除されたレコードに関する情報を保存できる量に影響する可能性があります。

全体として、ポーリング監視イベントは、スケジュールされたAPI呼び出しと永続カーソルを使用して最近の変更のみが処理されるようにすることで、新しいレコードと変更されたレコードを処理するための体系的なアプローチを提供します。

開始する前に

• Okta Workflowsにアクセスできるスーパー管理者である必要があります。

• コネクターをまだ作成していないときは、次の手順に従って作成します。

  • Okta Workflowsコンソールでコネクタービルダーコンソールのリンクを開きます。

  • コネクタービルダーで、+アイコンをクリックしてコネクターを作成します。新しいコネクターに一意の名前と有用な説明を付けます。

• コネクターに、「基本的なことからすぐに始める」セクションのタスクで基本的な基盤と認証要素があることを確認してください。

手順

1. コネクタービルダーでアイコンをクリックしてコネクターを作成します。名前を付け、必要に応じて説明を指定します。

2. 新しいコネクターの［Flows（フロー）］タブで、［+ New Flow（新規フロー）］をクリックしてフローを作成します。

3. ［Add Event（イベントを追加）］をクリックします。イベントの選択肢から、［Polling Monitor（ポーリング監視）］を選択します。

   カーソルおよび返答出力フロー制御関数カードがフローに自動的に追加されます。例にある初期状態を参照してください。

4. ［Add Options（オプションの追加）］をクリックして、ポーリング監視カードのオプションを宣言します。

5. ポーリング監視イベントフローによって返される出力グループとフィールドを構成するには、返答出力カードの［Add Outputs（出力の追加）］をクリックします。

   1. ポーリング監視イベントには常にアクティブな実行モードがあるため、［Enable run mode（実行モードを有効化）］トグルは自動的に有効になり、変更できません。「ポーリング監視の実行モードを有効化する」を参照してください。

   2. 出力ダイアログでは、ポーリング監視が返す出力値を指定できます。［Add group（グループの追加）］をクリックして出力グループを作成し、［Add Field（フィールドの追加）］をクリックしてグループに各フィールドを追加します。返答出力がオブジェクトである場合、グループはオブジェクト内の最上位のキーと値のペアを形成し、フィールドは第2レベルのキーと値のペアを形成します。

      

   3. ［Apply（適用）］をクリックして、返答出力カードへの変更を保存します。

6. ポーリング監視フローを構築する：

   1. 日付Now関数カードを追加して、endAtフィールドに新しい値を生成します。これは、APIクエリのフィルターとしてタイムスタンプを使用していることを前提としています。

   2. startAtおよびendAtクエリフィルターを使用して、HTTP呼び出しのクエリフィルターを構築します。ポーリング監視イベントカードの［Cursor（カーソル）］出力をstartAt日付の入力としてドラッグします。

      • カーソルがタイムスタンプではなくオブジェクトである場合は、オブジェクトGetカードを使用して、カーソルオブジェクトからタイムスタンプを取得します。

   3. フロー呼び出しカードを追加して、接続の既存のhttpHelperフローを実行し、リモートサービスのAPIを呼び出します。

      • 作成したクエリフィルターをフロー呼び出しカードの［query（クエリ）］フィールドの入力としてドラッグします。

      • ポーリング監視イベントカードの［Auth（認証）］フィールドで定義された接続を使用します。

   4. カーソルカードのプロパティー入力を使用して、新しいNow値を次回のスケジュールされた実行のカーソルとして保存します。これにより、元の［Cursor（カーソル）］値が上書きされます。

      • カーソルがタイムスタンプではなくオブジェクトである場合は、オブジェクトConstructカードを使用して、カーソルオブジェクト内のタイムスタンプを更新します。

      • さまざまなフローがポーリング監視を呼び出すことができるため、カーソル値はポーリング監視ではなく外部フローに保持されます。

   5. API呼び出しからのペイロード応答をオブジェクトのリストにフォーマットします。各オブジェクトには、グループの最上位レベルのキーと、グループフィールドの第2レベルのキーが含まれます。

   6. フォーマットされたAPI応答を返答出力カードの［List（リスト）］フィールドにマッピングします。

7. ［Save（保存）］をクリックし、フローに名前を付けます。

次の手順

フローのテスト

コネクターのデプロイ