Solution Lifecycle Reference

Information on how platform features support each phase of the solution lifecycle.

Platform | Installation | Solution | Modules | Controls | Code | Troubleshooting

Development Workflow

Solution Development Stages

Two Audiences

The Solution Lifecycle has two parallel reference paths.

Engineering teams managing solution change use the DevOps and Version Control Reference. It covers Track Changes, JSON / Git export, and impact analysis — author-time concerns.

IT teams deploying and operating the product use the FrameworX Enterprise IT Readiness Reference. It covers install, identity, audit, and monitoring — operations-time concerns.

The two paths overlap on audit and compliance and cross-link there. Most readers come in via one path and visit the other only at the audit boundary.

Platform UI Components

Three Essential Workspaces

Platform Components Key Features

Platform Components Primary Use

The Solution Lifecycle uses these integrated FrameworX components:

Quick Reference Tables

Development Time Estimates

(*) About the Development Time estimates

Best Practices Checklist

Project Planning with Four Pillars

Requirements Template by Pillar

Map requirements to FrameworX architecture:

Stakeholder Mapping

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:

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  Checkpoints

Change Management

Platform Change Tracking

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

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
• Deploying without Build & Publish
• Ignoring Track Changes warnings
• Missing backup before deployment

Tools and Templates

FrameworX Native Tools

Recommended Third-Party Tools

Standard Document Templates

Companion documents to maintain alongside the solution:

• Project Charter
• Requirements Specification
• Design Document
• Test Plan
• Deployment Guide
• Training Materials
• Support Procedures
• Change Request Form

Quality Gate Reviews

Three project-management gates between development and production release:

Gate 1: Design Review
  - Requirements complete
  - Architecture approved
  - Risks identified
  - Resources available
        |
        v
Gate 2: Development Review
  - Code complete
  - Testing done
  - Documentation ready
  - Performance met
        |
        v
Gate 3: Deployment Review
  - Customer approval
  - Training complete
  - Support ready
  - Rollback plan
        |
        v
Production Release

Risk Management

Common project risks and standard mitigations:

Workflow Optimization

Automation Opportunities

Collaboration Patterns

Solution Lifecycle Links

Explanation - to understand concepts

→ Modules / Solution Lifecycle

Tutorials - to learn by doing

→ Tutorials /  Solution Lifecycle Tutorials

How-to Guides - to accomplish specific tasks

→ How-to Guides / Solution Lifecycle How-to Guide

Reference - technical details

→ Technical Reference /  Solution Lifecycle / Reference

In this section...