Webhook イベントを構成する

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む5読むのに数分

    • プロバイダー構成テーブルで Webhook API イベントを構成し、バッジベンダーが Webhook イベントを使用してバッジテーブルから収集したバッジデータを共有できるようにします。

    始める前に

    必要なロール：admin

    このタスクについて

    バッジデータ (JSON) は、ServiceNow REST API エクスプローラーを使用して処理されます。単一または複数の生のバッジデータレコード (ペイロード) は、REST API エクスプローラーを使用して共有および処理できます。バッジデータの Webhook イベントは、単一または複数の JSON レコードでコネクタイベントテーブルにロードされます。複数のレコードがアレイとして送信されます。詳細については、「出席分析」を参照してください。

    手順

    1. 移動先 すべて > 職場ハードウェア関連コネクタ > プロバイダー構成.
    2. [新規作成] を選択します。

      フォームのフィールドに入力します。

      表 : 1. プロバイダー構成フォーム
      フィールド 説明
      名前 プロバイダー構成の名前
      ソースタイプ バッジデータが収集され、ターゲットの従業員出席テーブルにロードされるソース。

      [Webhook] を選択して Webhook イベントを構成します。
      トークンパラメーター名

      [トークンパラメーター名] と [トークン] の値は秘密キーと値のペアで、ベンダーバッジシステムからアプリケーションへの ワークプレイスコネクタ API 呼び出しを認証するために使用されます。どちらのシステムにもトークン名の値があります。トークン名を使用して、アプリケーションは API 要求を認証します。
      トークン値 トークン値は、サーバーに API 要求を認証させるために API イベントの呼び出し中にバッジベンダーが使用する秘密キーです。
      アクティブ プロバイダー構成がアクティブであることを示すオプション。
      コネクタ構成 ルックアップリストアイコン (ルックアップ リストアイコン) を検索して選択し、 バッジを選択するオプション。

      詳細については、「スポークコネクタの構成」を参照してください。
      コールバック URL コールバック URL アイコン (コールバック URL アイコン) を選択して、コールバック URLをロックまたは編集するオプション。
    3. [更新] を選択します。
    4. 新しく作成された Webhook イベントを選択します。

      [コールバック URL を生成] ボタンは、REST API 要求のコールバック URL を生成するために使用できます。

      [コールバック URL を生成] ボタンがある Webhook イベントを表示するプロバイダー構成。

    5. バッジベンダーは、次の場所に移動してバッジデータを JSON 形式で共有します。 すべて > システム Web サービス > REST > REST API Explorer.
    6. [REST API エクスプローラー] ページで、次を選択します。
      • 名前空間: ドロップダウン リストから [sn_wsd_wc] を選択します
      • API 名：Workplace Connector Webhook
      • API バージョン：v1
    7. [職場ハードウェア関連コネクタ Webhook] イベントページで、次の値を指定します。
      • token_name：ステップ 2 で使用するトークンパラメーター名。トークン名の値は、バッジベンダーがバッジデータ(JSON) を ワークプレイスコネクタ と共有するために使用されます。生データ (ペイロードまたはバッジデータ) が処理され、コネクタイベントテーブルにロードされます。
      • ni.nolog.id:ステップ 2 で作成したウェブフックのシステム ID をコピーして貼り付けます。ペインから [他のアクション] メニューアイコン ([他のアクション] メニューアイコン) を選択します。
      • token_value：ステップ 2 で提供されたトークン値。トークン値は、サーバーに API 要求を認証させるために API イベントの呼び出し中にバッジベンダーが使用する秘密キーです。
      1. API 要求本文で [ 生] を選択し、バッジデータ (ペイロード) を JSON 形式でコピーします。
        このバッジデータは、バッジセンサーから収集されます。
      2. [送信] を選択します。
        応答コードが [200 OK] で、応答結果が [成功] の場合、バッジデータはコネクタイベントテーブルにロードされます。
        • コネクタイベントテーブル (sn_wsd_wc_connector_events) は、バッジベンダーによって共有されるバッジデータをロードします。REST API エクスプローラーによってロードされたときのバッジデータのステータスは [ 新規 ] です。
        • ジョブスケジュール プロセス Webhook プロバイダーデータレコード は毎分実行され、コネクタイベントテーブルからバッジデータ (ステータスが [新規] のデータ) から従業員参加データテーブルにロードされます。
      ジョブスケジュールは、 Webhook イベントからソースデータを取得し、そのデータを必要な形式に変換してから、ターゲットの [従業員参加データ] テーブルに入力します。
      注:
      スケジュール設定済みジョブにアクセスするには ワークプレイスコネクタ 、次の場所に移動します。 すべて > システム定義 > スケジュール済みジョブ. [アプリケーション] 列で Workplace コネクタ を検索します。では ワークプレイスコネクタ2 つのジョブスケジュールを使用できます。
      • プロセスプロバイダーデータレコード:ベンダーバッジデータ (ソーステーブル) からデータを読み取ります。バッジデータを処理した後、レコードはそれを従業員参加データテーブル (ターゲットテーブル) にロードします。詳細については、「バッジテーブルデータの構成」を参照してください。
      • Webhook プロバイダーデータレコードを処理:コネクタイベントテーブルからデータを読み取ります。Webhook イベントデータを処理し、[従業員出席データ] テーブル (ターゲットテーブル) にロードします。
      • データは [従業員出席データ] テーブルにロードされます。[コネクタイベント] テーブルのバッジデータのステータスが [処理済み] に変わります。
      • [従業員出席データ] テーブルから、データが出席分析テーブルにロードされます。
        注:
        ステータスが [処理済み] のコネクタイベントテーブル内のバッジデータレコードは、作成日または現在の日付から 2 日後にコネクタイベントテーブル [sn_wsd_wc_connector_events] によって消去されます。エラー状態のデータは、作成日から 7 日後に消去されます。[新規] ステータスのデータは消去されません。