Page History
DevOps
& Version Control
features enable modern(Reference): Modern development practices for industrial automation solutions, combining audit trails, change tracking, and Git integration while maintaining
the reliability ofcentralized database
architecturereliability.
Parent Page: Solution Lifecycle (Reference)
On this page:
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Overview
FrameworX provides comprehensive DevOps capabilities through two integrated systems:
| System | Purpose | Access |
|---|---|---|
| Track Changes Tools | Internal audit and impact analysis | Designer UI |
| Git Integration | External version control and collaboration | Automatic 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 |
| Repository | External VCS |
| JSON Export Layer | Git Integration |
| Track Changes Database | Internal Tracking |
| Solution Configuration DB | Source of Truth |
Data Flow
| Operation | Internal DB | Track Changes | Git Export |
|---|---|---|---|
| Create Object | Stored | Logged | Exported |
| Modify Object | Updated | Tracked | Diff created |
| Delete Object | Removed | Recorded | File removed |
| Build Solution | Versioned | Milestone | Tagged |
Core Components
Track Changes Tools
Internal change tracking and analysis:
| Tool | Function | Use Case |
|---|---|---|
| Recent Changes | Change log with persistence | Audit trail |
| Version Control | Table version tracking | Online sync |
| Cross-Reference | Object usage mapping | Impact analysis |
| Use Count | Usage frequency | Optimization |
| Unused Objects | Cleanup candidates | Maintenance |
Git Integration
External version control and collaboration:
| Feature | Function | Use Case |
|---|---|---|
| Auto Export | Continuous sync to Git | Version tracking |
| JSON Format | Diff-friendly structure | Code review |
| Selective Export | Module-based control | Performance |
| Environment Variables | Configuration management | Multi-environment |
| CI/CD Support | Automation hooks | DevOps pipeline |
Workflow Integration
Development Lifecycle
| Phase | Track Changes | Git Integration |
|---|---|---|
| Development | Recent Changes tracking | Feature branches |
| Review | Cross-Reference analysis | Pull requests |
| Testing | Version Control sync | CI validation |
| Deployment | Build history | Release tags |
| Maintenance | Unused Objects cleanup | Hotfix branches |
Team Collaboration
Designer-Based Workflow:
- Multiple users edit solution
- Track Changes logs modifications
- Version Control maintains consistency
- Runtime diagnostics verify sync
Git-Based Workflow:
- Changes exported to JSON
- Developers review diffs
- Pull requests for approval
- Merge to main branch
- Deploy from Git tags
Security & Compliance
Audit Features
| Requirement | Track Changes | Git Export |
|---|---|---|
| Who | User tracking | Commit author |
| What | Object changes | File diffs |
| When | Timestamps | Commit history |
| Why | Change notes | Commit messages |
| Compliance | 21 CFR Part 11 | SOC 2 |
Data Protection
| Data Type | Track Changes | Git Export |
|---|---|---|
| Configuration | Full tracking | Exported |
| Passwords | Tracked changes | Never exported |
| Runtime Values | Not tracked | Not exported |
| Binary Assets | Reference only | Checksum verified |
Configuration
Track Changes Settings
Location: Track Changes → Recent Changes
| Setting | Options | Default |
|---|---|---|
| Auto-Delete | Various triggers | Previous Sessions |
| Tracking | Enabled/Disabled | Enabled |
| Persistence | Days to keep | 30 |
Git Export Settings
Location: Solution → Settings → Version Control
| Setting | Options | Default |
|---|---|---|
| Enable Export | On/Off | Off |
| Auto Export | On/Off | Off |
| Export Path | Directory | Solution-Data\Git |
| Export Delay | Seconds | 5 |
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
| System | Optimization | Impact |
|---|---|---|
| Track Changes | Set auto-delete policy | Database size |
| Cross-Reference | Regular refresh | Query speed |
| Git Export | Selective modules | Export time |
| Version Control | Batch changes | Network 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
Configuration
Track Changes Settings
Location: Track Changes → Recent Changes
| Setting | Options | Default |
|---|---|---|
| Auto-Delete | Various triggers | Previous Sessions |
| Tracking | Enabled/Disabled | Enabled |
| Persistence | Days to keep | 30 |
Git Export Settings
Location: Solution → Settings → Version Control
Troubleshooting
Common Issues
| Problem | Possible Cause | Solution |
|---|---|---|
| Changes not tracked | Tracking disabled | Enable in settings |
| Git export missing | Permissions issue | Check directory access |
| Version mismatch | Unsaved changes | Save and build |
| Cross-Reference incomplete | Indirect references | Manual verification |
| Large export files | Too many objects | Selective export |
Integration
with Other SystemsPoints
Internal Integration
| Module | Integration Point | Purpose |
|---|---|---|
| Runtime | Version sync | Online configuration |
| Designer | Find Results panel | Navigation |
| Security | User tracking | Audit trail |
| Solution | Build/Publish | Milestones |
External Integration
| System | Method | Purpose |
|---|---|---|
| GitHub/GitLab | JSON export | Version control |
| Jenkins/Azure DevOps | Webhooks | CI/CD pipeline |
| Jira/Azure Boards | Commit links | Issue tracking |
| Teams/Slack | Notifications | Change alerts |
Child Pages
Internal Tools:
- Track Changes Tools (Reference) - Designer tracking interface
- Recent Changes
- Version Control
- Cross-Reference
- Use Count
- Unused Objects
External Integration:
- Git Integration & Export (Reference) - Git/JSON export system
See Also
- Solution Settings & Tools (Reference) - Configuration settings
- Solution Export (Reference) - Export interface
- Runtime Diagnostics (Reference) - Version synchronization
- Find Results Panel (Reference) - Cross-reference UI
In this section
:...
| Page Tree | ||||
|---|---|---|---|---|
|
Overview
Content Tools
Tasks