コネクタの概要

コネクタは、情報を読み書きするために外部システムをアクセスするプロセス内の1つの要素です。Bonita BPMのデフォルトの コネクタがふさわしくない場合は、ご自身でコネクタを実装できます。Bonita BPM の Performance, Efficiency, Teamwork エディションでは、 新しいコネクタを作成するための コネクタ開発ツールキット の利用が推奨されています。一方、Bonita BPM Studio では、[開発] メニュー、[コネクタ ] サブメニューから起動したウィザードを使用しながら、新しいコネクタの定義と実装を定義できます。

このページは、コネクタの構造と Bonita BPM Studio で利用可能なコネクタ開発機能の要約を説明します。

コネクタの構造
コネクタのインポート/エクスポート
コネクタのテスト
コネクタを使用したプロセスの構成設定とデプロイ

コネクタの構造

Bonita BPM では、コネクタは2つの部分、つまり「定義」と「実装」部に実装されます。定義の変更なしに実装を変更することができます。単一の定義に対し、いくつかの実装を作成できます。

コネクタの定義

コネクタの定義は、コネクタの外部インターフェイス、つまりコネクタ利用者に対する可視化(コネクタの構成設定ウィザードと Bonita BPM Studio 内でコネクタを識別するためのアイコン)と Bonita BPM エンジンに対する可視化(入力と出力)をコントロールします。

コネクタの実装

コネクタの実装は、Java クラスを内包した実装ロジックで構成されます。与えられた定義に対応したさまざまな実装を作成できますが、1つのプロセスにおいては、コネクタの定義とコネクタの実装は1対1の関係になります。

Java クラスは、org.bonitasoft.engine.connector.Connector クラスを実装しなければなりません。これは次のメソッドを定義します:

  • setInputParameters :構成設定パラメータの取得のため
  • validateInputParameters :コネクタの構成設定が間違いなく定義されているかチェックするため
  • execute :コネクタを実行しすべての出力を含む map を返すため
  • connect :コネクションを開始するため
  • disconnect :コネクションを終了するため

注意: すべてのコネクタ出力は、実装の中にセットされている必要があります。そうしないと、コネクタの実行は失敗します。コネクタの出力はシリアル化可能(serializable)である必要があります。

API、メソット、関連オブジェクトの詳細については、Javadoc を参照してください。

なお、コードは、Java を使用しますが、コードの一部に既存のGroovy スクリプトを再使用することも可能です。 詳細は Integrating Groovy into applications を参照。

Bonita BPM Studioへのコネクタのインポート/エクスポート

コネクタ開発ツールキットを使用して作成されたコネクタ、あるいは別の Bonita BPM Studio からエクスポートされたコネクタをインポートできます。コネクタは zip ファイルでインポートされます。

  1. Bonita BPM Studio では、[開発] メニュー > [コネクタ ] > [コネクタをインポート…] に進みます。
  2. zip ファイルをアップロードします。

インポートされたコネクタは、コネクタの追加ダイアログ内ですぐさま利用可能になります。

[開発] メニューのオプションを使用してエクスポートすることも可能です。コネクタは、zip ファイルでエクスポートされ、別の Bonita BPM Studio にインポートすることができます。エクスポートするためには、「定義」と「実装」の両方を指定する必要があります。

コネクタのテスト

プロセスと切り離してコネクタ単体でテストするためには、 [開発] メニューに進んで、 [コネクタ ] を選択し、そして [コネクタをテスト… ] を選択し、テストしたいコネクタを選択し、ウィザードを使用してテストで要求される情報を構成設定し、[テスト]  をクリックします。コネクタが起動し結果がレポートされます。

テストする前に Bonita BPM Studio にコネクタをインポートする必要があります。

コネクタを使用したプロセスの構成設定とデプロイ

コネクタの構成設定には、2つの段階があります:

  1. プールやタスクにコネクタを追加したとき、コネクタの挙動を構成設定する。
  2. デプロイのためにプロセスを構成設定するとき、「定義」と各コネクタに含まれている「実装」を指定する。この場合、プロセスの依存性として任意のコネクタの依存性を指定する必要があります。

コネクタが構成設定内に指定された後、その構成設定を参照しながらデプロイ用のプロセスをビルドする際、そのコネクタのコードは、ビジネス アーカイブ(bar ファイル)内に含まれます。

Performance エディションを稼働している場合は、デプロイ後でも、ライブシステム(稼働中のBPM プロセスのこと)に対しコネクタ実装を直接更新できます。

情報: 以下は、オープンソース ジャパンからの追加情報です。

コネクタ構成設定の保存・再利用・編集

プロセス内の随所で同じ内容のコネクタ構成設定を行う場合があります。特にメーセージングの e-mail のコネクタ構成設定がその典型です。Bonita BPM Studio では、作成した構成設定をワークスペース内に保存し、あらゆるプロセスやタスクでその保存済み構成設定を再利用および編集する機能を提供しています。したがって、このような場合、次の3つの操作を行うことで開発および保守効率を向上させることができます。

1. 構成設定の保存

一度作成したコネクタ構成設定を他のタスクやプロセスで再利用したい場合は、コネクタ構成設定ウィザードの最下にある [保存] ボタンをクリックし、コネクタ構成設定名を指定してコネクタ リポジトリに保存することができます。

save_connector_config

2. 構成設定の再利用

コネクタ リポジトリに保存したコネクタ構成設定を再利用するには、コネクタ構成設定ウィザードの最下にある [ダウンロード] ボタンをクリックし、保存済みの構成設定名を選択します。
ダウンロード後は、その設定内容を変更できますが、ダウンロード元にコネクタ構成設定には反映されませんダウンロードはあくまでコピーであり、共有でないことに注意する必要があります。

reuse_connector_config

3. 構成設定の編集

コネクタ リポジトリに保存したコネクタ構成設定は、Bonita BPM Studio のトップバーにある [開発] メニュー -> [コネクタ] -> [構成設定を編集] をクリックし、設定内容を変更することができます。
ただし、前項2の「構成設定の再利用」でダウンロード済みの構成設定には、その変更内容は反映されません。最新の設定内容を反映させるには、再度ダウンロードが必要です。この点に注意する必要があります。

connectorEdit