Git Integration and Export Reference

Integrate solutions with Git repositories.

Reference → Solution → DevOps → Track Changes | Git 

Git Export Architecture

Hybrid Configuration Management

Git-Friendly JSON Format

Configuration

Enabling Git Export

Navigate to Solution → Settings → Version Control:

Export Modes

Automatic Export:

• Monitors configuration changes
• Exports on version increment
• Batches rapid changes
• Background operation

Manual Export:

• Export All - Complete solution
• Export Module - Selected module
• Export Current - Active object

Directory Structure

Solution Root Directory:

• Solution/ - Core configuration files
  • SolutionCategories.json
  • SolutionSettings.json
• Displays/ - UI and visualization components
  • Layouts/ - Display configurations
    • MainPage.json
    • Overview.json
  • Images/ - Visual assets
    • Logo.json (metadata)
    • Logo.png (binary file)
• Scripts/ - Application logic
  • Tasks/ - Server-side scripts
    • ServerStartup.json
  • Classes/ - Reusable code libraries
    • DataProcessor.json
  • ScriptsExpressions.json
• UNS/ - Unified Namespace data model
  • UnsTags.json
  • UserTypes/ - Custom data templates
    • CustomTemplate.json
• Alarms/ - Alarm configuration
  • AlarmsGlobalSettings.json
  • AlarmsItems.json
• .gitignore - Version control exclusions

JSON File Format

Standard Structure

json

{
  "ExportInfo": {
    "ObjectType": "ScriptsTasks",
    "TableVersionID": 6,
    "SolutionVersionID": 245,
    "ExportDate": "2025-08-23T10:30:00Z",
    "ExportUser": "john.doe"
  },
  "Header": {
    // Object metadata from table columns
  },
  "Body": {
    // Object content or table rows
  }
}

Export Categories

Individual Object Files:

• Script Tasks and Classes
• Display Layouts
• SQL Queries
• Report Definitions
• Symbol Definitions

Table Export Files:

• Tags (UNS)
• Alarm Items
• Device Points
• Security Settings
• Expressions

Security & Sensitive Data

Data Protection

Environment Variables

json

{
  "DatabaseConnection": "${DB_CONNECTION}",
  "EmailServer": "${SMTP_SERVER}",
  "HistorianPath": "${HISTORIAN_PATH}"
}

Variables resolved at runtime for environment-specific deployment.

Git Workflow

Recommended Process

1. Initialize Repository

bash

cd /path/to/solution
git init
git remote add origin https://github.com/company/scada-config.git

1. Development Branch

bash

git checkout -b feature/new-alarm-logic
# Make changes in FrameworX
git add .
git commit -m "Add temperature monitoring for Reactor-3"
git push origin feature/new-alarm-logic

1. Code Review
   • Create pull request
   • Team reviews changes
   • Merge to main branch

Branching Strategy

Main Branches:

• main - Production-ready code
• develop - Integration branch for features

Feature Branches:

• feature/new-screens - New display development
• feature/alarm-updates - Alarm system modifications
• feature/script-optimization - Script performance improvements

Maintenance Branches:

• hotfix/critical-alarm-fix - Emergency production fixes
• release/v2.1 - Release preparation and stabilization

Branch Hierarchy:

• Main branch serves as production baseline
• Develop branch integrates all feature work
• Feature branches created from develop
• Hotfix branches created from main for urgent fixes
• Release branches created from develop for version preparation

Best Practices Checklist 

What to Export

• Export to Git:
  • Application configuration
  • Display definitions
  • Script code
  • Alarm rules
  • Report templates
  • Static settings
• Keep in Database Only:
  • Runtime tag values
  • Historical data
  • User passwords
  • Session information
  • Temporary data
  • High-frequency updates

Commit Guidelines

Performance

Export Performance

Optimization Tips

• Use selective export for large systems
• Enable compression for repository
• Implement .gitignore for generated files
• Schedule exports during low activity
• Use shallow clones for CI/CD

CI/CD Integration

Example GitHub Actions

yaml

name: Validate FrameworX Configuration

on:
  pull_request:
    branches: [ main, develop ]

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    
    - name: Validate JSON Schema
      run: |
        for file in $(find . -name "*.json"); do
          python validate_schema.py $file
        done
    
    - name: Check Tag Naming Convention
      run: python check_naming.py ./UNS/UnsTags.json
    
    - name: Verify No Credentials
      run: |
        ! grep -r "password\|credential\|secret" --include="*.json"

Troubleshooting

In this section...