First Advantage スポークのセットアップ

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:9分
  • API キーを使用して ServiceNow インスタンスと First Advantage アカウントをデータ連携し、ServiceNow 要求を認証します。

    始める前に

    • 統合ハブ サブスクリプションの要求。
    • First Advantage スポークを有効にします。
    • 必要なロール:admin

    First Advantage スポーク の接続レコードの作成

    接続レコードを作成して、 ServiceNow インスタンスと First Advantage サーバーを統合します。ServiceNowインスタンスは、この接続レコードを使用して First Advantage スポークアクションを実行します。

    始める前に

    必要なロール:admin。

    First Advantage サーバーから API キーを取得します。

    手順

    1. 次のように移動する。 All (すべて) > プロセス自動化 > Workflow Studio (ワークフロースタジオ).
    2. [統合] を選択します。
    3. [Connections (接続)] タブを選択します。
    4. [すべての接続を検索] フィールドに「 First Advantage」と入力します。
      [ 送信] タブが選択されていることを確認します。
    5. FirstAdvantage タイルで、 [詳細の表示] を選択します。
      FirstAdvantage エイリアスタイルの [詳細を表示] ボタン。
    6. [Configure] を選択します。
    7. フォームに入力します。
      表 : 1. First Advantage スポーク接続フォーム
      フィールド 説明
      接続名 接続の名前。最初のレコードのデフォルトの読み取り専用名は、接続エイリアスの名前と同じです。[ 接続を追加] をクリックして、接続レコードを作成するときに別の名前を指定できます。
      接続 URL First Advantage サーバーへの接続 URL を指定するオプション。URL は https://rest-ua.fadv.comです。
      配布メール 配布メール ID を指定するオプション。
      バージョン API のバージョンを提供するオプション。
      API キー First Advantage サーバーがアクセス要求を認証するために使用する API キーを入力するオプション。
      First Advantage 接続フォーム。
    8. [接続を設定] を選択します。
      接続レコードが構成されます。

    ServiceNow インスタンスでの First Advantage 状況の作成

    ServiceNow インスタンスの [状況] リストに表示する First Advantage 状況を作成します。

    始める前に

    必要なロール:admin

    ドラフト、準備完了、および処理中の状況の作成

    タスク [task] テーブルでドラフト、準備完了、および処理中の状況を作成します。

    始める前に

    必要なロール:admin

    手順

    1. フィルターナビゲーターで、「sys_choice.list」と入力します。
      選択 [sys_choice] テーブルのレコードが表示されます。
    2. [新規] をクリックします。
    3. フォームでこれらの値を入力し、ドラフト状況のレコードを 3 つ作成します。
      表 : 2. レコード 1:ドラフト状況
      フィールド
      テーブル タスク [task]
      要素 state
      ラベル ドラフト
      137
      注:
      • ここに記載されているとおりに、[値] フィールドに正確な数値を入力してください。これらの数値に変更がある場合、スポークフローはトリガーされません。
      • レコードがグローバルアプリケーションで作成されていることを確認します。
    4. [送信] をクリックします。
    5. 同様に、準備完了状況処理中状況のレコードを作成します。
      表 : 3. レコード 2:準備完了ステータス
      フィールド
      テーブル タスク [task]
      要素 state
      ラベル 準備完了
      173
      表 : 4. レコード 3:処理中ステータス
      フィールド
      テーブル タスク [task]
      要素 state
      ラベル 処理中
      181
      注:
      • ここに記載されているとおりに、[値] フィールドに正確な数値を入力してください。これらの数値に変更がある場合、スポークフローはトリガーされません。
      • レコードがグローバルアプリケーションで作成されていることを確認します。

    タスクの結果

    タスク [task] テーブルでドラフト、準備完了、および処理中の状況が作成されます。

    完了状況とキャンセル状況の作成

    First Advantage タスク [sn_fadv_spoke_first_adventage_task] テーブルに完了状況とキャンセル状況を作成します。

    始める前に

    必要なロール:admin。

    手順

    1. 次のように移動する。 All (すべて) > First Advantage スポーク > 注文タスク.
    2. [New] をクリックします。
      注:
      レコードが First Advantage アプリケーションで作成されていることを確認します。
    3. [ステータス] を右クリックし、[選択を設定] を選択します。
    4. [キャンセル] ステータスを作成するには、次の手順を実行します。
      1. [新しいアイテムのテキスト] に「キャンセル」と入力します。
      2. [数値] に「149」と入力します。
        注:
        ここに記載されているとおりに、[数値] フィールドに正確な数を入力してください。これらの数値に変更がある場合、スポークフローはトリガーされません。
      3. [追加] をクリックします。
      4. [保存] をクリックします。
    5. [完了] ステータスを作成するには、次の手順を実行します。
      1. [新しいアイテムのテキスト] に「完了」と入力します。
      2. [数値] に「127 」と入力します。
        注:
        ここに記載されているとおりに、[数値] フィールドに正確な数を入力してください。これらの数値に変更がある場合、スポークフローはトリガーされません。
      3. [追加] をクリックします。
      4. [保存] をクリックします。

    タスクの結果

    First Advantage タスク [sn_fadv_spoke_first_advantage_task] テーブルに完了状況とキャンセル状況が作成されます。

    完了:成功状況および完了:交渉決裂状況の作成

    First Advantage 従業員タスク [sn_fadv_spoke_first_advantage_employee_task_table] テーブルに完了:成功状況および完了:交渉決裂状況を作成します。

    始める前に

    必要なロール:admin。

    手順

    1. 次のように移動する。 All (すべて) > First Advantage スポーク > 従業員タスク.
    2. [New] をクリックします。
      注:
      レコードが First Advantage アプリケーションで作成されていることを確認します。
    3. [ステータス] を右クリックし、[選択を設定] を選択します。
    4. [キャンセル] ステータスを作成するには、次の手順を実行します。
      1. [新しいアイテムのテキスト] に「完了:成功」と入力します。
      2. [数値] に「161」と入力します。
        注:
        ここに記載されているとおりに、[数値] フィールドに正確な数を入力してください。これらの数値に変更がある場合、スポークフローはトリガーされません。
      3. [追加] をクリックします。
      4. [保存] をクリックします。
    5. [完了] ステータスを作成するには、次の手順を実行します。
      1. [新しいアイテムのテキスト] に「完了:交渉決裂」と入力します。
      2. [数値] に「117 」と入力します。
        注:
        ここに記載されているとおりに、[数値] フィールドに正確な数を入力してください。これらの数値に変更がある場合、スポークフローはトリガーされません。
      3. [追加] をクリックします。
      4. [保存] をクリックします。

    タスクの結果

    First Advantage 従業員タスク [sn_fadv_spoke_first_advantage_employee_task_table] テーブルに完了:成功状況および完了:交渉決裂状況が作成されます。

    First Advantage Webhook のセットアップ

    Webhook を設定して、ServiceNow インスタンスで招待および注文イベントの更新を受信します。

    始める前に

    必要なロール:admin

    ServiceNow インスタンスの署名キーの指定

    First Advantage Webhook クライアントにキーを指定して、First Advantage Webhook を設定します。

    始める前に

    • 要件に従って安全なキーを生成し、その値を記録します。たとえば、base64 でエンコードされたキーなどです。
    • 必要なロール:admin

    手順

    1. 次のように移動する。 All (すべて) > First Advantage スポーク > FADV Webhook クライアントの詳細.
    2. [New] をクリックします。
    3. フォームに、これらの値を入力します。
      フィールド 説明
      名前 レコードを一意に識別する名前を入力します。
      認証キー 要件に従って生成したキー。
    4. [送信] をクリックします。

    アクセス API エンドポイント

    招待イベントと注文イベントの API エンドポイントにアクセスし、必要な詳細を First Advantage と共有して Webhook を設定します。

    始める前に

    必要なロール:admin

    手順

    1. 次のように移動する。 All (すべて) > システム Web サービス > スクリプト済み REST APIs.
    2. First Advantage スポークのレコードを開きます (例:First Advantage Webhook)。
    3. [リソース] タブで、次を実行します。
      1. 招待イベントのレコードを開きます (例:招待ステータス)。
      2. [リソースパス] に入力されたパスをコピーして記録します (例:/api/sn_fadv_spoke/fadv/invite_status)。
      3. 注文イベントのレコードを開きます (例:注文ステータス)。
      4. [リソースパス] に入力されたパスをコピーして記録します (例:/api/sn_fadv_spoke/fadv/order_status)。

    次のタスク

    First Advantage に連絡して、ServiceNow インスタンスの Webhook を設定します。このために、次の詳細を First Advantage と共有します。
    • 次の形式のカスタムヘッダー:fadvKey <authorization-key>
      注:
      • カスタムヘッダーがこの形式のみであることを確認します。変更がある場合、スポークフローはトリガーされません。
      • 以前に指定したものと同じキーを指定します First Advantage スポーク > FADV Webhook クライアントの詳細.
      • ここでの説明と同じケースの fadvKey を使用します。
    • 次の形式の招待イベントの API エンドポイント:<ServiceNow-instance-URL>/api/sn_fadv_spoke/fadv/invite_status
    • 次の形式の注文イベントの API エンドポイント:<ServiceNow-instance-URL>/api/sn_fadv_spoke/fadv/order_status

    First Advantage アカウントおよびパッケージと ServiceNow との同期

    First Advantage アカウントとパッケージを ServiceNow と同期して、First Advantage アカウントとパッケージの詳細を保存します。

    始める前に

    必要なロール:First Advantage admin

    手順

    1. 次のように移動する。 All (すべて) > First Advantage スポーク > アカウント.
    2. [New] をクリックします。
    3. フォームに、次の値を入力します。
      表 : 5. アカウントフォーム
      フィールド 説明
      プライマリアカウント アカウントがプライマリアカウントであることを指定するオプション。チェックボックスをオンにします。
      アカウント ID プライマリアカウントの ID。
      アカウント名 プライマリアカウントの名前。
    4. [送信] をクリックします。
      プライマリアカウントが作成され、レコードが表示されます。
    5. 次のように移動する。 First Advantage スポーク > アカウント.
    6. [アカウントを取得] 関連リストをクリックします。
    7. 次のように移動する。 First Advantage スポーク > パッケージ.
    8. [パッケージの取得] 関連リンクをクリックします。

    タスクの結果

    First Advantage アカウントとパッケージの詳細が取得されます。
    注:
    FADV admin ロールを持つユーザーのみが、アカウントとパッケージの詳細を同期できます。FADV user ロールを持つユーザーは、取得した詳細のみを表示できます。