Windchill RV&S客户端 URL 链接

入门 > 选择您的工作环境 > Windchill RV&S 客户端图形用户界面 > Windchill RV&S客户端 URL 链接

您可以在客户端生成的电子邮件通知中发送 Windchill RV&S客户端 URL 链接，这使收件人能够单击链接并在各类Windchill RV&S 客户端 GUI 视图中打开关联的项。您还可以在报告中包括 URL 链接，并从其他 URL 位置启动这些链接，例如：网页、Internet Explorer 和 Windows“开始” > run 菜单。

在 Windchill RV&S支持的所有 Windows 平台上均支持Windchill RV&S 客户端 URL 链接。有关最新的产品平台支持信息，请参阅 Windchill RV&S 支持的平台。

重要考虑事项

• Windchill RV&S客户端 URL 包含协议名称integrity://，它必须在每个客户端计算机的 Windows 操作系统中注册。安装 Windchill RV&S客户端时会自动进行注册。

如果单台计算机上安装了多个 Windchill RV&S客户端，则默认情况下，该协议会注册在最后安装的客户端上，并用于打开Windchill RV&S 客户端 URL。在客户端的“首选项配置”对话框的“常规”窗格中，通过切换“此 Windchill RV&S 客户端将响应 Windchill RV&S URL 链接。”选项，您可以在同一计算机的不同客户端上注册协议（或禁用该选项）。有关详细信息，请参阅“常规首选项”。

默认情况下，Windchill RV&S客户端和 Windchill RV&S 服务器生成的电子邮件通知包括 Windchill RV&S 客户端 URL，它们由 mksis.includeIntegrityGUILinks 中的Windchill RV&S 管理客户端特性控制。有关详细信息，请参阅有关电子邮件通知的主题或与您的管理员联系。

• Windchill RV&S客户端 URL 使用 Microsoft Outlook 无法识别的自定义协议。因此，您每次单击Windchill RV&S客户端 URL 链接时，都会显示标准“Microsoft Office Outlook 安全声明”提示，询问您是否要继续。在对话框中单击“是”以调用Windchill RV&S 客户端 URL。或者，您可以通过在操作系统中创建注册表条目来完全禁用integrity:// 协议的对话框。有关详细信息，请参阅 PTC eSupport 门户内的文章 CS121955。

• 要在包含多种格式的文本字段中使用 Windchill RV&S客户端 URL，必须在 Windchill RV&S 服务器上将 URL 前缀 integrity 添加至mksis.im.validURLPrefixes 特性中。

• 安装客户端服务包时，Windchill RV&S协议只有在其当前未在该客户端上注册时才会自动安装。因此，如果您为某客户端禁用协议，并稍后将服务包应用至同一客户端，则该协议可能会因此在该客户端上变为重新启用。

• 卸载 Windchill RV&S客户端时，系统会自动卸载Windchill RV&S 协议并移除其注册表条目。但是，如果在不同的客户端上注册该协议（如果在单台机器上存在多个客户端），则不会移除注册表条目。

Windchill RV&S客户端 URL 语法

Windchill RV&S客户端 URL 的语法如下：

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

其中：

• integrity:// 是 Windows 上注册的 Windchill RV&S URL 协议

• server 是安装 Windchill RV&S 服务器的计算机的主机名

可以根据管理员定义的值来确定主机名。

• port 是安装 Windchill RV&S 服务器的计算机的端口号

• app 是特定于域的 Windchill RV&S 应用程序的简写，例如，im= 工作流和文档，si= 配置管理

• command 是要调用的 CLI 命令和相应视图的名称，例如：viewissue（有关详细信息，请参阅支持的视图、命令以及命令选项）。

• selection=ID 是命令要求的 Windchill RV&S 项 ID (可以是逗号或空格分隔的值列表，其中空格会通过 URL 编码为 %20，例如，selection=12345%2023456%203456)

• option=值是任意的附加设置数（与 CLI 命令选项相对应（将多值选项定义为逗号分隔的列表））

对于命令选项的值，必须进行编码。有关详细信息，请参阅“URL 编码要求和考虑事项”。

发送和接收具有 Windchill RV&S客户端 URL 链接电子邮件通知

在 GUI 或 Web 中，可通过单击任何可见字段内突出显示的用户名，创建具有Windchill RV&S客户端 URL 的电子邮件通知。这将打开默认的电子邮件应用程序，该应用程序具有发送地址为您所选用户的新消息。

电子邮件主题是项的简要说明，并且正文包含两个超链接。第一个超链接将打开 Windchill RV&S Web 界面中的相应项，第二个超链接将打开 Windchill RV&S 客户端 GUI 中的相同项。例如，在项 1234 的“项详细信息”视图的页眉中单击用户 jriley，以生成包含下列链接的电子邮件：

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

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

在收件人收到电子邮件通知之前，Windchill RV&S客户端 URL 链接可能为非活动或不可单击，具体取决于您的电子邮件应用程序。

当您通过历史视图生成电子邮件时，电子邮件主题和正文会注释有与历史视图相对应的截止日期和时间。例如，在 1234 项的“历史记录”选项卡中，单击时间为 July 9, 2012 4:15:25 PM EST 的用户 jriley，以生成包含下列链接的电子邮件通知：

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 位数的月和日（单位数的月和日则要求有先导 0）

• T 将日期与时间分隔

• hhmmss 分别是 2 位数的小时、分以及秒（单位数的小时、分钟和秒则要求有先导 0）

• Z 是零 UTC 偏置的时区指示符

时间的指定范围是从 00:00:00 至 23:59:59，包括 24 小时格式，例如 URL 中提到的时间 13:56:45 等同于 1:56:45 PM。

此外，根据发件人的当地时间指定时间。如果收件人与发件人所在的时区不同，则在已单击链接并已打开项后，它会以当地时区的形式显示。

接收包含 Windchill RV&S客户端 URL 链接的电子邮件通知时，请注意下列事项：

• 在 Microsoft Outlook 电子邮件客户端中，Windchill RV&S客户端 URL 会以可单击的链接形式出现。

• 在 Microsoft Outlook Web 中，任何浏览器都不会支持可单击的 GUI 链接。

• 在 Lotus Notes 电子邮件客户端中，Windchill RV&S客户端 URL 会以不可单击的纯文本形式出现。您可以将文本复制到浏览器或 Windows 的“开始” > “运行”对话框中，以打开同一视图，获得与在 Microsoft Outlook 客户端中单击链接同样的效果。

客户端生成的电子邮件中的 Windchill RV&S项修订版本信息

如果项版本修订已启用，则在您单击用户名链接时，Windchill RV&S还会在Windchill RV&S 客户端生成的电子邮件中提供内容更为优化的汇总信息。当单击历史项中的用户名链接时，客户端生成的电子邮件的主题字段将包括以下格式的项修订版本信息：

类型 <项 ID>:项摘要 [修订版本信息] 截止截止日期

此外，在启用项版本修订后，客户端生成的电子邮件的正文包括：

截至：[修订版本信息] 截止日期

要查看 Windchill RV&S 项的历史记录上下文，请导航至“历史记录”选项卡，然后单击所需日期的时间戳链接以打开历史记录项。接着，您可以通过单击用户名链接（例如，“已分配用户”、“修改者”用户或者“创建者”用户），从历史记录 Windchill RV&S 项启动电子邮件消息。

当您单击项历史记录中的链接，或从未设置首个修订版本的项中工作时，在客户端生成的电子邮件中不会包含项修订版本信息。

如果未启用项版本修订，则 Windchill RV&S会创建生成的电子邮件的标准格式。

支持的视图、命令以及命令选项

下表描述了 Windchill RV&S客户端 GUI 视图以及 Windchill RV&S 客户端 URL 中支持的相应的 CLI 命令和命令选项。

Windchill RV&S客户端 GUI 视图

CLI 命令/支持的选项

URL 示例

“项”视图

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

要在“项”视图中的 Windchill RV&S客户端 GUI 中打开项：

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

“项详细信息”视图

im viewissue--asof

要在“项详细信息”视图中的 Windchill RV&S客户端 GUI 中打开项：

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

要在历史“项详细信息”视图中的 Windchill RV&S客户端 GUI 中打开项：

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

文档视图

im viewsegment--asof--fields--outlineColumns

要在“文档”视图中的 Windchill RV&S客户端 GUI 中打开文档：

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

关系视图

im relationships--asof--fields

要在“关系”视图中的 Windchill RV&S客户端 GUI 中打开文档：

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&S客户端 GUI：

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

源成员历史记录

si viewhistory--project--devpath--projectrevision

要在“源成员历史记录”视图中打开 Windchill RV&S客户端 GUI：

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

更改包

si viewcp

要在“更改包”视图中打开 Windchill RV&S客户端 GUI：

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

一览表

im rundashboard--fieldFilter

要打开 Windchill RV&S客户端 GUI 并运行指定一览表：

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

含有空格的一览表名称必须是带有引号的 URL 编码名称。

报告

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

要打开 Windchill RV&S客户端 GUI 并运行指定报告：

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

含有空格的报告名称必须是带有引号的 URL 编码名称。

此外，请注意有关 --project、--tvigui 和 --notvigui 命令选项的下列事项:

• --project 选项支持源配置路径和无格式路径语法。通过使用带 --project 选项的源配置路径语法，您可以指定变型项目并构建项目，而无需使用 --devpath 选项和 --projectrevision 选项。

例如，您可以不指定两个选项

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

您可以指定一个选项

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

有关这些语法的详细信息，请参阅 CLI 手册页的 options 手册页中的“指定配置管理项目”。

• --tvigui 选项和 --notvigui 选项可用于所有受支持的命令。这些选项控制 Windchill RV&S客户端 URL 是否在选项卡式视图界面（TVI）中启动指定的命令，即完全支持视图集或浮动视图的客户端视图。

◦ 如果未指定 --tvigui，则在 TVI GUI 中会启动命令。也就是说，使用用户当前的视图集打开 Windchill RV&S客户端 GUI，并且视图集配置会控制是否在浮动视图或者停靠的视图中打开命令。

◦ 如果已指定 --notvigui，则在浮动视图中会启动命令（不会启动 TVI GUI）。

有关视图集的详细信息，请参阅“了解视图集 (GUI)”。

系统生成的所有 Windchill RV&S客户端 URL 均会设为 --tvigui。可修改 Integrity 以生成单机 URL (--notvigui)；但是，您的管理员必须自定义生成电子邮件通知的触发器脚本。

URL 编码要求和考虑事项

在构建 Windchill RV&S客户端 URL 时，只需要对命令选项的值编码（不需要对整个 URL 编码）。

Windchill RV&S假定所有传入的Windchill RV&S 客户端 URL 均会按 RFC 1738 编码，以确保所有 URL 数据均可转换至/自 UTF-8。据万维网联合会建议，所有编码和解码均可使用 UTF-8 编码方案以实现最高的兼容性。例如，空格字符将编码为%20。有关详细信息，请浏览至 http://docs.oracle.com/javase/8/docs/api/java/net/URLEncoder.html。

所有非法字符的编码方式均为百分百 (%) 字符后接该字符的 ISO-Latin 代码点的两位十六进制表示形式。

下列是带有编码选项的 Windchill RV&S客户端 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&S客户端 URL 的自定义触发器脚本或自定义操作时，PTC 建议您使用诸如java.net.Encoder 等标准库对 URL 中的命令选项值进行编码。例如，您可以通过调用 Java 编码器类进行编码

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

此编码器类符合 RFC 1738（URL 规范），并可担保 Windchill RV&S客户端 URL 会在启动时通过Windchill RV&S 客户端进行正确的编码。有关详细信息，请浏览至 http://www.rfc-editor.org/rfc/rfc1738.txt。

触发器脚本文件 changePackageNotification.js 使用此 java 类在其 Windchill RV&S 客户端 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&S客户端 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 字符编码。这包括 ISO-Latin 集 80-FF 十六进制字符的整个上半部。
Unicode 字符	必须对所有 Unicode 字符编码。这包括 FF 上的全部内容。