ServiceNow

ServiceNow コネクタを使用すると、ServiceNow データベースに対して挿入、削除、更新、読み取りオペレーションを実行できます。

準備

Servicenow コネクタを使用する前に、次の作業を行います。

Google Cloud プロジェクトで次の操作を行います。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービスアカウントに、次の IAM ロールを付与します。
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  サービスアカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービスアカウントがない場合は、サービスアカウントを作成する必要があります。詳細については、サービスアカウントを作成するをご覧ください。
- 次のサービスを有効にします。
  - secretmanager.googleapis.com（Secret Manager API）
  - connectors.googleapis.com（Connectors API）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。
ServiceNow インスタンス内の次のテーブルへのアクセス権を付与します。
- sys_db_object
- sys_dictionary
- sys_glide_object
この権限は、コネクタがデータに接続するために必要です。この権限を付与する手順は次のとおりです。
1. ServiceNow アプリケーションで、[System Security] > [Access Controls（ACL）] に移動します。
2. [新規作成] を選択してアクセス制御オブジェクトを作成します。
3. [タイプ] で [レコード] を選択します。
4. [オペレーション] で [読み取り] を選択します。
5. [Name] で、最初のプルダウンで [Table [sys_db_object]] を選択し、2 番目のプルダウンで [--None--] を選択します。
6. [必要なロール] セクションで、[新しい行を挿入...] テキストボックスをダブルクリックし、目的のロールを検索して選択します。
7. [送信] をクリックして ACL オブジェクトを作成します。
8. 作成した ACL を含むロールを認証ユーザーに割り当てます。これを行うには、[User Administration] > [Users] > [Select authenticating user] > [Roles] > [Edit]... の順で選択します。> . コレクションからロールを追加します。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。
2. [NEXT] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [ServiceNow] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 63 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
6. イベントサブスクリプションの接続を使用するには、[イベントサブスクリプションを有効にする] を選択します。これを選択すると、次のオプションが表示されます。
  - エンティティとアクションを使用したイベントサブスクリプションを有効にする: このオプションを選択すると、イベントサブスクリプションとコネクタオペレーション（エンティティとアクション）の両方に対して接続が使用されます。
  - イベントサブスクリプションのみを有効にする: イベントサブスクリプションに対してのみ接続を使用するには、このオプションを選択します。
  これらのどちらを選択した場合でも、以降のステップでイベントの詳細を構成するように求められます。
7. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
8. プロキシを使用: このチェックボックスを選択して、接続用のプロキシサーバーを構成し、次の値を構成します。
9. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
10. [NEXT] をクリックします。
[宛先] セクションに、接続するリモートホスト（バックエンドシステム）の詳細を入力します。
1. Destination Type: 宛先の種類を選択します。
  1. [ホストアドレス] フィールドに、宛先のホスト名または IP アドレスを指定します。
    1. バックエンドシステムへのプライベート接続を確立する場合は、次のようにします。
      1. PSC サービスアタッチメントを作成します。
      2. エンドポイントアタッチメントを作成し、続いて [Host address] フィールドにあるエンドポイントアタッチメントの詳細を入力します。
    2. セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的送信 IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォールルールを構成します。
  他の宛先を入力するには、[+ 宛先を追加] をクリックします。
2. [NEXT] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  Servicenow 接続でサポートされる認証タイプは次のとおりです。
  - ユーザー名とパスワードを指定する
2. [NEXT] をクリックします。
イベントサブスクリプションを有効にしている場合は、接続作成ページに [イベントサブスクリプションの詳細] セクションが表示されます。イベントサブスクリプションの詳細の構成方法については、イベントサブスクリプションの構成をご覧ください。
Review: 接続と認証の詳細を確認します。
[Create（作成）] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

ユーザー名とパスワード
- ユーザー名: 接続に使用する ServiceNow ユーザー名。
- パスワード: ServiceNow ユーザー名に関連付けられたパスワードを含む Secret Manager の Secret。

イベントサブスクリプションを構成する [プレビュー]

イベントサブスクリプションを有効にしている場合は、[イベントサブスクリプションの詳細] セクションに次の値を入力します。

認証トークン:（省略可）認証トークンの Secret Manager の Secret と、[Secret のバージョン] プルダウンから対応する Secret バージョンを選択します。
HMAC アルゴリズム:（省略可）レスポンスペイロードを暗号化する HMAC アルゴリズムを選択します。
HMAC 秘密鍵: [HMAC アルゴリズム] を選択した場合、[Secret のバージョン] プルダウンから HMAC キーの Secret Manager の Secret と対応する Secret バージョンをクリックします。

接続作成後の手順

イベントサブスクリプションの構成を完了するには、Webhook URL を ServiceNow アプリケーションに登録する必要があります。したがって、接続が正常に作成されたら、次の追加の手順を実行します。

新しく作成した接続の接続詳細ページに移動し、イベントサブスクリプションの Webhook URL をコピーします。

ServiceNow アプリケーションにログインして、次の操作を行います。

[すべて] > [ビジネスルール] > [実行するタイミング] ページで、リッスンするオペレーションを選択します。
[Advanced] タブをクリックします。これにより、スクリプトエディタが開きます。

コールバック URL にリクエストを送信する JavaScript を入力します。有効なオペレーションが発生するたびにトリガーされるペイロードがリクエストに含まれます。JavaScript の例を次に示します。

テンプレート

(function executeRule(current, previous /*null when async*/ ) {
var request = new sn_ws.RESTMessageV2();
request.setEndpoint('WEBHOOK_URL'); // here you must the listener url where you want send the event payload

request.setHttpMethod('POST');

var authToken = "AUTHENTICATION_TOKEN"
request.setRequestHeader("authorization", authToken);
request.setRequestHeader("Accept", "application/json");
request.setRequestHeader('Content-Type', 'application/json');

request.setRequestBody("{\"eventType\":\"" +
"EVENT_TYPE" + CUSTOM_FIELDS "\"}");

var data = request.getRequestBody();
var secretKey = "SECRET_KEY";

var signature = SncAuthentication.encode(data, secretKey, "ENCRYPTION_ALGORITHM");
request.setRequestHeader("hmacauthorization",signature);
var response = request.execute();

})(current, previous);

次のように置き換えます。

WEBHOOK_URL: 統合コネクタの接続詳細ページから取得したイベントサブスクリプションの Webhook URL。
AUTHENTICATION_TOKEN: 接続用に構成した認証トークンの実際のテキスト。
EVENT_TYPE: ServiceNow トリガーで構成したイベントタイプの実際のテキスト。
CUSTOM_FIELDS: リクエスト本文には常に eventType フィールドが必要です。このフィールドに加えて、要件に基づいて他のフィールドを追加できます。
SECRET_KEY: 接続用に構成した秘密鍵の実際のテキスト。
ENCRYPTION_ALGORITHM: 次のいずれかの値にする必要があります。
- HmacSHA224
- HmacSHA256
- HmacSHA384
- HmacSHA512
このアルゴリズムは、接続用に構成したアルゴリズムと同じである必要があります。

例

(function executeRule(current, previous /*null when async*/ ) {
var request = new sn_ws.RESTMessageV2();
request.setEndpoint('https://webhook.site/bb37937e-24ea-19b3-9dcd-84eca77f60eg'); // here you must the listener url where you want send the event payload

request.setHttpMethod('POST');

var authToken = "YWRtaW46ZkVpNypxVzhCL3VY"
request.setRequestHeader("authorization", authToken);
request.setRequestHeader("Accept", "application/json");
request.setRequestHeader('Content-Type', 'application/json');

request.setRequestBody("{\"caller_id\":\"" +
current.caller_id + "\",\"eventType\":\"" +
"service_now_event_type_1" + "\",\"company\":\"" +
current.company + "\",\"number\":\"" +
current.number + "\",\"description\":\"" +
current.description + "\",\"FirstName\":\"" +
current.u_firstname + "\",\"LastName\":\"" +
current.u_lastname + "\",\"status\":\"" +
current.u_status + "\",\"Element\":\"" +
current.getElement() + "\",\"category\":\"" +
current.category + "\",\"opened_at\":\"" +
current.opened_at + "\",\"opened_by\":\"" +
current.opened_by + "\",\"location\":\"" +
current.location + "\",\"salesforceId\":\"" +
current.u_salesforceid + "\"}"); //fields you want

var data = request.getRequestBody();
var secretKey = "YWRtaW46ZkVpNypxVzhCL3VY";

// var MAC_ALG_4 = "HmacSHA384";
var MAC_ALG_3 = "HmacSHA256";
// var MAC_ALG_5 = "HmacSHA512";
// var MAC_ALG_2 = "HmacSHA224";

var signature = SncAuthentication.encode(data, secretKey, MAC_ALG_3);
request.setRequestHeader("hmacauthorization",signature);
var response = request.execute();

})(current, previous);

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがどのエンティティオペレーションもサポートしていない場合、サポートされていないオペレーションは Operations リストに表示されません。
アクション: コネクタインターフェースを介して統合で使用できる最初のクラス関数です。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

アクション

このセクションでは、Servicenow 接続でサポートされているすべてのアクションを一覧表示します。

UploadAttachment アクション

この操作では、指定したレコードにファイルを添付してアップロードします。

UploadAttachment アクションの入力パラメータ

パラメータ名	データ型	必須	説明
内容	文字列	いいえ	ファイルとしてアップロードする文字列コンテンツ。
ContentBytes	文字列	いいえ	ファイルとしてアップロードするバイトコンテンツ。
HasBytes	ブール値	いいえ	コンテンツをバイトとしてアップロードするかどうか。
TableName	文字列	いいえ	ファイルを添付するテーブルの名前。
TableSysId	文字列	いいえ	添付する TableName で指定されたテーブル内のレコードの Sys_id。

UploadAttachment アクションの出力パラメータ

このアクションは、アップロードされたエンティティから一連のパラメータを返します

UploadAttachment アクションの構成例については、例をご覧ください。

DownloadAttachment アクション

この操作では、特定のレコードから添付ファイルをダウンロードします。

DownloadAttachment アクションの入力パラメータ

パラメータ名	データ型	必須	説明
SysId	文字列	はい	添付ファイルの Sys_id。
HasBytes	ブール値	いいえ	コンテンツをバイトとしてダウンロードするかどうか。

DownloadAttachment アクションの出力パラメータ

このアクションは、Success パラメータでダウンロードが True または false であるかどうかを返し、True の場合、DownloadAttachment の内容を出力します。

DownloadAttachment アクションの構成例については、例をご覧ください。

例

このセクションでは、このコネクタでエンティティオペレーションとアクションの一部を実行する方法について説明します。

例 - インシデントの添付ファイルをアップロードする

[Configure connector task] ダイアログで、[Actions] をクリックします。
[UploadAttachment] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
  "Content": "File is uploaded",
  "TableName": "Incident",
  "TableSysId": "018f4057473ae5104593a6b5316d4357"
}
```

この例では、ペイロードからコンテンツ値を添付ファイルとしてアップロードし、アップロードしたエンティティのパラメータセットを返します。アクションが成功すると、UploadAttachment タスクの connectorOutputPayload レスポンスパラメータは次のような値になります。

{
                      "SysId": "a667f5d1939be110ff87352d6cba10fc",
                      "FileName": "7043426257788756581.connector.txt",
                      "TableSysId": "018f4057473ae5104593a6b5316d4357",
                      "TableName": "Incident",
                      "DownloadLink": "https://gcp.service-now.com/api/now/v1/attachment/a667f5d1939be110ff87352d6cba10fc/file",
                      "ContentType": "text/plain",
                      "SizeBytes": "16",
                      "ChunkSizeBytes": "700000",
                      "Compressed": "true",
                      "SizeCompressed": "36",
                      "SysTags": "",
                      "ImageHeight": "",
                      "ImageWidth": "",
                      "AverageImageColor": "",
                      "SysModCount": "0",
                      "Hash": "807e96c2942c41ad699d004a9d6a74595c84fab09111d479b6bbe013d5debff6",
                      "State": "pending",
                      "SysUpdatedBy": "gcp2",
                      "SysUpdatedOn": "2023-06-07 07:23:34",
                      "SysCreatedBy": "gcp2",
                      "SysCreatedOn": "2023-06-07 07:23:34",
                      "encryption_context": ""
                    }

例 - インシデントの添付ファイルをダウンロードする

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DownloadAttachment] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
  "SysId": "440c3995471fe1104593a6b5316d4384"
}
```

この例は、Success パラメータでダウンロードが True または false であるかどうかを返し、True の場合、DownloadAttachment のコンテンツを出力します。アクションが成功すると、DownloadAttachment タスクの connectorOutputPayload レスポンスパラメータは次のような値になります。

[
                    {
                      "Success": "True"
                    },
                    {
                      "Content": " A Simple Text File \r\n\r\n\r\n This is a small demonstration .txt file - \r\n just for use in the Virtual Mechanics tutorials. More text. And more \r\n text. And more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. Boring, zzzzz. And more text. And more text. And \r\n more text. And more text. And more text. And more text. And more text. \r\n And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. And more text. Even more. Continued on page 2 ...\r\n Simple PDF File 2 \r\n ...continued from page 1. Yet more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. Oh, how boring typing this stuff. But not as boring as watching \r\n paint dry. And more text. And more text. And more text. And more text. \r\n Boring. More, a little more text. The end, and just as well. "
                    }]

システムの上限

ServiceNow コネクタは、ノードごとに 1 秒あたり最大 10 件のトランザクションを処理し、この上限を超えるトランザクションをスロットル調整できます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

Terraform を使用して接続を作成する

Terraform リソースを使用して、新しい接続を作成できます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

接続作成用の Terraform テンプレートのサンプルを表示するには、サンプルテンプレートをご覧ください。

Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。

パラメータ名	データ型	必須	説明
proxy_enabled	BOOLEAN	False	接続用のプロキシサーバーを構成するには、このチェックボックスをオンにします。
proxy_auth_scheme	ENUM	False	ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。
proxy_user	文字列	False	ProxyServer プロキシへの認証に使用されるユーザー名です。
proxy_password	SECRET	False	ProxyServer プロキシの認証に使用されるパスワード。
proxy_ssltype	ENUM	False	ProxyServer プロキシへの接続時に使用する SSL のタイプです。サポートされている値は AUTO、ALWAYS、NEVER、TUNNEL です。
include_system_tables	BOOLEAN	False	システムテーブルを公開するかどうかを制御します。
filter_tables	STRING	False	目的のテーブルをカンマ区切りのリストで指定します。

統合で Servicenow 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。