IBM Rational ClearQuest Email Reader 概述
 

2009-02-06 作者:刘 美红 来源:IBM

 
本文内容包括:
本文将重点介绍 IBM Rational ClearQuest E-Mail Reader 的功能,如何配置使用 IBM Rational ClearQuest E-Mail Reader,以及使用邮件服务的典型应用案例。

前言

IBM® Rational® ClearQuest 是一个记录及其变更追踪系统,其通过提供给用户一个可定义的记录生命周期过程,实现从用户提交一个记录,并根据用户自定义的记录生命周期的过程来跟踪记录的变更,对记录及其变更进行管理。为了适应不同用户的需求,IBM Rational ClearQuest 除了提供 Windows 客户端,Web 客户端和 RCP 客户端外,用户还可以使用电子邮件作为其轻量级客户端。如图 1 所示,IBM Rational ClearQuest E-Mail Reader 功能组件,实现了用户电子邮箱作为 IBM Rational ClearQuest 客户端的功能。 本文将重点介绍 IBM Rational ClearQuest E-Mail Reader 的功能,如何配置使用 IBM Rational ClearQuest E-Mail Reader,IBM Rational ClearQuest E-Mail Reader 的合法消息格式,以及使用邮件服务的典型应用案例。

图 1. IBM Rational ClearQuest 系统体系结构
图 1. IBM Rational ClearQuest 系统体系结构

IBM Rational ClearQuest E-Mail Reader 功能概述

IBM Rational ClearQuest E-Mail Reader 提供一种通过邮件与 IBM Rational ClearQuest 数据库交互的功能。如图 2 所示,用户向指定的电子邮箱发送邮件消息,IBM Rational ClearQuest E-Mail Reader 定期从该邮箱读取电子邮件消息并对其进行处理。其处理过程,首先 IBM Rational ClearQuest E-mail Reader 判断消息是否格式正确,内容是否符合其标题所规定操作的要求。如果消息格式和内容不正确,则向用户和系统管理员发送包含错误信息,表明此次邮件更新记录企图失败的邮件,如果正确,IBM Rational ClearQuest E-Mail Reader 将通过 ClearQuest 核心组件和 RDBMS 组件更新其用户数据库,并判断该操作是否有邮件通知要触发。如果有,则利用邮件规则向预定用户发送关于此次变更信息的邮件消息。从而实现了终端用户可以在不安装任何 IBM Rational ClearQuest 客户端,只通过邮件客户端就可以提交,修改以及跟踪变更请求的需求。

IBM Rational ClearQuest E-Mail Reader 是 IBM Rational ClearQuest 在 Windows 平台上独有的功能组件。在实现上,它是一个 Windows 服务。由于使用邮件系统,该服务将打破企业内网的限制为用户随时随地访问 IBM Rational ClearQuest 用户数据库提供了可能。

图 2. IBM Rational ClearQuest E-Mail Reader 工作原理
图 2. IBM Rational ClearQuest E-Mail Reader 工作原理

IBM Rational ClearQuest E-Mail Reader 的安装与配置

IBM Rational ClearQuest E-Mail Reader 的安装

IBM Rational ClearQuest 采用组件化的安装模式,方便用户根据个人需要安装所需的 IBM Rational ClearQuest 系统的功能,如图 3 所示。IBM Rational ClearQuest E-Mail Reader 是 IBM Rational ClearQuest 的最小安装单元之一当在 Windows 上安装 IBM Rational ClearQuest 时,即使不选择任何组件,当安装成功时,IBM Rational ClearQuest E-Mail Reader 功能也会被安装。

图 3. IBM Rational ClearQuest 组件化安装模式
图 3. IBM Rational ClearQuest 组件化安装模式

IBM Rational ClearQuest 安装成功后,在 <IBM Rational ClearQuest 安装目录 >\Rational\ClearQuest\ 目录下有 mailreader 和 mailservice 两个应用程序文件。mailreader 是 IBM Rational ClearQuest E-Mail Reader 的配置工具,用来配置邮件服务器,邮件系统管理员为 IBM Rational ClearQuest E-Mail Reader 例程提供的邮箱和其访问信息,以及 IBM Rational ClearQuest E-mail Reader 读取邮箱消息的时间间隔,系统日志和出错处理。 mailservice 是一个邮件处理例程,mailservice 作为一个 Windows 服务,负责处理来自用户的邮件消息,它将合法的邮件消息转化成对指定的 IBM Rational ClearQuest 数据库的操作,例如:提交一条记录,修改一条记录或者对某条记录实施某种操作等。

配置 IBM Rational ClearQuest E-Mail Reader

mailreader 负责为 IBM Rational ClearQuest E-Mail Reader 配置邮件服务器信息和 IBM Rational ClearQuest 数据库信息,以及为 IBM Rational ClearQuest E-Mail Reader 的邮件处理例程对邮箱的读取时间间隔和出错处理等服务信息的配置。

如图 4 所示,在“开始”菜单中执行“运行”,输入 mailreader 启动 Mail Reader 配置工具。

图 4. 启动 IBM Rational ClearQuest E-Mail Reader 配置工具
图 4. 启动 IBM Rational ClearQuest E-Mail Reader 配置工具

在 IBM Rational ClearQuest E-Mail Reader 配置工具中,如图 5 所示,点击“添加”打开一个 IBM Rational ClearQuest 数据库和项目邮箱配置向导,用来对 IBM Rational ClearQuest 数据库和项目邮箱进行配置。

图 5. IBM Rational ClearQuest E-Mail Reader 配置工具
图 5. IBM Rational ClearQuest E-Mail Reader 配置工具

图 6,选择配置邮件服务器页面,输入邮件系统管理员提供的 SMTP 服务和 POP 服务的服务器地址:

图 6. 选择邮件服务器
图 6. 选择邮件服务器

图 7,配置邮件服务器帐户页面,设置 IBM Rational ClearQuest E-Mail Reader 将要读取的邮箱的 POP 访问信息,指定 POP 电子邮件地址,以及其登陆账户和密码,以便 IBM Rational ClearQuest E-Mail Reader 能通过 POP 协议登陆并获取指定邮箱中的信息。

图 7. 配置邮件服务器账户
图 7. 配置邮件服务器账户

图 8 配置电子邮件处理程序,为之配置关联的数据库。图 8 中,选择“ClearQuest”作为处理器,点击“配置”按钮关联一个 IBM Rational ClearQuest 数据库,配置一个合法用户作为记录的提交者,如图 9 所示。图 10 来设置缺省操作和字段名称。缺省操作和缺省字段,意味着当用户消息中,标题中不包含操作名称或者某段内容没有字段名称时 ,IBM Rational ClearQuest E-Mail Reader 将其解析为要完成默认操作或者默认字段值。

图 8. 配置邮件处理程序
图 8. 配置邮件处理程序

图 9. 配置 ClearQuest 数据库 - 第 1 步
图 9. 配置 ClearQuest 数据库 - 第 1 步

图 10. 配置 ClearQuest 数据库 - 第 2 步
图 10. 配置 ClearQuest 数据库 - 第 2 步

从图 4 到图 10 描述了 IBM Rational ClearQuest E-Mail Reader 的邮件服务和数据库信息的配置,IBM Rational ClearQuest E-Mail Reader 还提供了对 IBM Rational ClearQuest E-Mail Reader 服务信息的配置,如图 11 所示。

图 11. Mail Reader 服务信息配置
图 11. Mail Reader 服务信息配置

配置 IBM Rational ClearQuest Mail Service

除了 IBM Rational ClearQuest E-Mail Reader 的配置工具 mailreader, IBM Rational ClearQuest E-Mail Reader 还有一个执行邮件处理的服务模块 :IBM Rational ClearQuest Mail Service,它被实现为一个 Windows 服务。该服务缺省的登陆用户是本地系统账户,但是当 IBM Rational ClearQuest Mail Service 必须要存取网络资源的时候,必须指定一个具有相关权限的用户作为其登陆用户。方法:点击开始〉设置〉控制面板〉管理工具〉服务〉IBM Ratioanl ClearQuest Mail Service。右击选择“属性”,在其登陆页上指定服务的登陆用户。在“常规”页面可以设置服务为自动 / 手动启动模式。

至此,IBM Rational ClearQuest E-Mail Reader 的配置已经完成。运行“services.msc”,打开系统服务管理器,启动 IBM Rational ClearQuest Mail Service 服务,就可以通过向指定的邮箱(例如本例中的 mailserver@cn.ibm.com)发送邮件来操作 IBM Rational ClearQuest 的用户数据库(例如本例中的 mail/SAMPL)了。

提示:

  1. 要在 IBM Rational ClearQuest E-Mail Reader 工具添加一个数据库和邮箱,或对某个已有数据和邮箱修改必要,必须先停止 IBM Rational ClearQuest Mail Service 服务。
  2. 对服务信息的修改必须重起 IBM Rational ClearQuest Mail Service 服务才会生效。

邮件格式

IBM Rational ClearQuest E-Mail Reader 将符合格式的消息处理提交到 IBM Rational ClearQuest 数据库。IBM Rational ClearQuest E-Mail Reader 需要分析邮件携带的消息,如果消息格式正确并满足其操作的条件,IBM Rational ClearQuest E-Mail Reader 就会将该操作提交到 IBM Rational ClearQuest 用户数据库中。当邮件中携带的消息 IBM Rational ClearQuest E-Mail Reader 分析发现是不合法的消息格式或者携带的信息与操作的定义不相符时,IBM Rational ClearQuest E-Mail Reader 就会返回错误信息。

IBM Rational ClearQuest E-mail Reader 消息格式 :
 
消息标题 : 
< 记录类型 > < 操作 > < 记录 ID> 
消息体 : 
[< 字段名字 >:]< 字段合法值 > 
[< 字段名字 >:]< 字段合法值 > 
{[< 多行字符类型字段名字 >:] 这是个多行字段的例子,多行字段需要使用花括号,并且右括号要另起一行
}

提示:

  1. 消息体必须包含所有必需的字段及其值。
  2. 字段是没有顺序的,可重复出现的,且后者可以覆盖前者。
  3. 携带的附件直接处理为记录的附件
  4. 使用邮件通知邮件来生成提交或修改记录的模版是个很好的方法。

双向邮件处理

IBM Rational ClearQuest E-Mail Reader 对消息的处理可以是双向的。IBM Rational ClearQuest E-Mail Reader 不但可以将邮件消息转化成对 IBM Rational ClearQuest 用户数据库的操作,也可以根据用户订制的邮件规则来确定通过 IBM Rational ClearQuest E-Mail Reader 提交的操作是否触发邮件通知功能来向操作预定者发送邮件告知其预定用户 IBM Rational ClearQuest 数据库记录的变更情况。

要实现 IBM Rational ClearQuest E-Mail Reader 在接受邮件提交操作的基础上,实现邮件通知功能还需要完成三项配置工作。首先,在 IBM Rational ClearQuest 用户数据库中创建所需要触发邮件通知功能的邮件规则,并将邮件规则中“显示字段”选项页中的“发送者地址字段”设置为 IBM Rational ClearQuest E-Mail Reader 配置中指定的地址(例如本例中的 mailserver@cn.ibm.com)。然后,利用 IBM Rational ClearQuest 客户端启用电子邮件通知功能,关于如何定义邮件规则以及如何启动电子邮件通知功能已有文章详述,本文不做讲述。最后,需要对 IBM Rational ClearQuest Mail Service 服务的登陆用户身份进行设置并重起该服务。该服务需要登陆用户具有一定使用系统和网络资源的权限,否则 IBM Rational ClearQuest E-Mail Reader 的邮件通知功能不能正确工作,在本人的工作实践中将其设置为系统管理员账户可以成功的实现 IBM Rational E-Mail Reader 基于邮件规则的双向消息处理,如图 12 所示。操作方法:运行“services.msc”,选中“IBM Rational ClearQuest Mail Service 服务”,右击鼠标,选择“属性”-〉“登陆”页,修改登陆身份为“此账户”并输入“Administrator”,重起该服务。

图 12. 配置 ClearQuest Mail Service 登陆身份
图 12. 配置 ClearQuest Mail Service 登陆身份

实例演示

基于上述 IBM Rational ClearQuest E-Mail Reader 双向邮件处理的正确配置,利用 IBM Rational ClearQuest E-Mail Reader 接收处理消息和其邮件通知功能演示一个典型使用邮件双向处理缺陷的场景:

(1). 用户使用电子邮件提交一个新缺陷

用户使用电子邮件客户端,向系统管理员设置的 IBM Rational ClearQuest E-Mail Reader 服务邮箱指定的 POP E-Mail 地址 mailserver@cn.ibm.com 中发送符合邮件消息格式的邮件消息。如图 13 所示 :

图 13. 提交缺陷邮件
图 13. 提交缺陷邮件

图 13 中 : Headline 和 Severity:其定义类型为短字符串类型。其内容在提交操作中是否赋值的行为是必选项,所以它们的内容在邮件消息文本中必需提供。

Description 字段:其定义类型是多行字符串类型,在赋值时,需要使用“{}”。

(2). IBM Rational ClearQuest E-Mail Reader 处理邮箱信息,提交新缺陷,根据已定义的邮件通知规则触发向该缺陷所属的项目领导工程师发送被提交缺陷的相关信息。

领导工程师邮箱中收到该缺陷的通知信息,如图 14 所示:

图 14. 通知邮件
图 14. 通知邮件

(3). 项目领导工程师查看收到的主题为“Defect 冰箱恒温箱里有很多水”的电子邮件消息并通过邮件为其分配 engineer 作为该缺陷的负责人。如图 15:

图 15. 分配操作邮件
图 15. 分配操作邮件

(4). engineer 收到被分配的缺陷,开始工作,并发送邮件修改缺陷的记录信息。

engineer 工程师发送邮件消息来更新其发现。如图 16。

图 16. 修改操作邮件
图 16. 修改操作邮件

SAMPL00000052 缺陷被修改以后,项目领导工程师收到的邮件通知。如图 17。

图 17. 修改操作通知邮件
图 17. 修改操作通知邮件

总结

本文从 IBM Rational ClearQuest E-Mail Reader 的功能介绍入手,详细介绍了如何安装和配置 IBM Rational ClearQuest E-Mail Reader, 介绍了其处理的合法邮件格式,如何配置 IBM Rational ClearQuest E-Mail Reader 服务来实现双向邮件处理功能,最后给出了一个典型的 IBM Rational ClearQuest E-Mail Reader 应用场景实例。希望本文对想使用 IBM Rational ClearQuest E-Mail Reader 功能的用户提供参考价值。

参考资料

学习
  • 访问 IBM developerWorks 中国网站 Rational 专区,获得关于 IBM Rational 软件交付平台(Rational Software Delivery Platform)产品的技术资源和最佳实践。
  • 订阅 Rational Edge 中文版,获取软件开发领域的最佳实践。
  • 订阅 IBM developerWorks 时事通讯,一份关于 developerWorks 指南、文章、下载、社区活动、网络广播和技术讲座的电子周刊。
  • 学习 Hello World 系列教程,这是学习 IBM 软件工具的快速通道。在每一篇教程中,都会有快速入门产品演示动画。您可以通过其中的动画演示快速浏览如何使用 IBM 软件完成开发任务。
获得产品和技术
  • 访问 Rational ClearQuest 产品专题,了解最新的 IBM Rational ClearQuest 产品文档和产品信息,可以查阅产品概览、产品手册、产品技术支持、试用版下载,以及相关文章、教程、多媒体课堂和产品演示等信息。
  • 访问 IBM Rational 软件交付平台 V7 专题,了解 Rational V7 产品的方方面面。
  • 获取免费的 Rational 软件工具包系列,了解最新的 IBM Rational 软件开发工具技术文档和资源。
  • 下载免费的 IBM Rational 试用版软件,了解 IBM Rational 软件的最新特性。
  • 获取更多 IBM 试用版软件,并熟练掌握来自 DB2®、Lotus®、Tivoli®,以及 WebSphere® 的开发工具和中间件产品,用这些试用版软件开发您的下一个项目。这些试用版软件可以免费直接从 developerWorks 下载。
讨论

火龙果软件/UML软件工程组织致力于提高您的软件工程实践能力,我们不断地吸取业界的宝贵经验,向您提供经过数百家企业验证的有效的工程技术实践经验,同时关注最新的理论进展,帮助您“领跑您所在行业的软件世界”。
资源网站: UML软件工程组织