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

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

    • API キーを使用して ServiceNow インスタンスと First Advantage アカウントをデータ連携し、ServiceNow 要求を認証します。

    始める前に

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

    First Advantage スポーク の認証情報レコードの作成

    First Advantage スポーク の資格情報レコードを作成します。 First Advantage スポーク 接続および資格情報エイリアスでは、これらの資格情報を使用してアクションを許可します。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > 接続 & 認証情報 > 資格情報.
    2. [新規] をクリックします。
      「作成する資格情報のタイプは？」というメッセージが表示されます。
    3. [API キー資格情報] を選択します。
      空の API キー資格情報フォームが表示されます。
    4. 値を入力します。
      フィールド 必要な値
      名前 レコードを一意に識別する名前を入力します。たとえば、「FADV 資格情報」と入力します。
      有効 資格情報レコードを積極的に使用するオプションです。
      API キー First Advantage インスタンスから生成された API キー。
      注:
      API キーを取得するには、First Advantage チームにお問い合わせください。
      順番 この認証情報を適用する順番を選択します。たとえば、「100」と入力します。
    5. [送信] をクリックします。

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

    接続レコードを First Advantage API に作成します。 First Advantage スポーク接続および資格情報エイリアスでは、これらの接続を使用して First Advantage でアクションを実行します。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > 接続 & 認証情報 > 接続 & 資格情報エイリアス.
    2. First Advantage レコードを開きます。
    3. [接続] タブで、[新規] をクリックします。
      空の HTTP(s) 接続フォームが表示されます。
    4. 値を入力します。
      フィールド 必要な値
      名前 接続レコードを一意に識別する名前。たとえば、「FADV 接続」と入力します。
      資格情報 First Advantage のために作成された資格情報レコード。たとえば、[FADV 資格情報] を選択します。
      接続 URL First Advantage 接続 URL。「hhttps://rest-ua.fadv.com」と入力します。
    5. [属性] タブで、次の値を入力します。
      フィールド 説明
      配布メール 組織の配布メール。
      u_version v1.1
      注:
      First Advantage の別のバージョンを使用している場合は、バージョン番号を指定します。
    6. [Submit (送信)] をクリックします。
    7. 移動先 接続 & 認証情報 > 接続 & 資格情報エイリアス.
    8. First Advantage レコードを開きます。
    9. [接続属性] タブをクリックします。
    10. 必要に応じて、接続属性レコードのデフォルト値を変更します。
      接続属性レコード デフォルト値
      配布メール 組織の配布メール。
      バージョン v1.1
      注:
      First Advantage の別のバージョンを使用している場合は、バージョン番号を指定します。

    ServiceNow インスタンスでの First Advantage ステータスの作成

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

    始める前に

    必要なロール：admin

    ドラフト、準備完了、および処理中のステータスの作成

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

    始める前に

    必要なロール：admin

    手順

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

    タスクの結果

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

    完了ステータスとキャンセルステータスの作成

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

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > First Advantage スポーク > 注文タスク.
    2. [新規] をクリックします。
      注:
      レコードが 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. 移動先 すべて > First Advantage スポーク > 従業員タスク.
    2. [新規] をクリックします。
      注:
      レコードが 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 でエンコードされたキーなどです。
    • 必要なロール：管理者

    手順

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

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

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

    始める前に

    必要なロール：管理者

    手順

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

    タスクの結果

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