clm_server_rename.pl

このツールは、Rational solution for Collaborative Lifecycle Management (CLM) に対する Jazz Team Server のパブリック URI 成果物リンクを更新します。具体的には、このツールは、IBM Rational ClearQuest Web サーバー構成ファイルに格納されている URI を更新します。さらに、このツールは、ClearQuest ユーザー データベースの OSLCLinks レコードに格納されている URI も更新します。

概要

cqperl clm_server_rename.pl -username username -password password [ -dbset dbset ] -dbname dbname -oldprefix oldprefix -newprefix newprefix [ -remapconfigfiles | -preview number | -update ] [ -help ] [ -man ]

説明

Rational solution for Collaborative Lifecycle Management (CLM) のバージョン 4.0 以降の製品では、管理者は、デプロイメント後にサーバー名前変更オペレーションを使用することによって、Jazz Team Server または Rational solution for CLM アプリケーションのパブリック URI を変更できます。 その変更に伴って、URI をベースにする Rational solution for CLM リソースに適切な更新を行う必要があります。 ClearQuest Bridge の場合、Rational solution for CLM 製品のリソース (IBM Rational Team Concert、IBM Rational Quality Manager、および IBM Rational Requirements Composer) に対するこれらの成果物リンクは、ClearQuest Web サーバーの構成ファイル内、および ClearQuest ユーザー データベースの OSLCLinks レコード内に格納されます。

Rational solution for CLM の成果物に対するリンクには、次のようないくつかのタイプがあります。
  • 構造リンク。リソース間または成果物間の関係を記述したもので、追跡可能性およびデータ保全性を維持するために必要です。
  • 組み込みリンク。テキスト フィールドまたはリソースのノードに組み込むことのできる URI です。 組み込みリンクは、アンカー付きリンク またはプレーン テキスト リンク のいずれかです。
    • アンカー付きリンク は、ナビゲート可能なハイパーリンクとしてユーザーに表示されます。 例えば、リッチ テキスト ウィジェットでは、これらのリンクはナビゲート可能なハイパーリンクとして宣言され、通常は <a href=...> のような構造で格納されます。
    • プレーン テキスト リンク は、テキスト ウィジェットに入力される URI ですが、ナビゲート可能なハイパーリンクとしてはレンダリングされません。

ClearQuest が提供している clm_server_rename.pl ツールは、ClearQuest Web 構成ファイル内および OSLCLinks レコード内に格納されている URI 構造リンクを再マップします。 このツールを使用すると、構造リンクのプロトコル、ホスト名、ポート番号、およびアプリケーション コンテキストを再マップすることができます。

ツールの実行

clm_server_rename.pl ツールを実行するには、ローカル管理者特権および ClearQuest スーパーユーザー特権が必要です。

ツールは、次のディレクトリの cqweb.war ファイルに入っています。

WAS_profile_home¥installedApps¥nodecell¥TeamEAR.ear¥cqweb.war¥WEB-INF¥classes

cqperl.exe プログラムは、ClearQuest のインストール先のディレクトリにあります。

clm_server_rename.pl ツールを実行する前に、書き込み権限のあるディレクトリを TEMP 環境変数に設定することをお勧めします。 あるいは、ツールを実行するディレクトリに対して書き込み権限があることを確認してください。

このツールは、何回か実行する必要があります。

手順の詳細については、CLM サーバーの名前を変更した後の URI の再マップを参照してください。

コマンド行オプションの説明は、オプションと引数セクションを参照してください。

制限

clm_server_rename.pl ツールで再マップされるのは、ClearQuest Web サーバー構成ファイル内および OSLCLinks レコード内に格納されている構造リンクだけです。 このツールは、ClearQuest レコードに格納されている組み込みリンクは再マップしません。 そのような組み込みアンカー リンクは、レコードの添付ファイルに含まれていたり、フィールド内の説明やメモとして含まれていたりします。 スキーマによっては、送信後、またはメモの追加後に、これらのフィールドが読み取り専用になることがあります。 その場合、ツールの実行後に、組み込みアンカー リンクがリンク切れのままになります。 必要であれば、これらのリンクを修正するコードを作成できます。

ツールの実行後にリンク切れのままになる組み込みアンカー リンクの例として、Rational ClearQuest と Rational Quality Manager を統合する Rational solution for CLM に関係したものがあります。 Rational Quality Manager の成果物から ClearQuest レコードへのリンクが作成されると、Rational Quality Manager は成果物への URI リンクをレコード記述フィールドに挿入します。

オプションと引数

-username username
スーパーユーザー特権を持つ管理ユーザーのログオン名。
-password password
スーパーユーザー特権を持つ管理ユーザーのパスワード。
-dbset dbset
データベース接続の名前。
-dbname dbname
ユーザー データベースの名前。
-oldprefix oldprefix
既存の URI ストリングを指定します。 URI は、先頭が http で、アプリケーション コンテキストを含めた後にスラッシュ (/) を付けた形式にする必要があります。
-newprefix newprefix
-oldprefix オプションで指定した既存の URI ストリングを置き換える新しい URI ストリングを指定します。 URI は、先頭が http で、アプリケーション コンテキストを含めた後にスラッシュ (/) を付けた形式にする必要があります。
-remapconfigfiles
重要: このオプションを使用する場合は、ツールのインストール先のディレクトリでツールを実行する必要があります。

Rational solution for CLM アプリケーションに対する Jazz Team Server のパブリック URI 成果物リンクを再マップします。 具体的には、このオプションでは、ClearQuest Web サーバー構成ファイルに格納されている URI を再マップします。 このツールは、URI を再マップする前に構成ファイルのコピーを作成します。

このオプションを指定してツールを実行した後には、ClearQuest Web サーバーを再始動する必要があります。 それによって Web サーバー上のサーバー間通信が再構成され、ユーザーは Rational solution for CLM の成果物に対して新しい URI リンクを作成できるようになります。 しかし、Rational Solution for CLM の成果物に至る既存のリンクをたどるという方法は、このツールを -update オプションを指定して再度実行しなければ機能しません。

-preview number
ClearQuest データベース内の、oldprefix URI ストリングを含んだ number 個の OSLCLinks レコードに対して実行される変更のプレビューを表示します。 さらに、oldprefix URI ストリングを含んだ OSLCLinks レコードの合計数も報告します。 このオプションを使用した場合、ユーザー データベースに変更は加えられません。
-update
Rational solution for CLM の成果物に対する Jazz Team Server のパブリック URI リンクを更新します。 具体的には、このオプションでは、ClearQuest OSLCLinks レコードに格納されている URI を更新します。

このオプションを指定してツールを実行すると、OSLCLinks レコードに対する変更がログ ファイルに収集されます。 TEMP 環境変数を設定してある場合は、指定したディレクトリにログ ファイルが書き込まれます。そうでない場合は、ツールを実行したディレクトリにログ ファイルが書き込まれます (書き込み権限を持っている場合)。 ログ ファイルには次の命名規則が使用されます。

clm_server_rename_yyyymmdd_hhmmss.txt

ここで、

yyyymmdd
ツールが実行された日付 (年、月、日で指定)
hhmmss
ツールが実行された時刻 (時、分、秒で指定)

例: clm_server_rename_20120405_211711

  • MyCQWebServer という名前のサーバーで、ClearQuest Web サーバー構成ファイルにある、次の例で指定する URI ストリングと一致する Jazz Team Server URI 成果物リンクを再マップします。

    C:¥was_profiles¥MyCQWebServer¥installedApps¥Node02Cell¥TeamEAR.ear¥cqweb.war¥WEB-INF¥classes>cqperl clm_server_rename.pl -username admin -password secret -dbset 7.0.0 -dbname SAMPL -oldprefix https://clm7.mycompany.com/ccm/ -newprefix https://clm7.mycompany.com/jazz/ -remapconfigfiles

    Started: Remapping URIs in config file friendsconfig.rdf.
    Completed: Remapping URIs in config file friendsconfig.rdf.

    Started: Remapping URIs in config file project-area-links.rdf.
    Completed: Remapping URIs in config file project-area-links.rdf.

    Started: Remapping URIs in config file oauth-consumers.rdf.
    Completed: Remapping URIs in config file oauth-consumers.rdf.

  • ClearQuest データベース内の、次の例で指定するストリングと URI ストリングが一致する 5 つの OSLCLinks レコードをプレビューし、アプリケーション コンテキストを jazz から ccm に変更した場合のレコードの状態を確認します。

    cqperl clm_server_rename.pl -username admin -password secret -dbset 8.0.0 -dbname SAMPL -oldprefix https://servername.com:9443/jazz/ -newprefix https://servername.com:9443/ccm/ -preview 5

  • 次の例で指定する URI ストリングと一致する ClearQuest OSLCLinks レコードの URI 内のプロトコルを、http から https に変更します。

    cqperl clm_server_rename.pl -username admin -password secret -dbset 8.0.0 -dbname SAMPL -oldprefix http://servername.com:9443/jazz/ -newprefix https://servername.com:9443/jazz/

  • 次の例で指定する URI ストリングと一致する ClearQuest OSLCLinks レコードの URI 内のサーバー名を、servername から newservername に変更します。

    cqperl clm_server_rename.pl -username admin -password secret -dbset 7.0.0 -dbname SAMPL -oldprefix http://servername.com:9443/jazz/ -newprefix https://newservername.com:9443/jazz/

関連項目

CLM サーバーの名前を変更した後の URI の再マップサーバー名前変更を使用したパブリック URL の変更


フィードバック