Windchill RV&SClient の URL リンク

入門 > 作業環境の選択 > Windchill RV&S Client のグラフィカルユーザーインタフェース > Windchill RV&SClient の URL リンク

Windchill RV&SClient の URL リンクは、クライアントによって生成される電子メール通知に貼り付けて送信することができます。電子メールの受信者はこれらのリンクをクリックして、関連するアイテムをWindchill RV&S Client のさまざまな GUI ビューで表示することができます。また、URL リンクをレポートに追加しておいて、Web ページ、Internet Explorer、Windows の「スタート」 > 「ファイル名を指定して実行」メニューなど、URL を開くことができる他の場所からもレポートを開くことができるようになります。

Windchill RV&SClient の URL リンクは、Windchill RV&S Client でサポートされるすべての Windows プラットフォームで使用することができます。最新の製品プラットフォームサポート情報については、Windchill RV&S Supported Platforms を参照してください。

重要な考慮事項

• Windchill RV&SClient の URL には、プロトコル名の「integrity://」が含まれています。この名前は、各クライアントマシン上の Windows オペレーティングシステムに登録されている必要があります。Windchill RV&SClient をインストールすると、プロトコルが自動的に登録されます。

複数の Windchill RV&SClient が 1 台のマシンにインストールされている場合、デフォルトでは、このプロトコルは最後にインストールしたクライアントに登録され、このプロトコルを使用してWindchill RV&S Client の URL が開かれます。クライアントの「設定の構成」ダイアログボックスの「標準」ペインで「この Windchill RV&S クライアントは Windchill RV&S の URL リンクに応答します」オプションの有効と無効を切り替えることにより、このプロトコルを同じマシン上の別のクライアントに登録できます (このオプションを無効にすることもできます)。詳細については、標準設定を参照してください。

デフォルトでは、Windchill RV&SClient と Windchill RV&S Server によって生成される電子メール通知に Windchill RV&S Client の URL が記載されます。これらの URL は、Windchill RV&S Administration Client のmksis.includeIntegrityGUILinks プロパティによって制御されます。詳細については、電子メール通知に関するトピックを参照するか、管理者に問い合わせてください。

• Windchill RV&SClient の URL には、Microsoft Outlook で認識されないカスタムプロトコルが使用されています。そのため、Windchill RV&SClient の URL リンクをクリックするたびに、標準の「Microsoft Office Outlook のセキュリティに関する通知」ダイアログボックスが表示され、操作を続行するかどうかを尋ねられます。このダイアログボックスで「はい」をクリックして、Windchill RV&S Client の URL を開きます。または、オペレーティングシステムのレジストリエントリを作成し、integrity:// プロトコルに対してこのダイアログボックスを完全に無効にすることもできます。詳細については、PTC eSupport Portalでアーティクル CS121955 を参照してください。

• Windchill RV&SClient の URL をリッチテキストフィールドで使用するには、URL プレフィックスの integrity を、Windchill RV&S Server のmksis.im.validURLPrefixes プロパティに追加する必要があります。

• クライアントサービスパックをインストールすると、Windchill RV&Sプロトコルが自動的にインスールされます (ただし、インストール先のクライアントに登録されていない場合のみ)。したがって、クライアントでこのプロトコルを無効にしていると、後でサービスパックを同じクライアントに適用した結果、プロトコルがそのクライアントで再度有効になる場合があります。

• Windchill RV&SClient をアンインストールすると、Windchill RV&S プロトコルが自動的にアンインストールされ、プロトコルのレジストリエントリが削除されます。ただし、複数のクライアントを 1 台のマシンにインストールしていて、プロトコルを別のクライアントに登録している場合、そのレジストリエントリは削除されません。

Windchill RV&S Client の URL 構文

Windchill RV&S Client の URL 構文を以下に示します。

integrity://<server>:<port>/<app>/<command>?selection=<id>
&<option1>=<value1>&<option2>=<value2>

ここで

• integrity:// は、Windows に登録されている Windchill RV&S URL プロトコルです。

• server は、Windchill RV&S Server がインストールされているマシンのホスト名です。

ホスト名は、管理者が定義した値に基づいて指定することができます。

• port は、Windchill RV&S Server がインストールされているマシンのポート番号です。

• app は、ドメイン固有の Windchill RV&S アプリケーションの略称です。たとえば、im はワークフローとドキュメント、si はコンフィギュレーション管理です。

• command は、CLI コマンドの名前と開くビューです。たとえば、viewissue となります。詳細については、サポートされるビュー、コマンド、コマンドオプションを参照してください。

• selection=id は、コマンドで必要な Windchill RV&S アイテムの ID です (カンマ区切り値のリストとして指定することも、スペース区切り値のリストとして指定することもできます。スペースは、%20 に URL エンコーディングされます。例: selection=12345%2023456%203456)。

• option=値は、追加の設定の任意の数字です (CLI コマンドのオプションに対応します。複数の値を受け取るオプションはカンマ区切りのリストとして定義できます)。

コマンドオプションの値はエンコーディングする必要があります。URL エンコーディングの要件と考慮事項を参照してください。

Windchill RV&SClient の URL リンクが記載された電子メール通知の送受信

GUI または Web の表示フィールドで強調表示されているユーザー名をクリックすると、Windchill RV&SClient の URL が記載された電子メール通知を作成することができます。クリックすると、選択したユーザー宛ての新しいメッセージがデフォルトの電子メールアプリケーションで開きます。

電子メールの件名にはアイテムの簡単な説明が使用され、本文には 2 つのハイパーリンクが含まれます。最初のハイパーリンクをクリックすると、Windchill RV&S Web インタフェースで各アイテムが表示されます。2 番目のハイパーリンクをクリックすると、Windchill RV&S Client の GUI で同じアイテムが表示されます。たとえば、アイテム jriley の「アイテムの詳細」ビューのヘッダーでユーザー 1234 をクリックすると、次のリンクを含む電子メールが生成されます。

WEB: http://jriley.abcfinancial.com:7001/im/issues?selection=1234

GUI: url:integrity://jriley.abcfinancial.com:7001/im/viewissue?selection=1234

使用している電子メールアプリケーションによっては、受信者が電子メール通知を受信してから、Windchill RV&SClient の URL リンクがアクティブまたはクリック可能になる場合があります。

電子メールを履歴ビューから生成する場合、電子メールの件名と本文には、履歴ビューに対応する現在の日時の注釈が付きます。たとえば、アイテム 1234 の「履歴」タブで、ユーザー jriley を July 9, 2012 4:15:25 PM EST にクリックすると、次のリンクを含む電子メールが生成されます。

WEB: http://jriley.abcfinancial.com:7001/im/issues?selection=1234&asOf=20120709T211525Z

GUI: url:integrity://jriley.abcfinancial.com:7001/im/viewissue?selection=1234&asOf=20120709T211525Z

現在の日時のタイムスタンプは協定世界時 (UTC) の ISO 8601 基本表記に従い、タイムゾーン指定子付きの完全表記の日時として指定されます。たとえば、次のようになります。

YYYYMMddThhmmssZ

ここで

• YYYYMMdd は、それぞれ数値 4 桁の年、2 桁の月、2 桁の日です (1 桁の月と日の前には 0 が必要です)。

• T は、日付と時刻の区切り文字です。

• hhmmss は、それぞれ数値 2 桁の時間、分、秒です (1 桁の時間、分、秒の前には 0 が必要です)。

• Z は、タイムゾーン指定子であり、UTC との時差がゼロであることを示しています。

時刻は 00:00:00 ～ 23:59:59 までの 24 時間形式で指定されます。たとえば、URL で 13:56:45 が参照されている場合、その時刻は 1:56:45 PM ということです。

さらに、時刻は送信者の現地時間に基づいて指定されます。受信者のタイムゾーンが送信者のものと異なる場合、リンクをクリックすると、アイテムの時刻は受信者の現地のタイムゾーンで表示されます。

Windchill RV&SClient の URL リンクが記載された電子メール通知を受信する場合、次の点に注意してください。

• Microsoft Outlook 電子メールクライアントでは、Windchill RV&SClient の URL はクリック可能なリンクとして表示されます。

• Microsoft Outlook Web では、クリック可能な GUI リンクはどのブラウザでもサポートされません。

• Lotus Notes 電子メールクライアントでは、Windchill RV&SClient の URL はクリック不可のテキスト形式で表示されます。ブラウザまたは Windows の「スタート」 > 「ファイル名を指定して実行」ダイアログボックスにそのテキストをコピーすることで、Microsoft Outlook クライアントでリンクをクリックした場合と同じビューを開くことができます。

Windchill RV&Sクライアントによって生成された電子メール内のアイテムリビジョン情報

アイテムリビジョン機能が有効な場合、Windchill RV&Sでユーザー名リンクをクリックすると、Windchill RV&S Client から生成された電子メール内に詳細なサマリー情報も表示されます。履歴アイテムでユーザー名リンクをクリックすると、クライアントにより生成された電子メールの件名フィールドに、アイテムリビジョン情報が次の形式で含められます。

タイプ < アイテム ID>: アイテムサマリー [リビジョン情報] 日付本日現在

加えて、アイテムリビジョン機能が有効な場合、クライアントにより生成された電子メールの本文には次の内容が記載されます。

日付: 「リビジョン情報」本日現在

Windchill RV&S アイテムの履歴コンテキストを表示するには、「履歴」タブに移動し、目的の日付のタイムスタンプリンクをクリックして履歴アイテムを開きます。その後、ユーザー名リンク (担当ユーザー、変更者ユーザー、作成者ユーザーなど) をクリックすることで、Windchill RV&S の履歴アイテムから電子メールメッセージを開くことができます。

アイテム履歴のリンクからクリックした場合や、最初のリビジョンが設定されていないアイテムから作業している場合は、クライアントにより生成された電子メールにアイテムリビジョン情報が記載されません。

アイテムリビジョン機能が有効でない場合、電子メールは Windchill RV&Sにより標準形式で作成されます。

サポートされるビュー、コマンド、コマンドオプション

次の表に、Windchill RV&SClient の GUI ビューと、Windchill RV&S Client の URL でサポートされている対応する CLI コマンドとコマンドオプションを示します。

Windchill RV&SClient の GUI ビュー

CLI コマンド/サポートされるオプション

URL の例

「アイテム」ビュー

im issues--query--queryDefinition--fields--sortField--sortAscending--nosortAscending

Windchill RV&SClient GUI の「アイテム」ビューでアイテムを表示する場合の URL:

integrity://localhost:9001/im/issues?query=MyQuery&fields=Summary%2cPriority&sortField=Priority&sortAscending

「アイテムの詳細」ビュー

im viewissue--asof

Windchill RV&SClient GUI の「アイテムの詳細」ビューでアイテムを表示する場合の URL:

integrity://localhost:9001/im/viewissue? selection=1234

Windchill RV&SClient GUI の履歴の「アイテムの詳細」ビューでアイテムを表示する場合の URL:

integrity://localhost:9001/im/viewissue?selection=1234&asOf=20120730T190323Z

ドキュメントビュー

im viewsegment--asof--fields--outlineColumns

Windchill RV&SClient GUI の「ドキュメント」ビューでドキュメントを表示する場合の URL:

integrity://localhost:9001/im/viewsegment?selection=1234&fields=Category%2cText

「関連」ビュー

im relationships--asof--fields

Windchill RV&SClient GUI の「関連」ビューでドキュメントを表示する場合の URL:

integrity://localhost:9001/im/relationships?selection=1234&fields=ID%2cType%2cState%2cSummary

ソーストレースビューア

im viewsourcetraces--project--asof--devpath--scmHost--scmPort--fields--projectrevision--revision--sortField--sortAscending--nosortAscending

ソーストレースビューアで通常のプロジェクト/サブプロジェクトのメンバーを表示するには:

integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3a%2fproject.pj& revision=1.0

ソーストレースビューアでバリアントサブプロジェクトのメンバーを表示するには:

integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3A%2Fproject.pj&devpath=TestDevPath&revision=1.0

または

integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=%23c%3A%2F%23d%3DTestDevPath&revision=1.0

ソーストレースビューアでビルドプロジェクト/サブプロジェクトのメンバーを表示するには:

integrity://localhost:9001/im/viewsourcetraces?selection=code.java&project=c%3A%2Fproject.pj&projectrevision=1.0&revision=1.0

または

integrity://localhost:9001/si/viewsourcetraces?selection=code.java&project=%23c%3A%2F%23b%3D1.0&revision=1.0

ソースプロジェクト

si viewproject--project--devpath--projectrevision--filtersubs--nofiltersubs

Windchill RV&SClient GUI の「ソースプロジェクト」ビューで空のサブプロジェクトを除外して表示する場合の URL:

integrity://localhost:9001/si/viewproject?project=%2FTestProject%2Fproject.pj&filtersubs

ソースメンバー履歴

si viewhistory--project--devpath--projectrevision

Windchill RV&SClient GUI で「ソースメンバー履歴」ビューを表示する場合の URL:

integrity://localhost:9001/si/viewhistory?selection=source.java&project=%2FTestProject%2Fproject.pj

変更パッケージ

si viewcp

Windchill RV&SClient GUI で「変更パッケージ」ビューを表示する場合の URL:

integrity://localhost:9001/si/viewcp?selection=1234%3A1

ダッシュボード

im rundashboard--fieldFilter

Windchill RV&SClient GUI を開き、指定のダッシュボードを実行する場合の URL:

integrity://localhost:9001/im/rundashboard?selection=%22My%20Dashboard%22

スペースを含むダッシュボード名は、クォーテーションマークでエンコードされた URL である必要があります。

レポート

im runreport--fieldFilter--asOf--issues--query--param--[no]substituteParams

Windchill RV&SClient GUI を開き、指定のレポートを実行する場合の URL:

integrity://localhost:9001/im/runreport?selection=%22My%20Report%22

スペースを含むレポート名は、クォーテーションマークでエンコードされた URL である必要があります。

また、--project、--tvigui、--notvigui の各コマンドオプションについては以下の点に留意してください。

• オプション --project は、ソース構成パスとフラットパスの構文をサポートしています。--project オプションでソース構成パス構文を使用すると、--devpath と --projectrevision の各オプションを使用しないでバリアントプロジェクトとビルドプロジェクトを指定できます。

たとえば、2 つのオプションを指定した場合は次のようになります。

project=c%3A%2Fproject.pj&devpath=TestDevPath

この代わりに、次のように単一のオプションを指定できます。

project=%23c%3A%2F%23d%3DTestDevPath

これらの構文の詳細については、CLI マニュアルページの options マニュアルページの「コンフィギュレーション管理プロジェクトの指定」を参照してください。

• --tvigui および --notvigui の各オプションは、サポートされているすべてのコマンドで使用できます。Windchill RV&SClient の URL をクリックしたときに、ビューセットに完全に対応したクライアントビューであるタブ形式ビューインタフェース (TVI) とフローティングビューのどちらで指定のコマンドを実行するかは、これらのオプションによって制御されます。

◦ --tvigui が指定されていない場合は、コマンドが TVI GUI で実行されます。つまり、Windchill RV&SClient の GUI はユーザーの現在のビューセットを使用して表示され、コマンドがフローティングビューとドッキングビューのどちらで開くかはビューセットの構成によって制御されます。

◦ --notvigui が指定されている場合、コマンドはフローティングビューで実行されます (TVI GUI は起動しません)。

ビューセットの詳細については、ビューセットの概要 (GUI)を参照してください。

システムによって生成される Windchill RV&SClient のすべての URL は、--tvigui に設定されます。Integrity では、スタンドアロンの URL を生成するよう変更を加えることができます (--notvigui)。ただし、電子メール通知を生成するトリガースクリプトを管理者がカスタマイズする必要があります。

URL エンコーディングの要件と考慮事項

Windchill RV&SClient の URL を作成する場合は、コマンドオプションの値だけをエンコーディングする必要があります。URL 全体をエンコーディングしないでください。

Windchill RV&Sでは、すべての URL データを UTF-8 との間で確実に変換できるよう、受信したすべてのWindchill RV&S Client URL が RFC 1738 に従ってエンコーディングされていることを前提としています。WWW コンソーシアムの勧告に従い、エンコーディングとデコーディングでは、互換性を最大限に高めるために UTF-8 エンコーディング方式が必ず使用されます。たとえば、空白文字は%20 としてエンコーディングされます。詳細については、http://docs.oracle.com/javase/8/docs/api/java/net/URLEncoder.htmlを参照してください。

無効な文字の URL エンコーディングは、パーセント (%) 記号の後に、その文字に対する ISO-Latin コードポイントの 2 桁の 16 進数表現が続く形式で表されます。

以下に、さまざまなエンコーディングオプションを使用した場合の Windchill RV&SClient URL の例を示します。

• integrity://localhost:9001/im/viewissue?selection=12345&asof=%222012-01-01%2014%3a01%3a00%20z%22

ここでは、2012-01-01 12:01:00 z がエンコーディングされています。

• integrity://localhost:9001/si/viewproject?project=%2FTestProject%2Fproject.pj

ここでは、/TestProject/project.pj がエンコーディングされています。

• integrity://localhost:9001/im/viewissue?selection=12345&asof=jwWiki%20%e3%82%a2%e3%83%bc%e3%83%86%e3%82%a3%e3

• %82%af%e3%83%ab

ここでは、asof=jwWikiアーティクルがエンコーディングされています。

Windchill RV&SClient の URL を生成するカスタムのトリガースクリプトまたはカスタムのアクションを作成する場合は、java.net.Encoder などの標準的なライブラリを使用して、URL でコマンドオプションの値をエンコーディングすることをお勧めします。たとえば、Java エンコーダークラスを呼び出してエンコーディングできます。

java.net.URLEncoder.encode(some_URL, "UTF-8")

このエンコーダークラスは RFC 1738 (URL 規格) に準拠しているため、Windchill RV&SClient の起動時に、Windchill RV&S Client の URL が正しくデコーディングされます。詳細については、http://www.rfc-editor.org/rfc/rfc1738.txt を参照してください。

トリガースクリプトファイル changePackageNotification.js は、この Java クラスを使用して、Windchill RV&S Client URL のコマンドオプションをエンコーディングします。以下に例を示します。

/**
* Return a URL-encoded string version of the argument passed in.
*/
function urlEncode(arg)
{
try {
return java.net.URLEncoder.encode(arg,"UTF-8");
} catch (err) {
// Fall-through
}
// If UTF-8 failed, just use the default encoding.
return java.net.URLEncoder.encode(arg);
}

次の表に、Windchill RV&SClient の URL に含まれるコマンドオプションの値をエンコーディングする際の要件と考慮事項を示します。

文字タイプ	コーディングの要件/考慮事項
ASCII 制御文字	00 ～ 1F および 7F の範囲内のすべての文字をエンコーディングする必要があります。
予約文字	次の特殊文字が予約されています。 • ドル記号 ($) は %24 にエンコーディング • アンパサンド (\&) は %26 にエンコーディング • プラス記号 (+) は %2B にエンコーディング • カンマ (,) は %2C にエンコーディング • スラッシュ (/) は %2F にエンコーディング • コロン (:) は %3A にエンコーディング • セミコロン (\;) は %3B にエンコーディング • 等号 (=) は %3D にエンコーディング • 疑問符 (?) は %3F にエンコーディング • アットマーク (@) は %40 にエンコーディング
安全でない文字	一部の特殊文字は、URL で使用された場合に誤って解釈される可能性があります。たとえば、互換性がない文字または信頼性の低い文字として誤って解釈されることがあります。PTC では、以下の文字をエンコーディングすることをお勧めしています。 • 空白文字 ( ) は %20 にエンコーディング (特に複数の空白文字が続く場合) • 引用符 (“”) は %22 にエンコーディング • 小なり記号 (\<) は %3C にエンコーディング • 大なり記号 (\>) は %3E にエンコーディング • 番号記号 (#) は %23 にエンコーディング • パーセント記号 (%) は %25 にエンコーディング • 左中括弧 ({) は %7B にエンコーディング • 右中括弧 (}) は %7D にエンコーディング • 縦棒 (\|) は %7C にエンコーディング • バックスラッシュ (\) は %5C にエンコーディング • キャレット (^) は %5E にエンコーディング • チルダ (~) は %7E にエンコーディング • 左角括弧 ([) は %5B にエンコーディング • 右角括弧 (]) は %5D にエンコーディング • 抑音アクセント (`) は %60 にエンコーディング
非 ASCII 文字	非 ASCII 文字はすべてエンコーディングする必要があります。これには、80 ～ FF の 16 進数値から成る ISO-Latin セットの上半分がすべて含まれます。
Unicode 文字	Unicode 文字はすべてエンコーディングする必要があります。これには、FF より上の文字がすべて含まれます。