Versions Compared

Old Version 5

changes.mady.by.user admin

Saved on

compared with

New Version Current

changes.mady.by.user Roberto Vigiani

Saved on

Key

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

Track changes, version solutions, and collaborate with Git.

Reference → Solution →  Dev Ops | Concept | Reference

Image AddedDevOps & Version Control (Reference): Modern development practices for industrial automation solutions, combining audit trails, change tracking, and Git integration while maintaining centralized database reliability.

Table of Contents
maxLevel2
minLevel2
indent10px
excludeSteps
stylenone

Overview

FrameworX provides comprehensive DevOps capabilities through two integrated systems:

SystemPurposeAccess
Track Changes ToolsInternal audit and impact analysisDesigner UI
Git IntegrationExternal version control and collaborationAutomatic export

This hybrid approach maintains industrial-grade reliability while enabling modern CI/CD workflows, code reviews, and multi-environment deployments.

Architecture

Change Management Stack

Git RepositoryExternal VCS
JSON Export LayerGit Integration
Track Changes DatabaseInternal Tracking
Solution Configuration DBSource of Truth

Data Flow

OperationInternal DBTrack ChangesGit Export
Create ObjectStoredLoggedExported
Modify ObjectUpdatedTrackedDiff created
Delete ObjectRemovedRecordedFile removed
Build SolutionVersionedMilestoneTagged

Core Components

Track Changes Tools

Internal change tracking and analysis:

ToolFunctionUse Case
Recent ChangesChange log with persistenceAudit trail
Version ControlTable version trackingOnline sync
Cross-ReferenceObject usage mappingImpact analysis
Use CountUsage frequencyOptimization
Unused ObjectsCleanup candidatesMaintenance

Git Integration

External version control and collaboration:

FeatureFunctionUse Case
Auto ExportContinuous sync to GitVersion tracking
JSON FormatDiff-friendly structureCode review
Selective ExportModule-based controlPerformance
Environment VariablesConfiguration managementMulti-environment
CI/CD SupportAutomation hooksDevOps pipeline

Workflow Integration

Development Lifecycle

PhaseTrack ChangesGit Integration
DevelopmentRecent Changes trackingFeature branches
ReviewCross-Reference analysisPull requests
TestingVersion Control syncCI validation
DeploymentBuild historyRelease tags
MaintenanceUnused Objects cleanupHotfix branches

Team Collaboration

Designer-Based Workflow:

  1. Multiple users edit solution
  2. Track Changes logs modifications
  3. Version Control maintains consistency
  4. Runtime diagnostics verify sync

Git-Based Workflow:

  1. Changes exported to JSON
  2. Developers review diffs
  3. Pull requests for approval
  4. Merge to main branch
  5. Deploy from Git tags

Security & Compliance

Audit Features

RequirementTrack ChangesGit Export
WhoUser trackingCommit author
WhatObject changesFile diffs
WhenTimestampsCommit history
WhyChange notesCommit messages
Compliance21 CFR Part 11SOC 2

Data Protection

Data TypeTrack ChangesGit Export
ConfigurationFull trackingExported
PasswordsTracked changesNever exported
Runtime ValuesNot trackedNot exported
Binary AssetsReference onlyChecksum verified

Configuration

Track Changes Settings

Location: Track Changes → Recent Changes

SettingOptionsDefault
Auto-DeleteVarious triggersPrevious Sessions
TrackingEnabled/DisabledEnabled
PersistenceDays to keep30

Git Export Settings

Location: Solution → Settings → Version Control

SettingOptionsDefault
Enable ExportOn/OffOff
Auto ExportOn/OffOff
Export PathDirectorySolution-Data\Git
Export DelaySeconds5

Best Practices

Change Management

Track Changes:

  • Configure appropriate persistence
  • Review Recent Changes daily
  • Monitor Version Control before deployment
  • Use Cross-Reference before deletions
  • Clean Unused Objects regularly

Git Integration:

  • Enable auto-export for tracking
  • Use meaningful commit messages
  • Implement branching strategy
  • Review changes through PRs
  • Tag releases consistently

Performance Optimization

SystemOptimizationImpact
Track ChangesSet auto-delete policyDatabase size
Cross-ReferenceRegular refreshQuery speed
Git ExportSelective modulesExport time
Version ControlBatch changesNetwork traffic

Limitations

Track Changes Limitations

Not Detected:

  • Indirect string references
  • External API access
  • Dynamic object names
  • Runtime-only changes

Git Export Limitations

Not Exported:

  • Runtime tag values
  • Historical data
  • User passwords
  • Temporary objects
  • Binary executables

Troubleshooting

ProblemPossible CauseSolution
Changes not trackedTracking disabledEnable in settings
Git export missingPermissions issueCheck directory access
Version mismatchUnsaved changesSave and build
Cross-Reference incompleteIndirect referencesManual verification
Large export filesToo many objectsSelective export

Integration Points

Internal Integration

ModuleIntegration PointPurpose
RuntimeVersion syncOnline configuration
DesignerFind Results panelNavigation
SecurityUser trackingAudit trail
SolutionBuild/PublishMilestones

External Integration

SystemMethodPurpose
GitHub/GitLabJSON exportVersion control
Jenkins/Azure DevOpsWebhooksCI/CD pipeline
Jira/Azure BoardsCommit linksIssue tracking
Teams/SlackNotificationsChange alerts


In this section...

Page Tree
root@parent


  

Introduction to Track Changes

Image Removed

The Track Changes tools provides additional features  for logging and tracking the engineering solution changes, covering the following: Recent Changes, Version Control, Cross-Reference, Use Count, and Unused Objects.

On this page:

Table of Contents
maxLevel3
minLevel2
stylenone

TrackChanges Tables

Recent Changes

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

Version Control

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

Cross-Reference

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

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

In this section:

Page TreerootV10:@selfspacesV10