caliberrm sdk programmer's guide

CaliberRM™

SDK プログラマーズガイド

Borland Software Corporation は、本書に記載されているアプリケーションに対する特許を取得または申請している場合があります。適用される特許については、製品 CD または［バージョン情報］ダイアログボックスを参照してください。本書の提供によって、これらの特許に関するいかなる権利も使用者に付与されるものではありません。

Copyright (c) 1997-2006 Borland Software Corporation およびその関連会社。 Borland のブランド名および製品名はすべて、米国 Borland Software Corporation の米国およびその他の国における商標または登録商標です。その他の商標は、その所有者に帰属します。

CRM06-SDKPG2006 年 11 月

i

目次

第 1 章はじめに 1CaliberRM SDK . . . . . . . . . . . . . . . . . . . . . . . 1トレーサビリティアドインテクノロジー . . . . . . . 1その他の情報 . . . . . . . . . . . . . . . . . . . . . . . . 2

第 2 章Visual Basic を使用した SDK アプリケーションの記述 3はじめに . . . . . . . . . . . . . . . . . . . . . . . . . . 3IDE の設定 . . . . . . . . . . . . . . . . . . . . . . . . . 3CaliberRM ライブラリの初期化 . . . . . . . . . . . . . 4CaliberRM Server への接続 . . . . . . . . . . . . . . . . 5セッションの使用 . . . . . . . . . . . . . . . . . . . . . 6CaliberRM オブジェクトの作成 . . . . . . . . . . . . . 6CaliberRM オブジェクトの変更 . . . . . . . . . . . . . 7CaliberRM オブジェクトの削除 . . . . . . . . . . . . . 8要件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

要件の作成 . . . . . . . . . . . . . . . . . . . . . . . 8属性と属性値 . . . . . . . . . . . . . . . . . . . . . . 9リスト属性値 . . . . . . . . . . . . . . . . . . . . . 11属性値の設定 . . . . . . . . . . . . . . . . . . . . . 13要件の説明 . . . . . . . . . . . . . . . . . . . . . . 14ドキュメント参照 . . . . . . . . . . . . . . . . . . 15責任者 . . . . . . . . . . . . . . . . . . . . . . . . . 16履歴 . . . . . . . . . . . . . . . . . . . . . . . . . . 17ディスカッション . . . . . . . . . . . . . . . . . . 19要件ツリー . . . . . . . . . . . . . . . . . . . . . . 20

トレーサビリティ . . . . . . . . . . . . . . . . . . . . 23トレースの取得 . . . . . . . . . . . . . . . . . . . . 24要件間のトレースの作成 . . . . . . . . . . . . . . 24非要件ソフトウェアの成果物へのトレースの作成 25トレースの削除 . . . . . . . . . . . . . . . . . . . . 26

第 3 章Java を使用した SDK アプリケーションの記述 27はじめに . . . . . . . . . . . . . . . . . . . . . . . . . 27CaliberServer オブジェクトの作成 . . . . . . . . . . . 27セッションの使用 . . . . . . . . . . . . . . . . . . . . 29CaliberRM Java SDK の慣例 . . . . . . . . . . . . . . . 29CaliberRM オブジェクトの作成 . . . . . . . . . . . . 30CaliberRM オブジェクトの変更 . . . . . . . . . . . . 30CaliberRM オブジェクトの削除 . . . . . . . . . . . . 31要件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

要件ツリー . . . . . . . . . . . . . . . . . . . . . . 31要件の作成 . . . . . . . . . . . . . . . . . . . . . . 35要件の属性 . . . . . . . . . . . . . . . . . . . . . . 36要件の履歴 . . . . . . . . . . . . . . . . . . . . . . 37

トレーサビリティ . . . . . . . . . . . . . . . . . . . . 38トレースの取得 . . . . . . . . . . . . . . . . . . . . 39要件間のトレースの作成 . . . . . . . . . . . . . . 39非要件ソフトウェアの成果物へのトレースの作成 40

第 4 章CaliberRM 用のトレーサビリティアドインの作成 41はじめに . . . . . . . . . . . . . . . . . . . . . . . . . 41Visual Basic.NET サンプルの使用 . . . . . . . . . . . 41トレーサビリティアドインのインターフェイス . . 42

VendorSession . . . . . . . . . . . . . . . . . . . . . 42Public ReadOnly Property InterfaceVersion() As Integer . . . . . . . . . . . . . . . . . . . . . . . 43

VendorView . . . . . . . . . . . . . . . . . . . . . . 44VendorObject . . . . . . . . . . . . . . . . . . . . . 44

トレーサビリティアドインの登録と有効化 . . . . . 45

付録 ACaliberRM のオブジェクトモデル 47CaliberRM のオブジェクトモデル . . . . . . . . . . . 48

第 1 章 : はじめに 1

第章

Chapter1 はじめにCaliberRM は、 CaliberRM Software Development Kit （SDK）とトレーサビリティアドイン API を通じて機能を拡張することができます。

CaliberRM SDK

CaliberRM SDK を使用すると、プロジェクト、ベースライン、要件、ユーザー、グループなどの CaliberRM 情報を作成したり、変更したり、削除することができます。 CaliberRM SDK を利用して、 Java 言語や、 .NET または COM をサポートする任意の言語で記述されたプログラムから、 CaliberRM 内のあらゆる要件データにアクセスできます。

このドキュメントでは、 Visual Basic プログラマまたは Java プログラマが CaliberRM API を使い始めるために必要な情報を提供します。

メモ： Javadoc 形式の詳細なプログラマ向けドキュメントは、 Program Files\Borland\CaliberRM SDK <バージョン番号 >\api\index.html から参照できます。また、追加情報についてはボーランドのサポートにお問い合わせください。

重要：既存の SDK アプリケーションが、まだこのリリースにアップグレードされていないサーバーに接続する必要がある場合は、そのアプリケーションをこのリリースの SDK で再コンパイルしないでください。一般に、SDK アプリケーションを記述する場合は、そのアプリケーションの接続先となるサーバーの最も古いバージョンと同じバージョンの SDK を使用してください。このリリースで提供されている新しい SDK 機能（セキュリティプロファイルの作成と割り当て、LDAP ユーザー DN の取得 /設定）を利用するには、.NET/COM 用の SDK アプリケーションを再コンパイルする必要があります。また、再コンパイルしたアプリケーションは、このリリースのサーバーと互換性があります。

SDK アプリケーション作成の詳細については、このガイドの「Visual Basic を使用した SDK アプリケーションの記述」と「Java を使用した SDK アプリケーションの記述」を参照してください。

トレーサビリティアドインテクノロジー

CaliberRM は、トレーサビリティアドインテクノロジーを使用して、任意のサードパーティ製ツールとのトレーサビリティ情報を拡張するためのユニークな方法を提供しています。トレーサビリティアドインを作成して、外部アプリケーションへのトレーサビリティを提供できます。たとえば、 Microsoft Project 用のトレーサビリティアドインを作成することにより、 CaliberRM の要件から Microsoft Project のタスクへのリアルタイムなトレースを簡単に定義し、管理することができます。作成したトレースは、トレーサビリティマトリクス、トレーサビリティ図、およびドキュメントファクトリに表示できます。

2 CaliberRM SDK プログラマーズガイド

トレーサビリティアドイン作成の詳細については、このガイドの「CaliberRM 用のトレーサビリティアドインの作成」を参照してください。

その他の情報

CaliberRM SDK についてご質問またはご要望がある場合は、 CaliberRM SDK Newsgroup（news://newsgroups.borland.com/borland.public.caliber-rm.sdk）にその内容をご投稿ください。

CaliberRM SDK の問題をご報告いただく場合は、次のアドレスからサポート宛てにご連絡ください。http://support.borland.com/

第 2 章 : Visual Basic を使用した SDK アプリケーションの記述 3

第章

Chapter2Visual Basic を使用したSDK アプリケーションの記述

はじめに

この章では、 Visual Basic プログラマ向けに CaliberRM Software Development Kit （SDK）を紹介します。この章の内容は、次のとおりです。

■ CaliberRM SDK を使用するために IDE を設定する手順を説明します。

■ SDK を使用して Visual Basic アプリケーションから CaliberRM Server に接続する方法を説明します。

■ CaliberRM 情報を作成、変更、および削除する方法を説明します。

■ 要件ツリー、属性、および履歴での作業の概要を説明します。

■ CaliberRM のディスカッションで作業する方法を紹介します。

■ SDK を使用してトレースの関係を表示、作成、および削除する方法を説明します。

IDE の設定

Visual Basic プロジェクトで CaliberRM SDK を使用するには、 IDE で SDK のオブジェクトライブラリへの参照を設定する必要があります。

Visual Studio 6.01 メインメニューから [ プロジェクト｜参照 ...] をクリックします。 SDK が正常にインス

トールされていれば、参照可能なライブラリの一覧に CaliberRM library が表示されます。

2 CaliberRM library を選択し、 [OK] をクリックして変更を保存します。

3 参照リストに CaliberRM library という名前の参照が見当たらない場合は、 [ 参照 ...] をクリックして、ハードディスク上の CaliberRMSDK DLL ファイルの場所を指定します（通常、このライブラリは、 Program Files\Borland\CaliberRM SDK <バージョン番号 >\lib フォルダにあり、ライブラリファイルの名前は CaliberRMSDK<バージョン番号 >.dll です）。

4 [OK] をクリックし、 [ 参照 ] ダイアログボックスを閉じます。


Visual Studio .NET 20031 メインメニューから [ プロジェクト｜参照の追加 ...] をクリックします。

2 [ 参照の追加 ] ダイアログボックスの [ 参照 ...] ボタンをクリックします。

3 ハードディスク上の CaliberRM SDK ライブラリを指定し、 [ 開く ] をクリックします（通常、このライブラリは、 Program Files\Borland\CaliberRM SDK <バージョン番号 >\lib フォルダにあり、ライブラリファイルの名前は CaliberRMSDK<バージョン番号 >.NET.dll です）。

4 [OK] をクリックし、 [ 参照の追加 ] ダイアログボックスを閉じます。

Visual Studio 20051 メインメニューから [ プロジェクト｜参照の追加 ...] をクリックします。

2 [ 参照の追加 ] ダイアログボックスの [ 参照 ] タブをクリックします。

3 ハードディスク上の CaliberRM SDK ライブラリを指定し、 [OK] をクリックします（通常、このライブラリは、 Program Files\Borland\CaliberRM SDK <バージョン番号 >\lib フォルダにあり、ライブラリファイルの名前は CaliberRMSDK<バージョン番号 >.NET.dll です）。

4 [OK] をクリックし、 [ 参照の追加 ] ダイアログボックスを閉じます。

CaliberRM SDK への参照が正しく設定されたかどうかを確認するには、以下を実行します。

1 メインメニューから [ プロジェクト｜ Test VBNET Properties] をクリックします。

2 [ 参照 ] タブをクリックします。 [ 参照 ] ペインに CaliberRMSDK<バージョン番号>.NET が表示されます。

これで、コード内で CaliberRMSDK ライブラリを使用できるようになりました。以下のようにして、 CaliberRM SDK クラスをインポートしてください。

CaliberRM ライブラリの初期化

COM SDK を起動すると、必ず Java 仮想マシン（VM）が起動されます。いったん VM がロードされたらこのオプションは設定できないので、上のコードは他のどの SDK 読み出しよりも前に呼び出さなければなりません。

COM アプリケーションでは、 SDK の Initilizer オブジェクトと IStJavaVMInfo オブジェクトを次に示す例のように使用できます。

Imports Starbase.CaliberRM.Interop

' Initializer オブジェクトは、 Java VM のロードを制御します。 Dim objInitializer As New Initializer

' IStJavaVMInfo は、 Java VM を表します。 Dim objStJavaVMInfo As IStJavaVMInfo

' 現在の VM を Initializer オブジェクトから取得します。 Set objStJavaVMInfo = objInitializer.JavaConfiguration.CurrentJavaVM

' 大メモリフラグを 1000 MB に設定します。 objStJavaVMInfo.Options = "-Xmx1000M"


メモ：デフォルトでは、ほとんどの VM が大で 64 MB のメモリしか消費できません。この制限は、 VM の大メモリフラグ（Xmx）を設定することにより上書きできます。

メモリ割り当てプールの大サイズをバイト単位で指定します。この値は、 2 MB より大きい、 1024 の倍数でなければなりません。末尾に k または K を付けるとキロバイト、 m または M を付けるとメガバイトを表します。デフォルト値は 64 MB です。次に例を示します。

■ -Xmx83886080■ -Xmx81920k■ -Xmx80m

アプリケーションが Java VM を起動できずに、「Not enough space for object heap」エラーが表示された場合は、 JVM のヒープサイズを小さくしてください。一般に、コンピュータ上で利用可能なメモリに従って、 Java VM のメモリサイズを指定する必要があります。

CaliberRM Server への接続

CaliberRM SDK を使用する場合の初の手順は、 CaliberRM Server への接続の作成です。接続を確立するには、 CaliberServer オブジェクトの参照を作成する必要があります。簡単に言うと、 CaliberServer オブジェクトを使用すれば、 CaliberRM ユーザーの代わりにアプリケーションから CaliberRM との接続を確立し、その接続を維持することができます。

次のコードは、 CaliberRM Server との接続を作成する単純な Visual Basic アプリケーションです。

上の例では、 CaliberRM のサーバー参照を作成するのに 2 段階の手順を取っていることに注目してください。まず、 CaliberRM のサーバーファクトリを作成しなければなりません。

次に、サーバーファクトリを使用して、新しいサーバー参照を作成します。

Private Sub Form_Load()

' CaliberRM のサーバーファクトリオブジェクト、サーバーオブジェク ' ト、およびセッションオブジェクトのためのオブジェクト変数を宣言

' します。 Dim objServerFact As CaliberServerFactory Dim objServer As CaliberServer Dim objSession As Session

' サーバーファクトリ変数およびサーバー変数に ' オブジェクト参照を代入します。 Set objServerFact = New CaliberServerFactory Set objServer = objServerFact.Create("foo")

' CaliberRM Server にログインして、 ' セッション変数にオブジェクト参照を代入します。 Set objSession = objServer.login("admin", "admin")

End Sub

Set objServerFact = New CaliberServerFactory

Set objServer = objServerFact.Create("localhost")


セッションの使用

Session オブジェクトは、 CaliberRM でのユーザーのビューを表すオブジェクトであり、CaliberRM のオブジェクトモデルへのエントリポイントとなります。前出の例で、CaliberServer オブジェクトにログインすることによって Session オブジェクトを作成しました。次のコードでは、この Session オブジェクトを使用して、ユーザーが選択できるすべてのプロジェクトの名前を表示します。

CaliberRM オブジェクトの作成

CaliberRM SDK では、以下のオブジェクトの作成、変更、および削除を行えます。

■ プロジェクト

■ ベースライン

■ ユーザー

■ グループ

■ 部署

■ 要件

■ 要件タイプ

■ セキュリティプロファイル

■ 用語集

■ 用語集の用語

■ インテグレーション

ほとんどの CaliberRM 情報は、以下の手順で作成できます。

1 新しいオブジェクトを作成するためのファクトリを作成します。

2 ファクトリの Create メソッドを呼び出します。

3 新しいオブジェクトの save メソッドを呼び出します。

' CaliberRM プロジェクト用のオブジェクト変数を宣言します。 Dim objProject As Project

' セッション内の全プロジェクトを反復処理します。 For Each objProject In objSession.Projects Debug.Print objProject.Name Next objProject


次のサンプルでは、上記手順に従って新しい User オブジェクトを作成します。

CaliberRM オブジェクトの変更

CaliberRM オブジェクトに変更を加えるには、以下の手順を実行します。

1 CaliberRM オブジェクトのインスタンスを取得します。

2 オブジェクトの lock メソッドを呼び出します。

3 必要に応じて、オブジェクトのプロパティを設定します。

4 オブジェクトの save メソッドを呼び出します。

次に例を示します。

' 新しい User オブジェクトを作成するために使用するファクトリを作成します。 Set objUserFactory = New UserFactory

' 新しい User オブジェクトを作成します。 Set objNewUser = objUserFactory.Create("jdoe", objSession)

' 新しい User オブジェクトのプロパティを設定します。 objNewUser.FirstName = "John" objNewUser.LastName = "Doe"

' 新しい User オブジェクトを保存します。 objNewUser.save

' Group オブジェクトを取得します。 Set objGroup = objSession.Groups.Item(2)

' Group オブジェクトをロックします。 objGroup.lock

' Group オブジェクトのプロパティに変更を加えます。 objGroup.Name = “New Name” objGroup.EmailAddress = “New Email Address” objGroup.Description = “New Description” ' 変更を加えた Group オブジェクトを保存します。 objGroup.save


CaliberRM オブジェクトの削除

CaliberObject オブジェクトは、その remove メソッドを呼び出すことにより、 CaliberRM から削除できます。次に例を示します。

remove メソッドが行うのは、現在のベースラインからの要件の削除だけです。その要件が、それより前のすべてのベースラインから削除されるわけではありません。

要件

ここでは、要件の作成、変更、および削除について詳しく説明します。

要件の作成

SDK には、新しい要件を作成するためのメソッドが 2 つあります。 1 番目のメソッドは、プロジェクトの要件ツリー階層構造のトップレベルに要件を作成します。 2 番目のメソッドは、既存の要件の子要件を作成します。

次の例は、 1 番目の作成メソッド（Create1）を使用して新しい要件を作成します。

上の例で、 Create1 メソッドの 4 番目のパラメータに 0 を渡していることに注目してください。これは、新しい要件の挿入場所を指定するための、要件ツリー内での場所を示すインデックスです。

Dim objRequirement As RequirementSet objRequirement = objSession.getRequirement(1)objRequirement.remove

' セッションのコレクション内の先頭のプロジェクトを取得します。 Set objProject = objSession.Projects.Item(0)

' プロジェクト内の初の要件タイプを取得します。 Set objType = objProject.CurrentBaseline.RequirementTypes.Item(0)

' 新しい Requirement オブジェクトを作成するためのファクトリを作成します。 Set reqFactory = New RequirementFactory

' 新しい Requirement オブジェクトを作成します。 Set newRequirement = reqFactory.Create1( _

“New Requirement”, _ objProject, _ objType, _ 0, _ objSession) newRequirement.save ""


次の例は、 2 番目の作成メソッド（Create2）を使用して、既存の要件の子となる要件を作成します。

属性と属性値

CaliberRM では、任意の数のユーザー定義属性（UDA）で要件を定義することができます。さらに、すべての要件が、ステータスと優先度をシステム属性として持ちます。これと同じように、 CaliberRM SDK の Requirement オブジェクトも、そのステータスを返す Status プロパティと、優先度を返す Priority プロパティ、 UDA の値を返す AttributeValues プロパティを持っています。

CaliberRM SDK では、 Attribute オブジェクトが CaliberRM の属性の型を表し、AttributeValue オブジェクトが各型のインスタンスを表します。

次の表は、 CaliberRM 属性と SDK での Attribute オブジェクトおよび AttributeValue オブジェクトの関係をまとめたものです。

CaliberRM 属性SDK での Attribute

オブジェクトSDK での AttributeValue

オブジェクト

単一行テキスト

複数行テキストフィールド

UDAText UDATextValue

整数 UDAInteger UDAIntegerValue

継続期間 UDADuration UDADurationValue

浮動小数点数 UDAFloat UDAFloatValue

日付 UDADate UDADateValue

真偽値 UDABoolean UDABooleanValue

複数選択リスト

単数選択リスト

複数選択グループリスト

単数選択グループリスト

複数選択ユーザーリスト

単数選択ユーザーリスト

UDAList UDAListValue

' 新しい Requirement オブジェクトを作成するためのファクトリを作成します。 Set reqFactory = New RequirementFactory

' 新しい Requirement オブジェクトの親とする Requirement オブジェクトを取得します。 Set parentReq = objSession.getRequirement(1)

' 新しい Requirement オブジェクトを parentReq の子として作成します。 Set newChildRequirement = reqFactory.Create2( _

“New Child Requirement”, _ parentReq, _ 4, _ objSession)


たとえば、次のコードは、指定した要件タイプから Attribute オブジェクトを取得する方法を示します。

AttributeValue オブジェクトも、同様の方法で要件から取得できます。次の例は、上の例と同じ一覧を、値も追加して出力します。

この例では、次に示す行で、 AttributeValue オブジェクトの Attribute プロパティを使用して属性の名前を取得していることに注目してください。

' セッション内の初の要件タイプを取得します。Set objRequirementType = objSession.RequirementTypes.Item(0)

' その要件タイプ内の初のカスタムタブを取得します。Set objCustomTab = objRequirementType.CustomTabs.Item(0)

' カスタムタブに割り当てられている属性の名前を出力します。Dim objAttribute As CaliberRM.AttributeFor Each objAttribute In objCustomTab.attributes Debug.Print vbTab & vbTab & objAttribute.NameNext objAttribute

Dim objAttribValue As AttributeValue

' すべての属性値をループ処理します。For Each objAttribValue In objRequirement.AttributeValues

' 属性の名前とその値を出力します。 Debug.Print _

objAttribValue.Attribute.Name _& " = " _ & objAttribValue.Value

Next objAttribValue

objAttribValue.Attribute.Name


このプロパティは、 AttributeValue オブジェクトの型を取得する必要があるときにはいつでも使用できます。次の例では、特定の型の Attribute オブジェクトと AttributeValue オブジェクトを扱う方法を示します。

リスト属性値

前出の表で示したように、 UDAListValue オブジェクトは、要件に割り当てることができるすべてのリスト属性値を表すオブジェクトです。ここでは、単一選択リスト属性と複数選択リスト属性のどちらの表示にも UDAListValue を使用できる様子を示す、実際的な例を示します。

' すべての属性値をループ処理します。 For Each objAttribValue In objRequirement.AttributeValues

' UDATextValue を探します。 If TypeOf objAttribValue Is UDATextValue Then

' AttributeValue オブジェクトを UDATextValue にキャストします。 Dim textValue As UDATextValue Set textValue = objAttribValue

' Attribute オブジェクトを UDAText にキャストします。 Dim textAttribute As UDAText Set textAttribute = objAttribValue.Attribute

' この値に固有の情報を出力します。 Debug.Print _

“The value of the UDATextValue is: “ _ & textValue.Value

' この値の型に固有の情報を出力します。 Debug.Print _

“The maximum length this value can be: “_& textAttribute.MaximumLength

Debug.Print _

“The minimum length this value can be: “_& textAttribute.MinimumLength

End If

Next objAttribValue


下の例は、要件のステータスリストのリストエントリと選択中の値を出力します。

このコードは、次のように修正することにより、単一選択ユーザーリスト属性を出力するようにできます。

上の例では、次に示す行で、属性の UITypeName プロパティを UI_NAME_SSUL 定数と比較することによって、属性のコレクションから単一選択ユーザーリストのみを取り出していることに注目してください。

Private Sub Form_Load() ... Dim objRequirement As Requirement Set objRequirement = objSession.getRequirement(1) PrintList objRequirement.StatusEnd Sub

Private Sub PrintList(objListValue As UDAListValue)

' リストエントリを出力します。 Debug.Print “List Entries(s):” Dim listEntry As UDAListEntry For Each listEntry In objListValue.ListEntries Debug.Print listEntry.Object Next listEntry

' 選択中の値を出力します。 Debug.Print “Selected Value = “& objListValue.selectedValueEnd Sub

Private Sub PrintSSUserList(objReq As Requirement) Dim objAttribValue As CaliberRM.AttributeValue

' 渡された要件に割り当てられているすべての属性 ' を反復処理します。 For Each objAttribValue In objReq.AttributeValues

' 「単一選択ユーザーリスト」属性のみを出力します。 Set objAttribute = objAttribValue.Attribute If objAttribute.UITypeName = objAttribute.UI_NAME_SSUL Then

' ユーザーリストのエントリを出力します。 Debug.Print “User List Entries(s):”

Dim listEntry As UDAListEntry For Each listEntry In objAttribValue.ListEntries Debug.Print listEntry.Object.Name Next listEntry Debug.Print “Selected Value: “ & _ objAttribValue.SelectedValue.Name End If Next objAttribValue End Sub

If objAttribute.UITypeName = objAttribute.UI_NAME_SSUL Then


これに対し、名前を使用してコレクションから属性を選択することもできます。次に例を示します。

UDAListValue オブジェクトは、複数選択リスト値も表すことができます。たとえば、次のコードは、複数選択グループリスト値に含まれる各要素の Name プロパティと Selected プロパティを出力します。

属性値の設定

要件の属性値に変更を加えるには、以下の手順を実行します。

1 要件を取得します。

2 要件の lock メソッドを呼び出します。

3 要件に含まれている属性値の型（UDATextValue、 UDAListValue など）を調べます。

4 属性値の型に基づいて、 AttributeValue オブジェクトに変更を加えます。

5 AttributeValue プロパティに新しい値を設定することにより、要件を更新します。

6 要件の save メソッドを呼び出します。

次に例を示します。

If objAttribute.Name = "My SSUL Attribute" Then

Dim listEntry As UDAListEntry For Each listEntry In objAttribValue.ListEntries

' リストエントリの「Selected」プロパティを使用して ' そのグループが選択されているかどうかを調べます。 If listEntry.Selected Then

Debug.Print listEntry.Object.Name & “ *** Selected ***"“

Else Debug.Print listEntry.Object.Name End If Next listEntry


要件の説明

CaliberRM では、要件の説明をテキスト文字列として入力することもできれば、他の説明とのマッピング / 共有関係により指定することもできます。他の要件に使用されている要件説明のことを、「共有されている（"Shared"）」と言います。逆に、要件がその説明として他の要件の説明を使用している場合、その要件の説明ことを「マッピングされている（"Mapped"）」と言います。

CaliberRM SDK には、要件説明が取り得る 3 種類のステータスを表すために、RequirementDescription、 RequirementDescriptionMapped、RequirementDescriptionShared の 3 つのクラスが用意されています。この 3 つの説明オブジェクトはすべて Text プロパティを持っており、それを使用して説明テキストを取得することができます。このため、次に示すコードは、すべての要件に対して正常に実行できます。

Set objRequirement = objSession.getRequirement(1) objRequirement.lock

' Requirement オブジェクトのすべての属性値をループ処理します。Dim objAttribValue As AttributeValueFor Each objAttribValue In objRequirement.AttributeValues

If TypeOf objAttribValue Is UDABooleanValue Then

' 値が真偽値型の UDA 値の場合、現在の値とは' 逆の値を新しい値として設定します。objAttribValue.Value = Not objAttribValue.Value

ElseIf TypeOf objAttribValue Is UDATextValue Then

' 値がテキスト型の UDA 値の場合、現在の時刻を' 新しい値として設定します。objAttribValue.Value = Time

ElseIf TypeOf objAttribValue Is UDAIntegerValue Then

' 値が整数型の UDA 値の場合、' 値を 1 だけインクリメントします。objAttribValue.Value = objAttribValue.Value + 1

ElseIf TypeOf objAttribValue Is UDAListValue ThenIf objAttribValue.MaximumSelections = 1 Then

' 値が単一選択リスト値の場合は、' 選択中のインデックスを 1 だけインクリメントします。objAttribValue.SelectedIndex = _

objAttribValue.SelectedIndex + 1End If

End If

' 要件オブジェクトを新しい値で更新します。objRequirement.AttributeValue = objAttribValue

Next objAttribValue

' 変更後の要件を保存します。objRequirement.save "UDA 値を変更しています "


要件の説明を変更するには、単に要件の Description プロパティに新しい RequirementDescription オブジェクトまたは RequirementDescriptionMapped オブジェクトを代入します。たとえば、次のコードは、簡単なテキストの説明を作成します（分かりやすくするために、 lock メソッドと save メソッドの呼び出しは省略してあります）。

次の例は、要件に HTML 形式の簡単な説明を作成します。

次の例は、 1 番目の要件の説明を 2 番目の要件にマッピングします。

ドキュメント参照

CaliberRM SDK には、ドキュメント参照オブジェクトとして FileReference、TextReference、 WebReference の 3 つが用意されています。これらの参照オブジェクトはいずれも、作成した後、要件の DocumentReferences プロパティに追加できます。以下の例は、これらのオブジェクトのインスタンスをそれぞれ作成し、それを使用して要件に変更を加えます。

Debug.Print req.Description.Text

' 説明を作成するためのファクトリを作成します。 Dim descriptionFactory As New RequirementDescriptionFactory

' 新しい説明オブジェクトを作成し、それを使用して、要件の' Description プロパティを設定します。req.Description = descriptionFactory.Create(“A new description.”)

' 説明を作成するためのファクトリを作成します。Dim descriptionFactory As New RequirementDescriptionFactory

' 新しい説明オブジェクトを作成し、それを使用して、要件の' Description プロパティを設定します。req.Description = descriptionFactory.Create("<html><body>A new <i><b>formatted description.</b></i></body></html>")

Set req1 = objSession.getRequirement(1)Set req2 = objSession.getRequirement(2)

' マッピングされる説明を作成するためのファクトリを作成します。 Dim mapDescriptionFactory As New RequirementDescriptionMappedFactory

' 被マッピング説明を新しく作成し、それを使用して、 1 番目の要件の' Description プロパティを設定します。 req1.Description = mapDescriptionFactory.Create(req2, objSession)


上の例で初に行っていることは、 CollectionFactory オブジェクトの CreateByIStCollection メソッドを使用した新しいコレクションの作成だという点に注目してください。これが必要になるのは、要件の DocumentReferences プロパティが読み取り専用のコレクションであり、変更を加えることができないためです。

責任者

一般に、 CaliberRM 内の各要件には、その要件の責任を持つユーザーとして複数の担当者が割り当てられます。これらのユーザー、および各ユーザーが所属するグループは、要件の Responsibilities プロパティ（GroupMemberAssignment オブジェクトのコレクション）を通じて取得できます。

' まず、要件の既存の参照コレクションを' 変更可能なコレクションにコピーしなければなりません。Dim colFactory As New CollectionFactorySet docRefs = colFactory.CreateByIStCollection(req.DocumentReferences)

' テキスト参照を作成し、 docRefs コレクションに追加します。Dim textRefFactory As New TextReferenceFactorydocRefs.Add textRefFactory.Create("Text Reference")

' Web 参照を作成し、 docRefs コレクションに追加します。Dim webRefFactory As New WebReferenceFactorydocRefs.Add webRefFactory.Create("www.microsoft.com")

' ファイル参照を作成し、 docRefs コレクションに追加します。Dim fileRefFactory As New FileReferenceFactorydocRefs.Add fileRefFactory.Create("C:\foo.txt")

' 参照を設定し、保存します。req.lockreq.DocumentReferences = docRefsreq.save ""


次のコードは、要件に対して責任を持つすべてのユーザーの割り当てを解除します。

履歴

CaliberRM SDK では、要件の履歴レコードに完全にアクセスすることができます。要件の履歴は、どの Requirement オブジェクトでも History プロパティを使用して取得できます。次のコードで、これらのオブジェクトを使用して履歴のリビジョンを表示する方法を示します。

次に、この例を展開させて、これらのリビジョンを構成する個々の変更に関する情報も含めます。次のコードは、与えられた HistoryRevision オブジェクトに対するすべての HistoryChange オブジェクトを反復処理して、変更された要件フィールドの名前、加えられた変更のタイプ、およびフィールドの変更前の値と変更後の値を出力します。

' 要件の責任者に関する情報が入った GroupMemberAssignment ' オブジェクトのコレクションを取得します。 Dim gmaCollection As CaliberRM.Collection Set gmaCollection = req.responsibilities

' コレクション内のすべての GroupMemberAssignment オブジェクト' を反復処理します。 Dim gma As GroupMemberAssignment For Each gma In gmaCollection

' 割り当てられているすべてのメンバーを反復処理します。 Dim assignedMember As User For Each assignedMember In gma.AssignedMembers

' ... そして、それぞれについて割り当てを解除します。 gma.removeAssignedMember assignedMember Next assignedMember Next gma

' Requirement オブジェクトをロックして、その責任者を設定し、保存します。 req.lock req.responsibilities = gmaCollection req.save ""

Dim revision As HistoryRevision For Each revision In objReq.History.Revisions Debug.Print “Major Ver: “ & revision.Version.MajorVersion Debug.Print “Minor Ver: “ & revision.Version.MinorVersion Debug.Print “Date: “ & Format(revision.OLEDate, "d-mmm") Debug.Print “User Name: “ & revision.UserName Debug.Print “Comment: “ & revision.Comment Next revision


Change オブジェクトの OldValue プロパティと NewValue プロパティには、要件フィールドの変更前の値と変更後の値が格納されています。これらのオブジェクトで作業するには、これらをタイプごとに区別する必要があります。原則として、変更値オブジェクトは、次の 3 つのタイプのいずれかになります。

■ String ： UDA ではないテキストフィールド（要件の名前、説明など）への変更を表します。

■ Attribute ：すべてのユーザー定義属性およびシステム属性への変更を表します。

■ User ：要件の所有者フィールドへの変更を表します。

次のサブルーチン（前出の例で 2 度呼び出されたもの）は、これらの OldValue オブジェクトと NewValue オブジェクトが String、 Attribute、 User のいずれであるかを区別します。

Dim objChange As HistoryChange For Each objChange In revision.Changes Debug.Print “Field Name: “ & objChange.FieldName Debug.Print “Type: “ & ChangeTypeToString(objChange.changeType) Debug.Print “Old Value: “ & VariantToString(objChange.OldValue) Debug.Print “New Value: “ & VariantToString(objChange.NewValue) Next objChange

' 渡された Variant 型を String 型に変換します。Private Function VariantToString(ByVal vntValue As Object) As String

' まず変更がない（null）場合を、排除します。 If IsNull(vntValue) Then VariantToString = "[NULL]"

' 既に文字列型になっている場合は、単純にそれを返します。 ElseIf VarType(vntValue) = vbString Then VariantToString = vntValue

Else

' Variant 型をオブジェクトにまで絞り込みます。 Dim objValue As Object objValue = vntValue

' オブジェクトが CaliberObject の場合には、その ' Name 属性を返します。 If TypeOf objValue Is CaliberObject Then VariantToString = objValue.Name

' ユーザー定義属性およびシステム属性の変更を出力します。 ElseIf TypeOf objValue Is AttributeValue Then VariantToString = UDAValueToString(objValue)

Else VariantToString = "" End If

End IfEnd Function


このコードが初に行っていることは、このサブルーチンに渡された Variant 変数が null でないことの確認だという点に注目してください。一般に、 null 変更オブジェクトが現れるのは、 UDA が要件のタイプに追加されたり、要件のタイプから削除されたりした場合です。

また、 AttributeValue オブジェクトの処理ルーチンが、次のように UDAValueToString 関数を呼び出していることにも注目してください。

この変換関数（下のコードを参照）で、異なる型の AttributeValue オブジェクトを汎用的な方法で扱える様子を示します。

ディスカッション

CaliberRM では、プロジェクトチームは、グループディスカッション機能を通じて要件とプロジェクトに対するフィードバックを提出することができます。これと同様に、CaliberRM SDK では、要件とプロジェクトに関するディスカッションを表示することができます。

次のサブルーチンは、 CaliberObject オブジェクトを受け取り、その各ディスカッションメッセージに関する情報を表示します。これは、渡された CaliberObject オブジェクトの Discussion プロパティを使用することにより行われます。ディスカッションを持てるのは要件とプロジェクトだけなので、このサブルーチンは、渡された CaliberObject オブジェクトが Requirement オブジェクトでも Project オブジェクトでもない場合にはすぐに終了します。

ElseIf TypeOf objValue Is AttributeValue Then VariantToString = UDAValueToString(objValue)

' AttributeValue （つまり、 UDA 値）を文字列に変換します。Function UDAValueToString(ByVal objValue As AttributeValue) As String

' まず、 "Values" 属性を簡単に文字列に変換できる ' すべての AttributeValue オブジェクトを処理します。 If TypeOf objValue Is UDABooleanValue _ Or TypeOf objValue Is UDAFloatValue _ Or TypeOf objValue Is UDAIntegerValue _ Or TypeOf objValue Is UDATextValue Then UDAValueToString = objValue.Value

ElseIf TypeOf objValue Is UDADateValue Then UDAValueToString = Format(objValue.OLEDate, "d-mmm")

ElseIf TypeOf objValue Is UDADurationValue Then UDAValueToString = objValue.Value _ & objValue.Attribute.GranularityTextElseIf TypeOf objValue Is UDAListValue Then UDAValueToString = “Selected List Entries: “ For Each objListEntry In objValue.ListEntries If objListEntry.Selected = True Then UDAValueToString = UDAValueToString & _ VariantToString(objListEntry.Object) & _ "," End If Next objListEntry End If

End Function


CaliberRM SDK では、 Discussion オブジェクトの postMessage メソッドを通じて、ディスカッションメッセージを投稿することもできます。同様に、 DiscussionMessage オブジェクトの postReply メソッドを使用して、ディスカッションメッセージに返信することもできます。次の例で、この 2 つのメソッドの使用方法を示します。

要件ツリー

一般に、 CaliberRM のベースライン内の一連の要件の間には、階層構造状の関係が存在します。このため、これらの要件は要件ツリーを構成します。 RequirementTree オブジェクトと RequirementTreeNode オブジェクトを使用すると、これらのツリーを操作することができます。

次の手順により、要件ツリーのノードをたどることができます。

1 ベースラインから RequirementTree オブジェクトを取得します。

2 RequirementTree オブジェクトの Root プロパティにアクセスして、ルートの RequirementTreeNode オブジェクトを取得します。

3 RequirementTreeNode オブジェクトの Children プロパティを再帰的に呼び出します。

Private Sub PrintDiscussion(objCaliberObj As CaliberObject)

' ディスカッションを持てるのは、プロジェクトと要件だけです。 If Not TypeOf objCaliberObj Is Project _ And Not TypeOf objCaliberObj Is Requirement Then Exit Sub End If Dim objDiscussion As Discussion Set objDiscussion = objCaliberObj.Discussion Dim objMessage As DiscussionMessage For Each objMessage In objDiscussion.Messages intTab = objMessage.Depth * 5 Debug.Print Tab(intTab); “Subject: “ & objMessage.Subject Debug.Print Tab(intTab); “Have read: “ & objMessage.Read Debug.Print Tab(intTabDepth); “Date: “ & _ Format(objMessage.OLEDate, "d-mmm") Next objMessage End Sub

' 要件のディスカッションを取得します。 Set objDiscussion = req.Discussion

' ディスカッションにメッセージを投稿します。 Set objMessage = objDiscussion.postMessage(“My Subject”, “My Message”)

' 新しいメッセージへの返信を投稿します。 objMessage.postReply “Re: My Subject”, “My Reply”


次のコードは、上の手順に従って、要件ツリー内の各ノードに関する情報を出力します。

RequirementTreeNode オブジェクトは、要件ツリー内のプロジェクト、要件タイプ、要件ノードのいずれかを表すことができます。 RequirementTreeNode オブジェクトには、それに関連付けられている CaliberRM オブジェクトを表すための必要小限のデータが格納されています。たとえば、ノードが Project オブジェクトに関連付けられている場合は、RequirementTreeNode オブジェクトからプロジェクトの名前と ID 番号を取得できますが、プロジェクトの説明やベースラインをこのオブジェクトから直接取得することはできません。

...

' ベースラインの要件ツリーを取得します。 Dim objRequirementTree As RequirementTree Set objRequirementTree = objBaseline.RequirementTree

' ツリー内の移動をルートノードから開始します。 TraverseTree objRequirementTree.Root End Sub

' 指定されたノードをサブツリーのルートとして、サブツリー内をたどり、 ' 各ノードに関する情報を出力します。 Private Sub TraverseTree(ByVal parent As RequirementTreeNode)

' 親ノードに関する情報を出力します。 Debug.Print _ String(parent.Level, vbTab) _ & parent.HierarchyNumber _ & " " _ & parent.Name _ & " " _ & parent.SerialNumberTag

' その親の子ノードそれぞれに対してこの関数を ' 再帰的に呼び出します。 Dim child As RequirementTreeNode For Each child In parent.Children TraverseTree(child) Next child

End Sub


RequirementTreeNode オブジェクトに関連付けられているノードを表す完全なオブジェクトを取得するには、 RequirementTreeNode オブジェクトの AssociatedObjectID プロパティを使用します。次に例を示します。

RequirementTreeNode オブジェクトの addChild メソッドと insertChild メソッドを使用すると、要件ツリーに変更を加えることができます。次のサンプルコードは、 addChild メソッドを使用して、要件ツリー内の 1 番目の要件ノードの下に 2 番目の要件ノードを追加します。

ベースラインの Requirements コレクションを要件の ChildRequirements コレクションと組み合わせて使用することでも、要件ツリーをたどることができます。ただし、この方法はリモートの CaliberRM Server に Requirement オブジェクト全体を要求することになるため、ツリーをたどる方法としては、 RequirementTree オブジェクトと RequirementTreeNode オブジェクトを使用する場合に比べてはるかに多くのリソースを消費します。

次のサンプルコードは、この方法を使用して、要件ツリーの初の 2 レベルを表示します。

' そのノードが表す CaliberObject オブジェクトの ID を取得します。 Dim id As CaliberObjectID Set id = objRequirementTreeNode.AssociatedObjectID

' そのノードが表す CaliberObject オブジェクトを取得します。 Dim co As CaliberObject Set co = objSession.get(id)

' CaliberObject オブジェクトの各サブタイプに固有の属性を出力します。 If TypeOf co Is Project Then

' プロジェクトの説明を出力します。 Debug.Print co.Description

ElseIf TypeOf co Is RequirementType Then

' そのタイプのタグを出力します。 Debug.Print co.Tag

ElseIf TypeOf co Is Requirement Then

' 要件の説明を出力します。 Debug.Print co.Description.Text End If

...

' プロジェクトノードを取得します。これは必ずルートノードとなります。 Set objProjectNode = objRequirementTree.Root

' プロジェクトノードの下の初の要件タイプノードを取得します。 Set objTypeNode = objProjectNode.Children.Item(0)

' その要件タイプの下の 1 番目の要件と 2 番目の要件を取得します。 Set firstRequirementNode = objTypeNode.Children.Item(0) Set secondRequirementNode = objTypeNode.Children.Item(1)

' 2 番目の要件を 1 番目の要件に追加します。 firstRequirementNode.addChild secondRequirementNode

' ツリーに加えた変更を保存します。 objRequirementTree.save


Requirement オブジェクトの ParentRequirement プロパティを使用することにより、子から親へとツリーをたどることもできます。たとえば、次のプロシージャは、渡された要件からツリー内のルート要件までのパスを出力します。

CaliberRM アプリケーションは、一般に、ツリー内のトップレベルにあるすべての要件を要件タイプごとにグループ化し、並べ替えて表示します。このため、 Baseline オブジェクトの Requirements プロパティも、常にこれと同じように要件をグループ化し、並べ替えた状態で返すようになっています。

メモ：要件のプロジェクト、ベースライン、およびタイプは、各要件の Project プロパティ、 Baseline プロパティ、および RequirementType プロパティにアクセスすることにより調べられます。

トレーサビリティ

CaliberRM では、 2 つの要件間や、要件と CaliberRM 外のオブジェクト間にトレースの関係を持たせることができます。 CaliberRM SDK でも、同様に、 CaliberRM の要件と非要件ソフトウェアの成果物の両方の間のトレースの作成、削除、および変更がサポートされています。

トレース関連で比較的重要なオブジェクトをいくつか次に示します。

' Project オブジェクトと Baseline オブジェクトのための変数を宣言します。 Dim firstProject As Project Dim curBaseline As Baseline

' Session オブジェクトの Projects コレクション内の ' 初のプロジェクトを参照するように Project 変数を設定します。 Set firstProject = objSession.Projects.Item(0)

' 初のプロジェクト内の「現在の」ベースライン ' を参照するようにベースライン変数を設定します。 Set curBaseline = firstProject.CurrentBaseline

' ツリー内の初のレベルの要件を ' 一時的に格納するための変数を宣言します。 Dim parentReq As Requirement

' 初のレベルの要件を反復処理します。 For Each parentReq In curBaseline.Requirements Debug.Print parentReq.Name Dim childReq As Requirement

' 現在の親要件のすべての子を ' 反復処理します。 For Each childReq In parentReq.ChildRequirements log vbTab & childReq.Name Next childReq

Next parentReq

Private Sub PrintPathToRoot(ByVal objRequirement As Requirement) Do While Not objRequirement Is Nothing Debug.Print objRequirement.Name Set objRequirement = objRequirement.ParentRequirement Loop End Sub


■ Trace ： 2 つの CaliberRM オブジェクト間のトレースの関係を表します。対象となる CaliberRM オブジェクトは、要件でも、 CaliberRM の外にあるオブジェクトでもかまいません。

■ TraceManager ：トレースの作成、変更、および削除を行うための機能を提供します。

■ XGenericObjectManager ：要件と非要件ソフトウェアの成果物の間にトレースを作成するための機能を提供します。

■ VendorAddIn ：他のアプリケーションの領域内にあるオブジェクトへの参照を表します。 CaliberRM のトレーサビリティアドインモジュールを実装したアプリケーションのソフトウェアベンダーが、これらのオブジェクトを提供します。

トレースの取得

CaliberRM SDK では、 CaliberRM オブジェクトモデルのさまざまなレベルでトレースを取得することができます。たとえば、 Session オブジェクトは、使用可能なすべての CaliberRM オブジェクトの間のすべてのトレースを返す Traces プロパティを持ちます。さらに、 Project オブジェクトの Traces プロパティは、プロジェクト内の要件がトレース先またはトレース元となっているすべてのトレースを返します。そして、 Requirement オブジェクトは、トレースを取得するためのプロパティとして TracesFrom と TracesTo の 2 つを持ちます。

次の例は、 TracesTo プロパティと TracesFrom プロパティを使用して、要件のトレース元またはトレース先となっているオブジェクトの名前を出力します。

要件間のトレースの作成

TraceManager オブジェクトを使用すると、トレースの関係を作成したり変更したりできます。トレースを作成する際の初の手順は、次のようなコードによるこのオブジェクトの参照の取得です。

Private Sub PrintTraces(objRequirement As Requirement) Dim objTrace As CaliberRM.Trace Debug.Print “Objects tracing from “ & objRequirement.Name For Each objTrace In objRequirement.TracesFrom

' 次のトレースは、他の何らかのオブジェクトから ' このシステム内の要件へのトレースです。 Debug.Print objTrace.FromObject.Name _ & vbTab _ & objTrace.Suspect Next objTrace Debug.Print “Objects tracing to “ & objRequirement.Name For Each objTrace In objRequirement.TracesTo

' 次のトレースは、このシステム内の要件から ' 他の何らかのオブジェクトへのトレースです。 Debug.Print objTrace.ToObject.Name _ & vbTab _ & objTrace.Suspect Next objTrace End Sub

Dim objTraceManager As TraceManager Set objTraceManager = objSession.TraceManager


TraceManager オブジェクトを取得したら、それを使用してトレースを作成できます。次の例は、 2 つの要件間にトレースの関係を作成します。

非要件ソフトウェアの成果物へのトレースの作成

前の例では、 CaliberRM 内にある 2 つのオブジェクト（両方とも要件）の間にトレースの関係を作成する方法を示しました。次の例では、 XGenericObjectManager オブジェクトを使用して、要件と CaliberRM の外にあるオブジェクトの間にトレースを作成します。。

XGenericObjectManager は、 2 つの外部 VendorAddIn オブジェクト間にトレースを作成する機能も提供します。

Dim req1 As Requirement Set req1 = objSession.getRequirement(1) Dim req2 As Requirement Set req2 = objSession.getRequirement(2)

objTraceManager.createTrace3 req1, req2, False

... Dim req1 As Requirement Set req1 = objSession.getRequirement(1) Dim objIntegrationMgr As IntegrationManager Set objIntegrationMgr = objSession.IntegrationManager

' req1 から、 ABCCorp により提供された ' ABCObject へのトレースを作成します。 objIntegrationMgr. createTrace2 _ req1, _ True, _ "ABCCorp", _ "ABCObjectID" ...

objIntegrationMgr. createTrace1 _ "ABCCorp", _ "ABCObjectID", _ "XYZCorp", _ "XYZObjectID"


トレースの削除

トレースを削除するには、 TraceManager オブジェクトの deleteTrace メソッドを使用します。たとえば、次のサブルーチンは、渡された要件からすべてのトレースを削除します。

CaliberRM のオブジェクトモデルについては、「付録 A ： CaliberRM のオブジェクトモデル」の図を参照してください。この図は、使用したいオブジェクトを探したり、各オブジェクトが CaliberRM のオブジェクトモデル全体の中でどのような位置付けにあるかを理解したりする際に役立ちます。

Private Sub DeleteTraces(objRequirement As Requirement) Dim objTraceManager As TraceManager Set objTraceManager = objSession.TraceManager Dim objTrace As Trace For Each objTrace In objRequirement.TracesFrom objTraceManager.deleteTrace objTrace Next objTrace End Sub

第 3 章 : Java を使用した SDK アプリケーションの記述 27

第章

Chapter3Java を使用したSDK アプリケーションの記述

はじめに

この章では、 Java プログラマ向けに CaliberRM SDK を紹介します。この章の内容は、次のとおりです。

■ SDK を使用して Visual Basic アプリケーションから CaliberRM Server に接続する方法を説明します。

■ SDK で使用される慣例について説明します。

■ 要件ツリー、属性、および履歴での作業の概要を説明します。

■ SDK を使用してトレースの関係を表示したり作成したりする方法を説明します。

CaliberServer オブジェクトの作成

CaliberRM SDK を使用するアプリケーションは、必ず初に CaliberRM Server との接続を作成しなければなりません。接続を確立するには、 CaliberServer クラスの新しいインスタンスを作成する必要があります。 CaliberServer クラスを使用すると、 CaliberRM ユーザーの代わりにアプリケーションから CaliberRM との接続を確立し、その接続を維持することができます。


次のコードは、 CaliberRM Server との接続を作成する単純な Java アプリケーションです。

このコードは、すべての CaliberRM アプリケーションが実行しなければならない、次の基本手順を示しています。

■ 適切な CaliberRM パッケージをインストールします。

■ CaliberRM Server を作成します。

■ CaliberRM Server にログインします。

初の行は、メインの CaliberRM パッケージをインポートしています。

このパッケージには、 Session クラスが含まれています。 Session クラスの詳細については、 29 ページの「セッションの使用」を参照してください。

2 行目は、 CaliberRM Server パッケージをインポートしています。

このパッケージには、サーバー接続、トランザクション、および例外に関連したすべてのクラスが入っています。 CaliberServer クラスは、このパッケージに入っています。

次のコードは、 CaliberServer クラスのインスタンスを作成します。このインスタンスは、ホスト「foo」上にある CaliberRM Server との通信に使用されます。

import com.starbase.caliber.*;import com.starbase.caliber.server.*;

public class ConnectionCreator { public static void main(String[] args) { CaliberServer server = new CaliberServer("foo");try{ Session session = server.login("admin", "admin");

} catch(RemoteServerException rse) { rse.printStackTrace();

} } }

import com.starbase.caliber.*;

import com.starbase.caliber.server.*;

CaliberServer server = new CaliberServer("foo");


後に、 CaliberServer にログインして新しい Session オブジェクトを作成します。

上の例では、 login メソッドは、クライアントがリモート CaliberRM Server にログインできない場合には、 RemoteServerException をスローします。一般に、ログインの失敗は、login メソッドに渡されたユーザー ID かパスワードが間違っていた場合に発生します。 RemoteServerException の詳細については、下の「CaliberRM Java SDK の慣例」を参照してください。

メモ： Java SDK を起動すると、必ず Java 仮想マシン (VM) が起動されます。デフォルトでは、ほとんどの VM が大で 64 MB のメモリしか消費できません。この制限は、 VM の大メモリフラグ（Xmx）を設定することにより上書きできます。

Java SDK アプリケーションについては、このフラグはコマンドラインから、次のようなコマンドで設定できます。

いったん VM がロードされたらこのオプションは設定できないので、上のコードは他のどの SDK 読み出しよりも前に呼び出さなければなりません。

セッションの使用

Session は、 CaliberRM Server のユーザーのビューを表すオブジェクトであり、したがって CaliberRM のオブジェクトモデルへのエントリポイントとなります。次のコードでは、前の例で作成した Session オブジェクトを使用して、ユーザーが選択できるすべての CaliberRM プロジェクトの名前を表示します。

CaliberRM Java SDK の慣例

前出の 2 つの例には、 CaliberRM SDK で使用されるさまざまな慣例が示されています。まず第 1 に、 SDK のメソッドが、オペレーションの実行を CaliberRM Server に依存する場合には、必ずそのメソッドが RemoteServerException をスローするように宣言しなければなりません。 RemoteServerException は、リモートサーバーによりスローされる例外を「ラップ」します。例外の getMessage メソッドを呼び出すことにより、このラップされた例外を表す詳しいメッセージを取得できます。

次に、複数のオブジェクトを返すメソッドはすべて、それらのオブジェクトを配列に入れて返します。

try{ Session session = server.login("jdoe", "1234ABC");

} catch(RemoteServerException rse) { rse.printStackTrace();}

java -Xmx1000M com.company.SDKApp

try{ Project[] arrayOfProjects = session.getProjects();

for(int i = 0; i < arrayOfProjects.length; i++) { System.out.println(arrayOfProjects[i].getName());

}} catch(RemoteServerException) {

rse.printStackTrace();}


後に、 CaliberRM SDK は、 Java のコア API で確立された名前付け標準に従っています。次の表は、これらの規則をまとめたものです。

CaliberRM オブジェクトの作成

CaliberRM SDK では、以下のオブジェクトの作成、変更、および削除を行えます。

■ プロジェクト

■ ベースライン

■ ユーザー

■ グループ

■ 部署

■ 要件

■ 要件タイプ

■ セキュリティプロファイル

■ 用語集

■ 用語集の用語

■ インテグレーション

次のサンプルコードで、 CaliberRM オブジェクトを作成する典型的なパターンを示します。

CaliberRM オブジェクトの変更

CaliberRM オブジェクトに変更を加えるには、以下の手順を実行します。

1 CaliberRM オブジェクトのインスタンスを取得します。

2 オブジェクトの lock メソッドを呼び出します。

3 必要に応じて、オブジェクトのプロパティを設定します。

4 オブジェクトの save メソッドを呼び出します。

グループ規則例

取得 / 設定メソッド getXxxx/setXxxx getName() setName()

論理メソッド isXxxx isEstablished()isKeyReference()

イベントリスナインターフェイス

XxxxListener ServerConnectionListenerServerTransactionListener

イベントリスナ登録 addXxxxListener addServerConnectionListeneraddServerTransactionListener

イベントハンドラメソッド onXxxx onConnectionEstablishedonServerTransaction

イベントクラス XxxxEvent ServerTransactionEventServerConnectionEvent

User newUser = new User(“A New User”, session);newUser.save();


次の例は、上の手順に従って Group オブジェクトに変更を加えます。

CaliberRM オブジェクトの削除

CaliberObject オブジェクトは、その remove メソッドを呼び出すことにより、 CaliberRM から削除できます。次に例を示します。

remove メソッドが行うのは、現在のベースラインからの要件の削除だけです。その要件が、それより前のすべてのベースラインから削除されるわけではありません。

要件

ここでは、 Requirement オブジェクトで行う基本的な作業について説明します。

要件ツリー

一般に、 CaliberRM のベースライン内の一連の要件の間には、階層構造状の関係が存在します。このため、これらの要件は要件ツリーを構成します。 RequirementTree クラスと RequirementTreeNode クラスを使用すると、これらのツリーを操作することができます。

次の手順により、要件ツリーのノードをたどることができます。

■ Baseline オブジェクトから RequirementTree オブジェクトを取得します。

■ RequirementTree オブジェクトの getRoot メソッドを呼び出して、ルートの RequirementTreeNode オブジェクトを取得します。

■ RequirementTreeNode オブジェクトの getChildren メソッドを再帰的に呼び出します。

Group group = session.getGroups()[2];group.lock();group.setDescription("A New Description");group.setEmailAddress("[email protected]");group.save();

Requirement requirement = session.getRequirement(77);requirement.remove();


次のコードは、上の手順に従って、要件ツリー内の各ノードに関する情報を出力します。

このコードを実行すると、次のような出力が得られます。

RequirementTreeNode オブジェクトの getDepthFirstEnumeration メソッドと getBreadthFirstEnumeration メソッドを使用することでも、要件ツリーをたどることができます。この方法を示すために、上のコードの一部分を getDepthFirstEnumeration メソッドを使用するように書き直したコードを次に示します。

...

// 現在のベースラインのツリーを取得します。 RequirementTree tree = currentBaseline.getRequirementTree();

// ツリーのルートノードを取得します。 RequirementTreeNode root = tree.getRoot(); TraverseTree(root);}

public void TraverseTree(RequirementTreeNode parentNode) {

// 現在のノードに関する関連情報を出力します。 PrintTreeNode(parentNode);

// 子コレクションに対して反復処理を実行します。 RequirementTreeNode[] children = parentNode.getChildren(); for (int i = 0; i < children.length; i++) { TraverseTree(children[i]);}}private void PrintTreeNode(RequirementTreeNode node) { StringBuffer sb = new StringBuffer(); for(int i = 0; i < node.getLevel(); i++) { sb.append(" "); } sb.append(node.getHierarchyNumber()); sb.append(" "); sb.append(node.getName()); sb.append(" "); sb.append(node.getSerialNumberTag()); System.out.println(sb);}

X100 Droid 2016412 Business Requirements BR2016416 1 Operating Environment BR1 1.1 Temperature BR2 1.2 Humidity BR3 1.3 Radiation BR4 2 Continuous operation BR5 2.1 Recharge Time BR73 3 Startup time BR6


要件ツリーに含まれる RequirementTreeNode オブジェクトは、プロジェクト、要件タイプ、要件のいずれかを表すことができます。 RequirementTreeNode オブジェクトに関連付けられている CaliberObject オブジェクトの ID を取得するには、 RequirementTreeNode オブジェクトの getAssociatedObjectID メソッドを使用します。次に例を示します。

RequirementTreeNode オブジェクトの addChild メソッドと insertChild メソッドを使用すると、要件ツリーに変更を加えることができます。次のサンプルコードは、 addChild メソッドを使用して、要件ツリー内の 1 番目の要件ノードの下に 2 番目の要件ノードを追加します。

// 現在のベースラインのツリーを取得します。RequirementTree tree = currentBaseline.getRequirementTree();

// ツリーのルートノードを取得します。RequirementTreeNode root = tree.getRoot();

// ルートの下位レベルの全ノードの列挙を// 取得します。Enumeration nodes = root.getDepthFirstEnumeration();

// 全ノードに対して反復処理を実行します。while(nodes.hasMoreElements()) { RequirementTreeNode node = (RequirementTreeNode)nodes.nextElement(); PrintTreeNode(node); }

// ノードに関連付けられている CaliberObject オブジェクトの ID を

取得します。CaliberObjectID coid = node.getAssociatedObjectID();

// CaliberObjectID を使用して、 CaliberObject オブジェクトを取得し

ます。CaliberObject co = session.get(coid);if(co instanceof Project) { // プロジェクト固有の情報を出力します。 Project p = (Project)co; System.out.println(p.getDescription());

} else if(co instanceof RequirementType) { // タイプ固有の情報を出力します。 RequirementType rt = (RequirementType)co; System.out.println(rt.getTag());

} else { // 要件固有の情報を出力します。 Requirement r = (Requirement)co; System.out.println(r.getStatus().getSelectedValue());}


ベースラインの getRequirements メソッドを要件の getChildRequirements メソッドと組み合わせて使用することでも、要件ツリーをたどることができます。ただし、この方法はリモートの CaliberRM Server に Requirement オブジェクト全体を要求することになるため、ツリーをたどる方法としては、 RequirementTree オブジェクトと RequirementTreeNode オブジェクトを使用する場合に比べてはるかに多くのリソースを消費します。

次のサンプルコードは、この方法を使用して、要件ツリーの初の 2 レベルを表示します。

RequirementTree tree = currentBaseline.getRequirementTree();

// プロジェクトノードを取得します。これは、必ずルートノードとなります。RequirementTreeNode projectNode = tree.getRoot();

// プロジェクトノードの下の初の要件タイプノードを取得します。RequirementTreeNode typeNode = projectNode.getChildAt(0);

// その要件タイプの下の 1 番目の要件と 2 番目の要件を取得します。RequirementTreeNode requirementNode1 = typeNode.getChildAt(0);RequirementTreeNode requirementNode2 = typeNode.getChildAt(1);

// 2 番目のノードを 1 番目のノードに追加することにより、ツリーに変更を加えます。requirementNode1.addChild(requirementNode2);

// 変更内容をコミットします。tree.save();

try{

// デフォルトまたは現在のベースラインを取得します。 Baseline defaultBaseline = project.getDefaultBaseline();

// ベースラインの要件ツリー内の初のレベルの // 要件を取得します。 Requirement[] topLvlReqs = defaultBaseline.getRequirements();

// 初のレベルにある一連の要件に反復処理を実行します。 for(int i; i < topLvlReqs.length; i++) {

Requirement req = topLvlReqs [i];System.out.println(req.getName());

// 現在の要件の「子」を取得します。Requirement[] childReqs = req.getChildRequirements();

// 子を反復処理します。for(int j; j < childReqs.length; j++) {

Requirement childReq = childReqs[j];System.out.println("\t" + childReq.getName());

} }}


要件の getParentRequirement メソッドを使用することにより、子から親要件へとツリーをたどることもできます。たとえば、次のコードは、 1 つの要件からツリー内のルート要件までのパスを出力します。

CaliberRM アプリケーションは、一般に、ツリーのトップレベルにあるすべての要件を要件タイプごとにグループ化し、並べ替えて表示します。このため、 Baseline オブジェクトの getRequirements メソッドは、必ずこれと同じように要件をグループ化して並べ替えた状態で返します。

メモ：要件のプロジェクト、ベースライン、およびタイプは、それぞれ要件の getProject メソッド、 getBaseline メソッド、および getRequirementType メソッドを呼び出すことにより調べられます。

要件の作成

CaliberRM SDK には、 Requirement オブジェクトのコンストラクタが 2 つ用意されています。 1 番目のコンストラクタでは、プロジェクトの要件ツリー階層構造のトップレベルに要件を作成できます。そして、 2 番目のコンストラクタは、既存の要件の子として作成する際に使用します。次の例で、 1 番目のコンストラクタを使用して新しい要件を作成する方法を示します。

try{

// ID 番号が 10 の要件の // 新バージョンを取得します。 Requirement req = session.getRequirement( 10 );

while(req != null) { System.out.println(req.getName());

req = req.getParent(); }

} catch(RemoteServerException) { rse.printStackTrace();

}

// セッションの初のプロジェクトを取得します。 Project project = session.getProjects()[0];

// プロジェクトの現在のベースラインを取得します。 Baseline currentBaseline = project.getCurrentBaseline();

// ベースライン内の初の要件タイプを取得します。 RequirementType type = currentBaseline.getRequirementTypes()[0];

// 新しい要件を作成します。Requirement newRequirement = new Requirement(

“New Requirement”, project, type, 0, session);

// 新しい要件を保存します。 newRequirement.save();


次の例では、 2 番目のコンストラクタを使用して、既存の要件の子となる要件を作成する方法を示します。この新しい要件は、「子要件」という名前になり、その親の子階層構造内の 4 番目の子となります。

要件の属性

CaliberRM では、任意の数のユーザー定義属性（UDA）を使用して要件を定義することができます。これに加えて、どの要件も必ず、ステータスと優先度をシステム属性として持ちます。

CaliberRM SDK の Requirement オブジェクトには、その UDA 値を取得するための getAttributeValues メソッドと、システム属性値を取得するための getStatus メソッドおよび getPriority メソッドが用意されています。たとえば、次のコードは、要件のステータスの選択中の値を出力します。これは、 AttributeValue のサブクラス UDAListValue のインスタンスです。

getAttributeType( ) メソッドを使用することによって、属性のデフォルト値を取得することもできます。次に例を示します。

各 AttributeValue サブクラスが 1 つの Attribute サブクラスと関連付けられていることに注意してください。このため、 UDABooleanValue オブジェクトの getAttributeType メソッドは UDABoolean クラスのインスタンスを返し、 UDATextValue オブジェクトの getAttributeValue メソッドは UDAText クラスのインスタンスを返します。

// 新しい要件の親とする要件を取得します。 Requirement parentReq = session.getRequirement(125);

// 親要件オブジェクトを使用して、新しい要件を作成します。 Requirement newRequirement = new Requirement(

“Child Requirement”,parentReq,3,session);

// 新しい要件を保存します。 newRequirement.save();

UDAListValue status = requirement.getStatus();Object selectedValue = status.getSelectedValue();System.out.print("Selected Value: " + selectedValue);

// 対応する属性の型を取得します。 UDAList attributeType = status.getAttributeType();

// その属性の型のデフォルト値オブジェクトを取得します。UDAListValue defaultValue = attributeType.getDefaultValue();

// デフォルト UDAListValue から、選択中の値を取得します。Object selectedDefaultValue = defaultValue.getSelectedValue();

System.out.print(“Default Value: “ + selectedDefaultValue);


次の表は、 SDK の AttributeValue クラスおよび Attribute クラスと CaliberRM の属性の型との関係をまとめたものです。

要件の履歴

CaliberRM SDK では、要件の履歴レコードに完全にアクセスすることができます。要件の履歴は、要件の任意のインスタンスに対して getHistory メソッドを呼び出すことにより取得できます。

次のクラス図は、 Requirement クラス、 History クラス、 HistoryRevision クラス、および HistoryChange クラスの関係をまとめたものです。

AttributeValue サブクラス Attribute サブクラスアプリケーションでの属性の型

UDATextValue UDAText 単一行テキスト

複数行テキストフィールド

UDAIntegerValue UDAInteger 整数

UDADurationValue UDADuration 継続期間

UDAFloatValue UDAFloat 浮動小数点数

UDADateValue UDADate 日付

UDABooleanValue UDABoolean 真偽値

UDAListValue UDAList 複数選択リスト

単数選択リスト

複数選択グループリスト

単一選択グループリスト

複数選択ユーザーリスト

単一選択ユーザーリスト


次の例で、これらのクラスを使用して履歴情報を表示する方法を示します。

トレーサビリティ

CaliberRM では、 2 つの要件間や、要件と CaliberRM 外のオブジェクト間にトレースの関係を持たせることができます。 CaliberRM SDK でも、これと同様に、 CaliberRM の要件と非要件ソフトウェアの成果物の両方に対するトレースの作成、削除、および変更がサポートされています。

トレース関連で比較的重要なクラスをいくつか次に示します。

■ Trace ：要件とその他の CaliberRM オブジェクトの間のトレースの関係を表します。対象となる CaliberRM オブジェクトは、要件でも、 CaliberRM 外にあるオブジェクトでもかまいません。

■ TraceManager ：トレースの作成、変更、および削除を行うための機能を提供します。

■ ExternalObject ： CaliberRM 外にあるすべてのオブジェクトを表す抽象基本クラスです。

■ File ：ファイルシステムオブジェクトを表します。

■ SCMFile ：ソース構成管理ツールにより管理されるオブジェクトを表します。 File クラスと SCMFile クラスは、両方とも com.starbase.caliber.external.file 内にあります。

■ XGenericObjectManager ：要件と非要件ソフトウェアの成果物の間にトレースを作成するための機能を提供します。

■ VendorAddIn ：他のアプリケーションの領域内にあるオブジェクトへの参照を表します。

// 要件オブジェクトの履歴を取得します。History history = req.getHistory();

// 履歴を含むリビジョンを取得します。HistoryRevision[] revisions = history.getRevisions();

for(int i = 0; i < revisions.length; i++) { Revision revision = revisions[i]; System.out.println(“Revision: “ + revision.getVersion()); System.out.println(“Date: “ + revision.getDate()); System.out.println(“User: “ + revision.getUserName()); System.out.println(“Comment: “ + revision.getComment());

// リビジョンを含む変更内容を取得します。 HistoryChange[] changes = revision.getChanges(); For(int j = 0; j < changes.length; j++) { Change change = changes[j];

System.out.println(

“\tField: “ + change.getFieldName()); System.out.println(“\tOld Value: “ + change.getOldValue());System.out.println(“\tNew Value: “ + change.getNewValue()); }}


トレースの取得

トレースは、 CaliberRM オブジェクト階層構造のさまざまなレベルで取り出すことができます。 Session クラスは、そのセッションで使用可能なすべてのトレースを返す getTraces メソッドを提供します。同様に、プロジェクトクラスの getTraces メソッドは、プロジェクト内にある要件がトレース元かトレース先となっているすべてのトレースを返します。

要件クラスには、トレースを取得するためのメソッドとして getTracesFrom と getTracesTo の 2 つがあります。次の例は、これらのメソッドを使用して、要件のトレース元またはトレース先となっているオブジェクトの名前を出力します。

要件間のトレースの作成

TraceManager クラスを使用すると、トレースの関係を作成したり変更したりできます。 TraceManager のインスタンスを取得するには、 Session オブジェクトの getManager メソッドを呼び出さなければなりません。次の例で、 TraceManager のインスタンスを取得する方法を示します。

try{

// 次の行は ID 番号が 1 の要件の// 新バージョンを取得します。Requirement requirement = session.getRequirement(1);

Trace[] tracesTo = requirement.getTracesTo();for(int i = 0; i < tracesTo.length; i++) {

// 次のトレースは、このシステム内の要件から// 他の何らかのオブジェクトへのトレースです。Trace trace = tracesTo[i];CaliberObject obj = trace.getToObject();System.out.println(obj.getName());

}

Trace[] tracesFrom = requirement.getTracesFrom();for(int i = 0; i < tracesFrom.length; i++) {

// 次のトレースは、他の何らかのオブジェクトから // このシステム内の要件へのトレースです。

Trace trace = tracesFrom[i];CaliberObject obj = trace.getFromObject();System.out.println(obj.getName());

}

} catch(RemoteServerException) { rse.printStackTrace();

}

TraceManager traceMgr;traceMgr = (TraceManager)session.getManager(Trace.class);


TraceManager オブジェクトを取得したら、それを使用してトレースを作成できます。次の例は、 2 つの要件間にトレースを作成します。

非要件ソフトウェアの成果物へのトレースの作成

前の例では、 CaliberRM の範囲内にある 2 つのオブジェクト（両方とも要件）の間のトレースの関係を作成しました。次の例では、 CaliberRM の外部にあるオブジェクトをトレース先とするトレースを作成する方法を示します。

外部オブジェクトへの参照を作成するには、まず適切なオブジェクトマネージャの参照を取得しなければなりません。既に説明したように、 CaliberObjectManager のインスタンスは、 Session オブジェクトの getManager メソッドを呼び出すことにより取得できます。上の例では、次に示す行で、 com.starbase.caliber.xgeneric.XGenericObjectManager （CaliberRM 外部のほとんどのオブジェクトを管理するクラス）のインスタンスを取得しています。

createFileTrace メソッドは、次に示すように、その 1 番目のパラメータとして要件への参照を必要とすることに注意してください。

これは、外部オブジェクトへの参照は CaliberRM 内にしか存在できないのに、そのオブジェクトが要件とのトレースの関係に参加するためです。この関係が削除されると、参照も削除されます。この規則の唯一の例外は、 Mercury TestDirector オブジェクトと Select Enterprise オブジェクトです。これらは、要件とリンクすることなく CaliberRM に追加したり CaliberRM から削除したりできます。

Requirement req1 = session.getRequirement(1);Requirement req2 = session.getRequirement(2);

// 次の行は、 req1 から req2 へのトレースを作成します。TraceMgr.createTrace(req1, req2, false);

Class clazz = File.class;XGenericObjectManager extGenObjMgr =

(XGenericObjectManager)session.getManager(clazz);

Requirement req1 = session.getRequirement(1);

// 次の行は CaliberRM システム内に File オブジェクトを作成し、// req1 から新しい File へのトレースを作成します。File f = extGenObjMgr.createFileTrace(

Req1, true, "foo.txt", "C:\\temp\\");

Class clazz = File.class;FileManager fileMgr = (FileManager)session.getManager(clazz);

File f = fileMgr.createFileTrace( Req1, ...

第 4 章 : CaliberRM 用のトレーサビリティアドインの作成 41

第章

Chapter4CaliberRM 用のトレーサビリティアドインの作成

はじめに

トレーサビリティアドインの開発と配布は、 CaliberRM のためのカスタムソリューションをユーザーに提供するも簡単な方法です。アドインは、 CaliberRM に一連のオブジェクトを提供します。これらのオブジェクトは CaliberRM のユーザーインターフェイスを通じて表示されるため、ユーザーは、それらと要件とのトレース関係を作成できるようになります。たとえば、アドインが Microsoft Project のタスクや、設計ツールやテストツールのオブジェクトを表示します。

このドキュメントでは、 Microsoft Visual Basic.NET プロジェクトのサンプルを使用して CaliberRM 用のトレーサビリティアドインを作成する方法を説明します。サンプルファイルは、 Program Files\Borland\CaliberRM\Samples\Addins\ にあります。

Visual Basic.NET サンプルの使用

CaliberRM のインストールには、 CaliberRM 用のトレーサビリティアドインを Visual Basic.NET で作成するために使用できる一連のサンプルファイルが含まれています。

メモ：トレーサビリティアドインファイルと Assembly.Info.vb 内の GUID をすべて変更する必要があります。

デフォルトでは、サンプルプロジェクトは、 Program Files\Borland\CaliberRM\Samples\Addins\HelloWorld2 VB.NET に置かれています。ここには以下のファイルがあります。

■ AssemblyInfo.vb

■ HelloWorld2_VBNet.sln

■ HelloWorld2_VBNet.vbproj

■ HelloWorld2_VBNet.vbproj.user

■ Icon1.ico

■ Icon2.ico

■ Icon3.ico

■ Icon4.ico


■ Icon5.ico

■ VendorObject.vb

■ VendorSession.vb

■ VendorView.vb

トレーサビリティアドインを新規に作成するには、以下の手順を実行します。

1 " クラスライブラリ " テンプレートを使用して新規の Visual Basic プロジェクトを作成します。

2 VendorSession.vb、 VendorView.vb、および VendorObject.vb ファイルを、この新規 VB プロジェクトのディレクトリにコピーします。次に、 [ 既存項目の追加 ...] を使用して、これらのファイルをプロジェクトに追加します。

3 VB.NET の CreateGUID ツール（[ ツール｜ GUID の作成 ] メニュー）を使用して、新たに追加したファイルの COM GUID 値をすべて変更します。

4 次に、この新規プロジェクトをビルドします。 VS.NET が、ビルドの後に、新たにビルドされた DLL を登録します。コマンドラインから regasm （.NET Assembly Registration ツール ) を使用して、他のマシンにこの DLL を登録することもできます。

5 これでトレーサビリティアドインを使用する準備ができました。インターフェイスで必要なプロパティとメソッドを実装できます。

トレーサビリティアドインのインターフェイス

アドインを作成するには、 VendorSession、 VendorView、 VendorObject の 3 つのクラスのプロパティと関数を入力する必要があります。以下、これらのクラスそれぞれと、そのプロシージャについて詳しく説明します。

VendorSession

VendorSession クラスは、 CaliberRM クライアントがアドインとやり取りする際のコンテキストを提供します。その後は、 VendorSession が、公開で作成可能な唯一のクラスになります。

Public ReadOnly Property SupportsViewBuilding() As Booleanアドインを利用して、ユーザーが動的にカスタムビューを作成できるようにするには、このプロパティを "true" にます。たとえば、データベースとのインテグレーションを構築している場合に、クエリに基づいてデータの複数のビューを公開したいことがあります。逆に、デフォルトのビューだけをサポートするアドインを作成している場合は、このプロパティを "false" にします。

詳細については、 44 ページの「VendorView」を参照してください。

Public WriteOnly Property ConfigFilePath() As StringConfigFilePath プロパティは、 CaliberRM により設定され、アドインが使用する構成ファイルのパスを示します。この構成ファイルは、 CaliberRM Administrator でアドインを登録する際に指定します。新規のトレーサビリティアドインを有効にする方法については、 45ページの「トレーサビリティアドインの登録と有効化」を参照してください。

いったん設定された構成ファイルは、 CaliberRM システムにより管理され、 VendorSession クラスが初期化された直後に（ConfigFilePath プロパティを使用して）インテグレーションに渡されます。


Public Property SilentMode() As Booleanこのプロパティは、 CaliberRM により設定され、アドインがサイレントモードで実行されることを示します。サイレントモードでは、アドインは、ユーザー入力を必要とするダイアログボックスを一切表示しません。

CaliberRM がこのプロパティを取得した場合、アドインはサイレントモードで動作していることを示します。

メモ：サイレントモードを利用すると、 Datamart のレポートをスケジュールして、空いている時間にレポート生成をすることができます。 CaliberRM Server に、トレーサビリティアドインへのトレースを持つプロジェクトが含まれる場合、 Datamart がタスクを実行するときには認証情報を探しますが、アドインがサイレントモードで実行されていると、ログインダイアログは表示されません。ログインダイアログを表示しなくても、認証情報を収集できるように、それをファイルまたはアドイン用のレジストリに保存しておくことをお勧めします。

Public ReadOnly Property InterfaceVersion() As Integerこのプロパティは、アドインが実装しているアドインインターフェイスのバージョンを提供します。現在の CaliberRM は、このインターフェイスのバージョン 2.0 をサポートしています。従って、このプロパティは常に 2 になります。

Public Function GetVendorViews(ByVal BuildView As Boolean) As Collectionこの関数は、 CaliberRM に VendorView オブジェクトのコレクションを提供します。これらのビューは、 CaliberRM の [ トレーサビリティ修正 ] ウィンドウに、それぞれ 1 つのタブとして表示されます。

CaliberRM は、 [ トレーサビリティ修正 ] ウィンドウを初期化するときに、 BuildView パラメータを "false" に設定して（これは、 CaliberRM が初期の（つまりデフォルトの）ビューを要求していることを示します）、アドインの GetVendorViews メソッドを呼び出します。アドインが動的なビューの構築をサポートしている場合は（詳細は 42 ページの「Public ReadOnly Property SupportsViewBuilding() As Boolean」を参照）、 [ ビューの構築 ] ボタンが有効になります。ユーザーが [ ビューの構築 ] ボタンをクリックすると、 CaliberRM は BuildView パラメータを "true" に設定して GetVendorViews メソッドを呼び出します。アドインは、ダイアログボックスを表示し、ユーザーにビューパラメータの指定を要求します。戻されたビューは、既存のビュータブに追加されます。


Public Function GetVendorObject(ID As String) As VendorObjectGetVendorObject 関数は、単一の VendorObject オブジェクトを取得するために、 CaliberRM により呼び出されます。

VendorView

すでに説明したように、トレーサビリティアドインは、 VendorSession オブジェクトの GetVendorViews メソッドを通じて一連の VendorView オブジェクトを提供します。こうして取得された各 VendorView オブジェクトは、 CaliberRM の [ トレーサビリティ修正 ] ウィンドウでビューのタブに表示される一連の VendorObjects オブジェクトを提供します。

Public ReadOnly Property ViewName() As Stringこのプロパティは、ビューの名前を提供します。

Public ReadOnly Property IsList() As BooleanCaliberRM は、アドインオブジェクトのコレクションをツリーまたはリストとして表示することができます。このプロパティを "true" にすると、ビューのオブジェクトがリストとして表示されます。 "false" にすると、ツリーとして表示されます。

Public ReadOnly Property VendorObjects() As Collectionこのプロパティは、ビューを構成するオブジェクトを提供します。ビューがオブジェクトのツリーを表す場合（つまり IsList = "false"）は、このオブジェクトコレクションは、ツリー内のノードの第一レベルを表します。

VendorObject

VendorObject クラスは、アドインにより公開される単一のオブジェクトを表します。CaliberRM は、これらのオブジェクトを VendorView オブジェクトのメンバとして取得するか、または VendorSession オブジェクトの GetVendorObject メソッドを通じて取得します。

Public ReadOnly Property ID() As StringID プロパティは、 CaliberRM 内でのオブジェクトの一意の識別子を提供します。CaliberRM は、以降に VendorSession オブジェクトの GetVendorObject メソッドを呼び出す際に、この ID を使用します。

Public ReadOnly Property ObjectName() As StringObjectName プロパティは、 VendorObject の名前を提供します。

Public ReadOnly Property ShortObjectName() As Stringこのプロパティは、オブジェクトの省略名を CaliberRM に提供します。 CaliberRM は、この名前が 16 文字を超えている場合には、これを切り詰めます。

Public ReadOnly Property Icon() As Longこのプロパティは、オブジェクトのウィンドウアイコンハンドルを提供します。

Public ReadOnly Property Traceable() As BooleanTraceable プロパティは、 CaliberRM がユーザーに VendorObject オブジェクトへのトレースの作成を許可するかどうかを決定します。


Public ReadOnly Property HasChildren() As Booleanこのプロパティは、 VendorObject オブジェクトが子を持つかどうかを決定します。CaliberRM は、 VendorObject がオブジェクトのツリーとして提供された場合にのみ（VendorView オブジェクトの IsList プロパティを参照）、このプロパティをチェックします。このプロパティが "true" の場合、 CaliberRM は、オブジェクトツリーでそのオブジェクトの横に記号を表示します。

Public ReadOnly Property Children() As Collectionこのプロパティは、 CaliberRM から VendorObject オブジェクトの子へのアクセス手段を提供します。 CaliberRM は、 HasChildren プロパティが "true" であり、ユーザーがツリー内の VendorObject オブジェクトを展開した場合に、このメソッドを呼び出します。

Public ReadOnly Property Operations() As Variant各 VendorObject オブジェクトは、その Operations プロパティを通じて、必要な数だけの操作を CaliberRM ユーザーに公開できます。このプロパティは、オブジェクトに対して実行できる操作を表す文字列を要素とする配列を返します。たとえば、ファイルを表す VendorObject オブジェクトを作成している場合なら、それに対して実行できる操作として Open や Properties などを公開することになるでしょう。

Public Sub DoOperation(Operation As String)ユーザーが CaliberRM 内で VendorObject オブジェクトを右クリックすると、 CaliberRM は、Operations プロパティを参照し、返された文字列を入れたポップアップメニューを表示します。その後、ユーザーがどれかの操作のメニュー項目を選択すると、 CaliberRM は、VendorObject オブジェクトの DoOperation メソッドを呼び出して、選択された操作の名前を渡します。

Public Sub OnTraceCreated(RequirementID As Integer)このメソッドは、 CaliberRM の要件と VendorObject との間にトレースが作成されたときに、CaliberRM によって呼び出されます。

Public Sub OnTraceDeleted(RequirementID As Integer)このメソッドは、 CaliberRM の要件と VendorObject オブジェクトとの間のトレースが削除されたときに、 CaliberRM によって呼び出されます。

Public Sub OnStatusChange(RequirementID As Integer, MadeSuspect As Boolean)このメソッドは、 CaliberRM の要件と VendorObject オブジェクトとの間のトレースの " 要検討 " ステータスが変更されたときに、 CaliberRM によって呼び出されます。

トレーサビリティアドインの登録と有効化

アドインをコーディングしてコンパイルしたら、各 CaliberRM クライアントコンピュータにそれをデプロイするだけでなく、 CaliberRM Server 上の特定のプロジェクト用にそれを登録して有効化する必要があります。

アドインを登録して有効化するには、以下の手順を実行します。

1 CaliberRM Server のコンピュータ上で、 CaliberRM Administrator を開き、左ペインからプロジェクトを選択します。

2 右ペインで [External Traceability] タブを選択します。

3 [New...] ボタンをクリックします。 [New Integration] ダイアログボックスが表示されます。


4 [Vendor Name] （ [ トレーサビリティ修正 ] タブに表示される名前）と [Library Name]（Visual Basic で、プロジェクトの [ プロジェクトプロパティ ] ダイアログボックスの [プロジェクト名 ] フィールドに表示される名前）を入力し、アイコンを選択します。アドインが使用する構成ファイルの場所も指定できます。 CaliberRM は、このインテグレーションを使用するすべてのクライアントに、このファイルを自動的に配布します（詳細については、 42 ページの「VendorSession」の ConfigFilePath プロパティの説明を参照してください）。

5 [OK] をクリックして、新しいインテグレーションを作成します。これで、すべての CaliberRM プロジェクトの [Disabled] リストボックスに新しいインテグレーションが追加されます。

6 インテグレーションを有効にするには、 [Disabled] リストボックスでインテグレーションを選択し、 [ < ] ボタンをクリックします。

7 [File ｜ Save Changes] をクリックします。アドインが登録されて CaliberRM Server で有効になります。

8 ユーザーが要件からアドインオブジェクトへのトレースを必要とする場合は、各 CaliberRM クライアントマシンにアドインをデプロイします。セットアッププログラムを使用するか、必要なファイルを手動またログインスクリプトを使用して配布して登録することができます。

付録 A: CaliberRM のオブジェクトモデル 47

付録

Appendix ACaliberRM のオブジェクトモデル

以下の図は、使用したいオブジェクトを探す場合や、使用するオブジェクトの CaliberRM オブジェクトモデルにおける位置付けを理解したい場合に使用できます。

以下の表に、図中でのオブジェクトとコレクションの表示を示します。

オブジェクトを示します。

オブジェクトのコレクションを示します。

オブジェクト階層構造の完全な表示が図中の他の場所にあることを示します。


CaliberRM のオブジェクトモデル

付録 A: CaliberRM のオブジェクトモデル 49

caliberrm sdk programmer's guide

Documents