Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction to Track Changes

Image Modified

The Track Changes tools

provides additional

provide features

 for

for logging and tracking

the

engineering solution changes,

covering the following:

including Recent Changes, Version Control, Cross-Reference, Use Count, and Unused Objects.

On this page:

Table of ContentsmaxLevel3minLevel2stylenone

These tools enable audit trails, impact analysis, and solution optimization.

Access: Track Changes (in Solution Explorer)

Parent Page: DevOps & Version Control (Reference)



Navigation Pages

PagePurposePrimary Use
Recent ChangesChange log with configurable persistenceAudit trail and navigation
Version ControlTable version trackingOnline configuration sync
Cross-ReferenceObject usage locationsImpact analysis
Use CountUsage frequencyResource optimization
Unused ObjectsUnreferenced objectsCleanup candidates

Core Functions

Change Tracking

Version Control tables maintain a summary, by Module and Configuration Table, of the current version

of the

and last modification of all elements in a solution.

TrackChanges Tables

Recent Changes

Track Changes provides a table that automatically logs changes within solutions, covering configuration adjustments, as well as the creation and deletion of solution objects. The table lists the configuration name, modification type, date and time, and the responsible user.

When starting the Designer, the Home page shows the recent changes in the solution, querying the contents of this table.

You can customize the persistence of those records at TrackChanges / Recent Changes.

Presents the list objects modified in the Solution Configuration. See Recent Changes.

Version Control

The data from the Version Control is automatically used by the platform to ensure consistency when connecting the Solution in execution (Runtime) in order to perform online changes. 

The Designer UI under Runtime / Diagnostics compares the versions of your configuration files with the versions of all the tables in the solution in execution, allowing the online configuration to proceed or remain in offline configuration, showing which parts of the solution are out of date.

Presents the summary of all configuration tables and its version. See Version Control.

Cross-Reference

Cross-Reference provides a table to view and interact with the cross-referencing of all objects within the solution.

The contents of this table enables the Find Results Panel at the Designer main interface. See Designer (IDE Overview) / Find Results Panel.

Usually, it easier than to use the Find Results panel to presents the referenced elements of the selected object, rather than execution the search in this table.

Presents the list objects in use and its usage locations. See Cross-Reference.

Use Count

Presents the list objects in use, and the number of times it has been used. See Use Count.

Unused Objects

The Unused Objects page provides a table listing all unused objects in the solution. This view is not dynamic; it is updated when first loading and via the Refresh button.

Its purpose is to identify components that can be removed to enhance efficiency by eliminating unnecessary configurations.

Presents the list objects created but not used in the configuration. See Unused Objects.

Removing Unused Objects

Limitations, when its not safe to remove

This feature only shows the places where the object is being used directly, not those used by an indirect reference or string manipulation.

See TrackChanges / CrossReference for example of configuration using objects indirectly. 

This data ensures consistency when connecting to Runtime for online changes.

Cross-Reference Engine

The Cross-Reference system powers:

  • Find Results Panel in Designer
  • Use Count calculations
  • Unused Objects detection
  • Impact analysis for changes

Limitations

Important: Cross-Reference only detects direct object usage. Indirect references are not tracked:

Indirect Usage TypeExampleImpact
String referencesAsset("/folder1/tag1")Not detected
.Link propertyTagReference via stringNot tracked
API accessExternal applicationsNot visible
Dynamic referencesScript-generated namesNot found
OPC UA/MQTTExternal consumersNot tracked

Integration Points

With Designer

FeatureIntegrationPurpose
Find Results PanelUses Cross-Reference dataObject search
Home PageShows Recent ChangesQuick access
Runtime DiagnosticsCompares versionsOnline config
Double-click navigationFrom any table rowDirect access

With Runtime

The Version Control data enables:

  • Online configuration verification
  • Hot reload compatibility checks
  • Change synchronization
  • Version mismatch detection

Best Practices

Regular Maintenance

  • Review Recent Changes daily
  • Check Unused Objects weekly
  • Monitor Use Count for optimization
  • Verify Cross-References before deletion

Before Removing Objects

  1. Check Unused Objects table
  2. Verify no indirect references
  3. Confirm no external usage
  4. Use Find Results for verification
  5. Document removal reason

Change Management

  • Configure appropriate auto-delete settings
  • Keep audit trail for compliance
  • Export changes for version control
  • Review Version Control before deployment

Child Pages

Only remove unused objects if you're sure they aren't used indirectly or by external applications. 

In this section:

Page Tree
rootV10:@self
spacesV10