Versions Compared

Key

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

Solution Lifecycle (Reference): information on how FrameworX platform features support each phase of the solution lifecycle.

  • Solution Center
  • Designer
  • Runtime

DevOps & Version Control isn't one component, it a series of features in various module to enable that task.

On this page:

Table of Contents
maxLevel2
minLevel2
indent10px
excludeSteps
stylenone



Platform Components

The Solution Lifecycle uses these integrated FrameworX components:

ComponentPlatform FeaturesPrimary Use
Solution CenterSolution management, templates, licensingProject creation and management
DesignerConfiguration IDE, diagnostics, Track ChangesDevelopment and testing
RuntimeExecution profiles, Build & Publish, monitoringValidation and production
DevOps & Version ControlGit integration, change tracking, audit trailChange management and deployment

Project Planning with Four Pillars

Requirements Template by Pillar

Map requirements to FrameworX architecture:

PillarRequirements FocusPlatform Configuration
P1: UNS FoundationData points needed<br>Equipment hierarchy<br>Naming standardsTags to create<br>Templates (UDTs) to design<br>Asset tree structure
P2: Process ModulesField devices to connect<br>Alarm conditions<br>Historical data needsDevice channels & protocols<br>Alarm items & groups<br>Historian tables & retention
P3: Application ModulesBusiness logic required<br>Database integration<br>Reporting needsScript tasks & classes<br>Dataset connections<br>Report templates
P4: Operator UIUser roles & screens<br>Client deployment<br>Mobile accessDisplay pages & navigation<br>Security configuration<br>Client types

Stakeholder Mapping

StakeholderFrameworX InteractionAccess Level
OperatorsRuntime displays, alarm managementClient access
EngineersDesigner configuration, diagnosticsEngineering license
ManagersDashboards, reportsView-only access
IT SupportSolution Center, Runtime monitoringAdmin access

Testing with Platform Tools

UNS Integrity Verification

Verify foundation first:

  1. Designer Test Mode (F5)
    • Validate tag structure and values
    • Test templates and instances
    • Verify asset tree navigation
  2. Property Watch
    • Monitor real-time tag updates
    • Check quality and timestamps
    • Validate calculations
  3. Diagnostics Tools
    • Runtime → Diagnostics for data inspection
    • Cross-reference verification
    • Module status monitoring

Execution Profile Testing

Test across environments using built-in profiles:

ProfileUsePlatform Features
DevelopmentInitial testingLocal databases, full diagnostics, simulation
ValidationSystem testingTest servers, limited clients, performance monitoring
ProductionLive operationProduction databases, redundancy, optimized logging

Configure in Runtime → Execution Profiles


Deployment Using Platform Features

Build & Publish System

  1. Development Build
    • Runtime → Build & Publish
    • Create .dbsln for testing
    • Include debug information
  2. Production Publish
    • Create read-only .dbrun file
    • Version numbering
    • Release notes
  3. Deployment Package
    • Solution file
    • Execution profile
    • Client configurations

Backup & Recovery

Platform features for deployment safety:

  • Solution Backup: Before any deployment
  • Automatic Backups: Configurable schedule
  • Version History: Through Git integration
  • Rollback Capability: Previous .dbrun versions

Quality Gates

Platform Checkpoints

GatePlatform VerificationTool Location
Build SuccessSolution compiles without errorsRuntime → Build & Publish
No Unused ObjectsClean configurationTrack Changes → Unused Objects
References ValidAll cross-references verifiedTrack Changes → Cross-Reference
Test Mode PassRuns without errorsDesigner → Test Mode (F5)
Performance CheckMeets requirementsRuntime → System Monitor

Change Management

Platform Change Tracking

Change TypePlatform TrackingAccess Location
Configuration changesTrack Changes logTrack Changes → Recent Changes
User actionsAudit trailBuilt into all modules
Version historyGit exportSolution → Export (if enabled)
Build versionsBuild historyRuntime → Build & Publish

Recommended Workflow

  1. Enable Git Integration
    • Automatic JSON export
    • Version control ready
    • Diff-friendly format
  2. Use Track Changes
    • Monitor all modifications
    • Impact analysis before changes
    • Audit trail for compliance

Support & Maintenance

Platform Diagnostic Tools

Issue TypeFrameworX ToolLocation
Communication problemsModule InformationRuntime → Diagnostics
Performance issuesSystem MonitorRuntime → System Monitor
Configuration errorsOutput windowDesigner (bottom panel)
Tag issuesProperty WatchRuntime → Diagnostics
Historical data gapsHistorian statusRuntime → Module Information

Maintenance Features

  • Online Configuration: Changes without stopping runtime
  • Hot Updates: Apply modifications to running system
  • Remote Diagnostics: Connect Designer to remote runtime
  • Automatic Recovery: Self-healing connections

Best Practices Checklist

Leverage Platform Features

  •  Use Execution Profiles for environment management
  •  Enable Track Changes for audit trail
  •  Implement Git integration for version control
  •  Use Build & Publish for controlled deployments
  •  Monitor with built-in diagnostics

Avoid Common Pitfalls

  •  Skipping Test Mode validation
  •  Not using execution profiles
  •  Ignoring Track Changes warnings
  •  Deploying without Build & Publish
  •  Missing backup before deployment

See Also

Child Pages

Related Topics



In this section...

Page Tree
root@parent
spaces93DRAF