独自の連携プラグインの作成

私たちはさまざまなツールを利用しています。Proクラウドサーバにはいくつかのツールとの連携に使える連携プラグインが同梱されていますが、標準のWebサービスインターフェイスを備えた他の製品と、独自の連携を行うこともできます。この機能により、Enterprise Architectで作成したモデルが外部ツールと連携し、外部ツールの情報をEnterprise Architect内で要素として利用可能になります。たとえば、プロジェクト管理ツールの内容をEnterprise Architectで可視化するのに役立つ作業ページを定義したり、自動テストツールの内容をEnterprise Architectで可視化し、実装および仕様要素に関連したテストケースとテスト手順を定義したりできます。これには、C++やC#などのプログラミング言語のいずれかを使用してプラグインを作成するための技術的な知識が必要になります。プラグインは一度作成すれば、どのプロジェクトでも使用できます。

ProクラウドサーバとEnterprise Architect側で実際の処理を行いますので、管理者がProクラウドサーバ自身のセキュリティ設定を変更する必要はありません。新しい連携プラグインは、既存のポートとファイアウォールを介して動作します。また、開発者がhttp通信に関する処理を記述する必要がないため、RESTful API呼び出しの決定と構成のみを考えます。

独自の連携プラグインを作成するには、ゼロから開始するか、Proクラウドサーバと共にインストールされるサンプルの1つをコピーして変更します。プラグインは、C++またはC＃で作成できます。

(参考:Proクラウドサーバのインストール)

例はVisual Studio 2017を使用して記述されていますが、これは前提条件ではありません。

連携プラグインは、ISBPIIntegrationPlugin.h(C++の場合)またはISBPIIntegrationPlugin.cs(C＃の場合)に含まれているISBPIIntegrationPluginで定義されたインターフェイスを実装する必要があります。

プラグインプログラムの一般的な流れは次のとおりです。

Enterprise Architec内から、外部ツールの情報を取得を実行します。
プラグインが、Enterprise Architectから取得依頼を受けます。
プラグインは、取得依頼の内容を解析し、対応するデータを取得するよう、外部ツールのAPIを呼び出します。
プラグインは、外部ツールからその結果を受け取ります。受け取った内容を解析します。
コールバック関数でEnterprise Architectにその結果を通知します。場合によっては、エラーを返します。
Enterprise Architectはそのデータを受け取り、画面に表示します。

項目	説明
CheckVersion	(C#の場合には不要です) 入力値: 符号なし整数値プラグインが、指定されたバージョンに対応している場合にはtrueを返します。バージョン2では、Enterprise Architectの要素が外部項目にリンクされたり、リンクが解除されたり、変更されたりした場合に通知を行う機能が追加されています。バージョン2はバージョン1を拡張しています。対応しているバージョンまでのバージョンに対してtrueを返してください。例: return (version <= 2);
プラグインの作成	プラグインは、以下の関数を実装し公開しなければなりません。 extern "C" SBPI_API SBPI_INTEGRATION_PLUGIN CreatePlugin(); この関数の戻り値として、ISBPIIntegrationPluginインターフェースを持つクラスへのポインタを返さなければなりません。実装の一例は以下の通りです。 SBPI_INTEGRATION_PLUGIN CreatePlugin() { return new ExampleIntegrationPlugin; } 新しく作成された ISBPIIntegrationPlugin は ISBPIIntegrationPlugin::Release が呼ばれたら解放・破棄することができます。
ISBPIIntegrationPlugin インターフェース	DLLのプラグインは、ISBPIIntegrationPluginインターフェースで定義される全てのメソッドを実装する必要があります。