创建文档类型
|
CLI
|
im createtype 或 im edittype
|
本节描述了如何使用共享项、节点和段这三种文档类型创建一个名为 Requirement 的示例文档域。
|
|
本节假设您是首次设置文档域,但已经了解如何使用 PTC RV&S 管理客户端 创建状态、字段和类型。有关如何创建状态、字段和类型的说明,请参阅管理员文档。
|
下表描述了创建 Requirement 文档域所需的步骤:
|
任务
|
支持信息
|
|
|
|
|
|
|
|
|
这些值代表了内容或文档的可用类别。您可以在此列表中添加和移除值。
|
|
|
首先创建共享项,节点类型的定义中会用到共享项。
|
|
|
节点的创建先于段,段类型的定义中会用到节点。
|
|
|
创建新域所需的最后一个类型。
|
|
|
根据您的域限制内容的可用类别。
这是一个必需步骤,因为在创建段类型之前无法为参考段的节点创建约束。
|
|
|
完成域类型的创建后,更新“参考”字段以包括定义中的类型。
必须完成此步骤才能允许新域中的节点 (内容) 参考子文档 (段)。
|
|
|
完成文档类型的创建后,您可以在“文档”视图中测试用户如何查看和使用它。
有关如何从“文档”视图创建和管理文档的说明,请参阅文档用户文档。
|
步骤 1:创建状态
对于在此过程中创建的示例文档类型而言,您在本节创建的状态数量是满足其需求的最低数量。您可以根据自己的环境选择继续创建更多状态。
1. 从“状态”视图中,选择 > 。“创建状态”对话框随即显示。
有关该对话框中所有字段和选项卡的详细信息,请参阅
创建状态。
2. 创建以下状态:
◦ Active
|
|
若要只显示测试管理相关的基于状态的功能,请选择 Integrity Test 筛选器。
|
在“功能”选项卡下,若要在测试会话项处于选中状态时允许创建和修改测试结果,请启用“允许在此状态下创建和修改测试结果”。
◦ Open.
没有必需的功能。
◦ Available
没有必需的功能。
3. 完成状态的创建后,单击“确定”。
步骤 2:创建字段
对于在此过程中创建的示例文档类型而言,您在本节创建的字段数量是满足其需求的最低数量。
要了解如何创建适用于您的环境的其他字段,请参阅
添加其他字段至现有文档域。
1. 从“字段”视图中,选择 > 。“创建字段”对话框随即显示。
有关该对话框中字段和选项卡的详细信息,请参阅
创建字段。
2. 创建 Shared Attachments 字段。
在“值”选项卡下:
◦ 在“名称”字段中,键入 Shared Attachments。
在“显示名称”字段中,PTC RV&S 将自动输入与所选名称相同的名称。显示名称是用户在 PTC RV&S 中看到的字段标题。
◦ 选择“附件”作为“数据类型”。
无需在任何选项卡进行其他选择。要了解此选项卡上的所有选项,请参阅字段文档。
◦ 完成 Shared Attachments 字段的设置后,请单击“确定”。
3. 创建 Shared Text 字段:
◦ 在“名称”字段中,键入 Shared Text。
在“显示名称”字段中,PTC RV&S 将自动输入与所选名称相同的名称。显示名称是用户在 PTC RV&S 中看到的字段标题。
◦ 在“值”选项卡下:
▪ 选择“长文本”作为“数据类型”。
▪ 启用“多格式内容”。
▪ 选择 Shared Attachments 作为“默认附件字段”。
▪ 启用“创建文本搜索索引”。
◦ 完成 Shared Text 字段的创建后,请单击“确定”。
4. 创建 Text 字段。此步骤允许您通过 Shared Text 字段的“参考”关系字段创建字段值属性。
◦ 在“名称”字段中,键入 Text。
在“显示名称”字段中,PTC RV&S 将自动输入与所选名称相同的名称。显示名称是用户在 PTC RV&S 中看到的字段标题。
◦ 在“值”选项卡下:
▪ 选择“字段值属性”作为“数据类型”。
▪ 选择“参考”作为“关系”。
▪ 选择 Shared Text 作为“字段”。
◦ 在“可编辑性”选项卡下:
▪ 禁用“始终不可编辑”,将 Text 字段设为可编辑。
▪ 选择“将字段值与常量进行比较”,并设置 Reference Mode!=Share。
▪ 单击“添加”。新的条件随即显示在文本框中。
有关定义条件和此选项卡上可用选项的详细信息,请参阅
定义规则。
◦ 完成 Text 字段的创建后,请单击“确定”。
5. 创建 Text Attachment 字段。此步骤允许您通过 Shared Attachments 字段的“参考”字段创建字段值属性。
◦ 在“名称”字段中,键入 Text Attachment。
在“显示名称”字段中,PTC RV&S 将自动输入与所选名称相同的名称。显示名称是用户在 PTC RV&S 中看到的字段标题。
◦ 在“值”选项卡中:
▪ 选择“字段值属性”作为“数据类型”。
▪ 选择“参考”作为“关系”。
▪ 选择 Shared Attachments 作为“字段”。
◦ 在“可编辑性”选项卡下:
▪ 禁用“始终不可编辑”,将 Text Attachments 字段设为可编辑。
▪ 选择“将字段值与常量进行比较”,并设置 Reference Mode!=Share。
▪ 单击“添加”。新的条件随即显示在文本框中。
有关定义条件和此选项卡上可用选项的详细信息,请参阅
定义规则。
◦ 完成 Text Attachment 字段的创建后,请单击“确定”。
步骤 3:验证“共享类别”字段的值
“共享类别”字段是一个内置字段,具有数个预定义的值。它用于定义文档内容的类别。您不必为您的环境使用预定义的所有值。有关文档内各个类别的详细信息,请参阅
类别。
1. 从“字段”视图中,编辑“共享类别”字段。“编辑字段”对话框随即显示。
2. 添加更多值,或等到您知道了所需类别。
3. 确保已禁用“允许多个值”。
4. 确保已禁用“设置默认值”,并且列表中没有出现任何值。反之,对使用此字段的每个类型使用覆盖,使默认值适用于这些类型。
5. “共享类别”值的审阅和更改完成后,请单击“确定”。
步骤 4:创建共享项类型
1. 确保已按前三个步骤所述创建适用的字段和状态,并且“共享类别”字段的值正确无误。
2. 从“类型”视图中,选择 > 。“创建类型”对话框随即显示。
有关该对话框中所有字段和节点的信息,请参阅
创建类型。
|
|
此过程仅针对设置共享项类型所需的类型特性提供注解。
|
3. 在“名称”字段中,为共享项类型创建域名。在此过程中,请使用 Shared Requirement。
4. 选择“属性”节点,并在“常规”框中定义以下内容:
◦ 启用“显示工作流”,并确保“‘阶段’字段”设置为 -none-。
◦ 启用“可以复制树”和“可以创建分支”。
◦ 启用“使用自定义图像”,然后指定一个图像用作 Shared Requirement 的图标。
◦ 如有需要,可在“说明” 部分输入描述性语句。
5. 选择“可见字段”节点,然后选择以下字段:
◦ 状态
◦ Shared Attachments
◦ Shared Text
6. 选择“文档模型”节点,然后定义以下内容:
◦ 将角色指定为“共享项”。设置此字段可将该角色所需的其他内建字段添加到选择列表中。
◦ 指定下列“重要编辑”字段:
▪ Shared Text
▪ Shared Attachments
|
|
每当要将字段添加到被视为可共享数据的共享项类型时,建议您也将那些字段添加至“重要编辑字段”列表。否则,可能会导致数据被覆盖。编辑此列表中的字段会更新共享项上的“输入修订版本日期”,因此也会更新节点上的“重要编辑日期”。如上述字段被编辑,此列表还会控制是否将追溯关系中的内容项标记为“疑似”。“共享类别”字段可能并未列于“重要编辑字段”列表中。然而,此字段始终被视为重要字段。
“重要编辑日期”字段与先前版本的 PTC RV&S 中的“修订版本日期”字段同义。
|
7. 选择“工作流”节点,然后定义以下状态转变,使其可供所有人使用:
◦ Unspecified --> Available
◦ Available --> Available
8. 为 Shared Requirement 类型定义所需的其他类型属性,如演示模板。
|
|
默认情况下,即使列表显示为空白或不可用,也会复制共享项的所有字段。
|
有关所有类型属性选项的说明,请参阅类型文档。
9. 完成 Shared Requirement 类型的创建后,请单击“确定”。该类型会显示在 PTC RV&S 管理客户端 的“类型”视图中。
10. 在“类型”视图中,编辑您刚刚创建的现有 Shared Requirement 类型。“编辑类型”对话框随即显示。
11. 选择“约束”节点,单击“创建”,然后做出以下选择:
◦ 选择“基本”作为“约束方法”。
◦ 选择“共享类别”作为“约束字段”。
◦ 在“允许的值”中,设置与此域类型相关内容有关的所有共享类别的值。
12. 选择“字段覆盖”节点,单击列表中的“共享类别”字段,然后选择“编辑”。
13. 选择“覆盖默认值”,然后设置一个值。在此域中创建内容时,初始默认类别即为此值。
14. 完成共享项类型的创建后,请单击“确定”。
步骤 5:创建节点类型
1. 确保已按前四个步骤创建适用的字段、状态和共享项类型,并且“共享类别”字段的值正确无误。
2. 从“类型”视图中,选择 > 。“创建类型”对话框随即显示。
此过程只说明了在
“创建类型”对话框中设置节点类型所需的类型字段、特性和属性。有关该对话框中所有字段、节点和常规选项的信息,请参阅
创建类型。
3. 在“名称”字段中,为节点类型键入域名。在此过程中,请使用 Requirement。
4. 选择“属性”节点,然后定义以下内容:
◦ 启用“显示工作流”,并确保“‘阶段’字段”设置为 -none-。
◦ 启用“可以复制树”、“可以创建分支”和“可以应用标签”。
◦ 启用“使用自定义图像”,然后指定一个图像用作节点的图标。
◦ 如有需要,可在“说明”中键入相关内容。
◦ 您可以选择在节点类型上允许文档版本化。要执行此操作,请启用“可以有版本”。
5. 选择“可见字段”节点,然后将以下字段添加至可见字段列表:
◦ 项目
◦ 状态
◦ Text
◦ Text Attachments
其他元数据字段可能仅在节点上有关,并未作为共享项上某个字段的字段值属性。Reference Mode!= Share> 时,这些字段不需要通过可编辑性规则防止编辑。
6. 选择“文档模型”节点,然后定义以下内容:
◦ 将角色指定为“节点”。设置此字段可将该角色所需的其他内建字段添加到选择列表中。
此外,此处将会出现一个复选框,可用于在特定菜单中隐藏该类型,即:“隐藏在‘插入内容’菜单下”。此复选框默认不选中。只有想要在“插入内容”菜单和相关对话框中隐藏类型时,才需要选择此复选框。
|
|
隐藏某个类型只会影响 PTC RV&S GUI 和 Web 界面,并不会阻止从 CLI 和 API 创建这些项。
|
◦ 指定下列“重要编辑”字段:
|
|
此列表可控制对节点上“输入修订版本日期”产生影响的编辑有哪些 (同时也会影响“重要编辑日期”)。由于节点上的“重要编辑日期”也会随共享项 (Shared Requirement) 的重要编辑而更新,此列表对于更新“重要编辑日期”,或对于将项设置为“疑似”而言,并没有那么重要。
|
▪ Text
▪ Text Attachments
▪ 类别
|
|
“包含”和“包含者”字段可能并未列于“重要编辑字段”列表中。然而,这些字段始终被视为重要字段。
|
7. 选择“复制字段”节点,并将您要复制的字段添加到列表中。在复制节点、为节点创建分支或创建相关项时,系统默认复制这些字段。用户可以通过添加和移除任何可以查看和编辑的字段来覆盖这些默认字段。
8. 选择“工作流”节点,然后定义以下状态转变,使其可供所有人使用:
◦ Unspecified --> Active
◦ Active --> Active
9. 为节点类型定义所需的任何其他类型属性,如演示模板。有关所有类型属性选项的说明,请参阅类型文档。
10. 完成节点类型的创建后,请单击“确定”。新的 Requirement 节点类型会显示在 PTC RV&S 管理客户端 的“类型”视图中。
11. 编辑您刚刚创建的 Requirement 节点类型。“编辑类型”对话框随即显示。
12. 选择“约束”节点,单击“创建”,然后做出以下选择:
◦ 选择“字段关系”作为“约束方法”。
◦ 选择“被参考项类型”作为“字段”(在“选择源字段和值”下)。
◦ 选择 Shared Requirement 作为“值”(在“选择源字段和值”下)。
◦ 选择“类别”作为“约束字段”。
◦ 在
“值约束”下,建议将类别的
“允许的值”设为与“共享项”约束列表中的值一致。有关详细信息,请参阅
步骤 4:创建共享项类型。
|
|
您需要在创建“文档”被参考项类型之后创建第二个约束。
|
13. 完成节点的约束设置后,请单击“确定”。
步骤 6:创建段 (文档) 类型
1. 确保已按前五个步骤创建适用的字段、状态、共享项类型和节点类型,并且“共享类别”字段的值正确无误。
2. 从“类型”视图中,选择 > 。“创建类型”对话框随即显示。
有关该对话框中所有字段和节点的详细信息,请参阅
创建类型。
3. 在“名称”字段中,为段 (文档) 类型键入域名。在此过程中,请使用 Requirement Document。
4. 选择“属性”节点,然后定义以下内容:
◦ 启用“显示工作流”,并确保“‘阶段’字段”设置为 -none-。
◦ 启用
“可以复制树”、
“可以创建分支”和
“可以应用标签”。有关这些选项的详细信息,请参阅
配置类型属性。
◦ 启用“使用自定义图像”,然后指定一个图像用作段的图标。
◦ 如有需要,可在“说明” 部分键入描述性语句。
◦ 您可以选择在段类型上允许文档版本化。要执行此操作,请启用“可以有版本”。
5. 选择“特性”节点,然后定义以下两个 (建议的) 特性:
◦ MKS.RQ.Domain
键入 Requirement 作为域的“值”。您可将此特性与段的“共享类别”值结合使用,以定义“创建文档”对话框中的值。
有关详细信息,请参阅
PTC eSupport 门户内的文章
CS122709。
◦ MKS.RQ.item.editissue.title
键入 Properties for {Summary} 作为“值”。此特性为文档特性项的编辑对话框提供了一个有意义的标题。
6. 选择“可见字段”节点和以下字段:
◦ 项目
◦ 摘要
◦ 状态
◦ Shared Attachments
◦ Shared Text
7. 选择“文档模型”节点,然后定义以下选项:
◦ 将角色指定为“段”。设置此字段可将该角色所需的其他内建字段添加到选择列表中。
此外,此处将会出现两个复选框,可用于在特定菜单中隐藏此文档类型,即:“隐藏在‘创建文档’菜单下”和“隐藏在‘插入’/‘包括’下的‘新建文档’菜单下”。两个复选框默认均不处于选中状态。仅当您想要在对应菜单和相关对话框中隐藏类型时,才应选择其中一个或两个复选框。
|
|
隐藏某个类型只会影响 PTC RV&S GUI 和 Web 界面,并不会阻止从 CLI 和 API 创建这些项。
|
8. 指定下列“重要编辑字段”:
|
|
本列表可控制对段上的“输入修订版本日期”产生影响的编辑有哪些,进而影响“重要编辑日期”。
|
◦ Shared Attachments
◦ Shared Text
|
|
“共享类别”、“包含”和“包含者”字段可能并未列于“重要编辑字段”列表中。然而,这些字段始终被视为重要字段。
|
9. 对于
“打印报告”,选择您希望用户在
PTC RV&S 中打印此类型文档时看到的打印输出格式。建议您对报告进行设计以打印整个文档。您可以使用任何管理报告进行文档打印。有关详细信息,请参阅
PTC eSupport 门户内的文章
CS229164。
10. 若要使用“组文档”项类型对内容进行重新排序或分组,请选择相应复选框。您无法在组文档中创建或编辑有意义的内容。
例如,您可以使用“测试组”来收集测试执行的测试用例。测试的编写可以在测试套件中,可以基于功能,也可以基于架构设计,并链接至具体测试所验证的需求。对测试进行分组可使作者更容易确保测试覆盖的完整性。在某些测试环境中,可能不会同时执行同一套件中的所有测试。通过“测试组”,可以针对各个拥有不同测试者和脚本的环境分别整理出一个测试用例子集。有关在测试管理中使用分组的更多示例,请访问 PTC eSupport 门户:
11. 将“默认参考模式”设置为“重复使用”或“共享”。此设置用于控制如何将复制内容复制到或分支到此类型的文档中。典型的默认模式是“重复使用”。
12. 选择“复制字段”节点,然后将以下字段和任何其他相关字段添加至列表。在复制文档项、为文档项创建分支或创建相关项时,系统默认复制这些字段:
◦ 摘要
◦ Shared Text
◦ Shared Attachments
◦ 共享类别
用户可以通过添加和移除任何可以查看和编辑的字段来覆盖这些默认字段。
13. 选择“工作流”节点,然后定义以下状态转变,使其可供所有人使用:
◦ Unspecified --> Open
◦ Open --> Open
14. 为段类型定义所需的其他类型属性,如演示模板。有关所有类型属性选项的说明,请参阅类型文档。
15. 完成段类型特性的创建后,请单击“确定”。新的段类型现在显示在类型列表中。
16. 编辑您刚刚创建的现有 Requirement Document 段类型。“编辑类型”对话框随即显示。
17. 选择“约束”节点,单击“创建”,然后做出以下选择:
◦ 选择“基本”作为“约束方法”。
◦ 选择“共享类别”作为“约束字段”。
◦ 选择“文档”作为“允许的值”。
◦ 单击“确定”。
18. 选择“字段覆盖”节点,然后编辑“共享类别”字段。
19. 选择“覆盖默认值”,然后选择“文档”作为“值”。在此域中创建内容时,初始默认类别即为“文档”。
20. 完成段类型特性的设置后,请单击“确定”。
步骤 7:更新对节点类型的约束
1. 编辑您在
步骤 5:创建节点类型中创建的现有 Requirement 节点类型。
“编辑类型”对话框随即显示。
2. 选择“约束”节点,单击“创建”,然后做出以下选择:
◦ 选择“字段关系”作为“约束方法”。
◦ 选择“被参考项类型”作为“字段”(在“选择源字段和值”下)。
◦ 选择 Requirement Document 作为“值”(在“选择源字段和值”下)。
◦ 选择“类别”作为“约束字段”。
◦ 选择“文档”作为“允许的值”(在“值约束”下)。
3. 完成节点的约束更新后,请单击“确定”。
步骤 8:更新“参考”字段,新添允许的类型以提供异质文档支持
1. 从“字段”视图中,编辑“参考”字段。“编辑字段”对话框随即显示。
2. 在“类型”下,选择新的节点类型。在此用例中,请选择 Requirement。
3. 从“可用类型”列表中选择正确的段类型。例如,选择 Requirement Document,然后用箭头将其移至“允许的子段类型”部分。
4. 保存您的更改。
步骤 9:在 PTC RV&S 中测试文档类型配置
在 PTC RV&S 管理客户端 中完成文档类型的设置后,您可以在 PTC RV&S 中使用“文档”视图创建一个文档以对其进行测试。
1. 在 PTC RV&S 管理客户端 中创建一个项目。
2. 从“文档”视图中,选择 > > 。
3. 从您正在创建的文档中,选择您创建的项目。
4. 在“短标题”字段中,为您的文档键入一个名称。
5. 根据需要编辑文档特性。
有关在 PTC RV&S 客户端中使用文档的详细信息,请参阅用户文档中的“文档”主题。
6. 保存您的更改。您创建的文档随即会在“文档”视图中打开,其中包含单个虚拟行。