Reprise版QA·Cのライセンス設定解説書 for Windows - 東陽テクニカ

Windows 版 Reprise 設定解説書
C/C++言語 ソースコード・アナライザ
/
第 1.04 版
日
2014 年 6 月 23 日
最終更新日
2014 年 12 月 9 日
作
成
Programming Research Ltd.
ソフトウェア・ソリューション
©2014 Programming Research Ltd / (株)東陽テクニカ
1
目次
Windows 版 Reprise 設定解説書 .................................................................................................................... 1
はじめに .......................................................................................................................................................... 3
1.
Reprise がサポートするプラットフォーム ..................................................................................................... 4
2.
Reprise のインストール............................................................................................................................. 5
3.
Windows7 環境へのインストール .............................................................................................................. 6
4.
バッチファイルの配置.............................................................................................................................. 7
5.
ライセンスファイルの配置......................................................................................................................... 8
6.
prqa.opt の作成...................................................................................................................................... 9
7.
サービスの登録 .................................................................................................................................... 10
8.
サービス登録の確認と開始 .................................................................................................................... 12
9.
接続先サーバの設定 ............................................................................................................................ 15
10.
サービスの削除 .................................................................................................................................... 17
11.
ライセンスファイルの入れ替え ................................................................................................................ 18
12.
Web 管理画面...................................................................................................................................... 19
13.
Web 管理画面の操作 ........................................................................................................................... 20
14.
オプションファイルの使い方 ................................................................................................................... 23
14.1
レポートログの出力 ........................................................................................................................... 23
14.2
ライセンスサーバへアクセスできるクライアントを限定 ............................................................................ 24
14.3
ライセンスのタイムアウト時間を設定 .................................................................................................... 24
15.
RLM Log Reader .................................................................................................................................. 25
©2014 Programming Research Ltd / (株)東陽テクニカ
2
はじめに
本書は、ライセンス管理サーバで Reprise をサービスとして登録して開始する手順を記述します。
©2014 Programming Research Ltd / (株)東陽テクニカ
3
1. Reprise がサポートするプラットフォーム
Reprise は下記プラットフォームにインストールしてお使い頂く必要がございます。
(Reprise のバージョン 9.0 の場合になります。)
<Windows>
Windows 7 (64-bit, 32-bit)
Windows Vista (64-bit, 32-bit)
Windows XP (64-bit, 32-bit)
Windows 2000 (32-bit)
Windows server editions 2000 (32-bit)
Windows 2003 Server (32-bit)
Windows 2008 Server (64-bit, 32-bit)
<Linux>
Red Hat Enterprise Linux 3, 4, 5 (64bit, 32bit)
Linux PPC (64-bit)
<Solaris>
Solaris 8, 9, 10
©2014 Programming Research Ltd / (株)東陽テクニカ
4
2. Reprise のインストール
ライセンスサーバにするコンピュータの任意のディレクトリに Reprise をインストールして下さい。(インストール先が
Windows7 の場合は 3 章「Windows7 環境へのインストール」をご参照ください)
Reprise はインストール CD の中に含まれますが、以下の URL からダウンロードすることもできます。ダウンロード先にい
くつかのバージョンのインストーラがある場合は、最新のものをお使いください。インストール・ウィザードでは、特に必要
が無い場合、デフォルト設定を選択してください。
Windows 版:
http://www.programmingresearch.com/downloads/Windows/Reprise/
Solaris 版:
http://www.programmingresearch.com/downloads/Unix/Solaris/Reprise/
Linux 版:
http://www.programmingresearch.com/downloads/Unix/Linux/Reprise/
©2014 Programming Research Ltd / (株)東陽テクニカ
5
3. Windows7 環境へのインストール
Windows7 をお使いになられる場合は以下の手順に従って、インストールを実施します。
1.
2.
Administrator 権限を持っているユーザでログインします。
インストーラを右クリックして表示されるポップアップメニューより「管理者として実行」を選択します。
3.
ユーザアカウント制御の影響を避けるため、C:\Program Files もしくは C:\Program Files (x86)ディレクトリ配下への
インストールを避けていただくようにお願いいたします。以下の例ではインストール先フォルダを
C:\PRQA\Reprise にしています。
4.
インストーラの指示に従ってインストールを続行します。
©2014 Programming Research Ltd / (株)東陽テクニカ
6
4. バッチファイルの配置
Reprise 登録用バッチファイルを Reprise のインストールディレクトリと同じディレクトリに配置します。このバッチファイル
は、ここでは C:\PRQA\Reprise に配置したと仮定します。バッチファイルは以下の URL からダウンロードすることができ
ます。
http://www.toyo.co.jp/ss/qac/sheet/RepriseSettingBatch.zip
なお、各バッチファイルには以下の機能があります。
RepriseConfig.bat
Windowsサービスの起動条件を変更するためのバッチファイルです。
REPRISE_HOME :Repriseがインストールされているディレクトリの絶対パス
LICENSE_FILE :Repriseのライセンスファイルの絶対パス
LOG_FILE
:動作ログファイルの絶対パス
SERVICE_NAME :Windowsに登録するRepriseのサービス名
REPRISE_PORT :Web管理画面にアクセスするためのポート番号
RegistRepriseAsService.bat
RepriseのサービスをWindowsに登録するためのバッチファイルです。
DeleteRepriseService.bat
RepriseのサービスをWindowsから削除するためのバッチファイルです。
CreatePrqaOptionFile.bat
ご利用環境に対応したprqa.optを作成するファイルです。
©2014 Programming Research Ltd / (株)東陽テクニカ
7
5. ライセンスファイルの配置
ライセンスファイルを Reprise がインストールされているフォルダに配置します。
なお、ライセンスファイルを入手するために事前に“QA・C/QA・C++/QA・Verify(Reprise)ライセンス申請書”に hostid
等をご申請頂く必要があります。申請に必要な hostid の取得に関しましては、製品パッケージに同梱されている“QA・
C/QA・C++/QA・Verify(Reprise)のライセンスについて”をご参照ください。
ライセンスファイルの配置
次に RepriseConfig.bat を編集して、インストールディレクトリの絶対パスとライセンスファイルへの絶対パスをお
客様の環境に合わせます。
©2014 Programming Research Ltd / (株)東陽テクニカ
8
6. prqa.opt の作成
ライセンス使用許諾書に従って製品をご利用頂くためには、ライセンスの使用ログを継続して蓄積して頂く必要がござ
います。そして、使用ログを蓄積していくためには、オプションファイルを作成して、その中に所定の設定を含めて頂く
必要がございます。CreatePrqaOptionFile.bat は、ログを累積するための最低限の設定を含めたオプションファイルの
デフォルトファイル(prqa.opt)を作成するためのバッチになります。
CreatePrqaOptionFile.bat を実行すると、CreatePrqaOptionFile.bat と同じディレクトリに prqa.opt が生成されますので、
この prqa.opt を利用してライセンスサーバをお使いください。prqa.opt は、ライセンスサーバ起動時に自動的に読み込
まれます。
すでに prqa.opt が存在する場合は、prqa.opt を上書きするのか否かを問い合わせるメッセージが表示されます。もし、
アクセス可能なクライアント等の指定など、デフォルトから追記された設定が prqa.opt に含まれるようでしたら、上書きを
中止するため、N を入力してください。
©2014 Programming Research Ltd / (株)東陽テクニカ
9
7. サービスの登録
Reprise を Windows サービスとして登録します。手順は以下です。
1. Administrator 権限を持っているユーザでログインします。
2. コマンドプロンプトを表示します。
 Window7 の場合は Windows メニューの“プログラムとファイルの検索”に cmd と入力して、cmd.exe を検索します。
その後、検索された cmd.exe を右クリックしてポップアップメニューを表示し、「管理者として実行」を選択します。
(Windows7 の場合)
©2014 Programming Research Ltd / (株)東陽テクニカ
10

WindowsXP の場合はスタートメニューの“ファイル名を指定して実行”を選択します。次に、ファイル名を指定して
実行ダイアログに cmd と入力し、コマンドプロンプトを起動します。
(WindowsXP の場合)
3. cd コマンドを使用してカレントディレクトリを Reprise インストールしたフォルダに変更します。
RegistRepriseAsService.batを実行します。
4. コマンドプロンプトに正常に PRQA Reprise License サービスが登録できたことを示すメッセージが表示されることを
ご確認ください。
©2014 Programming Research Ltd / (株)東陽テクニカ
11
8. サービス登録の確認と開始
1. Windows メニューの[スタート]-[マイコンピュータ]-[管理]よりコンピュータの管理画面を開きます。
2. サービスとアプリケーションのサービスを選択して PRQA Reprise License が登録されていることを確認します。
©2014 Programming Research Ltd / (株)東陽テクニカ
12
3. 右クリックメニューの[開始]をクリックして PRQA Reprise License サービスを開始します。
4. PRQA Reprise License サービスが実行されているマシンにインストールされているブラウザで以下の URL にアクセ
スいたします。http://localhost:5054
5. 以下の Web 管理画面が表示されることを確認します。左のメニューの Status をクリックします。
©2014 Programming Research Ltd / (株)東陽テクニカ
13
6. Status 画面の ISV Servers リストの Server Status 列にある<prqa>ボタンをクリックします
7. License pool status にご申請頂いたライセンスのリストが表示されていれば、正常に Reprise ライセンスサーバが起
動していることになります。
©2014 Programming Research Ltd / (株)東陽テクニカ
14
9. 接続先サーバの設定
クライアントは、レジストリ
(Windows XP / Windows7 32bit 版)
HKEY_LOCAL_MACHINE\SOFTWARE\PR:QA\Licence\PRLDHOST
(Windows XP / Windows7 64bit 版)
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\PR:QA\Licence
の値を参照して、ライセンスサーバに接続します。この値はレジストリに手動で書き込むことも可能ですが、
PRQALicenceTool.exe を使って設定すると便利です。
1.
PRQALicenceTool.exe を起動します。このアプリケーションは<QA・C / QA・C++のインストール先>\bin もしくは
<QA・Verify のインストール先>\Server に配置されています。なお、ライセンスサーバの OS が Windows
Vista/Windows 7 の場合は、管理者権限を持つユーザでログインして、PRQALicenceTool.exe を右クリックし、[管
理者として実行]を選択して実行する必要があります。
正常に起動すると、以下のようなライセンス・ウィザードが現れます。
2. 接続先サーバを“ポート番号@ホスト名(IP アドレス)”の形式で指定します。
ライセンスファイルに記載されている SERVER から始まる行の 4 つ目の番号がポート番号になります。
通常は 5055 になります。
例:SERVER localhost xxxxxxx 5055
^^^^^^^
3. <Add>をクリックします。License Files/Server に指定した接続先が追加されます。
©2014 Programming Research Ltd / (株)東陽テクニカ
15
4.
5.
6.
<Test>をクリックします。ライセンスサーバと正常に接続できた場合は、”Available Features”にライセンスサーバが
所有するライセンス一覧が表示されます。表示されないときは、接続先が正しいのか、ライセンスサーバが起動し
ているのかを確認してから、再度同じ操作をしてください。
ウインドウの右上の<×>をクリックして設定を保存します。
QA・C もしくは QA・Verify が正常に起動できることを確認します。
©2014 Programming Research Ltd / (株)東陽テクニカ
16
10.サービスの削除
4 章で Windows に登録した Reprise サービスを削除する場合は、コマンドラインから DeleteRepriseService.bat を実行し
てください。(Windows7 をお使いの場合は「管理者として実行」を用いてバッチを実行する必要があります。)
©2014 Programming Research Ltd / (株)東陽テクニカ
17
11.ライセンスファイルの入れ替え
ライセンスファイルの入れ替えは以下の手順で実施してください。
(1) DeleteRepriseService.bat を実行します。
(2) Windows サービス一覧から PRQA Reprise License サービスが
削除されていることを確認します。
(3) 旧ライセンスファイルを別ディレクトリに移します。
(4) 新ライセンスファイルを Reprise インストールディレクトリに
配置します。
(5) RepriseConfig.bat を編集し直して、ライセンスサーバが
新ライセンスファイルを参照できるようにします。
(6) RegistRepriseAsService.bat を実行します。
(7) Windows サービス一覧から PRQA Reprise License サービスが
登録されていることを確認します。
(8) PRQA Reprise License サービスを開始します。
©2014 Programming Research Ltd / (株)東陽テクニカ
18
12.Web 管理画面
ライセンスサーバで http://localhost:5054/にアクセスすると Web 管理画面が表示されます。クライアントからは
http://<ライセンスサーバマシン名または IP アドレス>:5054/ にアクセスします。この画面では Reprise ライセンスサー
バの状態の表示、設定変更等を行うことができます。Web 管理画面の詳細な操作説明は
http://www.reprisesoftware.com/RLM_Enduser.html を参照してください。
なお、Web 管理画面にアクセスするためのポート番号は RepriseConfig.bat の環境変数 REPRISE_PORT で変更するこ
とができます。ファイアウォールの制限でデフォルトの 5054 番のポートを解放することができないときは、
REPRISE_PORT の値を変更してください。
例 5000 番ポートで Web 管理画面にアクセスする
©2014 Programming Research Ltd / (株)東陽テクニカ
19
13.Web 管理画面の操作
Web 管理画面では主に以下の操作を実施することができます。
1.
2.
3.
現在使用されているライセンスの一覧を表示する
ユーザが使用しているライセンスを強制的に解放する
ライセンスサーバが所有しているライセンスの一覧を表示する
これらの操作手順を下記に記載します。
 (現在使用されているライセンスの一覧を表示する)
1.1 左メニューの Status ボタンをクリックします。左ペインにライセンスサーバの状態が表示されることを確認します。
1.2 ISV Servers リストの License Usage ボタンをクリックします
©2014 Programming Research Ltd / (株)東陽テクニカ
20
1.3 左ペインに Get License Usage が表示されます。GET License Usage ボタンをクリックします
1.4 左ペインに現在使用されているライセンスの一覧が表示されます。

(ユーザが使用しているライセンスを強制的に解放する)
2.1 現在使用されているライセンスの一覧を表示します。(1.1~1.4 の手順を参照してください) Remove ボタンをクリッ
クして使用されているライセンスを強制開放します。
©2014 Programming Research Ltd / (株)東陽テクニカ
21

(ライセンスサーバが所有しているライセンスの一覧を表示する)
3.1 左メニューの Status ボタンをクリックします。左ペインにライセンスサーバの状態が表示されることを確認します。
3.2 ISV Servers リストの Server Status の prqa ボタンをクリックします
3.3 左ペインにライセンスサーバが所有するライセンスの一覧が表示されることを確認してください。
©2014 Programming Research Ltd / (株)東陽テクニカ
22
14.オプションファイルの使い方
オプションファイルを利用すると、ライセンスサーバの挙動を細かく設定することが可能です。例えば、クライアントからラ
イセンスサーバへアクセスできるマシンを限定、レポートログの出力を実施すること等ができます。Reprise のプログラム
と同じディレクトリ内のオプションファイルが読み込まれます。オプションファイルのデフォルト名は prqa.opt です。オプ
ションファイルの記述を変更したときは、ライセンスサーバを再起動して、変更を反映される必要があります。
14.1 レポートログの出力
オプションファイルに REPORTLOG オプションを使って、ライセンスサーバの利用状況を記録したレポートログを出力す
ることができます。REPORTLOG オプションの利用方法の一例を下記に示します。
REPORTLOG オプションの詳細に関しましては、http://www.reprisesoftware.com/RLM_Enduser.html をご参照くださ
い。
記述方法)
REPORTLOG [+]file_path [std | small | detailed] auth
※ファイルパスの先頭に+が付与された場合は、ライセンスサーバの再起動時もレポートログは、上書きされず追記さ
れるようになります。
例)std のフォーマットで C:\PRQA\Reprise\PRL_usage.log を出力。レポートログを上書きしない。
REPORTLOG +C:\PRQA\Reprise\PRL_usage.log std auth
また、ROTATE オプションを使って、1 ファイルのレポートログにどのぐらいの期間のログを蓄積するのかを設定すること
ができます。蓄積期間が完了したファイルは、report_log_file_name.yyyy.mm.dd というファイル名に自動的にリネームさ
れます。
記述方法)
ROTATE [daily | weekly | monthly | #days ]
例)ログを 30 日蓄積する
ROTATE 30
©2014 Programming Research Ltd / (株)東陽テクニカ
23
14.2 ライセンスサーバへアクセスできるクライアントを限定
オプションファイルに INCLUDEALL オプションを使って、ライセンスサーバへアクセスできるクライアントを限定すること
ができます。INCLUDEALL オプションの利用方法の一例を下記に示します。INCLUDEALL オプションの詳細に関しま
しては、http://www.reprisesoftware.com/RLM_Enduser.html をご参照ください。
記述方法)
INCLUDEALL [user|host|group|host_group|internet|internet_group|project] who
例)john, pc1, IP アドレスが 172.16.7.x の PC のみが使用できる
INCLUDEALL user john
INCLUDEALL host pc1
INCLUDEALL internet 172.16.7.*
14.3 ライセンスのタイムアウト時間を設定
TIMEOUT オプションでは、ライセンスサーバとクライアント間の通信が不能になってから、クライアントのライセンスが自
動的に解放されるまでの時間を設定することができます。TIMEOUT オプションは、デフォルトのオプションファイルでは
180 秒に設定されておりますが、必要であればこの値を変更することができます。このオプションを設定することで、クラ
イアントマシンとライセンスサーバとの接続ができなくなり、クライアントマシンがライセンスを保持したままになる状態を
防ぐことができます。
例)QAC の GUI のライセンスが自動的に解放されるまでの時間を 300 秒に設定する。
TIMEOUT 300 qac-gui
例)QAC++のメッセージブラウザのライセンスが自動的に解放されるまでの時間を 300 秒に設定する。
TIMEOUT 300 qacpp-mbrw
※1
この設定が有効になるためには、ライセンスファイルにタイムアウト情報が記載されている必要があります。タイムアウト
情報が記載されているのか否かはライセンスファイルに min_timeout=180 が記載されているか否かで判断してくださ
い。この記述が無い場合は、以下のページからライセンス申請書を入手し、必要事項を記入の上、ライセンスの再発行
をご申請ください。タイムアウト情報を記述したライセンスファイルを発行させて頂きます。なお、ライセンスファイルを再
発行するためには、保守契約が有効である必要がございます。
http://www.toyo.co.jp/ss/qac/licence.html
※2
設定値は 180 秒以上にしてください。(180 秒より短い値を設定しても TIMEOUT は強制的に 180 秒に設定されま
す。)
©2014 Programming Research Ltd / (株)東陽テクニカ
24
15.RLM Log Reader
RLM Log Reader を使用すると、prqa.opt(6 章参照)で指定されるログファイル prqa_usage.log の情報から csv 形式の利
用状況レポートを作成することができます。RLM Log Reader は以下から入手することができます。
http://sourceforge.jp/projects/sfnet_rlmlogreader/
【ご注意】
RLM Log Reader は Reprise ライセンス管理ツールの製造元である Reprise Software 社、QA・C/QA・C++の製造元であ
る Programming Research 社、弊社 東陽テクニカが作成したツールではありません。そのため RLM Log Reader の使用
方法や動作についてのお問い合わせにはお答えできない場合がありますことをご了承ください。
また、以下に簡単な使用方法や主なレポートの見方について述べますが、より詳しくは RLM Log Reader のパッケー
ジ内の README.html を参照ください。
[使用方法]
1. ライセンスサーバの OS に合った RLM Log Reader のパッケージを入手し、適当な場所に展開します。
2. RLMLogReader.exe を実行します。以下の画面が表示されます。
3. “RLM Log File” に prqa_usage.log のパス、”Report Output Directory” にレポートの出力先を指定し、Generate
ボタンを押下します。
[レポートの見方]
主なレポートについてのみ以下に記載します。
・prqa_usage_TotalDuration
prqa_usage.log の記録期間全体について、1 ユーザごとに 1 行で製品使用時間の合計が出力されます。
(出力例)
User
Cecil
Terra
使用実績のある
ユーザ名の一覧
qac Duration
(HH:MM:SS)
qac-gui Duration
(HH:MM:SS)
0:00:00
0:00:00
13:57:19
20:11:50
ユーザごとの
QA・C GUI の
合計使用時間
©2014 Programming Research Ltd / (株)東陽テクニカ
qac-mbrw
Duration
(HH:MM:SS)
4:23:33
0:41:03
ユーザごとの
QA・C メッセー
ジブラウザの
合計使用時間
qac-psr Duration
(HH:MM:SS)
0:20:25
0:03:05
qac-baseline
Duration
(HH:MM:SS)
0:00:00
0:00:00
ユーザごとの
QA・C 解析機能
の合計使用時間
25
・prqa_usage_UsageDuration
製品の 1 回の使用ごとに 1 行で、使用開始時刻、使用終了時刻、製品名、バージョン番号、ユーザ名、使用時間が出
力されます。
(出力例)
Checkout
Date/Time
12/01/2014
11:47:58
12/01/2014
11:49:14
12/01/2014
15:33:21
12/01/2014
15:34:49
12/01/2014
15:34:51
12/02/2014
11:31:20
12/02/2014
11:31:38
12/02/2014
11:34:55
12/02/2014
11:34:55
使用開始時刻
Checkin
Date/Time
12/01/2014
11:48:35
12/01/2014
12:03:34
12/01/2014
15:34:46
12/01/2014
15:34:49
12/01/2014
15:35:15
12/02/2014
11:31:25
12/02/2014
11:34:55
12/02/2014
11:51:29
12/02/2014
11:35:02
使用終了時刻
Product
Version
Duration
(HH:MM:SS)
User
qac-gui
8.1
Terra
0:00:37
qac-gui
8.1
Terra
0:14:20
qac-mbrw
8.1
Cecil
0:01:25
qac-psr
7.2
Cecil
0:00:00
qac-mbrw
7.2
Cecil
0:00:24
qac-mbrw
8.1
Terra
0:00:05
qac-gui
8.1
Terra
0:03:17
qac-mbrw
8.1
Cecil
0:16:34
qac-psr
8.1
Cecil
0:00:07
使用した製品名
©2014 Programming Research Ltd / (株)東陽テクニカ
使用したバージョン
使用したユーザ名
26
使用時間
以上の操作においてご質問等がございましたら、(株)東陽テクニカ ソフトウェア・ソリューションのサポート担当までお
問い合わせ下さい。
(株)東陽テクニカ ソフトウェア・ソリューション
〒103-8284 東京都中央区八重洲 1-1-6
TEL. 03-3245-1248
FAX. 03-3246-0645
E-mail (営業窓口):
[email protected]
E-mail (サポート窓口):
[email protected]
E-mail(ライセンス窓
[email protected]
口):
URL:
http://www.toyo.co.jp/ss
Windows, Microsoft は、Microsoft Corporation の登録商標です。
©2014 Programming Research Ltd / (株)東陽テクニカ
27