ServiceNow コネクタ V2.0

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

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

トピック

サポートされている機能
前提条件
接続手順
詳細はこちら

サポートされている機能

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

フィールドマッピング
ユーザーアクセスコントロール
包含/除外フィルター
完全および増分コンテンツ同期
ServiceNow インスタンスバージョン: Rome、Sandiego、Tokyo、その他
仮想プライベートクラウド (VPC)

前提条件

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

で ServiceNow、以下があることを確認します。

個人またはエンタープライズのデベロッパーインスタンスを作成し、 ServiceNow管理ロールを持つインスタンスを持つ。
ServiceNow インスタンス URL のホストをコピーしました。入力するホスト URL の形式は your-domain.service-now.com です。に接続するには、 ServiceNow インスタンス URL が必要です Amazon Kendra。
が ServiceNow インスタンス Amazon Kendra に接続できるように、ユーザー名とパスワードの基本的な認証情報を記録しました。

注記
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
オプション： ユーザー名、パスワード、生成されたクライアント ID、およびクライアントシークレット Amazon Kendra を使用してを識別できる OAuth 2.0 クライアント認証情報を設定しました。詳細についてはServiceNow 、OAuth 2.0 認証に関するドキュメントを参照してください。
各ドキュメントが 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 に接続するには、が ServiceNow データ Amazon Kendra にアクセスできるように、データソースの必要な詳細を指定する必要があります。をまだ設定していない場合は、 ServiceNow Amazon Kendra 「」を参照してください前提条件。

Console

Amazon Kendra に接続するには ServiceNow

にサインイン AWS Management Console し、Amazon Kendra コンソールを開きます。
左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

注記
[インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。
[使用開始] ページで、[データソースを追加] を選択します。
データソースの追加ページで、ServiceNow コネクタ を選択し、コネクタの追加 を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いたServiceNow コネクタを選択します。
[データソースの詳細を指定] ページで、次の情報を入力します。
1. [名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。
2. (オプション) [説明] - オプションで、データソースの説明を入力します。
3. デフォルト言語 - ドキュメントをフィルタリングしてインデックスを作成する言語を選択します。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。
4. タグで、新しいタグを追加 — リソースを検索およびフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。
5. [次へ] をクリックします。
[アクセスとセキュリティの定義] ページで、次の情報を入力します。
1. ServiceNow host — ホスト URL を入力します ServiceNow。入力するホスト URL の形式は your-domain.service-now.com です。
2. ServiceNow version — ServiceNow インスタンスのバージョンを選択します。ローマ、サンディーゴ、東京、その他から選択できます。
3. 承認 — ACL があり、アクセスコントロールに使用する場合は、ドキュメントのアクセスコントロールリスト (ACL) 情報をオンまたはオフにします。ACL は、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
4. 認証 — 基本認証と Oauth 2.0 認証のどちらかを選択します。
5. AWS Secrets Manager secret — 既存のシークレットを選択するか、新しい Secrets Manager シークレットを作成して ServiceNow 認証情報を保存します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。ウィンドウで、以下の情報を入力します。
  1. [シークレット名] - シークレットの名前。シークレット名には、プレフィックスAmazonKendra「-ServiceNow-」が自動的に追加されます。
  2. 基本認証を使用する場合 - アカウントのシークレット名 、ユーザー名 、パスワードを入力します。 ServiceNow
    
    OAuth2.0 認証を使用する場合 - ServiceNow アカウントで作成したシークレット名 、ユーザー名 、パスワード 、クライアント ID 、およびクライアントシークレットを入力します。
  3. シークレットを保存して追加します。
6. [仮想プライベートクラウド (VPC)] - VPC の使用を選択できます。選択する場合は、[サブネット] と [VPC セキュリティグループ] を追加する必要があります。
7. ID クローラー — Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendraの ID クローラーをオンにして、検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合、ID クローラーがオフになっていると、すべてのドキュメントをパブリックに検索できます。ドキュメントのアクセスコントロールを使用し、ID クローラーがオフになっている場合は、代わりに PutPrincipalMapping API を使用してユーザーコンテキストフィルタリング用のユーザーおよびグループのアクセス情報をアップロードできます。
8. IAM ロール — 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリ認証情報にアクセスし、コンテンツにインデックスを作成します。
  
  注記
  IAM インデックスに使用されるロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。
9. [次へ] をクリックします。
[同期設定の構成] ページで、次の情報を入力します。
1. [ナレッジ記事] の場合は、以下のオプションから選択してください。
  - [ナレッジ記事] - ナレッジ記事にインデックスを作成することを選択します。
  - [ナレッジ記事の添付ファイル] - ナレッジ記事の添付ファイルにインデックスを作成することを選択します。
  - ナレッジ記事のタイプ — ユースケースに基づいてフィルタークエリに基づいて、公開記事のみとナレッジ記事から選択します。 ServiceNow ServiceNow フィルタークエリに基づいて記事を含める を選択した場合は、アカウント ServiceNowからコピーされたフィルタークエリを入力する必要があります。フィルタークエリの例には、workflow_state=draft^EQ、kb_knowledge_base=dfc19531bf2021003f07e2c1ac0739ab^text ISNOTEMPTY^EQ、article_type=text^active=true^EQ などがあります。
    
    重要
    公開記事のみをクロールすることを選択した場合、はで公開アクセスロールが割り当てられたナレッジ記事のみを Amazon Kendra クロールします ServiceNow。
  - [簡単な説明フィルターに基づいて記事を含める] - 特定の記事を含めるか除外する正規表現パターンを指定します。
2. [サービスカタログ項目] の場合:
  - [サービスカタログ項目] - サービスカタログ項目のインデックスを作成することを選択します。
  - [サービスカタログ項目の添付ファイル] - サービスカタログ項目の添付ファイルのインデックスを作成することを選択します。
  - [アクティブなサービスカタログ項目] - アクティブなサービスカタログ項目のインデックスを作成することを選択します。
  - [非アクティブなサービスカタログ項目] - 非アクティブなサービスカタログ項目のインデックスを作成することを選択します。
  - フィルタークエリ — ServiceNow インスタンスで定義されたフィルターに基づいてサービスカタログ項目を含めるように選択します。フィルタークエリの例としては、short_descriptionLIKEAccess^category=2809952237b1300054b6a3549dbe5dd4^EQ、nameSTARTSWITHService^active=true^EQ などがあります。
  - [簡潔な説明フィルターに基づいてサービスカタログ項目を含める] - 特定のカタログ項目を含めるための正規表現パターンを指定します。
3. [インシデント] の場合:
  - [インシデント] - サービスインシデントのインデックスを作成することを選択します。
  - [インシデント添付ファイル] - インシデント添付ファイルのインデックスを作成することを選択します。
  - [アクティブなインシデント] - アクティブなインシデントのインデックスを作成することを選択します。
  - [非アクティブなインシデント] - 非アクティブなインシデントのインデックスを作成することを選択します。
  - [アクティブなインシデントタイプ] - ユースケースに応じて、[すべてのインシデント]、[未解決のインシデント]、[オープン - 未割り当てのインシデント]、[解決済みのインシデント] から選択します。
  - フィルタークエリ — ServiceNow インスタンスで定義されたフィルターに基づいてインシデントを含めるように選択します。フィルタークエリの例には、short_descriptionLIKETest^urgency=3^state=1^EQ、priority=2^category=software^EQ などがあります。
  - [簡単な説明フィルターに基づいてインシデントを含める] -特定のインシデントを含む正規表現パターンを指定します。
4. [追加の設定]:
  - [ACL 情報] - 選択したエンティティのアクセス制御リストがデフォルトで含まれます。アクセスコントロールリストを選択解除すると、そのカテゴリのファイルがすべて公開されます。選択されていないエンティティの ACL オプションは自動的に無効になります。パブリック記事には ACL は適用されません。
  - 最大ファイルサイズ - Amazon Kendra がクロールするファイルサイズの制限を MBs 単位で指定します。Amazon Kendra は、定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50MBです。最大ファイルサイズは 0MB より大きく、50MB以下である必要があります。
  - [添付ファイルの正規表現パターン] - カタログ、ナレッジ記事、インシデントの特定の添付ファイルを含めたり除外したりする正規表現パターンを追加します。最大 100 のパターンを追加できます。
5. [同期モード] - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとしてフル同期を選択しなくても、最初の同期が失敗した場合は、データのフル同期を実行する必要があります。
  - 完全同期: すべてのコンテンツを新しくインデックス化し、データソースがインデックスと同期するたびに既存のコンテンツを置き換えます。
  - 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。
6. 同期実行スケジュール で、頻度 — データソースコンテンツを同期してインデックスを更新する頻度を選択します。
7. [次へ] をクリックします。
[フィールドマッピングを設定] ページで、次の情報を入力します。
1. デフォルトフィールドマッピング — インデックスにマッピングする Amazon Kendra 、生成されたデフォルトデータソースフィールドから選択します。
2. [フィールドを追加] - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。
3. [次へ] をクリックします。
[確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

Amazon Kendra に接続するには ServiceNow

TemplateConfiguration API を使用してデータソーススキーマの JSON を指定する必要があります。これには、以下の情報を入力する必要があります。

データソース — JSON スキーマSERVICENOWV2を使用する場合は、データソースタイプを TemplateConfiguration として指定します。また、 CreateDataSource API を呼び出すTEMPLATEときにデータソースをとして指定します。
ホスト URL — ServiceNow ホストインスタンスのバージョンを指定します。例えば、your-domain.service-now.com です。
認証タイプ — basicAuthOAuth2インスタンスに使用する ServiceNow認証のタイプを指定します。
ServiceNow インスタンスバージョン — 、、Tokyo、またはのいずれかでSandiegoRome、使用する ServiceNow インスタンスを指定しますOthers。
同期モード — データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。データソースをと Amazon Kendra 初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとしてフル同期を選択しなくても、最初の同期が失敗した場合は、データのフル同期を実行する必要があります。以下のいずれかから選択できます。
- FORCED_FULL_CRAWL データソースがインデックスと同期するたびに既存のコンテンツを置き換え、すべてのコンテンツに新しいインデックスを付けます。
- FULL_CRAWL は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのみのインデックスを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツをインデックスできます。
シークレット Amazon リソースネーム (ARN) — ServiceNow アカウントで作成した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。

基本認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。
```
{
    "username": "user name",
    "password": "password"
}
```
OAuth2 クライアント認証情報を使用する場合、シークレットは次のキーを持つ JSON 構造に保存されます。
```
{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"
}
```
IAM ロール — を呼び出しCreateDataSourceて、 Secrets Manager シークレットにアクセスするためのアクセス許可を IAM ロールに提供し、 ServiceNow コネクタとに必要なパブリック APIs を呼び出すRoleArnタイミングを指定します Amazon Kendra。詳細については、「データソースの IAM ロール ServiceNow 」を参照してください。

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

[仮想プライベートクラウド (VPC)] - VpcConfiguration で CreateDataSource を呼び出すタイミングを指定します。詳細については、「を使用する Amazon Kendra ためのの設定 Amazon VPC」を参照してください。
包含フィルターと除外フィルター - ナレッジ記事、サービスカタログ、インシデントのファイル名とファイルタイプを使用して、特定の添付ファイルを含めるか除外するかを指定できます。

注記
ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。
インデックスを作成する特定のドキュメント — クエリを使用して ServiceNow、プライベートナレッジベースを含む 1 つ以上のナレッジベースから必要なドキュメントを指定できます。ナレッジベースへのアクセスは、 ServiceNow インスタンスへの接続に使用するユーザーによって決まります。詳細については、クエリでインデックス作成するドキュメントを指定するを参照してください。
インデックスパラメータ - 次のことを行うかどうかも指定できます。
- ナレッジ記事、サービスカタログ、インシデントまたはそのすべてにインデックスを作成します。ナレッジ記事、サービスカタログ項目、インシデントのインデックスを作成する場合は、 Amazon Kendra インデックスのインデックスドキュメントコンテンツ ServiceNow フィールドにマッピングされるフィールドの名前を指定する必要があります。
- ナレッジ記事、サービスカタログ項目、インシデントへのインデックス添付ファイル。
- short description フィルターパターンに基づいてナレッジ記事、サービスカタログ項目、インシデントを含めます。
- アクティブと非アクティブなサービスカタログ項目とインシデントをフィルタリングすることを選択できます。
- インシデントタイプに基づいてインシデントをフィルタリングすることを選択します。
- ACL をクロールするエンティティを選択します。
- ServiceNow クエリを使用して、プライベートナレッジベースを含む 1 つ以上のナレッジベースから必要なドキュメントを指定できます。ナレッジベースへのアクセスは、インスタンスへの接続に使用するユーザーによって決まります ServiceNow。詳細については、クエリでインデックス作成するドキュメントを指定するを参照してください。
ID クローラー — Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendraの ID クローラーをオンにして、検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合、ID クローラーがオフになっていると、すべてのドキュメントをパブリックに検索できます。ドキュメントのアクセスコントロールを使用し、ID クローラーがオフになっている場合は、代わりに PutPrincipalMapping API を使用してユーザーコンテキストフィルタリング用のユーザーおよびグループのアクセス情報をアップロードできます。
フィールドマッピング — 選択すると、データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします ServiceNow 。詳細については、データソースフィールドのマッピングを参照してください。

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

設定するその他の重要な JSON キーのリストについては、ServiceNow 「テンプレートスキーマ」を参照してください。

詳細はこちら

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

の更新済み ServiceNow コネクタ (V2) Amazon Kendraの発表の開始方法 Amazon Kendra

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

ServiceNow コネクタ V1.0

クエリでドキュメントを指定する