AmplifyからServiceNowへの更新

このページでは、Amplifyから実行されるリモートアクションまたはワークフローを使用して、Webhooksを利用してServiceNowチケットログを自動更新する方法を説明します。

構成に基づいて、自動更新は次の場合に発生します。

リモートアクションやワークフローがトリガーされた場合。
リモートアクションやワークフローが完了した場合。

このページのコードサンプルは、次の方法でServiceNowのやり取りにも適用できます:

WebhookのNQL条件でexternal_source== "SNOW-Incident"をexternal_source== "SNOW-Interaction"に置き換えます。

Webhookのリソースフィールドで/table/incident/を/table/interaction/に置き換えます。

ServiceNow用のコネクター認証情報を構成する

コネクター認証情報の構成ページから:

HTTPSオプションをプロトコルのドロップダウンから選択します。
インスタンスのURLルートhttps://<instancename>.service-now.com/をURLアドレスフィールドに貼り付けます。
- 他のURL例についてはconnector credential文書を参照してください。

https://XXXXXXXXXX.service-now.com/

OAuth 2.0 - クライアント認証情報オプションを認証ドロップダウンから選択します
- アクセストークンURL、クライアントID、クライアントシークレット、スコープフィールドをconnector credentialの説明に従って記入します。
認証情報を保存します。

Webhookの構成

次のセクションでは、ServiceNowを更新するための2つのシナリオについて詳しく説明します。各シナリオの手順は非常に似ており、リモートアクションとワークフローのNQL条件とペイロードがシナリオごとに異なります。

リモートアクションやワークフローがトリガーされたときのServiceNow更新

NexthinkでリモートアクションやワークフローがトリガーされたときにServiceNowのインシデントチケットログを自動的に更新するWebhookを設定します。

最初にWebhook用のコネクター認証情報をセットアップしてください。

Webhook構成ページから、次のNQL条件を挿入します。より多くの例についてはWebhook NQL条件の構成文書を参照してください。
- NQL条件を入力した後、システムはペイロードの許可されるプレースホルダーをリストします。

リモートアクションの NQL条件

remote_action.executions
| where internal_source == "Amplify" 
  And external_reference != "undefined" 
  And external_source == "SNOW-Incident" 
  And status == in_progress 
  and remote_action.nql_id != "undefined"
| list 
  remote_action.name , 
  remote_action.execution.request_time, 
  remote_action.execution.account_name, 
  remote_action.execution.external_reference

ワークフローの NQL条件

workflow.executions
| where internal_source == "Amplify" 
  And external_reference != "undefined" 
  And external_source == "SNOW-Incident" 
  And device.name != null 
  And user.name != null
  And outcome == null
  And status == in_progress 
  and workflow.nql_id != "undefined"
| list 
  workflow.name , 
  workflow.execution.request_time,  
  workflow.execution.external_reference

ワークフローとリモートアクションの処理中に、複数のイベントが送信され、詳細とともに元のイベントが更新されます。上記のクエリと使用される条件により、最も完全なイベントのみがServiceNowを更新するために使用されます。

このWebhookに対して、以前に設定したコネクタの資格情報を選択してください。
MethodのドロップダウンからPATCHオプションを選択してください。
Resourceフィールドに次のAPIを挿入してください。

リモートアクションのためのリソースAPI

api/now/v1/table/incident/{{remote_action.execution.external_reference}}

ワークフローのためのリソースAPI

api/now/v1/table/incident/{{workflow.execution.external_reference}}

{{remote_action.execution.external_reference}}と{{workflow.execution.external_reference}}は、Amplify拡張機能からリモートアクションまたはワークフローがトリガーされたときに自動的にServiceNowのチケット参照で埋められるプレースホルダーです。

詳しくは、このページの一番下にあるF.A.Qセクションを参照してください。

Payloadを挿入し、以下のメッセージ例を使用してください：

リモートアクションのためのペイロード

{"work_notes": "このチケットのためのリモートアクション{{remote_action.remote_action.name}}が、Amplifyユーザー{{remote_action.execution.account_name}}から{{remote_action.execution.request_time}}にトリガーされました"}

ワークフローのためのペイロード

{"work_notes": "このチケットのためのワークフロー{{workflow.workflow.name}}が、Amplifyから{{workflow.execution.request_time}}にトリガーされました"}

初回設定時には、テストを行わずにWebhookを保存し、Amplifyのドキュメントを参照して、ServiceNowからのリモートアクションまたはワークフローを実行し、Webhookが正しく動作しているかどうかを確認してください。
- Send testは、AmplifyのリモートアクションまたはワークフローがServiceNowでトリガーされ、Resourceのプレースホルダー{{....}}のインシデント参照値を生成するまで、Webhookを正常にテストすることはできません。
- ServiceNow から手動で remote_action.execution.external_reference または workflow.execution.external_reference の値を取得し、Webhook の設定をテストするには、F.A.Q セクションを参照してください。

Amplify 設定ガイドを参照して、NexthinkインスタンスをWebアプリケーションと統合し、Registryを介して設定の詳細をデプロイする方法を学びます。

リモートアクションまたはワークフローが完了した時にServiceNowを更新するためのWebhookを設定します。

Nexthink で Webhook を設定し、リモートアクションまたはワークフローの完了結果の詳細で ServiceNow のインシデントチケットログを自動的に更新します。

Webhookのためにコネクタの資格情報を最初に設定しておくことを忘れないでください。

Webhook設定ページから、以下のNQL条件を挿入してください。 Webhook NQL 条件の設定については、Webhook NQL 条件の設定のドキュメントを参照してください。
- NQL条件を入力すると、システムはPayloadの許可されたプレースホルダーをリストアップします。

リモートアクションのためのNQL条件

remote_action.executions
| where internal_source == "Amplify" 
  And external_reference != "undefined" 
  And external_source == "SNOW-Incident" 
  And status in [failure, success , expired] 
  and remote_action.nql_id != "undefined"
| list remote_action.name , 
  remote_action.execution.request_time, 
  remote_action.execution.time, 
  remote_action.execution.status, 
  remote_action.execution.status_details, 
  remote_action.execution.inputs, 
  remote_action.execution.outputs, 
  remote_action.execution.account_name, 
  remote_action.execution.external_reference

ワークフローのためのNQL条件


workflow.executions
| where internal_source == "Amplify"
 And external_reference != "undefined" 
 And external_source == "SNOW-Incident" 
 And status in [failure, success, expired, cancelled] 
 And workflow.nql_id != "undefined"
| list workflow.name ,
 workflow.execution.request_time, 
 workflow.execution.time, 
 workflow.execution.status, 
 workflow.execution.status_details, 
 workflow.execution.inputs, 
 workflow.execution.outcome, 
 workflow.execution.external_reference

このWebhookに対して、以前に設定したコネクタの資格情報を選択してください。
MethodのドロップダウンからPATCHオプションを選択してください。
Resourceフィールドに次のAPIを挿入してください。

リモートアクションのためのリソースAPI

api/now/v1/table/incident/{{remote_action.execution.external_reference}}

ワークフローのためのリソースAPI

api/now/v1/table/incident/{{workflow.execution.external_reference}}

詳しくは、このページの一番下にあるF.A.Qセクションを参照してください。

Payloadを挿入し、以下のメッセージ例を使用してください：

リモートアクションのためのペイロード

{"work_notes":"Amplifyユーザー{{remote_action.execution.account_name}}によってこのチケットのためにトリガーされたリモートアクション{{remote_action.remote_action.name}}のステータスは以下の通りです。\nリクエスト時間：{{remote_action.execution.request_time}} \n実行時間：{{remote_action.execution.time}} \nステータス：{{remote_action.execution.status}} \nステータス詳細：{{remote_action.execution.status_details}} \n入力：{{remote_action.execution.inputs.as(format = text)}} \n出力：{{remote_action.execution.outputs.as(format = text)}}"}

ワークフローのためのペイロード

{ "work_notes": "Amplifyからこのチケットのためにトリガーされたワークフロー{{workflow.workflow.name}}のステータスは以下の通りです。リクエスト時間：{{workflow.execution.request_time}} 実行時間：{{workflow.execution.time}} ステータス：{{workflow.execution.status}} ステータス詳細：{{workflow.execution.status_details}} 入力：{{workflow.execution.inputs}} 結果：{{workflow.execution.outcome"}}}

初回設定時には、テストを行わずにWebhookを保存し、ServiceNowからAmplifyでリモートアクションを実行し、Webhookが正しく動作しているかどうかを確認してください：
- Send testは、ServiceNowでAmplifyからのリモートアクションをトリガーするまで、Webhookを正常にテストすることはできません。このとき、Resourceプレースホルダー{{...}}のインシデント参照値が生成されます。
- ServiceNowから手動でremote_action.execution.external_referenceまたはworkflow.execution.external_referenceの値を取得し、Webhook設定をテストするには、F.A.Qセクションを参照してください。

NexthinkインスタンスをWebアプリケーションと統合し、Registryを使って設定詳細をデプロイする方法を学ぶために、Amplifyの設置と設定ガイドを参照してください。

F.A.Q

ServiceNowでAmplifyがインシデントまたは対話ログを更新しているかどうかを確認するにはどうすればよいですか？

Amplifyドキュメントでは、Amplify拡張機能を使用してServiceNowログにリモートアクションとワークフローを登録する方法について説明しています。つまり、このページに記載されているWebhook設定に従った後のことです。

Resourceフィールド内の`{{remote_action.execution.external_reference}}`と`{{workflow.execution.external_reference}}`プレースホルダーの値は何ですか？

Amplify Webhookのプロセスは、ServiceNowの提供する一連の指定されたURLを読み込んで、チケットのsys_idとタイプ（インシデントまたは対話）を見つけるために照合することで、ServiceNow URLからexternal_reference値を取得することにあります。

次に、Amplifyはこのexternal_reference値をremote_actionまたはworkflow情報と共にNexthinkプラットフォームに送信し、Webhookはこれらの値を使用してWebhookのResourceプレースホルダー（例：{{remote_action.execution.external_reference}}）を置き換えます。

Webhook設定をテストするためのServiceNow `remote_action.execution.external_reference`値の手動取得方法は？

ServiceNowのブラウザページからAmplifyでリモートアクションを実行した後：

ServiceNowのインシデントまたは対話URLからexternal_referenceを取得します。

ワークスペースビューでのURL例：

クラシックビューでのURL例：

NexthinkのWebhook設定ページから：

ServiceNow URLから手動で取得したexternal_referenceを使って、Resourceプレースホルダー{{remote_action.execution.external_reference}}を置き換えます。たとえば：

api/now/v1/table/incident/32dd789083xxxxxxxxxxxxxxxxxxxxx

Webhook設定をチェックするためにテストを送信してください。テストが成功したことを確認した後、正しいプレースホルダーでResourceを置き換えてWebhookを保存します。

api/now/v1/table/incident/{{remote_action.execution.external_reference}}

NexthinkプラットフォームでServiceNowのインシデントまたは対話`sys_id`を確認する方法は？

このページに記載されているWebhook設定に従い、ServiceNowでAmplify拡張機能を使用してリモートアクションを実行した後、Nexthinkのインベスティゲーションページで対応するNQLクエリを実行してチケットsys_idを取得します。

External referenceの下でsys_id、External sourceの下でチケットタイプ（external_source== "SNOW-Incident"またはexternal_source== "SNOW-Interaction"）を見つけます。

Checking ServiceNow incident or interaction ID in the Nexthink platform.