Dev to Production Workflow

Overview

FrameworX 10.1 follows a modular, scalable architecture designed for industrial applications from small single-machine interfaces to enterprise-wide systems. Understanding the platform architecture helps you design robust solutions, optimize performance, and plan for growth. This guide explores the core components, data flow, and deployment patterns that make FrameworX a powerful industrial application platform.

FrameworX is  more than just software tool,

It's the enabling field-proven architecture and methodology to deploy applications managing critical assets, from large distributed systems to standalone edge apps. It unlocks the sophistication, performance and openness of latest technologies, yet keeping a simple configuration, and a clear cost with advantageous Total Cost of Ownership.

Reference Link: 
    Solutions Guidebook (examples of solution architecture in production)

Solution Development Workflow

...

(1) Define Your Data

...

...

...

...

...

...

...

...

...

...

...

...

Solution Deployment Workflow

Configuration Workflow

Runtime Configuration Workflow

Complete Solution Lifecycle

Image Removed

...

Stage 1: Initiate (Planning)

Project Definition - Scope Development

Define clear boundaries and objectives:

• Project Scope Document
  • Business Objectives
    • ROI Targets
    • Efficiency Goals
    • Compliance Requirements
  • Technical Requirements
    • I/O Count
    • User Count
    • Integration Points
    • Performance Targets
  • Constrains
    • Budget
    • Timeline
    • Resources
    • Technology
  • Success Criteria
    • Acceptance Tests
    • Performance Metrics
    • Deliverables

Stakeholder Analysis

Requirements Gathering

Functional Requirements Checklist

• Process control requirements
• Data acquisition needs
• Alarm management requirements
• Reporting specifications
• User interface requirements
• Integration requirements
• Security requirements
• Performance requirements

Data Collection Worksheet Example

...

IP Address: <protected from public documents>

Scan Rate: 1 second

Point Count: 250 

...

DataTypes: 

Holding Registers: 150
Coils (digital): 100 

Stage 2: Design (Architecture)

System Architecture Design

Architecture Decision Matrix

Network Architecture

Image Removed

Data Architecture

Tag Naming Convention

Standard: [Area]_[Equipment]_[Component]_[Signal]

Examples:
WTP_PUMP01_MOTOR_RUNNING
WTP_PUMP01_MOTOR_SPEED_SP
WTP_TANK01_LEVEL_PV
BLDG_HVAC_AHU01_TEMP_SP

??? WTP (Water Treatment Plant)
?   ??? PUMP01
?   ?   ??? MOTOR
?   ?   ?   ??? RUNNING
?   ?   ?   ??? SPEED_SP
?   ?   ?   ??? SPEED_PV
?   ?   ??? VALVE
?   ?       ??? OPEN_CMD
?   ?       ??? POSITION
?   ??? TANK01
?       ??? LEVEL_PV
?    

UDT Design - UNS Data Template 

UDT: Motor_VFD
Properties:
  - Name: String
  - Location: String
  - RatedHP: Float
Members:
  Commands:
    - Start_CMD: Boolean
    - Stop_CMD: Boolean
    - Speed_SP: Float (0-100%)
  Status:
    - Running: Boolean
    - Faulted: Boolean
    - Speed_PV: Float
    - Current: Float
    - Temperature: Float
  Alarms:
    - OverCurrent: Boolean
    - OverTemp: Boolean
    - CommLoss: Boolean
  Statistics:
    - RunHours: Double
    - StartCount: Integer
    - LastStartTime: DateTime

Display Architecture

Navigation Hierarchy

Main Menu
??? Overview
?   ??? Plant Overview
??? Areas
?   ??? Area 1
?   ?   ??? Process Overview
?   ?   ??? Equipment
?   ?   ??? Trends
?   ??? Area 2
?   ??? Area 3
??? Utilities
?   ??? Power Monitoring
?   ??? Compressed Air
?   ??? Steam System
??? Reports
?   ??? Production
?   ??? Quality
?   ??? Maintenance
??? Administration
    ??? Setpoints
    ??? Recipes
    ??? User Management

Stage 3: Build (Development)

Development Workflow

Sprint Planning (Example of a 2-Week Sprints)

Sprint 1: Foundation
??? Day 1-3: Create tag database
??? Day 4-6: Build UDTs
??? Day 7-9: Configure devices
??? Day 10: Testing & review

Sprint 2: Process Logic
??? Day 1-3: Alarm configuration
??? Day 4-6: Scripts development
??? Day 7-9: Historian setup
??? Day 10: Testing & review

Sprint 3: Visualization
??? Day 1-3: Template displays
??? Day 4-6: Process graphics
??? Day 7-9: Dashboards
??? Day 10: Testing & review

Sprint 4: Integration
??? Day 1-3: Database connections
??? Day 4-6: Reports
??? Day 7-9: External interfaces
??? Day 10: Testing & review

Configuration Management

Version Control Strategy

Repository Structure:
/FrameworX-Project
??? /Documentation
?   ??? Requirements.docx
?   ??? Design.docx
?   ??? UserManual.docx
??? /Solution
?   ??? MyProject.dbsln
?   ??? /Exports
?       ??? Tags_v1.0.xml
?       ??? Displays_v1.0.xml
??? /Scripts
?   ??? Calculations.cs
?   ??? Reports.sql
??? /Graphics
?   ??? P&ID.svg
?   ??? Logos.png
??? /Tests
    ??? UnitTests.cs
    ??? TestProcedures.xlsx

Change Management Process

Change Request ? Impact Analysis ? Approval ? Implementation ? Testing ? Deployment
       ?              ?               ?            ?              ?           ?
   Document       Assess Risk     Get Signoff   Make Change    Validate   Release

Testing Strategy

Test Levels

Test Documentation - Test Case Template

...

Test ID: TC 001

Feature: Pump Control

...

Preconditions:

• Pump in Auto mode
• Tank level at 50&

...

Steps:

1. Set Tank Setpoint to 75%
2. Verify pump starts
3. Monitor speed increases

...

Expected Result:

• Pump running indication ON
• Speed ramps to calculated data
• No alarms generated

...

Stage 4: Deploy (Production)

Deployment Planning

Pre-Deployment Checklist

• All tests passed
• Documentation complete
• Backup created
• Licenses verified
• Training completed
• Support plan ready
• Rollback plan prepared
• Maintenance window scheduled

Deployment Sequence

1. Pre-Deployment (T-1 Week)
   * Final testing in staging
   * User training
   * Documentation review

2. Deployment Day (T-0)
   * 00:00 - System backup
   * 01:00 - Install software
   * 02:00 - Import configuration
   * 03:00 - Configure devices
   * 04:00 - Test communications
   * 05:00 - Verify operations
   * 06:00 - Go live

3. Post-Deployment (T+1 Day)
   * Monitor performance
   * Address issues
   * Gather feedback

Commissioning Process

System Commissioning Steps

1. Hardware Ready
2. Software & License Installation
3. Configuration load
4. I/O Checkout 
5. Device Testing
6. Function Testing   ==> Loop 4, 5, 6 as needed
7. Performance Testing
8. Customer Acceptance
9. Production Release

Commissioning Documentation

Stage 5: Support (Maintenance)

Support Structure

Support Tiers

Tier 1: Operations
* Basic troubleshooting
* Restart procedures
* Known issue resolution

Tier 2: Maintenance
* Configuration changes
* Device troubleshooting
* Performance tuning

Tier 3: Engineering
* Complex problems
* System modifications
* Root cause analysis

Tier 4: Vendor
* Software bugs
* License issues
* Advanced support

Maintenance Activities

Preventive Maintenance Schedule

Continuous Improvement

Performance Monitoring

KPI Dashboard Example

  System Uptime:       99.8%         
  Avg Response Time:   187ms         
  Alarm Rate:          12/hour       
  Data Loss:           0.00%         
  User Satisfaction:   4.5/5         

Improvement Opportunities:
- Reduce alarm rate (target: <10/hr)
- Optimize response time (<100ms)
- Increase automation (reduce manual tasks)

Tools and Templates

Project Management Tools

FrameworX Native Tools

...

Third-party recommend tools

...

Standard Templates

Available Templates

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

Quality Gates

Gate Reviews

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

Best Practices

Do's and Don'ts

DO:

• ? Follow naming conventions consistently
• ? Document all decisions and changes
• ? Test thoroughly at each stage
• ? Include operators in design reviews
• ? Plan for 20-30% growth
• ? Use version control
• ? Create reusable components

DON'T:

• ? Skip testing to save time
• ? Ignore user feedback
• ? Hardcode values
• ? Forget security considerations
• ? Deploy without backups
• ? Assume requirements won't change
• ? Neglect documentation

Risk Management

Workflow Optimization

Automation Opportunities

Manual Tasks → Automated Solutions
?????????????????????????????????
Tag Creation → Excel Import
Alarm Config → Template Application
Report Gen → Scheduled Tasks
Testing → Automated Scripts
Deployment → Scripted Installation
Backup → Automated Schedule

Collaboration Tips

Key Concepts

Planning and Design

Before you start developing a project, take time to plan and design the system. This includes defining the scope of the project, creating a functional specification, and determining the requirements for the user interface, data collection, and alarm management.

Modularization

Modularization is an important best practice in FactoryStudio. It involves breaking down the project into smaller, more manageable modules that can be developed and tested independently. This approach makes it easier to debug and maintain the project, as well as reuse modules across different projects.

Version Control

Using version control software is essential when working on projects. This allows you to track changes, revert to previous versions, and collaborate with other team members more effectively. Git is a popular version control system that integrates well with FactoryStudio.

Documentation

Creating documentation for your projects is crucial for ensuring that other team members can understand and maintain the project over time. Make sure to document the project structure, module dependencies, data sources, and other important aspects of the project.

Testing and Debugging

Testing and debugging are essential steps in the development process. Make sure to thoroughly test each module and the system as a whole before deploying it. Debugging tools such as breakpoints, watches, and log files can help you identify and fix issues quickly.

Security

Security is a critical consideration when building automation and SCADA systems. Make sure to follow best practices for network security, password management, user access control, and data encryption. FactoryStudio includes built-in security features such as user authentication and role-based access control.

Troubleshooting

Ideally, you can troubleshoot problems even before they happen in the field. Always review the troubleshooting topics on each module to ensure your solution is not at risk of being affected by the issues described in that item.

Performance Optimization

Optimizing the performance of your projects can help ensure that they run smoothly and efficiently. Consider using techniques such as caching, indexing, and data compression to improve performance. Also, make sure to monitor system performance regularly to identify and address any issues.

Next Steps

After Understanding Workflow

1. Download Templates
   • Project Templates
   • Documentation Standards
2. Review Examples
   • Solution Examples
   • Case Studies
3. Get Training
   • Project Management
   • Best Practices

Appendix

Pillar 1: Unified Namespace (Foundation)

...

Purpose

The Unified Namespace (UNS) is your solution's data foundation - a single source of truth for all real-time and configuration data.

What to Build

1. Tag Structure
   • Define naming conventions
   • Create tag hierarchy
   • Set data types and ranges
   • Configure engineering units
2. Asset Tree
   • Mirror physical/logical structure
   • Organize by area/process/equipment
   • Create navigable hierarchy
3. User Data Types (UDTs)
   • Create equipment templates
   • Define standard objects
   • Build reusable components

Purpose

The Unified Namespace (UNS) is your solution's data foundation - a single source of truth for all real-time and configuration data.

What to Build

1. Tag Structure
   • Define naming conventions
   • Create tag hierarchy
   • Set data types and ranges
   • Configure engineering units
2. Asset Tree
   • Mirror physical/logical structure
   • Organize by area/process/equipment
   • Create navigable hierarchy
3. User Data Types (UDTs)
   • Create equipment templates
   • Define standard objects
   • Build reusable components

Implementation Steps

Step 1: Plan Your Namespace
??? Define naming standards (Area_Equipment_Signal)
??? Document tag requirements
??? Plan for 20% growth

Step 2: Create Base Tags
??? System tags (heartbeat, status)
??? Communication tags
??? Calculation tags

Step 3: Build UDTs
??? Motor (Running, Speed, Current, Hours)
??? Valve (Open, Close, Position, Fault)
??? Tank (Level, Temperature, Pressure)
??? PID (SP, PV, CV, Mode)

Step 4: Organize Assets
??? Plant
   ??? Area1
      ??? Line1
      ??? Line2
          ??? Area2

Best Practices

• Naming Convention Example: WTP_PUMP01_RUNNING
  • WTP = Water Treatment Plant
  • PUMP01 = Equipment ID
  • RUNNING = Signal name
• Use consistent abbreviations
• Plan for expansion (reserve number ranges)
• Document everything

Detailed UNS Guide →

Pillar 2: Process Modules (Industrial Operations)

...

Purpose

Process modules connect your solution to the physical world, connecting & collecting data from field devices and managing industrial operations.

What to Build

1. Device Communications
   • Configure channels and protocols
   • Setup nodes and devices,
   • Map points to tags, or use direct binding
2. Alarm Management
   • Define alarm areas and groups
   • Configure conditions and limits
   • Setup notifications
3. Historian (Time-series Data Collection)
   • Configure historian storage
   • Set collection rates
   • Define retention policies

Implementation Steps

Step 1: Setup Devices
??? Create Channel (Protocol, Port, Timeout)
??? Add Nodes (IP, Device ID)
??? Map Points to Tags

Step 2: Configure Alarms
??? Create Areas (Plant sections)
??? Define Groups (Equipment types)
??? Set Conditions (Limits, Deviation)
??? Configure Notifications

Step 3: Enable Historian
??? Select Storage Location
??? Create Tables
??? Configure Tag Collection
??? Set Compression

Connection Architecture

Field Level        Communication        UNS & Operation
???????????         ???????????          ???????????
?  PLCs   ?         ? Drivers ?          ?  Tags   ?
???????????         ???????????          ???????????
?  RTUs   ? ??????? ?Protocols? ???????  ? Alarms  ?
???????????         ???????????          ???????????
? Sensors ?         ?Providers?          ?Historian?
???????????         ???????????          ???????????

Best Practices

• Start with slow poll rates, optimize later
• Group similar devices on same channel
• Use event-driven updates when available
• Test each connection thoroughly
• Document IP addresses and settings

Detailed Process Modules Guide →

Pillar 3: Application Modules (Store & Process)

...

Purpose

Application modules add business logic, data processing, and integration capabilities to transform raw data into actionable information.

What to Build

1. Database Integration
   • Connect to SQL databases
   • Create queries and views
   • Setup synchronization
2. Business Logic
   • Write calculation scripts
   • Implement control logic
   • Create data validation
3. Reporting
   • Design report templates
   • Configure schedules
   • Setup distribution

Implementation Steps

Step 1: Database Setup
??? Configure Connections
??? Create Tables/Views
??? Build Queries
??? Test Transactions

Step 2: Script Development
??? Calculation Tasks
??? Control Logic
??? Data Processing
??? Error Handling

Step 3: Report Creation
??? Design Templates
??? Configure Data Sources
??? Set Schedules
??? Test Distribution

Data Flow

Raw Data → Scripts → Calculations → Database → Reports
   ↓          ↓           ↓            ↓          ↓
  Tags     Process    Transform      Store    Distribute

Common Implementations

Detailed Application Modules Guide →

Pillar 4: User Interface (Analyze & Visualize)

User Interface (Displays) Recap

Purpose

The UI layer presents information to operators, managers, and stakeholders through interactive displays and dashboards.

What to Build

1. Operational Displays
   • Process graphics
   • Control panels
   • Navigation structure
2. Dashboards
   • KPI visualization
   • Analytics
   • Mobile views
3. Client Deployment
   • Rich clients
   • Web access
   • Mobile UI

Implementation Steps

Step 1: Display Architecture
??? Create Navigation Structure
??? Design Template Displays
??? Build Process Graphics
??? Implement Standards

Step 2: Display Development
??? Overview Displays
??? Detail Displays
??? Control Faceplates
??? Alarm Displays

Step 3: Dashboard Creation
??? KPI Dashboards
??? Analytics Views
??? Mobile Layouts
??? Executive Reports

Step 1: Display Architecture
??? Create Navigation Structure
??? Design Template Displays
??? Build Process Graphics
??? Implement Standards

Step 2: Display Development
??? Overview Displays
??? Detail Displays
??? Control Faceplates
??? Alarm Displays

Step 3: Dashboard Creation
??? KPI Dashboards
??? Analytics Views
??? Mobile Layouts
??? Executive Reports

Display Hierarchy

Plant Overview
    ↓
Area Overview
    ↓
Process Display
    ↓
Equipment Detail
    ↓
Faceplate Popup

Design Principles

• Follow ISA-101 HMI standards
• Use consistent color philosophy
• Implement situational awareness
• Minimize animation
• Optimize for target resolution

Detailed User Interface Guide →

From Development To Production 

Reference:  

Deployment Process Summary

PLAN                          BUILD                         DEPLOY
?????????????????            ?????????????????            ?????????????????
1. Requirements     ????     5. Implementation    ????    9. Installation
2. Architecture              6. Integration                10. Commissioning
3. Standards                 7. Testing                    11. Training
4. Design                    8. Validation                 12. Support

Phase 1: Planning (Week 1)

Requirements Gathering

• Define project scope
• Identify data sources
• List user requirements
• Document interfaces
• Establish success criteria

Architecture Design

• Size system (tags, users, data)
• Design network topology
• Plan redundancy
• Define security zones
• Select hardware

Phase 2: Development

Step 1: Foundation (UNS)

• Create Local Tags structure
• Build UDTs 
• Setup asset tree
• External Governance: Extend UNS with Dynamic Binding.

Step 2: Integration

• Configure devices
• Setup alarms
• Enable historian
• Test communications

Step 3: Logic

• Develop scripts
• Create queries
• Build reports
• Test calculations

Step 4: Visualization

• Design displays
• Create navigation
• Build dashboards
• Test clients

Step 5: Integration Testing

• End-to-end testing
• Performance testing
• Security testing
• User acceptance

Phase 3: Deployment

Go-Live Preparation

• Production installation
• Data migration
• User training
• Documentation
• Support handover

Next → Standards & Best  References

Dev to Production Workflow

AI Assistant Data

<details> <summary>Structured Information for AI Tools</summary>

json

{
  "page": "Solution Workflow",
  "type": "Process Guide",
  "purpose": "Define systematic approach to solution development",
  "stages": [
    {
      "name": "Initiate",
      "duration": "1-2 weeks",
      "deliverables": ["Requirements", "Scope", "Project Charter"]
    },
    {
      "name": "Design",
      "duration": "2-4 weeks",
      "deliverables": ["Architecture", "Standards", "Specifications"]
    },
    {
      "name": "Build",
      "duration": "4-12 weeks",
      "deliverables": ["Configuration", "Code", "Documentation"]
    },
    {
      "name": "Deploy",
      "duration": "1-2 weeks",
      "deliverables": ["Installation", "Training", "Go-Live"]
    },
    {
      "name": "Support",
      "duration": "Ongoing",
      "deliverables": ["Maintenance", "Updates", "Improvements"]
    }
  ],
  "keyActivities": [
    "Requirements gathering",
    "Architecture design",
    "Development sprints",
    "Testing phases",
    "Deployment planning",
    "Support structure"
  ],
  "tools": [
    "Project management",
    "Version control",
    "Testing frameworks",
    "Documentation systems"
  ]
}

...