Versions Compared

Key

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

Configuration Reference

Children Display
depth1
styleh3
excerptTypesimple

Overview

This reference provides detailed information about all configuration settings available in FrameworX 10.1. Settings are organized by module and scope, with descriptions of each parameter, valid ranges, and impacts on system behavior. Use this guide to optimize your solution configuration and understand advanced options.


Modules Descriptoins


Tags (UNS)

          → Devices (Read/write values)
          → Alarms (Monitor conditions, notify and request ack, as needed)
          → Historian (store and recover time-series data)
          → Scripts (process data, implement workflows)
          → Dataset (sync with SQL databases, or recipe files)
          → Reports (pub PDF or CSV data, exchange JSON/XML data
          → Displays (Visualize)

Security Module
          → Restrict access to configuration modules and artifacts.
          → Provides Identification & Authorization for Displays client users.


Module Execution 

Module Lifecycle



Image Added

Module Communication


Image Added



Modules Hierarchy



Image Added



DataFlow Examples

Example 1: PLC to Display

PLC → Driver  (Device Point) → Tag → Display

Example 2: PLC to Display, using Direct Binding.

PLC address → Dynamic TagProvider  → Display


Example 3: Calculation to Database

Tags → Script (Calculation) → Result Tag → Dataset  (SQL)


Example 4: User Command

Display → Button Click → Tag Write  (UNS) → Device → PLC

                                                                      & → Audit Log (when enabled)



Solution Settings

General Solution Properties

Solution Information

Configuration location: Solution Center → Properties → General

PropertyDescriptionDefaultValid Range
Solution NameUnique solution identifierNewSolution1-128 characters
VersionSolution version number1.0.0.0X.X.X.X format
DescriptionSolution documentationEmpty0-1000 characters
AuthorSolution creatorCurrent userText string
CompanyOrganization nameEmptyText string
CreatedCreation timestampAuto-generatedRead-only
ModifiedLast modificationAuto-updatedRead-only
GUIDUnique identifierAuto-generatedRead-only

Solution Behavior

Configuration location: Solution Center → Properties → Behavior

PropertyDescriptionDefaultOptions
Startup ModeHow solution startsManualManual, Automatic, Delayed
Startup DelaySeconds to wait00-300 seconds
Shutdown TimeoutGrace period for shutdown3010-120 seconds
Auto-SaveEnable periodic savesEnabledEnabled, Disabled
Auto-Save IntervalMinutes between saves101-60 minutes
Backup on OpenCreate backup when openingEnabledEnabled, Disabled
CompressionCompress solution filesEnabledEnabled, Disabled

Runtime Configuration

Memory Settings

Configuration location: Designer → Edit → Settings → Runtime → Memory

PropertyDescriptionDefaultRecommended
Initial HeapStarting memory allocation256 MB512 MB - 2 GB
Maximum HeapMaximum memory limit2 GB4 GB - 16 GB
Tag Cache SizeIn-memory tag storageAuto100 MB per 10K tags
String PoolString optimization cache64 MB64 MB - 256 MB
Buffer PoolCommunication buffers128 MB128 MB - 512 MB
GC ModeGarbage collection modeWorkstationServer for >50K tags

Thread Pool Settings

Configuration location: Designer → Edit → Settings → Runtime → Threading

PropertyDescriptionDefaultRange
Min Worker ThreadsMinimum thread pool42-32
Max Worker ThreadsMaximum thread pool2525-500
Min IO ThreadsMinimum I/O threads42-32
Max IO ThreadsMaximum I/O threads2525-500
Queue SizeTask queue limit1000100-10000
Thread PriorityExecution priorityNormalLow, Normal, High

Communication Settings

Configuration location: Designer → Edit → Settings → Runtime → Communication

PropertyDescriptionDefaultOptions/Range
Server PortMain TCP port90001024-65535
HTTP PortWeb server port8080, 8080, custom
HTTPS PortSecure web port443443, 8443, custom
Max ConnectionsClient limit10010-1000
TimeoutConnection timeout30 sec10-300 seconds
Keep AliveTCP keep-aliveEnabledEnabled, Disabled
CompressionData compressionAutoNone, Auto, Force

Module Properties

Tags Module Configuration

Tag Processor Settings

Configuration location: Designer → Unified Namespace → Settings

PropertyDescriptionDefaultImpact
Update RateTag scan rate100 msLower = more CPU
Event QueueEvent buffer size10000Memory usage
Deadband ModeChange detectionAbsoluteAbsolute, Percent
Quality PropagationQuality inheritanceEnabledData reliability
Timestamp SourceTime sourceSystemSystem, Device, GPS
Retain ModePersistence typeChangedNone, Changed, All

Tag Options

Configuration location: Per-tag properties

PropertyTypeDefaultDescription
DeadbandFloat0.0Minimum change to trigger update
Scan RateInteger1000 msIndividual tag update rate
HistoryBooleanFalseEnable historian logging
RetentiveBooleanFalsePersist value through restart
SecurityStringNoneSecurity zone assignment
ScalingBooleanFalseEnable engineering units

Devices Module Configuration

Channel Properties

Configuration location: Designer → Devices → Channel Properties

PropertyDescriptionDefaultValid Range
ProtocolCommunication protocolModbus TCPDriver-specific
ConnectionNetwork or serialEthernetEthernet, Serial
Scan RatePolling interval1000 ms10-60000 ms
TimeoutResponse timeout3000 ms100-30000 ms
RetriesRetry attempts30-10
Inter-RequestDelay between requests0 ms0-5000 ms
PriorityExecution priorityNormalLow, Normal, High

Node Properties

Configuration location: Designer → Devices → Node Properties

PropertyDescriptionDefaultType
IP AddressDevice network address192.168.1.1IPv4/IPv6
PortTCP/UDP portProtocol default1-65535
Unit IDDevice address10-255
Byte OrderData encodingBig EndianBig/Little
Block SizeMax request size1251-2000
Use BlocksOptimize readsEnabledBoolean

Alarms Module Configuration

Global Alarm Settings

Configuration location: Designer → Alarms → Settings

PropertyDescriptionDefaultOptions
Enable AlarmsMaster enableEnabledEnabled, Disabled
History SizeAlarm history records100001000-100000
Shelve TimeoutDefault shelve duration8 hours1-24 hours
Ack RequiredForce acknowledgmentEnabledEnabled, Disabled
Sound EnableAudio notificationsEnabledEnabled, Disabled
Flash RateVisual alarm rate1 Hz0.5-5 Hz

Alarm Item Properties

Configuration location: Per-alarm configuration

PropertyTypeDefaultDescription
PriorityInteger5001 (Critical) - 999 (Low)
Delay OnInteger0 secActivation delay
Delay OffInteger0 secClear delay
DeadbandFloat1.0Hysteresis value
Auto AckBooleanFalseAuto-acknowledge when clear
EmailBooleanFalseSend email notification

Historian Module Configuration

Storage Settings

Configuration location: Designer → Historian → Settings

PropertyDescriptionDefaultRecommended
Storage TypeDatabase typeSQLiteSQL Server for >10K tags
Buffer SizeMemory buffer1000010000-100000 records
Flush IntervalWrite frequency1000 ms500-5000 ms
CompressionData compressionEnabledEnabled for efficiency
Archive DaysDays before archive9030-365 days
Purge DaysDays before deletion36590-unlimited

Collection Properties

Configuration location: Designer → Historian → Collection

PropertyTypeDefaultRange
Collection RateInteger1000 ms100-60000 ms
Deadband TypeEnumAbsoluteAbsolute, Percent
Deadband ValueFloat1.00.0-100.0
Quality FilterEnumGoodGood, All, Custom
Max RateInteger00 (unlimited) - 60000 ms

Scripts Module Configuration

Script Engine Settings

Configuration location: Designer → Scripts → Settings

PropertyDescriptionDefaultOptions
Enable ScriptsMaster enableEnabledEnabled, Disabled
Debug ModeEnable debuggingDisabledEnabled, Disabled
TimeoutExecution timeout30 sec1-300 seconds
Memory LimitPer-script memory100 MB10-1000 MB
Thread PoolScript threads101-50
Compile ModeCompilation timingStartupStartup, On-Demand

System Parameters

Security Configuration

Authentication Settings

Configuration location: Designer → Security → Authentication

ParameterDescriptionDefaultOptions
Auth ModeAuthentication typeWindowsWindows, Forms, Mixed
Session TimeoutInactivity logout20 min1-1440 minutes
Max AttemptsLogin attempts31-10
Lockout DurationAccount lockout30 min1-1440 minutes
Password PolicyComplexity rulesMediumNone, Low, Medium, High
Two-Factor2FA requirementDisabledDisabled, Optional, Required

Authorization Levels

Configuration location: Designer → Security → Roles

LevelValuePermissionsTypical Use
Administrator0Full system accessSystem configuration
Engineer100Design and configureSolution development
Supervisor200Operational controlProduction management
Operator300Basic operationDaily operations
Guest999View onlyRead-only access

Performance Parameters

Database Optimization

Configuration location: Solution database settings

ParameterDescriptionDefaultPerformance Impact
Connection PoolPool size10More = better concurrency
Command TimeoutQuery timeout30 secLonger for complex queries
Batch SizeBulk operations1000Larger = fewer round trips
Index ModeIndex strategyAutoManual for optimization
StatisticsUpdate frequencyDailyMore frequent = better plans

Network Optimization

Configuration location: System network settings

ParameterDescriptionDefaultRecommendation
TCP NoDelayNagle algorithmFalseTrue for real-time
Send BufferSocket buffer8 KB32 KB for high throughput
Receive BufferSocket buffer8 KB32 KB for high throughput
Max Frame SizePacket size1500Jumbo frames if supported
Connection LimitPer-IP limit10Increase 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 TypeDefaultPurposePerformance Impact
RuntimeDisabledExecution flowHigh
CommunicationDisabledProtocol messagesMedium
DatabaseDisabledSQL operationsMedium
SecurityEnabledAccess attemptsLow
PerformanceDisabledTiming analysisHigh

Redundancy Configuration

Hot-Standby Settings

Configuration location: Designer → Edit → Settings → Redundancy

PropertyDescriptionDefaultCritical
RoleServer roleStandalonePrimary, Backup, Standalone
Partner IPOther serverNoneRequired for redundancy
HeartbeatCheck interval1000 ms100-5000 ms
TimeoutFailover trigger5000 ms3x heartbeat minimum
Virtual IPClient connectionNoneRequired for seamless
Sync ModeData sync typeFullFull, 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

  • Enable redundancy for critical systems
  • Configure appropriate timeouts
  • Set up automatic backups
  • Use retentive tags for important values
  • Implement store-and-forward for historians

...

AI Assistant Data

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

...