APIとアドイン

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

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

  • アドイン:
    Enterprise Architectの画面内から独自に作成した機能を呼び出し、独自の処理を実行させたり、Enterprise Architectの既定の動作を変更して独自の処理を実行するための仕組みです。これらの独自の処理の記述には、APIを利用します。
    アドインはDLLの形式となりますので、作成にはVisual Studioを利用することが一般的です。Javaの場合にはアドインは作成できません。(JavaアプリケーションからAPIを利用してEnterprise Architectのモデルの情報の参照・更新を行うことは可能です。)

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

  • 要素をダブルクリックすると表示される要素のプロパティダイアログを、独自の内容に変更したい。
    →例えば以下のような変更が可能です。

    (状態要素の場合のみ、独自のプロパティダイアログを表示する。)

  • ダイアグラム内で選択されている要素に対して、独自の一括処理を行いたい。
    →APIを利用してダイアグラムで選択されている要素を取得し要素のプロパティを書き換えるような、アドインやスクリプトを作成する。

  • UMLモデルの内容を独自のフォーマットで出力したい。
    →APIを利用してUMLモデルの内容を取得し、必要な情報を希望する順序・形式で出力するようなアドイン・アプリケーション・スクリプトを作成する。

  • 作成したモデルの内容を独自のルールでチェックしたい。
    →APIを利用してUMLモデルの内容を取得し、独自のルールに沿っているかをチェックする。

このAPIを利用したアプリケーション例・アドイン例はこちらにありますので、実際にどのようなことができるのかご覧いただけます。

APIについて

APIの文法や使用方法などの詳細はヘルプの「APIとアドイン」項目をご覧下さい。ご覧下さい。ヘルプの内容はこちらからもご覧いただけます

また、Enterprise Architectコーポレート版で利用できる「スクリプト」の機能を利用すると、APIを利用した単純なプログラム(スクリプト)をEnterprise Architect内部のエディタで作成し、実行することができます。このスクリプトの機能を利用することで、APIを利用したプログラムを簡単に作成して実行することができます。

アドインについて

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

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

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

2. イベントに応じた処理

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

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

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

アドインを使ってみる

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

アドインを作ってみる

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