ガイド付きセットアップを使用して Apigee X の API サービスグラフコネクタ を構成します

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:14分
  • Apigee X データを CMDB にプルするようにスケジュール済みインポートジョブを設定します。

    始める前に

    重要:
    ガイド付きセットアップ方法は廃止されるため、問題がない限り、 SGC セントラル ビューを使用してください。ガイド付きセットアップを使用して接続を構成すると、接続が SGC セントラル ビューに表示されないことがあります。
    依存関係と要件:
    • 自動的にインストールされる CMDB 共通統合ストアアプリ。「Integration Commons for CMDB」を参照してください。
    • 自動的にインストールされる CMDB CI クラスモデルストアアプリ。「CMDB CI クラスモデル」を参照してください。
    • ITOM ディスカバリーライセンスプラグイン (com.snc.itom.discovery.license)。このプラグインを有効にする必要があります。
    • ITOM Licensing プラグイン (com.snc.itom.license)。「Request Discovery」を参照してください。

    必要なロール:admin

    手順

    1. アプリケーションピッカーを使用して、アプリケーションスコープを Apigee X の API サービスグラフコネクタ アプリケーションに設定します。
      詳細については、「アプリケーションピッカー」を参照してください。
    2. 次のように移動する。 All (すべて) > Service Graph Connector > Apigee X > セットアップ.
    3. [ Apigee X の API サービスグラフコネクタ ] ページで、[ 続行] を選択します。
    4. Apigee X アプリケーションに要求を送信するための認証情報を構成します。
      1. [Apigee X の API サービスグラフコネクタ] ページの [接続と認証情報の構成] セクションで、[開始] を選択します。
      2. 添付ファイルの更新権限を付与して、SGA Apigee X フロントエンドバックエンドデータソースが Apigee X からファイルを取得してレコードに添付できるようにします。
        1. [ 添付ファイルのアクセスを更新 ] タスクを選択します。
        2. アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        3. [添付ファイル] サブページの [アプリケーションのアクセス] 関連リストで、[ 更新可能 ] チェックボックスをオンにして、[ 更新] を選択します。
        4. アプリケーションピッカーから Apigee X の API サービスグラフコネクタ アプリケーションスコープを選択します。
        5. [完了としてマーク] チェックボックスをオンにして [添付ファイルアクセスの更新] タスクを完了に設定し、[続行] を選択します。
      3. Apigee X環境を設定し、Java KeyStore (JKS) 証明書を作成して、Apigee X アプリケーションから取得したセキュリティ証明書を暗号化します。
        1. [Apigee X セットアップ手順] タスクを選択します。
        2. Now Supportナレッジベースの記事「API Service Graph connector for Apigee X - Setup Instructions (Apigee X の API サービスグラフコネクタ - セットアップ手順) [KBB0010364]」でセットアップ手順を確認して完了します。

          宛先キーストアのパスワードをメモします。このパスワードは、JKS 証明書を Apigee X の API サービスグラフコネクタ アプリケーションにインポートするときに指定する必要があります。

        3. [完了としてマーク] チェックボックスをオンにして [Apigee X セットアップ手順] タスクを完了に設定し、[続行] を選択します。
      4. X.509 証明書を作成して、 Apigee X アプリケーションの Java KeyStore (JKS) 証明書をコネクタに関連付けます。
        1. [X.509 証明書を作成] タスクを選択します。
        2. [New (新規)] を選択します。
        3. フォームのフィールドに入力します。
          表 : 1. [X.509 証明書] フォーム
          フィールド 説明
          名前 X.509 証明書の名前。例:SGA-ApigeeX-509Certificate
          期限切れ時に通知 証明書の有効期限が切れたときに通知するユーザー。ユーザーが選択されていない場合、ログインしているユーザーは、アドミニストレーターロールを持つ最後にログインした 2 人のユーザーとともにデフォルトで追加されます。
          有効期限切れ前に警告 証明書の有効期限が切れる前に通知を送信する日数。
          アクティブ 証明書をアクティブ化するオプションです。
          タイプ 自動的に Java Key Store に設定される証明書コンテナ。フィールドの値は [Java Key Store] に設定したままにします。
          期限切れまでの日数 証明書の有効期限が切れるまでの日数。
          キーストアパスワード 前のステップでメモした JKS 証明書にアクセスするためのパスワード。
          簡単な説明 X.509 証明書の説明。
        4. [添付ファイルを管理] アイコン ([添付ファイルを管理] アイコン) を選択します。
        5. [ファイルを選択] を選択して、ステップ 4.c で作成した JKS 証明書の keystore.p12 ファイルを参照してアップロードします。
        6. ダイアログボックスを閉じます。
        7. [ストア/証明書を検証] 関連リンクを選択します。
        8. 検証に成功したら、[更新] を選択してガイド付きセットアップページに戻ります。
        9. [完了としてマーク] チェックボックスをオンにして、[X.509 証明書を作成] タスクを完了に設定し、[続行] を選択します。
      5. 接続を構成します。
        1. アプリケーションピッカーを使用して、アプリケーションスコープを Apigee X の API サービスグラフコネクタ アプリケーションに設定します。
        2. [接続の構成] タスクを選択します。
        3. [ ここをクリック ] を選択して、別のブラウザタブで [接続] ページを開きます。
        4. [SGA Apigee X 接続の編集] を検索して選択します。
        5. [接続を編集 (Edit Connection)] ウィンドウの [接続情報 (Connection Information)] セクションで、フィールドに入力します。
          表 : 2. 接続情報
          フィールド 説明
          接続名 Apigee X接続レコードを識別する名前です。

          SGA Apigee X 接続 がデフォルトの認証情報エイリアス名です。複数の Apigee X インスタンスを追加できます。ただし、デフォルトの接続名は変更しないようにしてください。

        6. [接続を編集 (Edit Connection)] ウィンドウの [認証情報 (Credential Information)] セクションで、フィールドに入力します。
          表 : 3. 認証情報
          フィールド 説明
          サービスアカウントメール 「事前準備」セクションに記載されているとおり、Apigee X による認証に使用される ServiceNow サービスアカウントに関連付けられたメールアドレス。
          X.509 証明書 ステップ 4.d で作成された X.509 証明書。
          キーストアパスワード 「事前準備」セクションに記載されている、キーストアに関連付けられたパスワード。
        7. [OAuth トークンを編集して取得] を選択します。
        8. [Update (更新)] を選択します。
        9. OAuth トークンフローが正常に完了したら、ガイド付きセットアップページに戻り、[完了としてマーク] チェックボックスをオンにして [接続の構成] タスクを完了に設定し、[続行] を選択します。
      6. リソースにアクセスするためのコネクタのプロパティを設定します。
        1. [構成プロパティを追加] タスクを選択します。
        2. [サービスグラフ接続のプロパティ] 関連リストで、プロパティの値を入力します。
          表 : 4. サービスグラフ接続のプロパティ
          プロパティ 説明
          CollectionPeriod(日数) API 使用状況データを収集する期間 (日数)。
          使用状況データの収集 指定した期間の API 使用状況データを取得するには、使用状況データ収集を有効にします。
          ディスカバリースコープ Apigee X アプリケーションのディスカバリースコープ。使用可能なオプションは、次のとおりです。
          [組織]
          ServiceNow サービスアカウントが Apigee X 組織内のデータにアクセスできる場合は、[組織] を選択します。
          [プロジェクト]
          ServiceNow サービスアカウントが Apigee X プロジェクト内のデータにのみアクセスできる場合は、[プロジェクト] を選択します。
          環境を除外 Apigee X 接続から除外する必要がある環境。

          複数の環境の場合は、カンマで区切ります。Exclude Environments プロパティにリストされているものを除くすべてのゲートウェイがフェッチされます。

          組織 ID プロジェクトが属する Apigee X システム内の組織。
          ページサイズ ページあたりのレコードの数。デフォルトは 100、最小値は 2 です。
          パーティションサイズ 並列ロードが有効になっている場合の Apigee X マネージド API のパーティションサイズ。

          0 より大きい数値を受け入れます。空のままにすると、値が自動的に計算されます。

          プロジェクト ID 接続がリンクされる Apigee X 環境内のプロジェクト識別子。

          プロジェクト ID が複数ある場合は、カンマで区切ります。

          ヒント:
          プロパティ値を入力するには、ダブルクリック (またはキーボードショートカットを使用) して、プロパティの [値] セルに値を入力します。
        3. [完了としてマーク] チェックボックスをオンにして [構成プロパティの追加] タスクを完了に設定し、[続行] を選択します。
      7. 接続をテストします。
        1. [テスト接続] タスクを選択します。
        2. [テスト接続] 関連リンクを選択して、接続をテストします。

          接続のテストには少し時間がかかる場合があります。ページが更新され、テスト結果が表示されます。

        3. [ステータス] フィールドが [成功] に設定されている場合は、[更新] を選択します。

          いずれかのテストでエラーが発生した場合は、修正の提案に従ってください。

        4. [完了としてマーク] チェックボックスをオンにして、[テスト接続] タスクを完了に設定し、[続行] を選択します。
    5. オプション: 複数の Apigee X インスタンスと統合します。
      1. [Apigee X の API サービスグラフコネクタ] ページの [複数のインスタンスを追加] セクションで [開始] を選択します。
      2. 新しい Apigee X接続のデータソースの作成を有効にします。
        1. データソース [sys_data_source] テーブルの編集権限があることを確認します。
        2. [データソースアクセスを更新] タスクを選択します。
        3. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        4. 別のタブで表示される [データソース] フォームの [アプリケーションのアクセス] 関連リストで、[作成可能][更新可能]、および [削除可能] チェックボックスをオンにします。
        5. [Update (更新)] を選択します。
        6. アプリケーションピッカーから、Apigee X の API サービスグラフコネクタアプリケーションスコープを選択します。
        7. [完了としてマーク] チェックボックスをオンにして、[データソースアクセスを更新] タスクを完了に設定し、[続行] を選択します。
      3. 新しい Apigee X接続のスケジュール済みインポートジョブの作成を有効にします。
        1. 予定されているデータインポート [scheduled_import_set] テーブルの編集権限があることを確認してください。
        2. [予定されているデータインポートアクセスを更新] タスクを選択します。
        3. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        4. [予定されているデータインポート] フォームの [アプリケーションのアクセス] 関連リストで、[作成可能][更新可能]、および [削除可能] チェックボックスをオンにします。
        5. [更新] を選択します。
        6. アプリケーションピッカーから、Apigee X の API サービスグラフコネクタアプリケーションスコープを選択します。
        7. [完了としてマーク (Mark as complete)] チェックボックスをオンにして、[予定されているデータインポートアクセスを更新] タスクを完了に設定し、[続行] を選択します。
      4. データソース [sys_data_source] テーブルと予定されているデータインポート [scheduled_import_set] テーブルのキャッシュをクリアします。
        1. [データソースおよび予定されているデータインポートテーブルのキャッシュをクリア] タスクを選択します。
        2. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        3. [スクリプトを実行] フィールドに次のコードを入力します。
          GlideTableManager.invalidateTable("sys_data_source");
          GlideCacheManager.flushTable("sys_data_source");
          GlideTableManager.invalidateTable("scheduled_import_set");
          GlideCacheManager.flushTable("scheduled_import_set");
          GlideTableManager.invalidateTable("sys_db_object");
          GlideCacheManager.flushTable("sys_db_object");     
          GlideTableManager.invalidateTable("sys_attachment");
          GlideCacheManager.flushTable("sys_attachment");
        4. [スクリプトを実行] を選択します。
        5. アプリケーションピッカーから、Apigee X の API サービスグラフコネクタアプリケーションスコープを選択します。
        6. [完了としてマーク] を選択して、[データソースおよび予定されているデータインポートテーブルのキャッシュをクリア] タスクを完了に設定します。
      5. 新しい Apigee X インスタンスの X.509 証明書を作成するには、手順 4.d を繰り返し、[完了としてマーク] を選択して [X.509 証明書の作成] タスクを完了としてマークします。
      6. 新しい Apigee X インスタンスに別の接続を追加します。
        1. アプリケーションピッカーを使用して、アプリケーションスコープを Apigee X の API サービスグラフコネクタ アプリケーションに設定します。
        2. [別の接続を追加] タスクを選択し、[ここをクリック] を選択します。
        3. 新しいブラウザタブで開かれた [接続] ページで、[接続を追加] を選択します。
        4. [接続を作成] ウィンドウで、接続、サービスアカウント、およびキーストアの詳細 (キーストアパスワードを含む) を入力します。

          ステップ 5.e でキーストアを作成しました。

        5. [OAuth トークンを作成して取得] を選択します。
        6. [接続] ページを閉じて、ガイド付きセットアップページタブに戻ります。
        7. [完了としてマーク] チェックボックスをオンにして、[別の接続を追加] タスクを完了に設定し、[続行] を選択します。
      7. 新しい接続のプロパティを追加します。
        1. アプリケーションピッカーを使用して、アプリケーションスコープを Apigee X の API サービスグラフコネクタ アプリケーションに設定します。
        2. [構成プロパティを追加] タスクを選択します。
        3. [名前] 列から、ステップ 5.f で作成した接続名を選択します。
        4. [サービスグラフ接続のプロパティ] 関連リストで、プロパティの値を入力します。

          プロパティの詳細については、「4.f.ii」を参照してください。

          ヒント:
          プロパティ値を入力するには、ダブルクリック (またはキーボードショートカットを使用) して、プロパティの [値] セルに値を入力します。
        5. [完了としてマーク] チェックボックスをオンにして [構成プロパティの追加] タスクを完了に設定し、[続行] を選択します。
      8. 新しい接続をテストします。
        1. [新しい接続をテスト] タスクを選択します。
        2. [名前] 列から、ステップ 5.f で作成した接続名を選択します。
        3. [テスト接続] 関連リンクを選択して、接続をテストします。

          接続のテストには少し時間がかかる場合があります。ページが更新され、テスト結果が表示されます。

        4. [ステータス] フィールドが [成功] に設定されている場合は、[更新] を選択します。

          いずれかのテストでエラーが発生した場合は、修正の提案に従ってください。

        5. [完了としてマーク] チェックボックスをオンにして、[新しい接続をテスト] タスクを完了に設定し、[続行] を選択します。
    6. Apigee X データをインポートするためのスケジュール済みジョブを構成します。
      1. [Apigee X の API サービスグラフコネクタ] ページの [スケジュール済みインポートジョブを設定 (Set up Scheduled Import Jobs)] セクションで、[開始] を選択します。
      2. 「SGA Apigee X 組織」スケジュール済みジョブを選択します。
        複数のインスタンスをセットアップする場合は、ステップ 5.f の接続で作成されたスケジュール済みインポートを選択します。
      3. [予定されているデータインポート] フォームで、フィールド値を確認します。

        詳細については、「Schedule a data import」を参照してください。

      4. [アクティブ] チェックボックスをオンにして、スケジュール済みジョブをアクティブ化します。
      5. [実行] フィールドで、[定期的] を選択して、ジョブの実行頻度を指定します。
      6. [更新] を選択します。
      7. [完了としてマーク] チェックボックスをオンにして、[スケジュール済みインポートジョブを設定 (Set up Scheduled Import Jobs)] タスクを完了に設定し、[続行] を選択します。
    7. Apigee X の API サービスグラフコネクタページで、[完了] を選択して変更を保存します。
    8. [セットアップの完了] ダイアログボックスで、[完了] を選択してセットアップを完了します。
    9. 表示されるメッセージボックスで、 [完了] を選択します。