Configure a Type Name Change

Document Object Type Names are stored in many parts of the project.

When wanting to change a Type name, simply changing the type name in the .rvt file is not sufficient (Aligned Elements will interpret it such as "all objects of the old type name are gone and a new type has been added" i.e. Aligned Elements does not understand that the old and new type names relate to each other.)

Changing a Type Name

Preparations

Update the template type name in the rvt file in the TypeInfo tag.

Add a conversion hint to the TypeInfo tag with:

  • OldName="<the old type name>"

  • OldPrefix="<the old prefix>"

  • InlineConversion = "true"

  <TypeInfo TypeName="Requirement" Prefix="RQ" IncludeInOfficeIntegration="true" IsVisibleBook="true" DisplayOrder="123">
    <ConversionHint OldTypeName="Design Input Requirement" OldPrefix="DIR" InlineConversion="true"/>
  </TypeInfo>

Update the docx template by changing the type name in main tag.

  • Update all templates (rvt, docx and Trace Tables docx) that refer to the renamed template

  • The ProjectMapping.xml file might need to be updated if it is used

  • The ProjectExplorerTemplate.xml file might need to be updated if it is used

  • Do not forget to remove the originally named file from the template set

Execution

Make sure no one else is logged in to the project. Load the project with the Force Template Reload checkbox ticked.

Consequences

This operation will automatically update the Type Name in the database data records.

Changing a Type Name and Prefix

It is also possible to change the type name and prefix in one go.

A prefix change is considerable more intrusive than a type name change since the prefix is a part of the Document Object IDs. Therefore, a chage of prefix will lead to a new revision of all objects of the type in questions. The old revisions, and all artefacts that contain old artefacts, such as snapshots, queries, reviews, test runs etc. will no longer be accessible.

Inform yourself carefully before performing a prefix changes since the consequences are extensive.

Preparations

Update the template type name and prefix in the rvt file in the TypeInfo tag.

Add a conversion hint to the TypeInfo tag with:

  • OldName="<the old type name>"

  • OldPrefix="<the old prefix>"

  • InlineConversion = "false"

  <TypeInfo TypeName="Requirement" Prefix="RQ" IncludeInOfficeIntegration="true" IsVisibleBook="true" DisplayOrder="123">
    <ConversionHint OldTypeName="Design Input Requirement" OldPrefix="DIR" InlineConversion="false"/>
  </TypeInfo>

Update the docx template by changing the type name in main tag.

  • Update all templates (rvt, docx and Trace Tables docx) that refer to the renamed template

  • The ProjectMapping.xml file might need to be updated if it is used

  • The ProjectExplorerTemplate.xml file might need to be updated if it is used

  • Do not forget to remove the originally named file from the template set

Execution

Make sure no one else is logged in to the project. Load the project with the Force Template Reload checkbox ticked.

Consequences

A change of prefix will lead to a new revision of all objects of the type in questions. The old revisions, and all artefacts that contain old artefacts, such as snapshots, queries, reviews, test runs etc. will no longer be accessible.

The word documents must be updated manually since they are not adapted during the conversion.

Inform yourself carefully before performing a prefix changes since the consequences are extensive.

PreviousDownload Log Files