Page History
Configuration Reference
| Children Display | ||||||
|---|---|---|---|---|---|---|
|
Overview
Platform Modules (Reference): This reference provides detailed information about all configuration settings available in FrameworX
...
.
...
Settings are organized by module and scope, with descriptions of each parameter, valid ranges, and impacts on system behavior.
...
On this page:
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Core Modules
Data Management:
...
- Tags (UNS)
...
- - Unified Namespace for real-time data management
- Devices - Communication with field devices and PLCs
- Historian - Time-series data storage and retrieval
- Datasets - SQL database synchronization and queries
Process Control:
- Alarms - Condition monitoring and notification management
- Scripts - Data processing and workflow automation
- Reports - Document generation (PDF/CSV) and data exchange (JSON/XML)
User Interface:
- Displays - Operator visualization and control interfaces
- Security - Access control and user authorization
Module Lifecycle
The module lifecycle follows these states:
- Initialized - Module loaded, configuration read
- Starting - Resources allocated, connections established
- Running - Active operation, processing data
- Stopping - Graceful shutdown initiated
- Stopped - Resources released, module inactive
Module Communication
All modules communicate through the central TServer process:
- Tag Database acts as the central data hub
- Event System manages inter-module notifications
- Message Queue handles asynchronous operations
- Shared Memory enables high-speed data exchange
Data Flow Patterns
Common Configuration Patterns
Pattern
Module Execution
Module Lifecycle
Module Communication
Modules Hierarchy
DataFlow Examples
...
1: PLC to Display
- PLC → Device Driver
...
- → Tag Database → Display Client
...
Pattern 2:
...
Direct Device Binding
...
- PLC
...
- Address → Dynamic TagProvider
...
- → Display (bypasses Tag Database)
...
Pattern 3:
...
Calculated Values
- Source Tags → Script
...
- Engine → Result Tag → Dataset
...
- → SQL
...
- Database
...
Pattern 4:
...
Operator Commands
- Display
...
- Button
...
- → Tag Write
...
- → Device Driver → PLC
...
- Parallel Path: Tag Write → Audit Log (when enabled)
Solution Settings
General Solution Properties
Solution Information
Configuration location: Solution Center → Properties → General
| Property | Description | Default | Valid Range |
|---|---|---|---|
| Solution Name | Unique solution identifier | NewSolution | 1-128 characters |
| Version | Solution version number | 1.0.0.0 | X.X.X.X format |
| Description | Solution documentation | Empty | 0-1000 characters |
| Author | Solution creator | Current user | Text string |
| Company | Organization name | Empty | Text string |
| Created | Creation timestamp | Auto-generated | Read-only |
| Modified | Last modification | Auto-updated | Read-only |
| GUID | Unique identifier | Auto-generated | Read-only |
Solution Behavior
Configuration location: Solution Center → Properties → Behavior
| Property | Description | Default | Options |
|---|---|---|---|
| Startup Mode | How solution starts | Manual | Manual, Automatic, Delayed |
| Startup Delay | Seconds to wait | 0 | 0-300 seconds |
| Shutdown Timeout | Grace period for shutdown | 30 | 10-120 seconds |
| Auto-Save | Enable periodic saves | Enabled | Enabled, Disabled |
| Auto-Save Interval | Minutes between saves | 10 | 1-60 minutes |
| Backup on Open | Create backup when opening | Enabled | Enabled, Disabled |
| Compression | Compress solution files | Enabled | Enabled, Disabled |
Runtime Configuration
Memory Settings
Configuration location: Designer → Edit → Settings → Runtime → Memory
| Property | Description | Default | Recommended |
|---|---|---|---|
| Initial Heap | Starting memory allocation | 256 MB | 512 MB - 2 GB |
| Maximum Heap | Maximum memory limit | 2 GB | 4 GB - 16 GB |
| Tag Cache Size | In-memory tag storage | Auto | 100 MB per 10K tags |
| String Pool | String optimization cache | 64 MB | 64 MB - 256 MB |
| Buffer Pool | Communication buffers | 128 MB | 128 MB - 512 MB |
| GC Mode | Garbage collection mode | Workstation | Server for >50K tags |
Thread Pool Settings
Configuration location: Designer → Edit → Settings → Runtime → Threading
| Property | Description | Default | Range |
|---|---|---|---|
| Min Worker Threads | Minimum thread pool | 4 | 2-32 |
| Max Worker Threads | Maximum thread pool | 25 | 25-500 |
| Min IO Threads | Minimum I/O threads | 4 | 2-32 |
| Max IO Threads | Maximum I/O threads | 25 | 25-500 |
| Queue Size | Task queue limit | 1000 | 100-10000 |
| Thread Priority | Execution priority | Normal | Low, Normal, High |
Communication Settings
Configuration location: Designer → Edit → Settings → Runtime → Communication
| Property | Description | Default | Options/Range |
|---|---|---|---|
| Server Port | Main TCP port | 9000 | 1024-65535 |
| HTTP Port | Web server port | 80 | 80, 8080, custom |
| HTTPS Port | Secure web port | 443 | 443, 8443, custom |
| Max Connections | Client limit | 100 | 10-1000 |
| Timeout | Connection timeout | 30 sec | 10-300 seconds |
| Keep Alive | TCP keep-alive | Enabled | Enabled, Disabled |
| Compression | Data compression | Auto | None, Auto, Force |
Module Properties
Tags Module Configuration
Tag Processor Settings
Configuration location: Designer → Unified Namespace → Settings
| Property | Description | Default | Impact |
|---|---|---|---|
| Update Rate | Tag scan rate | 100 ms | Lower = more CPU |
| Event Queue | Event buffer size | 10000 | Memory usage |
| Deadband Mode | Change detection | Absolute | Absolute, Percent |
| Quality Propagation | Quality inheritance | Enabled | Data reliability |
| Timestamp Source | Time source | System | System, Device, GPS |
| Retain Mode | Persistence type | Changed | None, Changed, All |
Tag Options
Configuration location: Per-tag properties
| Property | Type | Default | Description |
|---|---|---|---|
| Deadband | Float | 0.0 | Minimum change to trigger update |
| Scan Rate | Integer | 1000 ms | Individual tag update rate |
| History | Boolean | False | Enable historian logging |
| Retentive | Boolean | False | Persist value through restart |
| Security | String | None | Security zone assignment |
| Scaling | Boolean | False | Enable engineering units |
Devices Module Configuration
Channel Properties
Configuration location: Designer → Devices → Channel Properties
| Property | Description | Default | Valid Range |
|---|---|---|---|
| Protocol | Communication protocol | Modbus TCP | Driver-specific |
| Connection | Network or serial | Ethernet | Ethernet, Serial |
| Scan Rate | Polling interval | 1000 ms | 10-60000 ms |
| Timeout | Response timeout | 3000 ms | 100-30000 ms |
| Retries | Retry attempts | 3 | 0-10 |
| Inter-Request | Delay between requests | 0 ms | 0-5000 ms |
| Priority | Execution priority | Normal | Low, Normal, High |
Node Properties
Configuration location: Designer → Devices → Node Properties
| Property | Description | Default | Type |
|---|---|---|---|
| IP Address | Device network address | 192.168.1.1 | IPv4/IPv6 |
| Port | TCP/UDP port | Protocol default | 1-65535 |
| Unit ID | Device address | 1 | 0-255 |
| Byte Order | Data encoding | Big Endian | Big/Little |
| Block Size | Max request size | 125 | 1-2000 |
| Use Blocks | Optimize reads | Enabled | Boolean |
Alarms Module Configuration
Global Alarm Settings
Configuration location: Designer → Alarms → Settings
| Property | Description | Default | Options |
|---|---|---|---|
| Enable Alarms | Master enable | Enabled | Enabled, Disabled |
| History Size | Alarm history records | 10000 | 1000-100000 |
| Shelve Timeout | Default shelve duration | 8 hours | 1-24 hours |
| Ack Required | Force acknowledgment | Enabled | Enabled, Disabled |
| Sound Enable | Audio notifications | Enabled | Enabled, Disabled |
| Flash Rate | Visual alarm rate | 1 Hz | 0.5-5 Hz |
Alarm Item Properties
Configuration location: Per-alarm configuration
| Property | Type | Default | Description |
|---|---|---|---|
| Priority | Integer | 500 | 1 (Critical) - 999 (Low) |
| Delay On | Integer | 0 sec | Activation delay |
| Delay Off | Integer | 0 sec | Clear delay |
| Deadband | Float | 1.0 | Hysteresis value |
| Auto Ack | Boolean | False | Auto-acknowledge when clear |
| Boolean | False | Send email notification |
Historian Module Configuration
Storage Settings
Configuration location: Designer → Historian → Settings
| Property | Description | Default | Recommended |
|---|---|---|---|
| Storage Type | Database type | SQLite | SQL Server for >10K tags |
| Buffer Size | Memory buffer | 10000 | 10000-100000 records |
| Flush Interval | Write frequency | 1000 ms | 500-5000 ms |
| Compression | Data compression | Enabled | Enabled for efficiency |
| Archive Days | Days before archive | 90 | 30-365 days |
| Purge Days | Days before deletion | 365 | 90-unlimited |
Collection Properties
Configuration location: Designer → Historian → Collection
| Property | Type | Default | Range |
|---|---|---|---|
| Collection Rate | Integer | 1000 ms | 100-60000 ms |
| Deadband Type | Enum | Absolute | Absolute, Percent |
| Deadband Value | Float | 1.0 | 0.0-100.0 |
| Quality Filter | Enum | Good | Good, All, Custom |
| Max Rate | Integer | 0 | 0 (unlimited) - 60000 ms |
Scripts Module Configuration
Script Engine Settings
Configuration location: Designer → Scripts → Settings
| Property | Description | Default | Options |
|---|---|---|---|
| Enable Scripts | Master enable | Enabled | Enabled, Disabled |
| Debug Mode | Enable debugging | Disabled | Enabled, Disabled |
| Timeout | Execution timeout | 30 sec | 1-300 seconds |
| Memory Limit | Per-script memory | 100 MB | 10-1000 MB |
| Thread Pool | Script threads | 10 | 1-50 |
| Compile Mode | Compilation timing | Startup | Startup, On-Demand |
System Parameters
Security Configuration
Authentication Settings
Configuration location: Designer → Security → Authentication
| Parameter | Description | Default | Options |
|---|---|---|---|
| Auth Mode | Authentication type | Windows | Windows, Forms, Mixed |
| Session Timeout | Inactivity logout | 20 min | 1-1440 minutes |
| Max Attempts | Login attempts | 3 | 1-10 |
| Lockout Duration | Account lockout | 30 min | 1-1440 minutes |
| Password Policy | Complexity rules | Medium | None, Low, Medium, High |
| Two-Factor | 2FA requirement | Disabled | Disabled, Optional, Required |
Authorization Levels
Configuration location: Designer → Security → Roles
| Level | Value | Permissions | Typical Use |
|---|---|---|---|
| Administrator | 0 | Full system access | System configuration |
| Engineer | 100 | Design and configure | Solution development |
| Supervisor | 200 | Operational control | Production management |
| Operator | 300 | Basic operation | Daily operations |
| Guest | 999 | View only | Read-only access |
Performance Parameters
Database Optimization
Configuration location: Solution database settings
| Parameter | Description | Default | Performance Impact |
|---|---|---|---|
| Connection Pool | Pool size | 10 | More = better concurrency |
| Command Timeout | Query timeout | 30 sec | Longer for complex queries |
| Batch Size | Bulk operations | 1000 | Larger = fewer round trips |
| Index Mode | Index strategy | Auto | Manual for optimization |
| Statistics | Update frequency | Daily | More frequent = better plans |
Network Optimization
Configuration location: System network settings
| Parameter | Description | Default | Recommendation |
|---|---|---|---|
| TCP NoDelay | Nagle algorithm | False | True for real-time |
| Send Buffer | Socket buffer | 8 KB | 32 KB for high throughput |
| Receive Buffer | Socket buffer | 8 KB | 32 KB for high throughput |
| Max Frame Size | Packet size | 1500 | Jumbo frames if supported |
| Connection Limit | Per-IP limit | 10 | Increase for terminals |
Advanced Options
Diagnostic Settings
Logging Configuration
Configuration file: FrameworX.log.config
xml
<LogSettings>
<LogLevel>Information</LogLevel> <!-- Trace, Debug, Information, Warning, Error -->
<MaxFileSize>10MB</MaxFileSize> <!-- 1MB - 1GB -->
<MaxFiles>10</MaxFiles> <!-- 1 - 100 -->
<LogPath>Logs</LogPath> <!-- Relative or absolute -->
<Components>
<Runtime>Enabled</Runtime>
<Devices>Enabled</Devices>
<Scripts>Warning</Scripts>
<Database>Error</Database>
</Components>
</LogSettings>Trace Settings
Configuration location: Designer → Tools → Diagnostics
| Trace Type | Default | Purpose | Performance Impact |
|---|---|---|---|
| Runtime | Disabled | Execution flow | High |
| Communication | Disabled | Protocol messages | Medium |
| Database | Disabled | SQL operations | Medium |
| Security | Enabled | Access attempts | Low |
| Performance | Disabled | Timing analysis | High |
Redundancy Configuration
Hot-Standby Settings
Configuration location: Designer → Edit → Settings → Redundancy
| Property | Description | Default | Critical |
|---|---|---|---|
| Role | Server role | Standalone | Primary, Backup, Standalone |
| Partner IP | Other server | None | Required for redundancy |
| Heartbeat | Check interval | 1000 ms | 100-5000 ms |
| Timeout | Failover trigger | 5000 ms | 3x heartbeat minimum |
| Virtual IP | Client connection | None | Required for seamless |
| Sync Mode | Data sync type | Full | Full, Differential |
Custom Configuration Files
Application Settings
File: FrameworX.config
xml
<configuration>
<appSettings>
<add key="Culture" value="en-US" />
<add key="Theme" value="Default" />
<add key="MaxLogSize" value="10485760" />
<add key="EnableMetrics" value="true" />
<add key="CustomPath" value="C:\Custom" />
</appSettings>
<connectionStrings>
<add name="MainDB" connectionString="..." />
<add name="HistorianDB" connectionString="..." />
</connectionStrings>
</configuration>Configuration Best Practices
Performance Tuning
- Set scan rates based on actual process dynamics
- Use event-driven updates when possible
- Optimize database indexes regularly
- Monitor memory usage and adjust limits
- Balance thread pool with CPU cores
Security Hardening
- Enable HTTPS for all web access
- Use Windows authentication when possible
- Implement role-based access control
- Regular password policy review
- Enable audit logging for compliance
Reliability Settings
...
Pattern 5: Alarm Notification
- Tag Value Change → Alarm Condition → Notification System → Email/SMS
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|
...
Overview
Content Tools
Tasks