Best Practices For Document Versioning
This section describes best practices recommended by PTC when using document versioning:
• To improve the accuracy of query results, include the Is Live filter in all queries for live items.
• To improve the accuracy of reports, include the (item is live) filter in all report recipes for live items.
• To improve the accuracy of computations, include the IsLive() function in all computed expressions for live items.
• To improve the accuracy of rules, include the Item is live condition in all rules for live items.
• Before versioning a document containing a computed field, carefully consider whether or not you want the computed field to Allow Computation Updates on Versioned Items. If you change the option after versioning the document, historical views of versioned items may not display the expected field value.
• With document versioning, a computed field containing an ambiguous computation returns an empty value. If a computed field may contain an ambiguous computation, as a best practice, PTC recommends wrapping the expression in the IsEmpty() function. This ensures that any empty computed field values stored to history are as a result of an ambiguous computed expression.
• If you have any trigger scripts affected by the CLI commands, classes and methods updated in Integrity 10.5 or higher, review those scripts and update them as required.
• When you write new integrations or upgrade existing integrations, upgrade the API version to 4.13 or higher and specify if you want to include versioned items by using an appropriate query definition. This ensures that your integrations use the appropriate item data.