Limitations For Document Versioning
This section lists the following limitations for document versioning:
• Databases
• Integrity Clients
• Queries
• Charts
• Reports
• Rules
• Configuration Management
• Test Management
• Integrations
• Editable Fields
• Constraints
• Field Value Attribute Relationships
• Checking in a Document
• Existing Solutions
• Versioned Item IDs
For a list of known issues with document versioning, see the Integrity Lifecycle Manager release notes.
Integrity Lifecycle Manager Clients
If you are working with document versions using Integrity client 10.4 or older, some item operations may not work or may produce unexpected behavior.
To make full use of the document versioning capabilities, PTC recommends upgrading your Integrity Lifecycle Manager client to 10.5 or higher.
The following is a list of specific limitations in Integrity clients 10.4 or older:
• Older clients do not display hyperlinks to document or content version information in the header and History tab of the Item Details view. Older clients display Created by and Modified by information only.
• Older clients do not support searching for versioned documents using the Document ID field.
• Queries containing versioned item IDs, the Is live query filter, or the include versions query filter are not visible in older clients. In addition, charts, reports, and dashboards containing those queries are not visible in older clients.
• Report recipes containing report tag filters for live and versioned item IDs display an error message in older clients.
• Older clients cannot evaluate rules with live or versioned item conditions correctly, potentially resulting in unexpected behavior.
• Older clients cannot create, edit, or view (click on) hyperlinks to versioned items in the Item Details view.
Queries
• You cannot display a range of versioned items, for example, ID > 123-1.0 and < 123-2.0.
• You cannot display the content from a range of versioned documents, for example, Document ID > 123-1.0 and < 123-2.0.
Charts
Charts do not display ambiguous computed expression values in versioned content item data. If a chart contains an ambiguous computed expression, an error message displays.
Reports
The
Integrity Lifecycle Manager client GUI and Web interface include icons to indicate live fields (
) and ambiguous computed fields (
) in versioned items; however, reports cannot display these icons.
Rules
For information on how versioning impacts rules, see
Rule Format.
Configuration Management
Document versioning is not intended for use with configuration management capabilities in Integrity Lifecycle Manager. Some configuration management operations may not work or may produce unexpected behavior. For example, you cannot create change packages with versioned items and the Associated Issues tab in a Project Information window does not display versioned item IDs.
Test Management
Test Steps are not currently supported for versioned items. When creating a new version, Test Steps and Shared Test Steps fields are not copied to the new version. The Integrity Lifecycle Manager client Web, GUI, and CLI display a message indicating that Test Steps are not supported for versioned items. The Integrity Lifecycle Manager API displays an empty value.
In addition, the following limitations apply:
• Test Case relationships are not copied to the new version.
• Review Session relationships are not copied to the new version because they are a single-valued relationship field. Only multi-valued relationships fields can be copied.
Integrations
Document versioning is not intended for use with integrations. Some integrations may not work or may produce unexpected behavior. For example, note the following about the Microsoft Word, Microsoft Project, Microsoft Excel, and Integrity Integration Platform integrations:
• Microsoft Word integration
◦ A versioned document can be exported using Gateway. But, if you export a live document with trace relationships to versioned documents, the trace relationships are exported, though the versioned item IDs are not exported.
◦ The > command is disabled for a versioned document.
◦ Reimport functionality is not supported for a versioned document. When reimporting a versioned document that is exported from Integrity Lifecycle Manager, Gateway treats it as a new import operation and creates a fresh document.
• Microsoft Project integration
If you export a live document with trace relationships to versioned documents, the Microsoft Project integration successfully creates a row for the live document item and its related items. Rows are also created for versioned items in the relationship field.
When attempting to synchronize with Integrity, the Microsoft Project integration is unsuccessful in synchronizing the versioned items. This occurs because the Integrity Lifecycle Manager API excludes versioned items when using the im issues command. For rows containing non-versioned items, you can synchronize them individually.
• Microsoft Excel integration
If you export live items with relationships to versioned content, the versioned item IDs are not exported.
• Integrity Integration Platform (IIP) integrations
IIP integrations, such as Integrity Lifecycle Manager to Windchill, do not work correctly with document versioning. For example, if document versioning is enabled, versioned documents are not published to Windchill and integration-specific fields in versioned documents are incorrect for previously published documents.
PTC recommends that you do not use versioned data with integrations, for example, RIF, Microsoft Project, Microsoft Excel and IIP integrations.
Editable Fields
By default, once a type is configured to allow versioning, fields are not editable on document and content versions of that type. As administrator, you can allow editing for certain fields on versions.
For document model items, the
Version Edit Fields list allows you to specify the fields that users can edit on versions. To indicate to users the fields that can update on versions, a live field icon (
) displays next to the fields when viewing versions. You can configure the following standard (default) fields as editable for versions:
Backward
Forward
| For document and content versions, you can only allow editing on some field types and some built-in fields are not allowed. For the list of supported field types and built-in field restrictions, see “Significant Edit Fields” in the Integrity Lifecycle Manager Installation and Upgrading Guide. If any of the integer fields in the list of Version Edit Fields back a range field, the range field displays the live field icon ( ) in document and content versions. |
For example, if you add a float or integer field to the Version Edit Fields list, it can be used as a metrics field in document and content versions that is updated by an event trigger.
Constraints
If document versioning is enabled, versioned items may contain field data that does not currently match existing constraint rules even though the field data was valid at the time of versioning. Constraint rules are not evaluated and do not cause errors if the current values do not match existing constraint rules. Constrained fields display all possible values.
Field Value Attribute Relationships
If a field value attribute (FVA) relationship on a content node points to a single-valued relationship field on the shared item, versioning the content node displays a warning message that the FVA relationship field is one of the relationship fields that is not copied to the new versioned content node item.
Existing Solutions
If you have an existing solution installed, such as the ALM solution, enabling document versioning may impact fields and admin objects in the solution. For example, certain reports or triggers in the ALM solution may not work or may produce unexpected behavior.
| With the release of Integrity 10.6 or later, the ALM solution download is no longer maintained or available for download from the Integrity Lifecycle Manager Support Center. Contact your PTC Account Representative to learn more about available ALM solution offerings from PTC. |
For more information on known issues, browse the Knowledge Base at:
The Knowledge Base articles may indicate potential workarounds or fixes that could be made to correct known issues.
Checking In a Document
Depending on the size of a document and your document model configuration, the initial check in to create a document version and content versions may take a long time to complete.
If the document contains content that was previously checked in individually, this may reduce the length of time to perform the initial document check in.
Deleting Live Document or Content Items
A live document or content item with versioned items cannot be deleted.
Versioned Item IDs
Versioned item IDs cannot be specified or displayed for the following:
Integrity Component | Affected Area |
Relationships View | When loading a branch in the Relationships view (GUI), the versioned item ID does not display. After the branch is loaded, the versioned item ID displays. |
Viewing and Editing Items | Computed fields and range fields (if using an FVA to ID) do not display versioned item IDs. |
Export Items to Microsoft Excel | im exportissues (CLI) and Export Items to Excel (GUI/Web) do not export versioned item IDs. |
CLI Commands | You cannot specify versioned item IDs with the following CLI commands: • im printissue • im propagatetraces • im branchsegment --insertLocation, --parentID • im issues --focusIssueID • im viewsegment --focusIssueID, --sessionID • im viewduplicates |
Visual Studio and Eclipse Integrations | Versioned items are not returned in the integrations. |
Integrity Web Services | You cannot specify versioned item IDs for input and output does not display versioned item IDs. |
Document Read and Review Application | You cannot specify versioned item IDs. |
Logging | • Audit log does not display versioned item IDs. • Client and server logs display some versioned item IDs. |
E-mail Notification | Relationship field values do not display versioned item IDs. |
