【ServiceNow PDI】Integration Hubを使い他システム連携機能部品を実装する手順まとめ

2025年8月29日 12:08

ServiceNowのWorkfow Data Fabric製品は、旧Automation Engineという他システム連携機能群を今年からリブランディングされたものとなって提供されています。
この中に含まれるIntegration Hubという機能製品があります。平たく説明すると、REST APIなど様々な接続方式を使った連携機能を
①各ベンダー製品とすぐに連携できる機能部品テンプレート
②利用者が自分で連携機能をカスタム開発できる開発機能群
という形で提供されています。

https://www.servicenow.com/docs/ja-JP/bundle/yokohama-integrate-applications/page/administer/integrationhub/concept/exploring-integration-hub.html

今回は、②の観点、自分で他システム連携機能をカスタムで作ってみることにチャレンジしたいと思います。

さらに、今回もRPA Hubの投稿と同様に、無償で技術学習できる環境としてのPDI(Personal Development Instance)で作成を行ってみました。

そして、もう１つのチャレンジが ”ノーコード” という設定ベースで連携機能部品が本当に作れるのか、という点にもチャレンジしてみます。

１．PDIの払い出しとプラグインのインストール

まずPDIの払い出しを行い開発できるインスタンス環境を用意します。
PDIの払い出しはこちらより行ってください。

続いてPDIへのプラグインのインストールを行います。
PDIの払い出しが完了したのち、[My Instance]の中から、[Activate Plugin]を選択します。

リストから、IntegrationHubと記載のある機能を検索します。この中の、以下のいずれかをActivateします。
・IntegrationHub Professional Package
・IntegrationHub Enterprise Package
プラグインインストール後に、完了メールが届きます。

２．開発する連携機能と利用するAPIサービス

今回開発してみようと思う機能は、以下です。
・金融機関コードを変数値でREST APIでクラウドAPIへ送信し、その応答値に金融機関名などを含むデータをJSONで受領し、後続ステップ（Flow）で利用できるように出力値を生成

よく銀行振込みなどで所定の金融機関を検索するような機能があるかと思います。今回は金融コードを外部の金融機関情報を提供してくれる無償の儀金融機関コードAPIサービスより受領させてもらう形で簡単な情報牽引機能を作ってみようと思います。

そして、利用させていただく無償のAPIサービスはこちらを利用しました。

簡単にAPIの仕様だけご案内すると、

このような様式でAPIにGETを要求します。{bank_code} 箇所が所定の金融機関コード（4桁）を入れる部分です。

https://bank.teraren.com/banks/{bank_code}.json

例）https://bank.teraren.com/banks/0001.json
要求を実行すると、以下のようなJSONが取得できます。

{
  "code": "0001",
  "name": "日本",
  "kana": "トウキョウ",
  "hira": "とうきょう",
  "normalize": {
    "name": "日本銀行",
    "kana": "ニホンギンコウ",
    "roma": "nihonginkou",
    "hira": "にほんぎんこう"
  },
  "url": "https://bank.teraren.com/banks/0001.json",
  "branches_url": "https://bank.teraren.com/banks/0001/branches.json",
  "created_at": "2021-10-15T12:13:26.433+09:00",
  "updated_at": "2021-10-15T12:13:26.433+09:00"
}

このAPIサービスを利用して、JSONに含まれる金融機関情報を取得する機能を開発してみようと思います。

ちなみに、ブラウザでURLに金融機関コードも含めて入力して開くと、
・https://bank.teraren.com/banks/0005.json

このようなJSONが応答されることが分かります。

３．WorkFlow Studioでの連携機能(Action)の作成

Workflow Studioを起動します。

ServiceNowのVancouver以降で、フローや連携機能（スポークと呼びます）、Decision Tableなどの機能を統合開発できるようになったのがこのWorkflow Studioです。

これ以前は様々な開発ツール画面を個別に開いて開発していたので、ロジックや自動化機能を単一画面上で開発できるようになり、とても便利になりました。

[新規] > [アクション]を選択します。

アクションの設定を行います。
・アクション名：Get Bank Name
・アプリケーション名：任意アプリを指定
※この機能を呼び出すカスタムアプリ"Bank Info Management"を利用する形としました。利用アプリの作成については、次回以降で投稿を行います。

４．アクションのステップ定義

ここから、アクション内のステップを作成してゆきます。まず先に作成するステップ全体の完成形をご案内します。

完成形のアクションアウトライン画面に以下４つのステップが含まれます。
①入力：金融機関コードを引き渡す”入力変数”を定義
②REST step：APIサービスにGETを要求し応答を受領するステップ
③JSON Parser step：受領したJSONをパースし要素値を抽出
④出力：外部処理（フローなど）へ値を引き渡す"出力値変数"
※エラーの評価ステップについては本実装では割愛します。

まず、①入力変数には以下のような定義を行い、外部から入力値を受け付ける器を用意しておきます。
・ラベル：Bank Code
・名前：bank_code
・タイプ：String

ここから、ステップの作成に入ります。アウトラインの[+]（新しいステップの追加）ボタンよりステップを追加してゆきます。

統合カテゴリに含まれる機能群が他システムへの接続およびデータ連携を行う機能を作成できるメニューとなってます。
この中から、[REST]を選択します。

ステップ②のREST stepには、以下の定義を行います。
・接続：インラインで接続を定義
※個別に接続先(URL)を指定する場合にはこちらを選択します。
・ベースURL：https://bank.teraren.com/
・接続タイムアウト：30秒

少し画面をスクロールし以下の定義を行います。
・ビルド：手動
・リソースパス：banks/[入力変数のBank Code].json
※APIサービスの仕様で、/XXXX.jsonのようにXXXXに金融機関コードの値を要求するため、↑のようにパスの途中に入力変数を挿入する設定をドラッグ＆ドロップで指定します。
・HTTPメソッド：GET

続いて、③ステップのJSON Parserステップを作成します。
アクションアウトライン上で、REST Stepの下にある[+]ボタンよりアクションステップを追加します。

検索バーに[JSON]と入力し、リストされた中から[JSON Parser]メニューを選択します。

JSON Parserステップを定義します。
・ソースデータ：REST stepで受領する応答本文データピルを挿入
※画面右のREST stepより[応答本文]データピルをドラッグ&ドロップで配置
・ペイロード：APIサービスより受領されるペイロード様式を指定
※↓に挙げているペイロード様式をコピペします。

以下のJSONペイロード様式をコピー&ペーストします。

{
  "code": "0001",
  "name": "日本",
  "kana": "トウキョウ",
  "hira": "とうきょう",
  "normalize": {
    "name": "日本銀行",
    "kana": "ニホンギンコウ",
    "roma": "nihonginkou",
    "hira": "にほんぎんこう"
  },
  "url": "https://bank.teraren.com/banks/0001.json",
  "branches_url": "https://bank.teraren.com/banks/0001/branches.json",
  "created_at": "2021-10-15T12:13:26.433+09:00",
  "updated_at": "2021-10-15T12:13:26.433+09:00"
}

次に、[ターゲット生成]を押下します。
コピペしたJSONペイロードを基に[ターゲット]が生成されます。
これによって、JSON応答から特定の値を抽出する仕組みがノーコードで作成できました。