Comprehensive reference showing how FrameworX platform features support each phase of the solution lifecycle. This page connects project management concepts with specific platform tools and capabilities.
→ Concept | How-to Guide | Reference
Platform Components
The Solution Lifecycle leverages these integrated FrameworX components:
| Component | Platform Features | Primary Use |
|---|---|---|
| Solution Center | Solution management, templates, licensing | Project creation and management |
| Designer | Configuration IDE, diagnostics, Track Changes | Development and testing |
| Runtime | Execution profiles, Build & Publish, monitoring | Validation and production |
| DevOps & Version Control | Git integration, change tracking, audit trail | Change management and deployment |
→ Detailed documentation in child pages below
Project Planning with Four Pillars
Requirements Template by Pillar
Map your requirements directly to FrameworX architecture:
| Pillar | Requirements Focus | Platform Configuration |
|---|---|---|
| P1: UNS Foundation | Data points needed<br>Equipment hierarchy<br>Naming standards | Tags to create<br>Templates (UDTs) to design<br>Asset tree structure |
| P2: Process Modules | Field devices to connect<br>Alarm conditions<br>Historical data needs | Device channels & protocols<br>Alarm items & groups<br>Historian tables & retention |
| P3: Application Modules | Business logic required<br>Database integration<br>Reporting needs | Script tasks & classes<br>Dataset connections<br>Report templates |
| P4: Operator UI | User roles & screens<br>Client deployment<br>Mobile access | Display pages & navigation<br>Security configuration<br>Client types |
Stakeholder Mapping
| Stakeholder | FrameworX Interaction | Access Level |
|---|---|---|
| Operators | Runtime displays, alarm management | Client access |
| Engineers | Designer configuration, diagnostics | Engineering license |
| Managers | Dashboards, reports | View-only access |
| IT Support | Solution Center, Runtime monitoring | Admin access |
Testing with Platform Tools
UNS Integrity Verification
The Unified Namespace is the foundation - verify it first:
- Designer Test Mode (F5)
- Validate tag structure and values
- Test templates and instances
- Verify asset tree navigation
- Property Watch
- Monitor real-time tag updates
- Check quality and timestamps
- Validate calculations
- Diagnostics Tools
- Use Runtime → Diagnostics for data inspection
- Cross-reference verification
- Module status monitoring
→ See [Designer (Reference)] and [Runtime (Reference)] for tool details
Execution Profile Testing
Test your solution across environments using built-in profiles:
| Profile | Use | Platform Features |
|---|---|---|
| Development | Initial testing | Local databases, full diagnostics, simulation |
| Validation | System testing | Test servers, limited clients, performance monitoring |
| Production | Live operation | Production databases, redundancy, optimized logging |
→ Configure in Runtime → Execution Profiles
Deployment Using Platform Features
Build & Publish System
FrameworX provides built-in deployment tools:
- Development Build
- Runtime → Build & Publish
- Create .dbsln for testing
- Include debug information
- Production Publish
- Create read-only .dbrun file
- Version numbering
- Release notes
- 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
→ See [DevOps and Version Control (Reference)] for Git integration
Quality Gates
Platform Checkpoints
Use these FrameworX tools to verify quality:
| Gate | Platform Verification | Tool Location |
|---|---|---|
| Build Success | Solution compiles without errors | Runtime → Build & Publish |
| No Unused Objects | Clean configuration | Track Changes → Unused Objects |
| References Valid | All cross-references verified | Track Changes → Cross-Reference |
| Test Mode Pass | Runs without errors | Designer → Test Mode (F5) |
| Performance Check | Meets requirements | Runtime → System Monitor |
Change Management
Platform Change Tracking
FrameworX automatically tracks:
| Change Type | Platform Tracking | Access Location |
|---|---|---|
| Configuration changes | Track Changes log | Track Changes → Recent Changes |
| User actions | Audit trail | Built into all modules |
| Version history | Git export | Solution → Export (if enabled) |
| Build versions | Build history | Runtime → Build & Publish |
Recommended Workflow
- Enable Git Integration (recommended)
- Automatic JSON export
- Version control ready
- Diff-friendly format
- Use Track Changes
- Monitor all modifications
- Impact analysis before changes
- Audit trail for compliance
→ See [DevOps and Version Control (Reference)] for setup
Support & Maintenance
Platform Diagnostic Tools
| Issue Type | FrameworX Tool | Location |
|---|---|---|
| Communication problems | Module Information | Runtime → Diagnostics |
| Performance issues | System Monitor | Runtime → System Monitor |
| Configuration errors | Output window | Designer (bottom panel) |
| Tag issues | Property Watch | Runtime → Diagnostics |
| Historical data gaps | Historian status | Runtime → 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
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
- [Solution Center (Reference)] - Solution management interface
- [Designer (Reference)] - Development environment and tools
- [Runtime (Reference)] - Execution environment and diagnostics
- [DevOps and Version Control (Reference)] - Change tracking and Git integration
Related Topics
- [Solution Lifecycle (Concept)] - Understanding the three stages
- [Solution Lifecycle (How-to Guide)] - Step-by-step procedures
- [Four Pillars (Reference)] - Architecture framework
Comprehensive templates and reference materials for managing FrameworX solutions through development, validation, and production stages using platform-specific tools and features.
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|