APIとアドイン
Enterprise Architectの重要な特徴の一つとして、APIとアドイン機能を活用した独自の拡張が行える点が挙げられます。Enterprise Architectは基本機能としても数多くの機能を提供していますが、ソフトウェアの設計開発におけるプロセスは、それぞれの部署や組織ごとに異なるものです。こうした異なるやり方にツールを対応させる方法として、APIとアドインによる拡張機能は必須です。
APIはActiveX COMで提供されていますので、C#やVB.NETなどで簡単に作成できます。また、アドインはActiveX DLLとして作成し、Enterprise Architectが起動時に読み込んで利用する形になります。
例えば、以下のような拡張が可能です。
- 要素をダブルクリックすると表示される要素のプロパティダイアログを、独自の内容に変更したい。
→例えば以下のような変更が可能です。
(無料アドインの「状態要素の独自プロパティ画面アドイン」を利用した例。「状態」要素の場合のみ、独自のプロパティダイアログを表示する。)
- ダイアグラム内で選択されている要素に対して、独自の一括処理を行いたい。
→ダイアグラムで選択されている要素を取得し、要素のプロパティを書き換えるアドインを作成する。 - UMLモデルの内容を独自のフォーマットで出力したい。
→UMLモデルの内容を取得し、必要な情報を希望する順序・形式で出力するアドインを作成する。 - 特性の種類の要素を作成できないようにしたい。
→「要素の新規作成」イベントを取得し、作成しようとしている要素の種類によって、「許可」「不許可」を返すアドインを作成する。
APIについて
APIの文法や使用方法などの詳細はヘルプファイルを参照下さい。ヘルプファイルはこちらからもダウンロードできます。ヘルプの「APIとアドイン」項目をご覧下さい。下記のPDFドキュメントも役に立ちます。
API・アドインに関するドキュメント
| 内容 | 更新日 | - |
| Enterprise ArchitectAPI 機能ガイド Enterprise Architect日本語版で、VisualBasicやC#などからEnterprise Architectのモデルファイルを操作するためのAPIの概要です。 | 2009/8/31 |  ダウンロード |
API・アドインに関するセミナー
使用例
Enterprise Architectが提供しているAPIは、Microsoft の ActiveX COM になっていますので、C#・VisualBasic・VB.NET・VisualC++・Delphiなどから簡単に利用することができます。VBScriptでも利用できますので、WSH(Windows Scripting Host)やWord・Excelなどからも利用できます。なお、Java用のインターフェースもあります。Javaの場合にはアドインは作成できません(JavaアプリケーションからEnterprise Architectのモデルの情報の参照・更新が可能です)。
このAPIを利用したアプリケーション例・アドイン例はこちらにありますので、実際にどのようなことができるのかご覧いただけます。
アドインについて
Enterprise Architectのアドイン機能を利用すると、Enterprise Architectの機能追加を行うことができます。アドインで実行可能な内容は、大きく分けると次の2点です。
1. アドインメニューからの実行
ダイアグラム内やプロジェクトブラウザで要素などを選択し、メインメニューやコンテキストメニューからアドインを呼び出します。呼び出されたアドインでは、どの要素が選択されているかを取得できますので、選択している要素に対して、独自の処理を行うことができます。
2. イベントに応じた処理
Enterprise Architect内部でイベントが発生した場合、そのイベントに応じて処理を行うことができます。主なイベントは次のとおりです。
- Enterprise Architectの起動と終了
- プロジェクトファイルを開いたとき・閉じたとき
- 要素やダイアグラムなどの作成時(作成を許可しないことが可能・作成される要素のプロパティを変更することも可能)
- 要素やダイアグラムなどの削除時(削除を許可しないことが可能)
- ダイアグラムやプロジェクトブラウザで要素などが選択されたとき
- ダイアグラムやプロジェクトブラウザで要素などがダブルクリックされたとき
アドインを使ってみる
弊社で作成したオリジナルアドインを実際にインストールして使用することができます。アドインとは何か？を知りたい方、使用したい機能がアドインにある場合など、ぜひご利用下さい。
こちらをご覧下さい。
アドインを作ってみる
アドイン作成に必要な情報やソースコードの公開、便利ツールなどをご紹介しています。アドイン作成に必要な情報がまとまっていますので、作成の際にはどうぞご活用下さい。
こちらをご覧下さい。
