LoginSignup
3
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

IBM Integration & WebSphereAdvent Calendar 2024

Day 13
@namio2024(Nami Ono)

webMethods でカスタムコネクタを作る

Posted at

webMethods でカスタムコネクタを作る

背景

iPaaS としての webMethods は 600 以上のコネクタを持つ強力なインテグレーションツールです。使いやすい GUI を備え、ウェブ上から簡単にフローを作成できる、非常に便利なソリューションですが、海外製品ならではの弱点が存在します。

日本特有の製品コネクタが用意されていない という点です… ( ；∀；)

しかしここで終わらないのが webMethods です。iPaaS 上で 簡単にコネクタを自作 することが可能です。
そこで、どれだけ簡単にカスタムコネクタが作れるのかをご紹介します。

今回の目的

  • kintone API のコネクタ を作成する

前提要件

  1. webMethods SaaS環境（フリートライアルでも製品環境でも可）
    *1: トライアル環境はこちらから申請可能。申請後 30 分ほどで利用可能。
  2. kintone アカウント（開発者アカウントで OK）
    *2: kintone 開発者ライセンスはこちらから申請可能。

用意する資料

手順

1. webMethods SaaS ログイン後、Integration Server を開く

image.png

  1. webMethods SaaS のダッシュボードにアクセス
  2. Integration などのメニューから Integration Server をクリックして開く

2. カスタムコネクタを作成したいプロジェクトを選択

  • 接続を作成したいプロジェクト（Workspace）を選びます。
    image.png

3. Connector タブをクリック

  • 画面上部またはサイドバーから Connector タブを探してクリックします。
    image.png

4. REST をクリック

  • Connector タブから REST を選択。
    image.png

5. Add Connector をクリック

  • 新しいコネクタを追加するために Add Connector を選びます。
    image.png

6. API の仕様書・必要情報を整理する

  • 一度 webMethods の画面から離れて、今回作成する kintone の API 仕様書を確認します。

今回作成したい API:

  • kintone アプリのレコードを取得する API

取得 API に関する情報

  • 複数のレコードを取得する: cybozu developer network
  • URL:
    • 例） https://ftog18sh3p2a.cybozu.com
    • 例） https://XXXXXXXX.cybozu.com
  • リソースのパス:
    • k/v1/records.json
  • HTTP メソッド:
    • GET
  • パラメータ:
    • app (数値または文字列 / 必須)
    • fields (文字列の配列 / 省略可)
    • query (文字列 / 省略可)
    • totalCount (文字列 / 省略可)
  • ヘッダー:
    • X-Cybozu-API-Token
    • Content-Type: application/json (念のため準備)
kintone アプリの API キー
  • アプリの設定 ＞ Customization and integration ＞ API token から取得可能
    image.png

7. webMethods に戻り、コネクタを作る

7-1. 全体的な定義

  1. Connector の名前（必須）: 好きな英数字の名前を設定
  2. URL（必須）: API のエンドポイントアドレスを入力
  3. Description（任意）: わかりやすい説明を記載（日本語可）
  4. Icon（任意）: PNG などの画像を設定可能（サイズに注意）
  5. Authentication Type: kintone は API キーを使用するので、最もシンプルな Credentials を選択
    image.png

7-2. リソースを追加

  • Path に API のパスを設定（例： k/v1/records.json ）
  • Methods で GET を選択
    image.png

7-3. Get のパラメータと Header を設定

  • Parameter

    • Name: パラメータ名（例： app）
    • Value: 初期値
    • Parameter Type: QueryString_Param
    • Mandatory: 必須なら Yes

  • Header

    • Name: X-Cybozu-API-Token
    • Value: kintone のアプリ API キーを入力しておくと後々楽
    • Mandatory: Yes
      image.png
      image.png
      image.png

  • 以上を設定したら Next をクリック

7-4. Response の設定

  • HTTP code: 200 (正常系)
    image.png

  • Document Type 横の + ボタンをクリックして Save AS に任意のデータ型名を英数字で入力し、Load Json ボタンを押下
    image.png

    • ここで受け取る JSON の構造を取り込みます
      image.png

  • 取り込みが終わったら Save をクリック
    image.png

  • Document Type のプルダウンから先ほど設定した JSON 形式名を選択して NEXT
    image.png

  • 最後に Save をクリック
    image.png

8. フローサービスで使ってみる

  1. 画面上部または左側メニューから Integrations をクリック
    image.png

  2. ＋ ボタンをクリックして Create New Workflow を選択
    image.png
    image.png

  3. 右側のパレットに先ほど作成したコネクタがあるので、（見つからない場合は検索）ドラッグ & ドロップ
    image.png

9. コネクタ設定をフローに組み込む

  1. ドロップしたコネクタのアイコンをダブルクリックして設定
    image.png

  2. ＋ ボタンをクリックしてアクションを登録（初回使用時のみ必要）
    image.png

  3. Connect to xxxxx の部分でさらに ＋ ボタンをクリックし、

    • Account Name を任意で設定
    • ほかの設定は特に変更せず Add をクリック
      image.png

  4. Name に分かりやすい処理名（例：getrecord）を入力して Next をクリック

  5. 使いたいコネクタのリソースを選択して Next
    image.png

  6. Done で終了
    image.png

  7. Next で設定を確認
    image.png
    image.png

  8. Test をクリックして情報が取得できることを確認
    image.png

参考リンク

以上で webMethods でカスタムコネクタを作成する 手順の紹介は完了です。
気軽に試してみてください！

3
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
3
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?