Introduction to rvt templates

Description

A rvt template defines a Document Object Type, specifying its appearance and behavior. It defines a Document Object Type's attributes, traces, validation rules and more.

A rvt template is an XML file with the "RevisableObjectTemplate" as the root XML element. It contains various other XML elements, each serving a specific purpose or function related to the Document Object Type.

Example of a rvt template

The following example shows a complete configuration of the Document Object "User Need" and its corresponding appearance in Aligned Elements.

Some elements like the Rich Text Attribute "Description" are directly visible in Aligned Elements, others are more hidden and describe behavior like the Validation Rules element.

rvt template

<?xml version="1.0" encoding="utf-8"?>
<RevisableObjectTemplate xmlns="urn:RevisableObjectTemplate.xsd">
  <TypeInfo TypeName="User Need" Prefix="UN" IsVisibleBook="true" DisplayOrder="5">
    <Category Name="Design Input" Order="0" Color="#1BADE8" />
    <ChapterTemplate>Calibri11.rtf</ChapterTemplate>
  </TypeInfo>
  <CompulsoryTraceHolders>
    <CompulsoryTraceHolder Type="Issue" />
    <CompulsoryTraceHolder Type="Attachment" />
  </CompulsoryTraceHolders>
  <Attributes>
    <RichTextAttribute Name="Description" ValueIfEmpty="Intentionally left blank" Height="500">
      <Template>Calibri11.rtf</Template>
    </RichTextAttribute>
    <MultiSelectAttribute Name="Applicable To" Height="100">
      <Items>
        <Item value="Patient" selected="true" />
        <Item value="Operator" selected="false" />
        <Item value="Service Engineer" selected="false" />
      </Items>
    </MultiSelectAttribute>
  </Attributes>
  <TraceHolders>
    <TraceHolder TypeName="Design Input Requirement" Generatable="true" Executable="false" />
    <TraceHolder TypeName="Validation Test Case" Generatable="true" Executable="false" />
  </TraceHolders>
  <PositiveCues>
    <PositiveCue FulfilledColor="#1ec158" NotFulfilledColor="#e63329" NotEvaluatedColor="#444444" Label="Traced">
      <ValidationRuleRef RuleID="UNTraced" />
      <ValidationRuleRef RuleID="UNValTraced" />
      <ValidationRuleRef RuleID="IsUNSuspect" />
    </PositiveCue>
    <PositiveCue FulfilledColor="#1ec158" NotFulfilledColor="#e63329" NotEvaluatedColor="#444444" Label="ReadyToSign">
      <ValidationRuleRef RuleID="IsUNReviewed" />
      <ValidationRuleRef RuleID="IsUNInDoc" />
    </PositiveCue>
  </PositiveCues>
  <ValidationRules>
    <TracedToRule ToTraceTypeName="Design Input Requirement" RuleID="UNTraced" />
    <TracedToRule ToTraceTypeName="Validation Test Case" RuleID="UNValTraced" />
    <HasOpenIssueRule TypeNameIssue="Issue" OpenAttributeName="Status">
      <ExpectedAttributeValue>Closed</ExpectedAttributeValue>
      <ExpectedAttributeValue>Duplicate</ExpectedAttributeValue>
      <ExpectedAttributeValue>Misunderstood</ExpectedAttributeValue>
    </HasOpenIssueRule>
    <NotReviewedRule ReviewTypeName="Review" RuleID="IsUNReviewed" />
    <SuspectTraceRule RuleID="IsUNSuspect" />
    <ObjectInFileRule FileTypeName="File" AttributeName="ObjectsInFile" RuleID="IsUNInDoc" />
  </ValidationRules>
</RevisableObjectTemplate>

Appearance in Aligned Elements

Appearance of User Need in Aligned Elements