APIとアドイン

Enterprise Architectの重要な特徴の一つとして、APIとアドイン機能を活用した独自の拡張が行える点が挙げられます。Enterprise Architectは基本機能としても数多くの機能を提供していますが、ソフトウェアの設計開発におけるプロセスは、それぞれの部署や組織ごとに異なるものです。こうした異なるやり方にツールを対応させる方法として、APIとアドインなどによる拡張があります。

  • API (Application Programming Interface):
    Enterprise Architectで作成したモデル(要素や図など)の内容を外部のアプリケーションから参照・編集したり、Enterprise Architectの機能(ドキュメント生成やソースコード生成など)を外部のアプリケーションから呼び出したりできます。
    Enterprise Architectが提供しているAPIは、C#・VB.NET・Visual C++・Javaなどから利用できます。VBScriptでも利用できますので、WSH(Windows Scripting Host)やWord・Excelのマクロなどからも利用できます。

  • アドイン:
    Enterprise Architectの画面内から独自に作成したプログラムを呼び出して独自の処理を実行させたり、Enterprise Architectの既定の動作を変更して独自の処理を実行したりできます。これらの独自の処理の具体的な記述には、APIを利用します。
    アドインは基本的にはActiveX COMのDLLファイルの形式となりますので、作成にはVisual Studioを利用することが一般的です。Javaではアドインは作成できません。
  • スクリプト:
    アドインが、基本的にはVisual Studio等のツールを利用して作成するのに対し、スクリプト機能は、Enterprise Architect内部のコードエディタでJavaScript・VBScript・JScriptで処理を記述してAPIを利用できます。画面表示がないような一括処理の定義・利用などに有用です。
  • アプリケーション:
    独立して実行されるアプリケーション(Exeプログラム)の内部から、Enterprise Architectのプロジェクトを開いて、モデルの情報の取得や編集ができます。これらの取得等の操作でAPIを利用します。作成にはVisual Studioを利用することが一般的です。この場合に限り、Javaも利用できます。

API・アドイン・スクリプトを利用することで、例えば以下のような拡張が可能です。

  • 要素をダブルクリックすると表示される要素のプロパティダイアログを、独自の内容に変更したい。
  • ダイアグラム内で選択されている要素に対して、独自の一括処理を行いたい。
    →APIを利用してダイアグラムで選択されている要素を取得し要素のプロパティを書き換えるような、アドインやスクリプトを作成する。
  • モデルの内容を独自のフォーマットで出力したい。
    →APIを利用してモデルの内容を取得し、必要な情報を希望する順序・形式で出力するようなアドイン・アプリケーション・スクリプトを作成する。
  • 作成したモデルの内容を独自のルールでチェックしたい。
    →APIを利用してモデルの内容を取得し、独自のルールに沿っているかをチェックする。

このAPIを利用したアプリケーション例・アドイン例として、スパークスシステムズ ジャパンが配布しているアドインがあります。

API

APIの文法や使用方法などの詳細はヘルプの「APIとアドイン」の項目をご覧下さい。

アドイン

Enterprise Architectのアドイン機能を利用すると、Enterprise Architectの機能追加を行うことができます。アドインで実行可能な内容は、大きく分けると次の2点です。

アドインメニューからの実行

ダイアグラム内やモデルブラウザで要素などを選択し、リボンやコンテキストメニューからアドインを呼び出します。呼び出されたアドインでは、どの要素が選択されているかを取得できますので、選択している要素に対して、独自の処理を行うことができます。

イベントに応じた処理

Enterprise Architect内部でイベントが発生した場合、そのイベントに応じて処理を行うことができます。主なイベントは次のとおりです。

  • Enterprise Architectの起動と終了
  • プロジェクトファイルを開いたとき・閉じたとき
  • 要素やダイアグラムなどの作成時(作成を許可しないことが可能・作成される要素のプロパティを変更することも可能)
  • 要素やダイアグラムなどの削除時(削除を許可しないことが可能)
  • ダイアグラムやモデルブラウザで要素などが選択されたとき
  • ダイアグラムやモデルブラウザで要素などがダブルクリックされたとき

このようなイベントに応じた処理をすることで、Enterprise Architectの機能を拡張できます。例えば「名前初期値削除アドイン」は、要素の作成完了のイベント(EA_OnPostNewElement)を受信し、作成する要素が特定の種類である場合に名前を削除する処理をしています。

アドインを使ってみる

弊社で作成したオリジナルアドインを実際にインストールして使用できます。アドインとは何か？を知りたい方、使用したい機能がアドインにある場合など、ぜひご使用下さい。
詳細はこちらをご覧下さい。

アドインを作ってみる

アドイン作成に必要な情報やソースコードの公開、便利ツールなどをご紹介しています。アドイン作成に必要な情報がまとまっています。
詳細はこちらをご覧下さい。

アドインを作ってもらう

スパークスシステムズ ジャパンでは、お客様が希望する内容のアドインの作成も請け負っています。詳細は「有償追加サポート : アドイン・アプリケーション作成」をご覧ください。

「APIやアドインについて学ぶ工数が割けない」「作成する人員・工数がない」「作成だけでなく保守やバージョンアップ時の対応まで責任をもって対応してほしい」のような場合に好評です。