ServiceNow コネクタ V1.0

ServiceNow は、IT サービス、チケットシステム、サポートなど、組織レベルのワークフローを作成および管理するためのクラウドベースのサービス管理システムを提供します。 Amazon Kendra を使用して、ServiceNow カタログ、ナレッジ記事、それらの添付ファイルのインデックスを作成できます。

注記

ServiceNow コネクタ V1.0 / ServiceNowConfiguration API は 2023 年に終了しました。ServiceNow コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。

Amazon Kendra ServiceNow データソースコネクタのトラブルシューティングについては、「」を参照してくださいデータソースのトラブルシューティング。

サポートされている機能

Amazon Kendra ServiceNow データソースコネクタは、次の機能をサポートしています。

• ServiceNow インスタンスバージョン: London、その他

• 包含/除外パターン: サービスカタログ、ナレッジ記事、およびその添付ファイル

前提条件

Amazon Kendra を使用して ServiceNow データソースのインデックスを作成する前に、ServiceNow と AWS アカウントでこれらの変更を行ってください。

ServiceNow で、次のものがあることを確認してください。

• ServiceNow 管理者アカウントを作成し、ServiceNow インスタンスを作成しました。

• ServiceNow インスタンス URL のホストをコピーしました。例えば、インスタンスの URL が https://your-domain.service-now.com の場合、入力するホスト URL の形式は your-domain.service-now.com です。

• ServiceNow インスタンスへの Amazon Kendra の接続を許可するユーザー名とパスワードを含む基本認証情報を記録しました。

  注記

  認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。

• オプション： ユーザー名、パスワード、クライアント ID、クライアントシークレットを識別 Amazon Kendra して生成できる OAuth 2.0 認証情報トークンを設定しました。ユーザー名とパスワードは、ServiceNow ナレッジベースとサービスカタログへのアクセスを提供する必要があります。詳細については、OAuth 2.0 認証に関する ServiceNow のドキュメントを参照してください。

• 以下のアクセス許可を追加しました。

  • kb_category

  • kb_knowledge

  • kb_knowledge_base

  • kb_uc_cannot_read_mtom

  • kb_uc_can_read_mtom

  • sc_catalog

  • sc_category

  • sc_cat_item

  • sys_attachment

  • sys_attachment_doc

  • sys_user_role

• ServiceNow で、また同じインデックスに使用する予定の他のデータソースでも、各ドキュメントが一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。

で AWS アカウント、以下があることを確認します。

• Amazon Kendra インデックスを作成し、 API を使用している場合はインデックス ID を記録しました。

• データソースの IAM ロールを作成し、 API を使用している場合は、 IAM ロールの ARN を記録しました。

  注記

  認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。

• ServiceNow の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済みです。

  注記

  認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。

既存の IAM ロールまたはシークレットがない場合は、ServiceNow データソースを接続するときに コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。

接続手順

ServiceNow データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように、ServiceNow データソースの必要な詳細を指定する必要があります。ServiceNow をまだ設定していない場合は、 Amazon Kendra 「」を参照してください前提条件。

Console

ServiceNow Amazon Kendra に接続するには

1. AWS マネジメントコンソールにサインインし、Amazon Kendra コンソールを開きます。

2. 左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

   注記

   [インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。

3. [使用開始] ページで、[データソースを追加] を選択します。

4. [データソースを追加する] ページで [ServiceNow コネクタ V1.0] を選択し、[データソースを追加する] を選択します。

5. [データソースの詳細を指定] ページで、次の情報を入力します。

   1. [名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。

   2. (オプション) [説明] - オプションで、データソースの説明を入力します。

   3. デフォルト言語 - インデックスのドキュメントをフィルタリングする言語を選択します。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。

   4. タグで、新しいタグを追加する - リソースを検索およびフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。

   5. [Next (次へ)] を選択します。

6. [アクセスとセキュリティの定義] ページで、次の情報を入力します。

   1. ServiceNow ホスト - ServiceNow ホスト URL を入力します。

   2. ServiceNow バージョン - ServiceNow バージョンを選択します。

   3. ユースケースに基づいて、[基本認証] と [Oauth 2.0 認証] のどちらかを選択します。

   4. AWS Secrets Manager secret - 既存のシークレットを選択するか、ServiceNow 認証情報を保存する新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。

      1. [シークレット名] - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-ServiceNow-」が自動的に追加されます。

      2. 基本認証を使用している場合-ServiceNow アカウントの [シークレット名]、[ユーザー名]、[パスワード] を入力します。

         OAuth2 認証を使用する場合 - ServiceNow アカウントで作成した [シークレット名]、[ユーザー名]、[パスワード]、[クライアント ID]、[クライアントシークレット] を入力します。

      3. [シークレットを保存して追加する] を選択します。

   5. IAM role - 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。

      注記

      IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。

   6. [Next (次へ)] を選択します。

7. [同期設定の構成] ページで、次の情報を入力します。

   1. [ナレッジ記事を含める] - ナレッジ記事にインデックスを作成することを選択します。

   2. [ナレッジ記事のタイプ] - ユースケースに基づいて、[パブリック記事のみを含める] または [ServiceNow フィルタークエリに基づいて記事を含める] を選択します。[ServiceNow フィルタークエリに基づいて記事を含める] を選択した場合は、ServiceNow アカウントからコピーした [フィルタークエリ] を入力する必要があります。

   3. [ナレッジ記事の添付ファイルを含める] - ナレッジ記事の添付ファイルにインデックスを作成することを選択します。特定のファイルタイプを選択してインデックスを作成することもできます。

   4. [カタログ項目を含める] - カタログ項目のインデックスを作成することを選択します。

   5. [カタログ項目の添付ファイルを含める] - カタログ項目の添付ファイルのインデックスを作成することを選択します。特定のファイルタイプを選択してインデックスを作成することもできます。

   6. 頻度 — Amazon Kendra がデータソースと同期する頻度。

   7. [Next (次へ)] を選択します。

8. [フィールドマッピングを設定] ページで、次の情報を入力します。

   1. ナレッジ記事とサービスカタログ — Amazon Kendra 生成されたデフォルトのデータソースフィールドと、インデックスにマッピングする追加の推奨フィールドマッピングから選択します。

   2. [フィールドを追加] - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。

   3. [Next (次へ)] を選択します。

9. [確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

ServiceNow Amazon Kendra に接続するには

ServiceNowConfiguration API を使用して以下を指定する必要があります。

• データソース URL - ServiceNow URL を指定します。ホストエンドポイントは、your-domain.service-now.com のようになります。

• データソースホストインスタンス - ServiceNow ホストインスタンスのバージョンを LONDON または OTHERS として指定します。

• シークレット Amazon リソースネーム (ARN) — ServiceNow アカウントで作成した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。

  基本認証を使用している場合、シークレットは以下のキーを持つ JSON 構造に保存されます。

  {
      "username": "user name",
      "password": "password"
  }

  OAuth 2.0 認証を使用している場合、シークレットは以下のキーを持つ JSON 構造に保存されます。

  {
      "username": "user name",
      "password": "password",
      "clientId": "client id",
      "clientSecret": "client secret"
  }

• IAM role - を呼び出しCreateDataSourceて IAM ロールに Secrets Manager シークレットへのアクセス許可を付与し、ServiceNow コネクタと に必要なパブリック APIs を呼び出すRoleArnタイミングを指定します Amazon Kendra。詳細については、「IAM roles for ServiceNow data sources」を参照してください。

オプションで、次の機能を追加することもできます。

• フィールドマッピング - 選択すると、ServiceNow データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「データソースフィールドのマッピング」を参照してください。

  注記

  がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 にマッピングする必要があります_document_body。その他のすべてのフィールドはオプションです。

• 包含フィルターと除外フィルター - カタログとナレッジ記事の特定の添付ファイルを含めるか除外するかを指定します。

  注記

  ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。

• インデックスパラメータ - 次のことを行うかどうかも指定できます。

  • ナレッジ記事とサービスカタログ、またはその両方にインデックスを作成します。ナレッジ記事とサービスカタログ項目のインデックスを作成する場合は、 Amazon Kendra インデックスのインデックスドキュメントコンテンツフィールドにマッピングする ServiceNow フィールドの名前を指定する必要があります。

  • ナレッジ記事とカタログ項目へのインデックス添付ファイル。

  • 1 つ以上のナレッジベースからドキュメントを選択する ServiceNow クエリを使用します。ナレッジベースは、パブリックまたはプライベートのいずれかです。詳細については、クエリでインデックス作成するドキュメントを指定するを参照してください。

詳細

ServiceNow データソース Amazon Kendra との統合の詳細については、以下を参照してください。

• Amazon Kendra ServiceNow Online コネクタの開始方法