Excel Export Add-in Manualby SparxSystems Japan

Excel 出力アドイン 利用ガイド(2022/12/21 更新)

1Copyright (c) 2017-2022 Sparx Systems Japan目次
1

はじめに .............................................................................................................................................................32

動作環境 .............................................................................................................................................................33

利用条件 .............................................................................................................................................................3

4

アドインのインストール....................................................................................................................................3

5

アドインの操作方法 ...........................................................................................................................................4
5.1

アドインの実行 ...........................................................................................................................................4

5.2

Excel・CSV の出力 ....................................................................................................................................5

5.3

テンプレートの作成・編集 .........................................................................................................................7

5.3.1

テンプレート編集画面 .........................................................................................................................7

5.3.2

検索条件画面 .......................................................................................................................................9

5.3.3

タグ付き値の追加画面 .......................................................................................................................10

5.3.4

テンプレートのレイアウト変更 ........................................................................................................ 116

特記事項 ...........................................................................................................................................................127

改訂履歴 ...........................................................................................................................................................132
Copyright (c) 2017-2022 Sparx Systems Japan

1

はじめに

本アドインは、要素や接続の情報を一覧形式で Excel・CSV に出力します。出力内容・順序のほか、書式や罫線などをお客様自身でカスタマイズして Excel 出力することもできます。
本資料は、Excel 出力アドインバージョン 1.6.0 を基に作成しています。

2

動作環境

・ Enterprise Architect 日本語版 バージョン 14.0 以降
・ Enterprise Architect すべてのエディション(種類)・ .NET フレームワーク 4.7.2 以降のランタイム
・ Excel2010 以降
・Excel が無い場合でも、テンプレートの作成、Excel・CSV 出力は可能です。
（テンプレートのレイアウト変更はできません）
・動作確認は Excel 2019 で行っていますが、Excel2007 以降であればおそらく動作します。
（テーブルスタイルには Excel2010 以降で対応しています）※Enterprise Architect の動作環境(OS など)は下記ページをご覧ください。
https://www.sparxsystems.jp/products/EA/ea_sysreq.htm

3

利用条件

・ アドインのインストールには管理者権限が必要です。
・ 差分比較・マージツール「LemonTree」との同時利用について
LemonTree がインストールされていて、EA 用アドイン「LemonTree.EAAddin」が有効な場合、本アドインとの同時利用には既知の問題があります。
https://www.sparxsystems.jp/forum/modules/xhnewbb/viewtopic.php?topic_id=6943
この問題は本アドインのバージョン 1.5.0 で対策されていますので、要すればバージョン 1.5.0 以降をご利用ください。

4

アドインのインストール

下記ページをご覧ください。
https://www.sparxsystems.jp/products/EA/tech/Addins.htm#install3
Copyright (c) 2017-2022 Sparx Systems Japan5

アドインの操作方法

5.1

アドインの実行

以下いずれかの方法で実行します。
・ プロジェクトブラウザ上で実行
プロジェクトブラウザ上で、パッケージ・要素・ダイアグラムを選択し、右クリックで表示されるコンテキストメニューで「アドイン・拡張」→「Excel 出力」を選択します。
・ ダイアグラム上で実行
ダイアグラム上の背景で右クリック、もしくは、ダイアグラム上の要素を選択し（複数選択可）、右クリックで表示されるコンテキストメニューで「アドイン・拡張」→「Excel 出力」を選択します。
アドイン実行時にアドイン用パッケージが無い場合は、アドイン用パッケージ作成場所を選択する画面が表示され、選択されたパッケージ配下にサンプルテンプレートを含む「Excel 出力アドイン」パッケージが作成されます。尚、アドイン実行時に既に「Excel 出力アドイン」パッケージがある場合、サンプルテンプレートの配置は行ないません。

4
Copyright (c) 2017-2022 Sparx Systems Japan

5.2

Excel・CSV の出力

アドインを実行すると以下の画面が表示されます。
この画面ではテンプレートを選択し、Excel・CSV を出力することができます。

5
Copyright (c) 2017-2022 Sparx Systems Japan

項目名

説明

出力対象

出力対象を表示します。「…」ボタンをクリックして、パッケージ・ダイアグ
ラムのツリーから選択することもできます。

出力情報出力する情報（要素・接続）を選択します。以下、オプション設定です。
・属性・操作も出力 ※「要素」選択時のみ・子要素も出力・タグ付き値の値が GUID の場合、要素名を出力 ※「要素」選択時のみ・接続なしの要素も出力 ※「接続」選択時のみ・集約はソース・ターゲットを入れ替えて出力 ※「接続」選択時のみシート単位

Excel 出力時のシート単位を選択します。※Excel 出力時のみ「パッケージ」「ダイアグラム」は出力対象にパッケージを指定した場合のみ設定可能です。
「パッケージ」を選択して Excel 出力した場合、出力項目に「名前」があれば、シート間のハイパーリンクが設定されます。具体的には、Excel 上の「名前」欄に記載のパッケージ名にハイパーリンクが設定され、該当パッケージのシートにジャンプできます。また、A1 セルをクリックすると、親パッケージのシートにジャンプできます。

テンプレート名

テンプレートを選択します。テンプレートを作成・編集したい場合は、「編集/新規」ボタンをクリックしてください。（アドイン用パッケージ作成時にサンプルテンプレートも登録されます）

出力する種類

出力する種類を限定したい場合に設定します。複数の種類を指定する場合はカンマで区切ります。設定可能な文字列は、以下のヘルプをご確認ください。
・要素API・アドイン・スクリプト > API > リファレンス > 要素 > Elementに記載されている「要素の種類名」
・接続
API・アドイン・スクリプト > API > リファレンス > 接続 > Connectorに記載されている「単語」と「対応する接続」の項目表

出力形式

Excel、CSV を選択します。

分割記号

CSV の分割記号を設定します。 ※CSV 出力時のみ

出力ファイル

保存先ファイルパスを表示します。「…」ボタンをクリックして、ダイアログで保存先を指定できます。（テンプレートを選択すると、デスクトップあるいは前回保存場所のパスが自動設定されます）

出力ファイルを直前に出力したファイルを開きます。

表示ボタン
出力ボタン

ファイルを出力します。

閉じるボタン

この画面を閉じます。

6
Copyright (c) 2017-2022 Sparx Systems Japan5.3

テンプレートの作成・編集

5.3.1 テンプレート編集画面
ファイル出力画面で「編集/新規」ボタンをクリックすると以下の画面が表示されます。
この画面ではテンプレートの作成・編集をすることができます。

7Copyright (c) 2017-2022 Sparx Systems Japan項目名

説明

出力情報

出力する情報（要素・接続）を選択します。

テンプレート名

新規作成時は、テンプレート名を入力してください。
編集時は、編集したいテンプレートを選択してください。
お客様独自の Excel ファイルをレイアウトとして利用したい場合は、「既存ファイルをレイアウトに利用する」のチェックを有効にしてください。テンプレート保存時に Excel ファイル選択画面が表示され、お客様独自の Excel ファイルを設定することができます。※新規作成時のみ利用可

ノート

テンプレートに関するメモを入力します。

出力対象情報出力対象情報の出力有無・出力セルを設定します。

データ開始セル

データ行の出力開始セルを設定します。
また、オプションとして、レイアウト要素にヘッダ行（項目名）の出力有無を設定できます。出力する場合、データ開始行-1 行目に出力されます。
※新規作成時のみ利用可※新規作成後、出力項目の追加・削除・順序変更してもExcel 上のヘッダ行は同期しませんのでご注意ください。

出力する種類

出力する種類を限定したい場合に設定します。
設定可能な文字列は、5.2 章の同項目をご参照ください。

検索条件「条件指定」ボタンをクリックして、要素の名前・ステレオタイプ・タグ付き値について条件を設定します。詳細は 5.3.2 章をご参照ください。

選択可能項目

出力可能な項目の一覧です。「出力項目」に設定されている項目は表示されません。タグ付き値も表示されませんが、「タグ付き値追加」ボタンよりタグ付
き値を「出力項目」に設定することができます。

出力項目

出力する項目の一覧です。

追加->ボタン「選択可能項目」で選択されている項目を「出力項目」に追加します。

<-削除ボタン「出力項目」で選択されている項目を「出力項目」から削除します。

タグ付き値

タグ付き値を「出力項目」に設定します。詳細は 5.3.3 章をご参照ください。

追加ボタン
↑↓ボタン

「出力項目」で選択されている項目の順序を変更します。

レイアウト要素にプロジェクトブラウザ上で該当テンプレートのレイアウト要素にフォーカスフォーカスボタンを当て、この画面を閉じます。Excel 上でレイアウト変更をしたい場合などに利用すると便利です。

新規ボタンテンプレートを新規作成するために画面を初期状態にします。

保存ボタン

表示内容でテンプレートを保存します。

別名保存ボタン

表示内容でテンプレートを別名保存します。

削除ボタン表示されているテンプレートを削除します。

閉じるボタン

この画面を閉じます。

8
Copyright (c) 2017-2022 Sparx Systems Japan

5.3.2 検索条件画面
テンプレート編集画面で「条件指定」ボタンをクリックすると以下の画面が表示されます。
この画面では、出力する要素の名前・ステレオタイプ・タグ付き値の条件を指定することができます。

項目名

説明

AND/OR

条件が複数の場合に、AND/OR を設定します。

一覧（項目）

条件指定したい項目を設定します。

一覧（タグ名）

タグ付き値の名前をリスト選択あるいは入力します。
※「タグ付き値」選択時のみ

一覧（条件）

値に対する条件として下記が自動表示されます。編集はできません。
「名前」選択時：含む（部分一致）「ステレオタイプ」選択時：同じ（完全一致）「タグ付き値」選択時
一覧（値）：含む（部分一致）

条件指定したい値を入力します。「ステレオタイプ」「タグ付き値」選択時は、リスト選択することもできます。「タグ付き値」選択時は、タグ付き値の値に対する検索条件となります。

9
Copyright (c) 2017-2022 Sparx Systems Japan

5.3.3 タグ付き値の追加画面
テンプレート編集画面で「タグ付き値追加」ボタンをクリックすると以下の画面が表示されます。
この画面では、出力したいタグ付き値を設定することができます。ここで設定すると「テンプレート編集」
画面の「出力項目」に「TaggedValue_xxxxx」のような項目が追加されます。

項目名

説明

対象タグ「タグ名」に表示する内容を指定します。
・「新規/使用中」：当該プロジェクトの要素あるいは接続が利用しているすべてのタグ名を「タグ名」に表示します。
・「選択要素」：「要素の指定」ボタンをクリックし、「要素の選択」画面で指定した要素が保持するタグ名を「タグ名」に表示します。
※「テンプレート編集」画面の「出力情報」で「要素」選択時のみタグ名出力するタグ名を選択します。
「接続」「ソース側の端」「ターゲット側の端」は、いずれが保持するタグ付き値を出力するかを指定します。
※「テンプレート編集」画面の「出力情報」で「接続」選択時のみ出力対象タグ付き値の値・ノートのいずれを出力するか選択します。

10
Copyright (c) 2017-2022 Sparx Systems Japan

5.3.4 テンプレートのレイアウト変更
作成したテンプレートのレイアウトは、お客様自身で以下のような変更をすることができます。
・ 書式の変更や罫線の追加
・ ヘッダ項目名の変更（ヘッダ項目名を直接編集）
・ 行の高さ、列の幅の変更 ※アドイン側で自動調整機能はありません
・ 固定出力する文字の追加 ※追加できないセルが一部あります
レイアウトの変更方法は以下のとおりです。
（アドインインストール時にサンプルテンプレートも登録されますので合わせてご確認ください）
1. 「テンプレート編集」画面でテンプレートを選択します。
2. 「レイアウト要素にフォーカス」ボタンをクリックします。
※プロジェクトブラウザ上で該当テンプレートのレイアウト要素の位置が分かる場合、上記 1,2 の手順は不要です。
3. 該当のレイアウト要素を右クリックして表示されるコンテキストメニューより「保護しているファイルを開く」を選択します。
4. 対象テンプレートの Excel が開きますので編集してください。
下図の赤枠のセルを移動しても、データ出力箇所は変更されませんのでご注意ください。

5. Excel の編集が終わりましたら Excel 上で保存します。
6. その後、Enterprise Architect 画面をクリックすると以下の画面が表示されますので「保存」を選択します。

※上記 5,6 のように、保存は Excel と Enterprise Architect のそれぞれで操作が必要です。

11
Copyright (c) 2017-2022 Sparx Systems Japan

6

特記事項

・ 出力対象の要素が同じタグ名を複数保持している場合、API で取得した 1 件のタグ付き値のみがExcel・CSV に出力されます。
・ ダイアグラム単位・ダイアグラム指定・ダイアグラム上の要素指定で接続を出力する場合、ダイアグラム上で非表示としている接続は Excel・CSV に出力されません。また、非表示接続の両端の要素については、当該接続がないものとして扱われます。
・ テーブルレイアウトの利用について・レイアウト要素の Excel でテーブルレイアウトを利用している場合、テーブルレイアウトのヘッダ位置とテンプレートで設定しているデータ開始セルの前行の位置が重なっていればテーブルレイアウトと見なし、テーブルレイアウトの最終行としてデータ行の最終行を設定します。
・新規テンプレートの作成において、テーブルレイアウトが設定されている Excel ファイル使って、「既存ファイルをレイアウトに利用する」とした場合、テンプレート編集画面で指定する「出力対象情報」「データ開始セル」がテーブルレイアウトのヘッダ行と重なると正しくレイアウト要素が作成できないことがあります。
※「データ開始セル」については、該当セルの行から 3 行分を示します。
・ 本製品は、アドバンスソフトウェア株式会社の著作物である「ExcelCreator 10.0 for .NET」を再配布条件に基づき使用しています。

12
Copyright (c) 2017-2022 Sparx Systems Japan

7

改訂履歴

日付

改訂内容

2017/06/26

・新規作成

2017/06/27

・1 章、記述修正
・4.3 章、既存テンプレートの項目変更に関する記述追加
・4.4 章、テンプレートのレイアウト変更に関する記述追加2017/07/04

・1 章、記述修正

2018/05/16

・バージョン 0.60 リリースに伴い、更新

2018/07/23

・バージョン 1.0.0.6 リリースに伴い、更新

2018/09/06

・1 章、記述修正

2019/08/07

・2 章、本アドインのインストールに関する記述を削除
・3 章、記述修正

2020/02/03

・旧バージョンに関する記述を削除
・2 章、EA バージョン・エディション、.NET に関する記述修正

2021/06/17

・バージョン 1.0.3 リリースに伴い、更新
・表紙、改訂履歴などの文言調整

2021/08/12

・バージョン 1.1.0 リリースに伴い、更新

2021/10/19

・バージョン 1.2.0 リリースに伴い、更新

2022/03/02

・バージョン 1.2.1 リリースに伴い、更新

2022/12/07

・タグ付き値の追加画面に関する記述追加
・動作環境や画面項目の説明などの文言調整

2022/12/12

・アドイン同時利用に関する説明を更新

2022/12/21

・バージョン 1.6.0 リリースに伴い、更新

以上

13
Copyright (c) 2017-2022 Sparx Systems Japan