FrameworX 10.1 introduces comprehensive Git integration capabilities, enabling version control, collaboration, and DevOps workflows while maintaining the security and performance of a centralized database architecture. This hybrid approach allows teams to leverage modern development practices without compromising industrial-grade reliability.
When enabled, FrameworX monitors configuration changes and automatically exports modified objects to Git-compatible JSON files.
? Enable Automatic Export
Export Trigger: On Version Change
Export Delay: 5 seconds (batch rapid changes)
Target Directory: C:\Projects\MyScada\GitRepo
Export entire solution or specific modules on-demand:
solution-root/
??? Solution/
? ??? SolutionCategories.json
? ??? SolutionSettings.json
??? Displays/
? ??? Layouts/
? ? ??? MainPage.json
? ? ??? Overview.json
? ??? Images/
? ? ??? Logo.json
? ? ??? Logo.png
? ??? DisplaysLocalization.json
??? Scripts/
? ??? Tasks/
? ? ??? ServerStartup.json
? ??? Classes/
? ? ??? DataProcessor.json
? ??? ScriptsExpressions.json
??? UNS/
? ??? UnsTags.json
? ??? UserTypes/
? ??? CustomTemplate.json
??? Alarms/
? ??? AlarmsGlobalSettings.json
? ??? AlarmsItems.json
??? .gitignore
Every exported file follows a consistent structure:
{
"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
}
}
Objects with rich editors are exported as individual files:
Configuration tables are exported as single files with all rows:
Configure Git Repository
cd /path/to/solution
git init
git remote add origin https://github.com/company/scada-config.git
Initial Commit
git add .
git commit -m "Initial FrameworX configuration export"
git push -u origin main
Development Workflow
# Create feature branch
git checkout -b feature/new-alarm-logic
# Make changes in FrameworX
# Automatic export creates/updates files
# Review changes
git diff
# Commit and push
git add .
git commit -m "Add new alarm logic for Tank-101"
git push origin feature/new-alarm-logic
Code Review Process
FrameworX supports environment-specific configurations through placeholder substitution:
{
"DatabaseConnection": "${DB_CONNECTION}",
"EmailServer": "${SMTP_SERVER}",
"HistorianPath": "${HISTORIAN_PATH}"
}
Environment variables are resolved at runtime, allowing the same configuration to work across development, staging, and production.
? Export to Git:
? Keep in Database Only:
Recommended Git branching model:
main
??? develop
? ??? feature/new-screens
? ??? feature/alarm-updates
? ??? feature/script-optimization
??? hotfix/critical-alarm-fix
??? release/v2.1
Write clear, descriptive commit messages:
Good: "Add temperature monitoring for Reactor-3"
Good: "Fix alarm delay calculation in Tank-Level script"
Bad: "Updated stuff"
Bad: "Changes"
Export not triggering automatically
Large file sizes
Merge conflicts
Define which objects to export:
// ExportFilter.cs
public bool ShouldExport(ConfigObject obj)
{
// Skip temporary objects
if (obj.Name.StartsWith("_temp")) return false;
// Skip test configurations in production
if (Environment == "Production" &&
obj.Name.Contains("test")) return false;
return true;
}
Execute custom actions after export:
# post-export.bat
cd %EXPORT_DIR%
git add .
git commit -m "Auto-export: %DATE% %TIME%"
git push origin develop
FrameworX validates imported configurations:
// Export entire solution
FrameworX.Git.ExportSolution(targetPath);
// Export specific module
FrameworX.Git.ExportModule("Scripts", targetPath);
// Export current object
FrameworX.Git.ExportObject(currentObject, targetPath);
<GitExport>
<Enabled>true</Enabled>
<AutoExport>true</AutoExport>
<ExportPath>C:\GitRepo</ExportPath>
<ExportDelay>5000</ExportDelay>
<IncludeModules>
<Module>Scripts</Module>
<Module>Displays</Module>
<Module>Alarms</Module>
</IncludeModules>
</GitExport>
| Configuration Size | Export Time | File Count | Total Size |
|---|---|---|---|
| Small (< 100 objects) | < 1 sec | 50-100 | < 1 MB |
| Medium (1,000 objects) | 3-5 sec | 200-500 | 5-10 MB |
| Large (10,000 objects) | 15-20 sec | 1,000+ | 50-100 MB |
| Enterprise (50,000+) | 60-90 sec | 5,000+ | 500+ MB |
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"
Last Updated: December 2025 | FrameworX Version: 10.1