PTC RV&SClient の URL リンク
PTC RV&SClient の URL リンクは、クライアントによって生成される電子メール通知に貼り付けて送信することができます。電子メールの受信者はこれらのリンクをクリックして、関連するアイテムをPTC RV&S Client のさまざまな GUI ビューで表示することができます。また、URL リンクをレポートに追加しておいて、Web ページ、Internet Explorer、Windows の > メニューなど、URL を開くことができる他の場所からもレポートを開くことができるようになります。
 |
PTC RV&SClient の URL リンクは、PTC RV&S Client でサポートされるすべての Windows プラットフォームで使用することができます。製品のプラットフォームサポートに関する最新情報については、PTC Release Advisor を参照してください。
|
重要な考慮事項
• PTC RV&SClient の URL には、プロトコル名の「integrity://」が含まれています。この名前は、各クライアントマシン上の Windows オペレーティングシステムに登録されている必要があります。PTC RV&SClient をインストールすると、プロトコルが自動的に登録されます。
複数の PTC RV&SClient が 1 台のマシンにインストールされている場合、デフォルトでは、このプロトコルは最後にインストールしたクライアントに登録され、このプロトコルを使用してPTC RV&S Client の URL が開かれます。クライアントの「設定の構成」ダイアログボックスの「標準」ペインで「この PTC RV&S クライアントは PTC RV&S の URL リンクに応答します」オプションの有効と無効を切り替えることにより、このプロトコルを同じマシン上の別のクライアントに登録できます (このオプションを無効にすることもできます)。詳細については、標準設定を参照してください。
|
|
デフォルトでは、PTC RV&SClient と PTC RV&S Server によって生成される電子メール通知に PTC RV&S Client の URL が記載されます。これらの URL は、PTC RV&S Administration Client のmksis.includeIntegrityGUILinks プロパティによって制御されます。詳細については、電子メール通知に関するトピックを参照するか、管理者に問い合わせてください。
|
• PTC RV&SClient の URL には、Microsoft Outlook で認識されないカスタムプロトコルが使用されています。そのため、PTC RV&SClient の URL リンクをクリックするたびに、標準の「Microsoft Office Outlook のセキュリティに関する通知」ダイアログボックスが表示され、操作を続行するかどうかを尋ねられます。このダイアログボックスで「はい」をクリックして、PTC RV&S Client の URL を開きます。または、オペレーティング システムのレジストリ エントリを作成し、integrity:// プロトコルに対してこのダイアログ ボックスを完全に無効にすることもできます。詳細については、PTC eSupport Portalでアーティクル CS121955 を参照してください。
• PTC RV&SClient の URL をリッチテキストフィールドで使用するには、URL プレフィックスの integrity を、PTC RV&S Server のmksis.im.validURLPrefixes プロパティに追加する必要があります。
• クライアントサービスパックをインストールすると、PTC RV&Sプロトコルが自動的にインスールされます (ただし、インストール先のクライアントに登録されていない場合のみ)。したがって、クライアントでこのプロトコルを無効にしていると、後でサービス パックを同じクライアントに適用した結果、プロトコルがそのクライアントで再度有効になる場合があります。
• PTC RV&SClient をアンインストールすると、PTC RV&S プロトコルが自動的にアンインストールされ、プロトコルのレジストリエントリが削除されます。ただし、複数のクライアントを 1 台のマシンにインストールしていて、プロトコルを別のクライアントに登録している場合、そのレジストリ エントリは削除されません。
PTC RV&S Client の URL 構文
PTC RV&S Client の URL 構文を以下に示します。
integrity://<server>:<port>/<app>/<command>?selection=<id>
&<option1>=<value1>&<option2>=<value2>
ここで
• integrity:// は、Windows に登録されている PTC RV&S URL プロトコルです。
• server は、PTC RV&S Server がインストールされているマシンのホスト名です。
|
|
ホスト名は、管理者が定義した値に基づいて指定することができます。
|
• port は、PTC RV&S Server がインストールされているマシンのポート番号です。
• app は、ドメイン固有の PTC RV&S アプリケーションの略称です。たとえば、im はワークフローとドキュメント、si はコンフィギュレーション管理、extended-web-ui は更新された Web インタフェースです。
• selection=id は、コマンドで必要な PTC RV&S アイテムの ID です (カンマ区切り値のリストとして指定することも、スペース区切り値のリストとして指定することもできます。スペースは、%20 に URL エンコーディングされます。例: selection=12345%2023456%203456)。
• option=値は、追加の設定の任意の数字です (CLI コマンドのオプションに対応します。複数の値を受け取るオプションはカンマ区切りのリストとして定義できます)。
|
|
コマンド オプションの値はエンコーディングする必要があります。詳細については、URL エンコーディングの要件と考慮事項を参照してください。
|
PTC RV&SClient の URL リンクが記載された電子メール通知の送受信
GUI または Web の表示フィールドで強調表示されているユーザー名をクリックすると、PTC RV&S Client の URL が記載された電子メール通知を作成することができます。クリックすると、選択したユーザー宛ての新しいメッセージがデフォルトの電子メール アプリケーションで開きます。
電子メールの件名にはアイテムの簡単な説明が使用され、本文には 2 つのハイパーリンクが含まれます。最初のハイパーリンクをクリックすると、PTC RV&S Web インタフェースで各アイテムが表示されます。2 番目のハイパーリンクをクリックすると、PTC RV&S Client の GUI で同じアイテムが表示されます。たとえば、アイテム jriley の「アイテムの詳細」ビューのヘッダーでユーザー 1234 をクリックすると、次のリンクを含む電子メールが生成されます。
WEB: https://jriley.abcfinancial.com:7001/im/issues?selection=1234
REFRESHED WEB: https://jriley.abcfinancial.com:7001/extended-web-ui/items/item/1234
GUI: url:integrity://jriley.abcfinancial.com:7001/im/viewissue?selection=1234
|
|
使用している電子メールアプリケーションによっては、受信者が電子メール通知を受信してから、PTC RV&SClient の URL リンクがアクティブまたはクリック可能になる場合があります。
|
電子メールを履歴ビューから生成する場合、電子メールの件名と本文には、履歴ビューに対応する現在の日時の注釈が付きます。たとえば、アイテム 1234 の「履歴」タブで、ユーザー jriley を July 9, 2012 9:15:25 PM EST にクリックすると、次のリンクを含む電子メールが生成されます。
WEB: https://jriley.abcfinancial.com:7001/im/issues?selection=1234&asOf=20120709T211525Z
REFRESHED WEB: https://jriley.abcfinancial.com:7001/extended-web-ui/items/item/1234?asof=2012-07-09T21:15:25Z
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 ということです。
さらに、時刻は送信者の現地時間に基づいて指定されます。受信者のタイムゾーンが送信者のものと異なる場合、リンクをクリックすると、アイテムの時刻は受信者の現地のタイムゾーンで表示されます。
|
PTC RV&SClient の URL リンクが記載された電子メール通知を受信する場合、次の点に注意してください。
• Microsoft Outlook 電子メールクライアントでは、PTC RV&SClient の URL はクリック可能なリンクとして表示されます。
• Microsoft Outlook Web では、クリック可能な GUI リンクはどのブラウザでもサポートされません。
• Lotus Notes 電子メールクライアントでは、PTC RV&SClient の URL はクリック不可のテキスト形式で表示されます。ブラウザまたは Windows の > ダイアログ ボックスにそのテキストをコピーすることで、Microsoft Outlook クライアントでリンクをクリックした場合と同じビューを開くことができます。
PTC RV&Sクライアントによって生成された電子メール内のアイテムリビジョン情報
アイテムリビジョン機能が有効な場合、PTC RV&S でユーザー名リンクをクリックすると、PTC RV&S Client から生成された電子メール内に詳細なサマリー情報も表示されます。履歴アイテムでユーザー名リンクをクリックすると、クライアントにより生成された電子メールの件名フィールドに、アイテムリビジョン情報が次の形式で含められます。
タイプ < アイテム ID>: アイテム サマリー [リビジョン情報] 日付 本日現在
加えて、アイテムリビジョン機能が有効な場合、クライアントにより生成された電子メールの本文には次の内容が記載されます。
日付: 「リビジョン情報」本日現在
PTC RV&S アイテムの履歴コンテキストを表示するには、「履歴」タブに移動し、目的の日付のタイムスタンプリンクをクリックして履歴アイテムを開きます。次に、ユーザー名リンク (「担当ユーザー」、「変更者」ユーザー、「作成者」ユーザーなど) をクリックして、PTC RV&S の履歴アイテムから電子メールメッセージを開くことができます。
|
|
アイテム履歴のリンクからクリックした場合や、最初のリビジョンが設定されていないアイテムから作業している場合は、クライアントにより生成された電子メールにアイテムリビジョン情報が記載されません。
|
アイテムリビジョン機能が有効でない場合、電子メールは PTC RV&Sにより標準形式で作成されます。
サポートされるビュー、コマンド、コマンド オプション
次の表に、PTC RV&SClient の GUI ビューと、PTC RV&S Client の URL でサポートされている対応する CLI コマンドとコマンドオプションを示します。
|
PTC RV&SClient の GUI ビュー
|
CLI コマンド/サポートされるオプション
|
第 1 世代の Web インタフェース URL の例
|
更新された Web インタフェース URL の例
|
||||
|---|---|---|---|---|---|---|---|
|
「アイテム」ビュー
|
im issues--query--queryDefinition--fields--sortField--sortAscending--nosortAscending
|
PTC RV&SClient GUI の「アイテム」ビューでアイテムを表示する場合の URL:
integrity://localhost:9001/im/issues?query=MyQuery&fields=Summary%2cPriority&sortField=Priority&sortAscending
|
更新された Web インタフェースの「アイテム」ビューでアイテムを開く場合の URL:
integrity://localhost:9001/extended-web-ui/items?query=MyQuery&fields=Summary%2cPriority&sortField=Priority&sortAscending
クエリー定義では、以下の特殊文字はサポートされていません。
• プラス記号 (+)
• 等号 (=)
• コロン (:)
• セミコロン (;)
• アットマーク (@)
• アンパサンド (&)
• 疑問符 (?)
• ドル記号 ($)
• カンマ (,)
• スラッシュ (/)
• アスタリスク (*)
• 感嘆符 (!)
• 一重引用符 (‘)
• 左角かっこ ([)
• 右角かっこ (])
• 左かっこ (
• 右かっこ )
• 左中かっこ ({)
• 右中かっこ (})
|
||||
|
「アイテムの詳細」ビュー
|
im viewissue--asof
|
PTC RV&SClient GUI の「アイテムの詳細」ビューでアイテムを表示する場合の URL:
integrity://localhost:9001/im/viewissue? selection=1234
PTC RV&SClient GUI の履歴の「アイテムの詳細」ビューでアイテムを表示する場合の URL:
integrity://localhost:9001/im/viewissue?selection=1234&asOf=20120730T190323Z
|
更新された Web インタフェースの「アイテム詳細」ビューでアイテムを開く場合の URL:
integrity://localhost:9001/extended-web-ui/items/item/1234
更新された Web インタフェースの履歴「アイテム詳細」ビューでアイテムを開く場合の URL:
integrity://localhost:9001/extended-web-ui/items/item/1234?asOf=20120730T190323Z
|
||||
|
ドキュメント ビュー
|
im viewsegment--asof--fields--outlineColumns
|
PTC RV&SClient GUI の「ドキュメント」ビューでドキュメントを表示する場合の URL:
integrity://localhost:9001/im/viewsegment?selection=1234&fields=Category%2cText
|
更新された Web インタフェースの DocStudio ビューでドキュメントを開く場合の URL:
integrity://localhost:9001/extended-web-ui/doc-workspace/doc/1234?fields=Category%2cText
|
||||
|
「関連」ビュー
|
im relationships--asof--fields
|
PTC RV&SClient GUI の「関連」ビューでドキュメントを表示する場合の URL:
integrity://localhost:9001/im/relationships?selection=1234&fields=ID%2cType%2cState%2cSummary
|
更新された Web インタフェースの「関連」ビューでドキュメントを開く場合の URL:
integrity://localhost:9001/extended-web-ui/relationships/item/1234?fields=ID,Type,State,Summary
|
||||
|
ソース トレース ビューア
|
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
|
更新された Web インタフェースでは、「コンフィギュレーション管理」機能はサポートされていません
|
||||
|
ソース プロジェクト
|
si viewproject--project--devpath--projectrevision--filtersubs--nofiltersubs
|
PTC RV&SClient GUI の「ソースプロジェクト」ビューで空のサブプロジェクトを除外して表示する場合の URL:
integrity://localhost:9001/si/viewproject?project=%2FTestProject%2Fproject.pj&filtersubs
|
更新された Web インタフェースでは、「コンフィギュレーション管理」機能はサポートされていません
|
||||
|
ソース メンバー履歴
|
si viewhistory--project--devpath--projectrevision
|
PTC RV&SClient GUI で「ソースメンバー履歴」ビューを表示する場合の URL:
integrity://localhost:9001/si/viewhistory?selection=source.java&project=%2FTestProject%2Fproject.pj
|
更新された Web インタフェースでは、「コンフィギュレーション管理」機能はサポートされていません
|
||||
|
変更パッケージ
|
si viewcp
|
PTC RV&SClient GUI で「変更パッケージ」ビューを表示する場合の URL:
integrity://localhost:9001/si/viewcp?selection=1234%3A1
|
更新された Web インタフェースでは、「コンフィギュレーション管理」機能はサポートされていません
|
||||
|
ダッシュボード
|
im rundashboard--fieldFilter
|
PTC RV&SClient GUI を開き、指定のダッシュボードを実行する場合の URL:
integrity://localhost:9001/im/rundashboard?selection=%22My%20Dashboard%22
|
指定したダッシュボードを更新された Web インタフェースで実行する場合の URL:
https://ppuwsv-alm18t.ptcnet.ptc.com:1340/extended-web-ui/dashboards/run?selection=__id121
|
||||
|
レポート
|
im runreport--fieldFilter--asOf--issues--query--param--[no]substituteParams
|
PTC RV&SClient GUI を開き、指定のレポートを実行する場合の URL:
integrity://localhost:9001/im/runreport?selection=%22My%20Report%22
|
指定したレポートを更新された Web インタフェースで実行する場合の URL:
https://ppuwsv-alm18t.ptcnet.ptc.com:1340/extended-web-ui/reports/run?selection=12345
|
||||
|
チャート
|
im runchart--fieldFilter--query
|
PTC RV&S Client GUI を開き、指定のチャートを実行する場合の URL:
integrity://localhost:9001/im/runchart?selection=%22My%20Chart%22
|
指定したチャートを更新された Web インタフェースで実行する場合の URL:
https://ppuwsv-alm18t.ptcnet.ptc.com:1340/extended-web-ui/charts/run?selection=__id158
|
|
|
mksis.im.enableautomaticredirectiontoRWI プロパティが true に設定されている場合、第 1 世代の Web インタフェースを指すすべての URL が、更新された Web インタフェースにリダイレクトされます。
|
また、--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 の各オプションは、サポートされているすべてのコマンドで使用できます。PTC RV&SClient の URL をクリックしたときに、ビューセットに完全に対応したクライアントビューであるタブ形式ビューインタフェース (TVI) とフローティングビューのどちらで指定のコマンドを実行するかは、これらのオプションによって制御されます。
◦ --tvigui が指定されていない場合は、コマンドが TVI GUI で実行されます。つまり、PTC RV&SClient の GUI はユーザーの現在のビューセットを使用して表示され、コマンドがフローティングビューとドッキングビューのどちらで開くかはビューセットの構成によって制御されます。
◦ --notvigui が指定されている場合、コマンドはフローティング ビューで実行されます (TVI GUI は起動しません)。
|
|
ビューセットの詳細については、ビューセットの概要 (GUI)を参照してください。
|
システムによって生成される PTC RV&SClient のすべての URL は、--tvigui に設定されます。Integrity では、スタンドアロンの URL を生成するよう変更を加えることができます (--notvigui)。ただし、電子メール通知を生成するトリガー スクリプトを管理者がカスタマイズする必要があります。