Versions Compared

Key

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

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.


...

Solution Development Workflow

Specification to Solution Flow 

Configuration Workflow

(1) Define Your Data

(2) Setup Industrial Process Modules
Image Removed

Image AddedUnified Namespace (Local UNS)

Image Removed

Image AddedSQL Database Connections and Queries

Image Removed

Image AddedDataExplorer

Image Removed

Image AddedScripts and Business Logic

Image Removed

Image AddedExtended UNS using Direct Binding

Image Removed

Image AddedReports, data pub (PDF, CSV, HTML, XML & JSON



(3)  Setup Application Modules (4) User Interface Design
Image Removed

Image AddedDevices, Field Connections

Image Removed

Image AddedSymbol Library extensions

Image Removed

Image AddedAlarms, Events, and Audit-trail

Image Removed

Image AddedUnified Designer (Canvas & Responsive Dashboard)

Image Removed

Image AddedHistorian, time-series data

Image Removed

Image AddedLayouts, Desktop (.NET), Web &r Mobile (WebAssembly)


...

Solution Deployment Workflow

Development to Production Flow

...

Image Added

Tools  Interaction


Image AddedImage Removed

...

Complete Solution Lifecycle

Image RemovedImage Added



...

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

StakeholderRoleRequirementsConcerns
OperationsEnd UsersIntuitive interface, reliable operationEase of use, training
MaintenanceSupport StaffDiagnostic tools, documentationTroubleshooting, updates
ManagementDecision MakersReports, KPIs, ROICost, timeline, benefits
ITInfrastructureSecurity, integration, standardsCompliance, compatibility
EngineeringTechnical DesignFlexibility, features, performanceTechnical debt, scalability

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

Source: PLC-01
Protocol: Modbus TCP

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

ComponentOption 1Option 2DecisionRationale
DeploymentStandaloneDistributedDistributedMultiple sites
DatabaseSQLiteSQL ServerSQL ServerScale requirements
RedundancyNoneHot-StandbyHot-StandbyCritical process
ClientsRich onlyRich + WebRich + WebRemote access
HistorianLocalEnterpriseEnterpriseCorporate reporting

Network Architecture

Image RemovedImage Added



Data Architecture

Tag Naming Convention

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

...

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

UDT Design - UNS Data Template 

Code Block
languageyml
titleUDT: MOTOR_VF0
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

Code Block
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)

Code Block
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

Code Block
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

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


Testing Strategy

Test Levels

LevelScopeResponsibilityTools
Unit TestingIndividual componentsDeveloperDesigner test mode
Integration TestingModule interactionsDeveloperRuntime test
System TestingComplete solutionQA TeamTest scripts
Acceptance TestingBusiness requirementsCustomerTest procedures

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
Actual Result:


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

Code Block
titleDeployment 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


Code Block
titleSystem Comissoning Step
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

DocumentPurposeResponsibility
I/O ListVerify all pointsControls Engineer
Loop SheetsTest each control loopTechnician
Alarm ListVerify alarm functionsOperations
Interlock MatrixTest safety interlocksSafety Engineer
Performance LogRecord system metricsSystem Integrator

...

Stage 5: Support (Maintenance)

Support Structure

Support Tiers

Code Block
titleSupport Ties
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

FrequencyTasksResponsibility
DailyCheck system status, Review alarms, Monitor performanceOperations
WeeklyBackup solution, Review logs, Check disk spaceMaintenance
MonthlyArchive data, Update documentation, Performance analysisEngineering
QuarterlySecurity review, Disaster recovery test, Training updateManagement
AnnuallyLicense renewal, Major updates, System auditAll teams

Continuous Improvement

Performance Monitoring

Code Block
titleKPI Dashboard Example
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

ToolPurposeDescription
Track Cross-ReferenceGovernancemonitor governance of all places a object is used.
Track RecentChangesVersion Controllight, built-in, record of latest used phases
Track  Unused objectsOptimizationIdentify objects potentially not in use
Track VersionControlVersion ControlKeep automated VersionID to all modules, tables and objects. Global VersionID for entire solution. 
Build, backup flagBackup/Restore pointCrete a backup copy of product current stage
Publish Lock production versionFDA compliance, lock solution file version

Third-party recommend tools

ToolPurposeComments
JIRA//Azure DevOpsTask trackingcritical for maintenance  and product phases
Git/SVNVersion controlAdd comparing version, in top of built-in FrameworX TrackChanges tools
ConfluenceDocument managementAll phases
Teams/SlackCommunicationAll phases


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

Code Block
titleGate Review
Gate 1: Design Review
*? Requirements complete?
*? Architecture approved?
*? Risks identified?
*? Resources available?
         ?
      *Pass*
    * Pass     ?
Gate 2: Development Review
*? Code complete?
*? Testing done?
*? Documentation ready?
*? Performance met?
    *
    * Pass?
Gate  3: Deployment Review
* Customer approval?
* *Pass*
         ?
Gate 3: Deployment Review
? Customer approval?
? Training complete?
*? Support ready?
*? Rollback plan?
         ?
      *Pass*
     *    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

RiskProbabilityImpactMitigation
Scope CreepHighHighClear change control process
Integration IssuesMediumHighEarly testing, vendor support
Performance ProblemsMediumMediumLoad testing, optimization
User ResistanceMediumMediumTraining, involvement, support
Hardware DelaysLowHighEarly ordering, alternatives

...

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

TeamBest Practices
Cross-FunctionalRegular sync meetings, shared workspace
Remote TeamsVideo calls, screen sharing, cloud tools
Customer InteractionDemos, prototypes, feedback sessions
Vendor CoordinationClear specifications, regular updates

...

Next Steps

After Understanding Workflow

  1. Download Templates
  2. Review Examples
  3. Get Training

...

AI Assistant Data

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

...