Rational Publishing Engine によるRational Rhapsody レポート...

®

IBM Software Group

© 2010 IBM Corporation

Rational Publishing Engine によるによるによるによるRational Rhapsody レポートレポートレポートレポート作成作成作成作成ガイドガイドガイドガイド

IBM Software Group | Rational Software

1

®

このこのこのこのガイドガイドガイドガイドについてについてについてについて

�目的

�Rational Publishing Engine（RPE）の概要を理解する。

�RPEによるRational Rhapsodyレポート（Word形式）の基本的な作成手順を理解する。

�対象者の前提

�Rhapsodyの使用経験・知識があること。

�ソフトウェア環境

�Rational Publishing Engine 1.1.1.2

�Rational Rhapsody 7.5.2

�Microsoft Word 2002


2

®

目次目次目次目次

� Rational Publishing Engine（RPE）概要

� RPEドキュメント・スタジオでの作業

� RPEランチャーでの作業

� RPEによるRhapsodyレポート発行の流れ

� ドキュメント・テンプレートの作成

�表紙の作成

� マスター・ページの作成と適用

�目次の追加

� ユースケース図の抽出

�パッケージ情報の抽出

� レポートの発行

�参考情報

�付録

�付録1. タグ情報の抽出

�付録2. 再帰のしくみ


3

®

�Rational Publishing Engine（RPE）は、Rational製品および一部の3rdパーティ製品から複数形式のレポートを自動的に作成するためのアプリケーションです。

�RPEには以下の２つのアプリケーションが含まれています。�RPE ドキュメントドキュメントドキュメントドキュメント・・・・スタジオスタジオスタジオスタジオ

用途：ドキュメント・テンプレートの編集

�RPE ランチャーランチャーランチャーランチャー

用途：文書仕様の編集およびレポートの発行

※このガイドではIBM Rational RhapsodyからMS Word形式のレポートを出力する方法について説明します。

Rational Publishing Engine （（（（RPE））））概要概要概要概要

RationalRationalRationalRational

PublishingPublishingPublishingPublishing

EngineEngineEngineEngine

IBM Rational DOORS

RESTRESTRESTREST対応対応対応対応アプリケーションアプリケーションアプリケーションアプリケーションex) IBM Rational Rhapsodyex) IBM Rational Rhapsodyex) IBM Rational Rhapsodyex) IBM Rational Rhapsody

HTML

PDF

データ・ソース

XSL-FO

レポート出力

・・・

IBM Rational Tau

MS WordMS WordMS WordMS Word


4

®

RPEドキュメントドキュメントドキュメントドキュメント・・・・スタジオスタジオスタジオスタジオでのでのでのでの作業作業作業作業

�レポートの構成を定義するドキュメントドキュメントドキュメントドキュメント・・・・テンプレートテンプレートテンプレートテンプレート（（（（.dta））））を作成します。

�ドキュメント・テンプレートには以下の情報が含まれます。

�段落、テキスト、テーブルなどのレポート構成要素の配置

�データ・ソース（Rhapsodyプロジェクト）から情報を抽出するためのクエリー

ドキュメントドキュメントドキュメントドキュメント・・・・スタジオスタジオスタジオスタジオ・・・・エディターエディターエディターエディタービュービュービュービューレポート構成要素の追加 / 編集を行います。

データデータデータデータ・・・・ソースソースソースソース・・・・スキーマスキーマスキーマスキーマビュービュービュービュー実在のデータ・ソースではなくスキーマを利用してクエリーを定義することでドキュメント・テンプレートの再利用性が高まります。


5

®

RPEランチャーランチャーランチャーランチャーでのでのでのでの作業作業作業作業

�発行する文書について定義する文書仕様文書仕様文書仕様文書仕様（（（（.dsx））））の作成を行い、レポートを発行します。

�文書仕様には以下の情報が含まれます。

�レポート出力形式（複数指定可）

�ドキュメント・テンプレート（複数指定可）

文書仕様文書仕様文書仕様文書仕様ビュービュービュービュー出力形式 / ドキュメント・テンプレートを指定します。

複数のドキュメント・テンプレートを指定すると、それらを結合したレポートを発行することができます。

出力形式出力形式出力形式出力形式のののの指定指定指定指定

ドキュメントドキュメントドキュメントドキュメント・・・・テンプレートテンプレートテンプレートテンプレートのののの指定指定指定指定


6

®

Rational Publishing EngineRational Publishing EngineRational Publishing EngineRational Publishing Engine

RPEによるによるによるによるRhapsodyレポートレポートレポートレポート発行発行発行発行のののの流流流流れれれれ

.doc

MS Wordレポート

RPE ドキュメントドキュメントドキュメントドキュメント・・・・スタジオスタジオスタジオスタジオ・ドキュメント・テンプレートの作成

RPE ランチャーランチャーランチャーランチャー・文書仕様の作成・レポートの発行

データデータデータデータ・・・・ソースソースソースソース（Rational Rhapsody）

（※1 ）RPE用のデータ・ソース・スキーマファイルは Rhapsody のインストール・ディレクトリに用意されています。

データ・ソース・スキーマ（※１）

レポートレポートレポートレポート発行発行発行発行

ドキュメントドキュメントドキュメントドキュメント・・・・テンプレートテンプレートテンプレートテンプレート

指定

指定

データデータデータデータのののの抽出抽出抽出抽出

.xsd

.dta

文書仕様文書仕様文書仕様文書仕様.dsx

RPEを用いてWord形式のレポートを発行する流れを表した図です。


7

®

ドキュメントドキュメントドキュメントドキュメント・・・・テンプレートテンプレートテンプレートテンプレートのののの作成作成作成作成

ドキュメント・テンプレートの基本的な作成手順を示します。

�手順一覧

�ドキュメント・スタジオの起動

�ドキュメント・テンプレートの保存

�データ・ソース・スキーマの追加

�表紙の作成

�マスター・ページの作成

�目次の追加

�ユースケース図の抽出

�パッケージ情報の抽出（表形式での表示）

⇒手順の詳細は次のページ以降で説明します。

※当ガイドでは、レポート発行対象のプロジェクトとして、 Rhapsodyのサンプル・プロジェクトである「DishWasher」を想定しています。ただし、ドキュメント・テンプレートは対象プロジェクトを限定するものではないため、この手順で作成するテンプレートを使用して、他のプロジェクトのレポートを発行することも可能です。


8

®

ドキュメント・テンプレートの作成

ドキュメント・スタジオの起動

� RPE ドキュメント・スタジオを起動します。

� デスクトップ上のショートカットをダブルクリックする。（または<RPEインストールディレクトリ>¥studio¥rpe-studio.exeを実行）

� 「Welcome」画面を閉じる。

� 「RPE Studio」パースペクティブが選択されていることを確認する。


9

®

� エディターに新規のドキュメント・テンプレートが開いている状態となります。２つのタブがありますが、通常はTemplate Contentタブで作業します。

� 新規ドキュメント・テンプレートを保存します。

� File > Save を選択する。

� ファイルを保存する。（ファイル名は任意）


ドキュメント・テンプレートの保存

Zoom Editor では、テンプレート内の要素を一部抜き出して作業することが可能です。テンプレートの構成が複雑になってきた場合に便利です。


10

®


データ・ソース・スキーマの追加（1/3）� Rhapsodyプロジェクトからデータを抽出するためのデータ・ソース・スキーマを追加します。

� Data > Add Data Source Schema…を選択して、ウィザードを開始する。

� 「Next」をクリックする。


11

®


データ・ソース・スキーマの追加（2/3）�以下の情報を入力し、「Next」をクリックする。

� Schema type ：REST

� Schema file ：<Rhapsodyインストールディレクトリ>/RPE/Schemas/Default.xsd

� Data Source ID：⇒ 任意のID （例：Rhapsody_ds）

�サマリーを確認し、「Finish」をクリックする。


12

®


データ・ソース・スキーマの追加（3/3）�データ・ソース・スキーマビューに追加したスキーマが表示されます。

Rhapsody プロジェクトとの対応例


13

®


表紙の作成（1/9）

RPE - Rhapsody サンプル・レポート

DishWasherRhapsodyのプロジェクト名を抽出

シンプルなテキスト

� レポートの表紙となるページの定義を行います。

このセクションでは2種類のテキスト表示方法とプロパティの変更について説明します。

� シンプルなテキストの表示

� クエリーで抽出したデータの表示

表紙のイメージ

ページ中央に配置


14

®


表紙の作成（2/9）� テンプレートに Paragraph を配置します。� エディター上で右クリックし、メニューから Insert > Paragraphを選択する。

【補足】パレットビューを使用して要素を配置することもできます

パレットで要素を選択した状態で、エディター上でクリックする


15

®


表紙の作成（3/9）� Paragraph の中に Text を配置します。� 前のページで追加したParagraphを右クリックし、 Insert > Textを選択する

※Paragraphはこのように他の要素を格納するプレースホルダーとしての役割を持ちます。Textを単体で配置することも可能ですが、文字をページ中央に配置するためにはParagraphに格納してプロパティの設定を行う必要があります。

※Paragraphの先頭には「改行」が入ります。


16

®


表紙の作成（4/9）� Textに表示する値をセットします。� TextをダブルクリックしてSet Content For Current Elementダイアログを開く。

� Simple Valueタブに“RPE – Rhapsody サンプル・レポート”と入力してOKをクリックする。

※Set Content For Current Element ダイアログでは、３つの方法で値をセットすることができます。

�Simple Value ：テキストを直接入力

�Data Expression ：データ・ソース・スキーマの属性および変数を指定

�Script Expression ：Javaスクリプトを用いて値を算出


17

®


表紙の作成（5/9）� 文字を斜体にするため、プロパティビューを用いてText のプロパティを変更します。� Textを選択した状態で、Formatting > font > italicの値をtrueに変更する。

エディターで選択した状態で操作する

プロパティの入力欄にカーソルをあてると、プロパティについての説明が表示されます

プロパティを変更した箇所にはアスタリスク（＊）が表示されます


18

®


表紙の作成（6/9）� テキストをページ中央に配置するため、Paragraph のプロパティを変更します。� Formatting > spacing > before spacing ： 300 （縦位置調整）

� Formatting > alignment > paragraph alignment ： center （横位置調整）


19

®


表紙の作成（7/9）� Rhapsodyのプロジェクト名を表示するためのParagraphとTextを配置します。� 前の手順と同様にParagraphの中にTextを配置する。

� Paragraphにクエリーをセットします。� データ・ソース・スキーマビューからProjects > Project(Project)をドラッグ＆ドロップする。

※Paragraph内に格納されるすべての要素で Projects > Project（Project）直下の属性を利用可能となります。Text に直接クエリーを設定することも可能です。


20

®


表紙の作成（8/9）� Text にRhapsodyのプロジェクト名を表示するための設定を行います。� Text をダブルクリックしてSet Content For Current Elementダイアログを開く。

� Data Expressionタブを開く。

� Attributes > $1-Projects/Project > nameを選択してOKをクリックする。


21

®


表紙の作成（9/9）� Text のプロパティを変更してフォントを太字にします。� Formatting > font > bold ：true

� Paragraphのプロパティを変更して表示位置を調整します。� Formatting > alignment > paragraph alignment ： center

以上で表紙の作成の手順は終了です。テンプレートは以下のようになります。


22

®


【参考】プロパティの設定

� プロパティビューで値を直接入力することもできますが、ダイアログを使用することも可能です。

データ・ソース・スキーマの属性および変数、スクリプトによって値を設定することも可能です。

設定可能な値が表示されます。

プロパティビュー内のボタンをクリック


23

®


【【【【参考参考参考参考】】】】ParagraphととととContainer�Paragraphと似た働きをするContainerという要素があります。

ParagraphもContainerも同様に他のRPE要素のプレースホルダーとしての役割を果たしますが、以下のような違いがあります。

�Paragraph の場合、スタイルや配置などの多くのプロパティ指定が可能。

�Paragraph の場合、先頭に「改行」が入る。

空のContainerを配置した場合 ⇒レポートには何も出力もされない空のParagraphを配置 ⇒レポートには空の行が挿入される

=====================

=====================

=====================

出力のイメージ

Paragraphによって空の行が挿入される


24

®


マスター・ページの作成（1/13）

RPE-Rhapsody Sample Report DishWasher

- ページ番号 -

� マスター・ページを作成し、ヘッダー / フッターを定義します。

� ヘッダー

� 左部分にはシンプルなテキスト、右側にはプロジェクト名を表示する

� アンダーラインを入れる

� フッター

� ページ番号を表示する

ヘッダーヘッダーヘッダーヘッダー

フッターフッターフッターフッター


25

®


マスター・ページの作成（2/13）� マスター・ページを追加します。

� メニューから Master Pages > New Master Page...を選択する。

� Nameに“MP_sample”と入力してOKクリックする。

用紙の向き、サイズを指定することができます。ここでは Portrait （縦）の設定のままとします。


26

®


マスター・ページの作成（3/13）� エディター上にマスター・ページ編集用のタブが追加されたことを確認してください。

※マスター・ページではHeader / Footer 内部のみ編集可能となっています。


27

®


マスター・ページの作成（4/13）� テーブルを利用してヘッダーの定義を行います。

� Header に Table を配置します。� Header を右クリックして、Insert > Table を選択する。

� New Table ダイアログで、rows を“1”、をcolumns を “2” に設定してOKをクリックする。

（セルの下側の線だけ表示）

DishWasherRPE-Rhapsody Sample Report ＜左寄せ右寄せ＞

テーブルの幅はページに合わせる


28

®


マスター・ページの作成（5/13）� テーブルのプロパティを変更して、サイズの自動調整を指定します。

� Table を選択して、以下のプロパティを変更する。

� Formatting > Specific > table auto fit ：autofit to window


29

®

�左のセルにテキストを追加します。

�左のCell を右クリックして、 Insert > Text を選択する。

�Textをダブルクリックして Set Content for Current Element ダイアログを開く。

�Simple Value タブに “RPE-Rhapsody Sample Report” と入力し、OKをクリックする。




30

®

�セルのプロパティを変更して、テキストの表示位置およびセル幅を調整します。

�左のCellを選択し、以下のプロパティを変更する。

� Formatting > Specific > cell alignment ：center left

� Formatting > Specific > cell width ：600に変更



※テーブルのサイズ調整を autofit to window に設定している場合、Wordの仕様上、最も右に位置するセルが最大になるよう自動調整されます。ここでは左側のセルに適切は幅を持たせるため、cell widthを設定しています。


31

®

�右のセルにRhapsodyのプロジェクト名を表示するための設定を行います。マスター・ページではクエリーを使用することができないため、変数を利用します。

�Data > New Variable… を選択し、New Variable ダイアログを開く。

�Nameを”ProjectName”としてOKをクリックする。



Access設定internal ：ドキュメント・テンプレート内で使用可能external ：ドキュメント・テンプレート内および文書仕様にて使用可能

※この時点では ProjectName の値はブランクとなっています。後の手順で値をセットします。


32

®

�右のCellに変数の値を表示するためのText を追加します。�右のCell を右クリックして、 Insert > Text を選択する。

�Textをダブルクリックして Set Content for Current Elementダイアログを開く。

�Data Expression タブで Variables > ProjectName を選択し、OK をクリックする。




33

®

�セルのプロパティを変更して、テキストの表示位置を調整します。

�右のCellを選択し、以下のプロパティを変更する。

� Formatting > Specific > cell alignment ：center right




34

®

�ヘッダーにアンダーラインを引くため、Table のプロパティを変更します。�Table を選択し、以下のプロパティを変更する。

� Formatting >cell border >cell border color >all cell borders color ：ブランク

� Formatting >cell border >cell border color >bottom cell border color ：000000

� Formatting >cell border >cell border style >all cell borders style ：ブランク

� Formatting >cell border >cell border style >bottom cell border style ：single

� Formatting >cell border >cell border width >all cell borders width ：ブランク

� Formatting >cell border >cell border width >bottom cell border width：1




35

®

�フッターにページ番号を表示するための設定を行います。

�Footer を右クリックし、Insert > Paragraph を選択する。

�Paragraph を右クリックし、Insert > Text を選択する。

�Paragraph を右クリックし、Insert > Page Number を選択する。

�Paragraph を右クリックし、Insert > Text を選択する。

�両サイドのText に “ - ” （ハイフン）が表示されるよう設定する。（ Set Content For Current Element ダイアログの Simple Value タブを利用する。）



はじめに追加したText最後に追加したText ページ番号


36

®

�ページ番号が中央に表示されるよう、プロパティを変更する。

�Paragraph を選択し、以下のプロパティを変更する。

� Formatting > alignment > paragraph alignment ：center




37

®

�作成したマスター・ページをテンプレート本体に適用します。

�テンプレート本体を編集するため、エディターのTemplate Content タブを選択する。

�下の余白を右クリックし、 Insert > Container を選択する。


マスター・ページの適用（1/6）


38

®

�Container に対して、マスター・ページの設定を行います。

�Container を選択し、以下のプロパティを変更する。

� Formatting > common > masterpage ：MP_sample



マスター・ページを設定するとアイコンが表示されます


39

®

�マスター・ページで使用している変数 ProjectNameにRhapsodyプロジェクト名を設定するため、Container にクエリーをセットします。

�データ・ソース・スキーマビューからProjects > Project(Project) をドラッグ＆ドロップする。




40

®

�変数 ProjectNameに値をセットします。�Container を右クリックし、 Data > Edit Assignment...を選択します。

�Assignment Editor ダイアログで Add をクリックする。

�Select VariableダイアログでProjectName を選択して OK をクリックする。




41

®

�Set Assignment for Current Element ダイアログで Data Expression タブを開く。

�Attributes > $2 Projects/Project > name を選択して OK をクリックする。




42

®

�Assignments Editor ダイアログで設定した内容を確認し、OK をクリックする。



以上でマスター・ページの適用手順は終了です。マスター・ページを設定した箇所に改ページが挿入され、以降のページにヘッダー / フッターが表示されます。

Assignmentsを設定するとアイコンが表示されます


43

®

�レポートに目次を追加します。


目次の追加(1/2)


44

®

�テンプレートにTable of Contents を配置し、プロパティを変更します。�エディター上で右クリックし、Insert > Table of Contents を選択する。

�Table of Content を選択し、以下のプロパティを変更する。

（見出し３までを目次として表示するよう設定）

� Formatting > toc item > level ：3

�Table of Contents の下に、改ページ（Page Break）を追加します。�余白を右クリックし、Insert > Page Break を選択する。


目次の追加(2/2)


45

®

�ユースケース図を表示するセクションを作成します。Dishwasher プロジェクトにはユースケース図がひとつ含まれています。


ユースケース図の抽出（1/11）

セクションのタイトル（見出し１）

ユースケース名（見出し２）

ユースケース図

図のキャプション


46

®


ユースケース図の抽出（2/11）�セクション全体を格納するための、Container を配置します。�Page Break の下の余白を右クリックし、Insert > Container を選択する。

�Container にクエリーをセットします。�データ・ソース・スキーマビューから

Projects > Project > Usecase Diagrams をドラッグ&ドロップする。

※仮にプロジェクトにユースケース図がない場合、クエリー結果はnullとなり、Containerの内部の要素は出力されません。


47

®

�セクションのタイトルを表示するためのTextを配置し、値をセットします。�Container を右クリックして、Insert > Text を選択する。

�Text をダブルクリックして Set Content for Current Element ダイアログを開く。

�Simple Value タブに “ユースケース図” と入力し、OKをクリックする。

�Textのプロパティを変更します。�Text を選択し、プロパティビューで以下のプロパティを変更する。

� Formatting > common > style name ：1（Text を右クリックし、 Style > Heading Styles で選択することも可能）



スタイルを設定するとアイコンが表示されます


48

®

�Paragraph を配置し、クエリーをセットします。�前の手順で作成したContainer 右クリックし、Insert > Paragraph を選択する。

�データ・ソース・スキーマビューからProjects>Project>Usecase Diagrams>Usecase Diagram をドラッグ&ドロップする。

�Select Context ダイアログでOK をクリックする。



※クエリーのコンテキスト設定については後の手順で解説します。


49

®

�ParagraphにTextを配置し、ユースケース名を表示するよう値をセットします。�前の手順で追加した Paragraph に Text を配置し、プロパティを変更する。

� Formatting > common > style name ：2

�Set Content for Current Element ダイアログのData Expression タブを開き、以下を選択してOKをクリックする。

Attributes > $4 Projects/Project/UseCaseDiagrams/UseCaseDiagram > name




50

®

�ユースケース図を表示するため、Paragraph を配置し、クエリーを追加します。�前の手順で追加した Paragraph を右クリックし、Insert > Paragraph を選択する。

�図をページ中央に表示するよう、Paragraph のプロパティを変更する。

� Formatting > alignment > paragraph alignment ： center

�データ・ソース・スキーマビューから下記クエリーをドラッグ＆ドロップする。

Projects>Project>Usecase Diagrams>Usecase Diagram>Pictures>Picture



Text の下に配置するため、Paragraphの下部で右クリックする。


51

®

�Select Context ダイアログで $4 のクエリーを選択してOK をクリックする。



親要素を持つ要素に対してクエリーをドラッグすると、ドラッグしたクエリーが親要素のクエリーをコンテキストとして実行可能かが判断され、コンテキストとして指定可能なクエリーがSelect Contextダイアログに表示されます。親要素のクエリーをコンテキストとして指定することで、クエリーをネスト化することができます。

ここでは、$4 のクエリーで抽出したユースケース図に付随するイメージを取得する必要があるため、 $4をコンテキストとして設定します。

ネスト化される


52

®

�ParagraphにImage を配置します。�Paragraphを右クリックし、Insert > Image を選択する。

� Image をダブルクリックする。




53

®

�Data Expressionタブを開き、以下を選択してOKをクリックする。



Attirbutes > $5-Projects/Project/UsecaseDiagrams/UseCaseDiagram/Pictures/Picture > path


54

®

�図にキャプションを追加します。

� Image の下に Paragraph を配置し、Paragraph 内にFigure Caption を配置する。

�Figure Caption をダブルクリックし、Set Field Label Value ダイアログを開く。

�Script Expression タブの左側で $4のクエリーのname にチェックを入れる。

�Script Expression タブの右側に以下のスクリプトを記述する。

"ユースケース図(" + name + ")"



スクリプト内で使用する変数や属性にはチェックを入れる必要があります。変数や属性を、左側から右側にドラッグ＆ドロップすることも可能です。


55

®

以上でユースケース図を表示するセクションの作成手順は終了です。

これまでに作成したテンプレートは以下のようになります。



ユースケース図抽出の部分


56

®

�パッケージ情報を表示するセクションを作成します。パッケージごとに、クラスの情報（操作一覧）を表形式で表示します。


パッケージ情報の抽出（1/9）

セクションのタイトル（見出し１）

パッケージ名（見出し２）

クラスの操作一覧表

クラス名（見出し３）


57

®

�セクション全体を格納するための、Container を配置します。�Page Break の下の余白を右クリックし、Insert > Container を選択する。

�Container にクエリーをセットします。�データ・ソース・スキーマビューから

Projects > Project > Packages をドラッグ&ドロップする。

�セクションのタイトルを表示するための Text を配置し、値をセットします。�Container を右クリックして、Insert > Text を選択する。

�Text をダブルクリックして Set Content for Current Elementダイアログを開く。

�Simple Value タブに “パッケージ” と入力し、OKをクリックする。

�Textのプロパティを変更します。�Text を選択し、プロパティビューで以下のプロパティを変更する。





58

®

�Paragraph を配置し、クエリーをセットします。�前の手順で作成した Container 右クリックし、Insert > Paragraph を選択する。

�データ・ソース・スキーマビューからProjects > Project > Packages > Package をドラッグ&ドロップする

�Select Context ダイアログでOK をクリックする。

�ParagraphにTextを配置し、パッケージ名を表示するよう値をセットします。�前の手順で追加した Paragraph に Text を配置し、プロパティを変更する。


�Set Content for Current Element ダイアログのData Expression タブを開き、以下を選択してOKをクリックする。

Attributes > $7 Projects/Project/Packages/Package > name




59

®

�クラスの情報を表示するため、Paragraph を配置し、クエリーを追加します。�前の手順で追加した Paragraph 下部を右クリックし、Insert > Paragraph を選択する。


Projects > Project > Packages > Package > Classes > Class


�ParagraphにTextを配置します。�前の手順で追加した Paragraph に Text を配置し、プロパティを変更する。





60

®

�Text にクラス名を表示するよう値をセットします。�Set Content for Current Element ダイアログを開く。

�Script Expression タブの左側で $8のクエリーのname にチェックを入れる。

�Script Expression タブの右側に以下のスクリプトを記述し、OKをクリックする。

name + "クラス"




61

®

�操作一覧表を表示するための Paragraph と Table を配置する。�前の手順で配置した Text の下に Paragraph を配置する。


Projects > Project > Packages > Package > Classes > Class > Operations


�Paragraph を右クリックし、Insert > Table を選択する。

�New Table ダイアログで rows： 2 、colums：2 として OK をクリックする。




62

®

�Table のプロパティを変更する。

� Formatting > Specific > table auto fit ：autofit to window

�Table 内の全ての Cell に Text を配置する。

�１行目に表示する値をセットする。（ Set Content for Current Element ダイアログのSimple Value タブを使う）

� 左Cell のText ：操作名

� 右Cell のText ：説明

�上のRowのプロパティを変更する。

� Formatting > Font > bold ： true




63

®

�２行目以降にRhapsodyから操作名と説明を抽出して表示します。�２つ目のRowに以下のクエリーをドラッグ＆ドロップする。

Projects > Project > Packages > Package > Classes > Class > Operations > PrimitiveOperation


�表示する値をセットする。（ Set Content for Current Element ダイアログのData Expression タブを使う）

� 左のText ： Attributes > $10 - Projects/Project・・・/PrimitiveOperation > name

� 右のText ： Attributes > $10 - Projects/Project・・・/PrimitiveOperation > descriptionText




64

®

以上でパッケージ情報を表示するセクションの作成手順は終了です。

このセクションのテンプレートは以下のようになります。



$10のクエリーで抽出される操作の分、繰り返し表示されます。


65

®


【【【【参考参考参考参考】】】】クエリークエリークエリークエリーののののネストネストネストネスト化化化化についてについてについてについて

例えば「パッケージごとのクラス一覧」を表示するには、クエリーのネスト化が必要です。ネスト化をした場合としない場合の出力を比較してください。

Rhapsodyプロジェクトの構成 RPEドキュメント・テンプレート

Package01class_Aclass_B

Package02class_C

■ネスト化した場合の出力

パッケージごとにクラスが表示される

Package01class_Aclass_Bclass_C

Package02class_Aclass_Bclass_C

■ネスト化しない場合の出力

パッケージに関わらずすべてのクラスが表示される

コンテキストとして指定


66

®

レポートレポートレポートレポートのののの発行発行発行発行

レポート発行の手順を示します。

� 手順一覧手順一覧手順一覧手順一覧

� 事前準備

� Rhapsodyを起動し、レポート発行対象のプロジェクトを開く

� Rhapsody Web サーバーを起動する

� 文書仕様の作成

� 「RPEランチャー」パースペクティブを開く

� データ・ソースの構成

� ドキュメント・テンプレートの設定

� Word出力プロパティ

� レポートを発行し、内容を確認する。

⇒手順の詳細は次のページ以降で説明します。


67

®

レポートの発行

事前準備

� レポート発行の対象とするRhapsodyプロジェクト(DishWasher) を開きます。<Rhapsodyインストールフォルダ>¥Samples¥CppSamples¥Dishwasher¥Dishwasher.rpy

� Rhapsody サーバーを起動します。� <Rhapsodyインストールフォルダ>¥ApplivationServer¥startserver.bat を実行する。

Rhapsody サーバーにアクセスするためのURLが表示されます。http://localhost:27463/Rational/Rhapsody


68

®


文書仕様の作成（1/5）

� 文書仕様の作成は、RPEランチャーを用いて行います。

RPEランチャーはスタンドアロンのアプリケーションとして提供されていますが、ここではRPEドキュメント・スタジオの「RPE ランチャー」パースペクティブで作業します。

� パースペクティブを切り替える。

「RPEランチャー」タブをクリック


69

®



� 「RPEランチャー」パースペクティブでは、新規の文書仕様が開いています。文書仕様の編集は文書仕様ビューで行います。

テンプレートで利用しているデータ・ソース・スキーマが表示されます。

RPE Studioパースペクティブで編集中のテンプレートが指定されています。

利用する出力形式を指定します。デフォルトで全ての形式が含まれているので、不要なものは削除します。

テンプレート内にアクセス指定が”external”となっている変数がある場合、ここで値を設定することができます。


70

®



� 不要な出力形式を削除します。

� Word 以外の形式を右クリックし、「出力の削除…」を選択する。

※Word以外の出力内容も確認したい場合には、削除をしなくても構いません。


71

®



� Word形式の出力について、プロパティを設定します。� Target: Word を選択し、以下のプロパティを変更する。

� path ：任意のパス（レポートの出力先）

� stylesheet ：<RPEインストールディレクトリ>¥utils¥word¥rpe.dot

� macro ：rpe

Wordのテンプレートを指定しています。rpe.dotは、RPEレポート出力の際に便利なマクロを含むWordテンプレートです。見出しの書式設定もされています。

RPEレポート出力の際に実行するマクロを指定しています。このマクロには、目次を表示するための「フィールドの更新」などが含まれます。マクロを実行しない場合、出力したWord文書にて手動で「フィールドの更新」を行うまで、目次は表示されません。レポート出力と同時にマクロを実行するには、RPEのホストにMicrosoft Wordがインストールされている必要があります。

データ・ソースにアクセスするために認証が必要な場合に値を設定します


72

®



� データ・ソースの構成を行います。

� Rhapsody_ds - RESTを右クリックし、「データ・ソースの構成…」を選択する。

� 「REST データ・ソースの構成」ダイアログで、Rhapsody サーバーにアクセスするためのURLを入力し、OKをクリックする。

� URL ： http://localhost:27463/Rational/Rhapsody

データ・ソースにアクセスするために認証が必要な場合に値を設定します


73

®



� 文書仕様を保存します。

� メニューから File > Save を選択する。

� 任意の名前をつけて文書仕様を保存する。

� レポートを発行します。

� メニューから「文書仕様」 > 「現行文書の生成」を選択する。

※「現行文書の生成」ボタンから実行することも可能です。


74

®


レポートの確認

� 出力されたレポートを開いて内容を確認してください。

� 結果ダイアログに表示されるリンクをクリックし、Word文書を開く。


75

®

以上で,RPEによるRhapsodyレポート作成の基本手順の説明は終了です。

参考用に、ガイド内で作成した成果物を添付します。

�ドキュメント・テンプレート：Sample.dta

�文書仕様：Sample.dsx

�出力されたWord文書：sample.doc


76

®

参考情報参考情報参考情報参考情報リンクリンクリンクリンク

� Rational Publishing Engine Information Centerhttp://publib.boulder.ibm.com/infocenter/rpehelp/v1r1m1/index.jsp

� IBM DeveloperWorks� Forum：Rational Publishing Engine (including Telelogic DocExpress)

http://www.ibm.com/developerworks/forums/forum.jspa?forumID=1512&start=0

� Rational Publishing Engine (RPE) Community Wikihttp://www.ibm.com/developerworks/wikis/display/rpe/Home


77

®

付録付録付録付録

�付録１．タグ情報の抽出

�付録２．再帰のしくみ


78

®

タグを利用してモデルに独自の情報を付加している場合、

スクリプトを使うことにより、特定のタグの情報を抽出することができます。

付録付録付録付録１１１１．．．．タグタグタグタグ情報情報情報情報のののの抽出抽出抽出抽出

if (name == "uc_number"){ value }

クエリークエリークエリークエリー：：：： Tags/Tag （（（（コンテキストコンテキストコンテキストコンテキスト：：：：$1））））

タグの名前が uc_number の場合のみ値を表示するスクリプトを記述します。

uc_number という名前のタグの情報を表示するには・・

Rhapsodyプロジェクト

データ・テンプレート記述例


79

®

付録１．タグ情報の抽出

スクリプトスクリプトスクリプトスクリプトのののの記述方法記述方法記述方法記述方法

�Set Content for Current Element ダイアログに以下のように記述します。

スクリプト内で使用する属性にチェックを入れる

Script Expressionタブを開く

スクリプトを記述する


80

®

付録付録付録付録２２２２．．．．再帰再帰再帰再帰のしくみのしくみのしくみのしくみ

入れ子状態で同じ構造の繰り返しがあり、それぞれの階層の情報を表示する必要がある

場合、「再帰」のしくみを利用してデータ・テンプレートの記述を簡略化することができます。

再帰を利用するには、データを表示する Paragraph（もしくはContainer）に対して以下の２つのプロパティを設定します。

�Recursive Segment 繰り返し部分に含まれる階層の数

�Recursive Level 繰り返しの数

下のようなRhapsodyプロジェクトの場合、Packages/Packageという構造（2階層）が４回繰り返されるため、再帰を使ってすべてのパッケージの情報を抽出するには Recursive Segmentの設定を 2 、Recursive Level の設定を 4 とします。

PackagesPackage

PackagesPackage

PackagesPackage

PackagesPackage

Recursive Segment = 2

Recursive Level = 4


81

®

付録２．再帰のしくみ

データデータデータデータ・・・・テンプレートテンプレートテンプレートテンプレート記述例記述例記述例記述例

Paragraphのプロパティ

※ 再帰を使用する場合、Paragraphのクエリーは親クエリーのコンテキストに属している必要があります。

Level1Level2Level3Level4

前ページのRhapsodyプロジェクトの

レポートを出力した場合

パッケージ名を表示

Paragraph に $1Projects/Project をコンテキストとしたクエリー（Packages/Package ）を適用（※）


82

®

Disclaimer

�この資料に含まれる情報は可能な限り正確を期しておりますが、日本アイ・ビー・エム株式会社ならびに日本アイ・ビー・エムシステムズ・エンジニアリング株式会社の

正式なレビューを受けておりません。

当資料は、資料内で説明されている製品の仕様を保証するものではありません。

�この資料の内容は2011年1月現在の情報であり、製品の新しいリリース、PTFなど

によって動作、仕様が変わる可能性がありますのでご注意下さい。

Rational Publishing Engine によるRational Rhapsody レポート...

Documents

Transcript of Rational Publishing Engine によるRational Rhapsody レポート...