Every knowledge area has its own terminology, and the same applies to software applications are no exception. Certainly While the nomenclature used by Tatsoft FrameworX on this platform follows market standards whenever possible, but some specific terms related to the system and other common words may have a special meaning when using meanings in this context.
This glossary
has mostincludes the key terms and
keywordsconcepts used by our platform
and also concepts and related technologies that are relevant to our context, as well as relevant technologies.
It is recommended to
at leastread this glossary at least once after using our platform for a
couple offew months.
Doing a review ofReviewing the definitions and
nomenclature used by the FactoryStudio platform and Tatsoft development and engineering teamsconcepts, combined with your experience
with the product, will
putenhance your understanding of the system and improve your efficiency
onin creating applications
to a new higher level.
Name | Description | ||
|---|---|---|---|
AccessTypes, Device AccessType | Each Point is associated with an AccessType, defining rules for when to read and/or write values. It includes settings like polling rate and read/write permissions, allowing users to configure the data acquisition and the sending of commands to the devices with total flexibility. | ||
AlarmArea | A hierarchical grouping of AlarmGroups for structured alarm management. It can contain child AlarmAreas, useful for large systems with many AlarmItems configured. | ||
AlarmItem | A tag or expression monitored by the Alarm Module, containing information such as tag name, alarm condition, and AlarmGroup. It includes properties like Limit, Deadband, and Message. | ||
AlarmGroup | A collection of AlarmItems sharing common properties. It simplifies alarm management with configuration properties like AckRequired, AutoAckTime, and Sound. | ||
App Domain, Application Domain | Represents the A virtual, isolated computer environment , where a .NET application runs. Isolated, in its context, means that the memory areas and components used by programming running in that environment are completely isolated from other programs running in the same computer. | ||
Application, Project, Solution | Refers to solution or the final system created using FactoryStudio. The terms Application. Project and Solution are used with close meaning, referring to the engineering configuration and files necessary to implement the an application intend to deploy in a production environment. Project is used to refer to application created with version 0.2 or older, as Solutions refer to applications created with version 10.configuration created using the platform. “Project” is used for version 9.2 or older versions, while “Solution” is for version 10 and up. "Application" is used to refer to the functionally the configuration is intended to perform, in opposition to "Project" and "Solution" that are more closely related to the configuration itself. | ||
Application Modules | Software components that manage and execute a system's internal logic and data transformations. They encompass Scripts, Reports, and Datasets. Manage and execute a system’s internal logic and data transformations, including the Modules: Datasets, Reports, Scripts and Displays. | ||
Assembly | An | Assembly | Refers to an executable file (.EXE or Library .DLL) created using managed code and Microsoft .NET framework. the .NET framework. |
Asset Tree | A hierarchical representation of the solution data, containing variables, tags, and data templates matching sensor reading physical equipments, setpoints, recipes, management data, and all the variables necessary to implement and operate an application. | ||
Audit Trail | Logs changes and events when executing the solution, tracking who made changes and when. Useful for troubleshooting, analysis, and compliance. | ||
Build and Publish | The Build process compiles the solution code, while Publish creates a read-only version for distribution in regulated sites. | ||
Categories | Metadata labels used across configuration tables to organize large solutions. | ||
Channels | Devices Module object that encapsulates configuration settings and execution properties for a selected Communication Protocol. | ||
Client | A software component interacting with a server or services, including .NET Clients, HTML5 Clients, and Remote Clients. Regarding Scripts or Tags, refers to the Client Domain, meaning values that reside and methods that are executed on the client software components. | ||
CodeBehind | Allows custom code in VB.NET or C# for event handling, calculations, and application behavior management. It also allows to call Python classes. | ||
Connection Target | Configures the location of the data source, selecting from Local Solution, TagProviders, or Remote sources. | ||
Component, User Controls | Graphical User Controls available for creating displays, including customizable objects and elements. | ||
DatasetDBs | Connection settings created by the Datasets Module to communicate with an external database. | ||
Date Template (UDT) | User-defined data structures that include variables and references to other templates, creating a hierarchical data structure. | ||
DatasetFile | Datasets Module object, logical name defining parameters for reading and writing files in ASCII, Unicode, or XML formats. | ||
DatasetTable | Datasets Module object, logical name created to hold configuration settings to access specific tables in a connected database, mapping tags to table columns for operations. | ||
DatasetQuery | Datasets Module object, logical name associated with the configuration for SQL query statements with a Database, and its properties and methods for running queries. | Component | Graphical User Controls available to create displays |
Designer, Solution Designer | Application and User Interface to configure The application and user interface for configuring FrameworX Solutions. | ||
Display / Screen | A window or frame of your application’s user interface, containing static or dynamic graphical elements. | ||
Draw | Part of the Solution Designer configuration used to draw and animate displays and synoptic screens. | ||
DLL Hell | Term used to refer the complications on running the Complications from running legacy Windows applications as there is no due to lack of built-in isolation on the in DLL libraries, memory and COM objects used . Solved by the applications. The .NET Framework completely eliminated that problem. | ||
Domain, Server Domain, Client Domain | Refers to the values and location Values and locations of objects at run time. Domain server objects running on the server are the objects running on the server during runtime. Values associated with this object are system-wide. Client domain means that the object is running on the client station and each machine can have different values.runtime, with server objects having system-wide values and client objects having machine-specific values. | ||
Dynamics and Animations | Definition for changes in the graphical elements attributes, driven by the values of real-time tags. | ||
TagProvider Connections | Enable direct interaction with variables, tags and data structures in remote systems without creating specific tags, enhancing data access within the Unified Namespace. | ||
Enumerations | Define potential values or ranges for a variable, mapping messages and colors to each state. | ||
Forms, Report Forms | Rich Text documents that can include real-time tag values, tables, and symbols, saved as Text or PDF files. | ||
Graphical Element | Components used in screens, such as shapes, checkboxes, or trend charts. | ||
Image resources | Imported image files used as graphical elements in your solution. | ||
Industrial icons | Pre-built icons designed for industrial automation applications. | ||
Internal Module | Features and programs that implement internal system functions which run, running without anyuser configuration. Examples are the Network Synchronization task and the Background Report Generator. Some Studio tools (e.g., ModuleInformation.exe) may display status information of those internal Modules. However, this information is required only for advanced system optimizations. | ||
FactoryStudio | A scalable product version for | FactoryStudio | Scalable product version by I/O and Clients, simple to advanced SCADA/HMI, IIoT Edge, and Gateway all applications, built on Tatsoft’s FrameworX. |
FrameworX | Our The software platform . It's also used in the context to refer to the and underlying technologies and components of the platform. | ||
FrameworX Unlimited | Includes unlimited Clients, Connections, and Developers. Built, with built-in drivers, SQL, OPC UA, MQTT, and more. | ||
FX EDGE | A FrameworX Edge application. | ||
FX MQTT BrokerOur embedded Broker for testing | The embedded broker within the FrameworX Platform. | ||
FX MQTT Simulator | A An MQTT Client simulator ( with Sparkplug) for testing, included in the product installation. | ||
Hot Updates (Hot Reload) | Apply offline solution changes without disrupting the runtime environment, maintaining stability and preventing downtime. | ||
HistorianTables | Groups Tags for historical archiving, defining settings for storage and retention. | ||
HistorianTag | Tags whose values are stored in a HistorianTable, including dynamic references to external data. | ||
Project File | Main Solution File | Refers to the SQL Studio encoded database that contains containing the Solution configuration. The extension .TPROJ references the current project still under development. The extension .TRUN references read-only published projectsProject configuration, with extensions .TPROJ and .TRUN. | |
Layout | Organizes the user interface into frames or panels, acting as containers for Displays. | ||
Modifier (Device/Points) | Auxiliary parameter to effect for read and write points for a device, the treatment of /write operations on DevicePoints, handling Arrays, bit masks, strings, swap and other operations in which a DataType definition can not define them completelysettings. | ||
Modular architecture | Breaks down complex functionalities into distinct modules, providing flexibility in design and configuration. | ||
Module | A program that accesses the database in real time (RtDB) and can be Program accessing the real-time database, composed of one or more Assemblies. | ||
Namespace | An address space . All objects created with a Namespace have unique names . "Address space" can also be understood as a form of tier objects. All process variables are grouped in the tag namespace; all reports grouped in the namespace report. The name of an object should be unique within the namespace to which the object belongsfor objects, grouping process variables, modules properties and methods, etc. | ||
Nodes | Device Module object defining the settings to physical devices, using the protocol defined in the DeviceChannel. Each Node contains one or more DevicePoints. | ||
Online Configuration | Allows real-time modifications to a running solution without stopping execution. | ||
Object Type (RunObj type) | Determines the type of runtime object (display, report, script). | ||
Objects, Runtime Objects | Runtime objects are those objects visible (through their names) to access Visible objects in the Solution, accessed via scripts and displays, such as Tags, Reports, Alarms, Displays among others. The namespaces also identify which execution module is responsible to update those values, for example the Alarm Module will start and will update the values of the runtime objects associated with the alarmsupdated by the respective execution modules. | ||
PanelType | Defines how graphical elements are organized, supporting Canvas and Dashboard types. Canvas (or Process Screens): The elements are in a drawing surface, where each element has its specific location and size. Grid (or Dashboard Screens): The elements are placed in a grid with responsive size, columns and rows. The graphical elements adjust accordingly. | ||
Permissions, PermissionsGroup | Set levels of access for users, determining their capabilities within the solution. | ||
Policies | Manage user identification and session control requirements. | ||
Plugin | Subset of a FrameworX Solution, exported and imported using the Solution-Export command. Reusable components of a solution, containing Tags, Displays, or other objects. | ||
ObjectValues, PropertyValueRuntime | objects (e.g.: Tags, deviceNodes, etc.) can have one or more properties defined. The TAG and the property value, for example, MIN, MAX, description, among other propertiesProperties defined for runtime objects, such as Tags and DeviceNodes. | ||
PropertyWatch | Diagnostic utility to check and modify the object values of the objects at runtime. | ||
Parameters (Tag Configuration) | Definition of the parameters of Defines behavior and values value processing for Tags. | ||
Plug-in | Sub-set of a FrameworX Solution. Plugins are created using the Solution-Export command, selecting which parts and objects from the Solution will be exported. The Plugins can be imported or used by other solutions. | ||
Product Family | Specify the many options in our product line. It includes: FrameworX: Our Unlimited version, unlimited Clients, I/O and development, server based with all the tools you need FactoryStudio: Scalable, by the number of I/O & clients EdgeHMI: Scalable by I/O, more affordable EdgeGateway: Embedded device communications and processing at the edge or as flexible secure gateway This Product Family reflects in the software licenses. | ||
Solution | A configuration set Studio sketches of displays, reports, scripts and user notes created and edited with a single entity. | ||
SolutionDB / SolutionDatabase | SolutionDB (or Solution database) is a database that contains configuration information. Matches files with the extension <Solution>.dbsln (current type, for example) or <Solution>_ version.Teng (type released, for example). | ||
Process Modules | Software components facilitating interactions between the system and its environment, including Alarms, Devices, and Historian. | ||
Points, DevicePoint | Individual items read or written from/to DeviceNodes, mapping specific Tags to device registers or PLC I/O addresses. | ||
Product Family | Options in the product line, including FrameworX, FactoryStudio, EdgeHMI, and EdgeGateway. | ||
Product Family and Model | Define licensing requirements for running the Solution in production. | ||
Project File | In order to facilitate distinction of current version with legacy product versions, Project File refers to files with extension .tproj created with version 9.3 or older. | ||
Protocols | Rules for communication between devices, supported by the software. | ||
Solution | Application for real-time data built on the platform, including configurations for all Modules. | ||
SolutionDB / SolutionDatabase | Database containing configuration information, with extension .dbsln. | ||
Solution File / Solution Name | Configuration of an application saved in a .dbsln file, matching the solution name. | ||
Property or Attribute | Associated value of | Property or Attribute | Property (value) associated with a Tag or object. |
Real time database, RunDB, Runtime Database, RtDB | The real time database created when the Solution is running. All objects running accessible (such as Tags, Displays, Reports) are objects on the Runtime Database, also called Real-Time Database or RtDB. | ||
Runtime | A Solution with modules loaded and running. | ||
Runtime Startup | Operation that is the Solution at run time. This operation can be performed from the program TStartup.exe in the current version of FactoryStudio, or TServer.exe in the published version of the Solution. | ||
Tag | A process variable. Name of a Namespace that includes all the variables created by the user in a Solution configuration. | ||
In-memory database managing Unified Namespace data during solution execution, implemented by the TServer.exe process. | |||
Rendering Engine | Generates visual output from an application’s display drawing, supporting WPF, HTML5, or Portable clients. | ||
Runtime | Phase where a solution is in active execution, utilizing configured modules for tasks, data management, and operations. | ||
Runtime Database | In-memory real-time database for Unified Namespace data, ensuring efficient data management during solution execution. | ||
RuntimeUsers | Users created and retrieved from an external encrypted SQL database or other identification servers. | ||
TargetPlatform | Defines the operating platform for running the solution, either Windows Only (.NET Framework 4.8) or Multiplatform (Linux and .NET 8). | ||
Runtime Startup | Operation of the Solution at runtime, performed by TStartup.exe or TServer.exe. | ||
Script References | External DLLs included for script or display code compilation. | ||
ScriptClass | Library of functions and methods for Script Tasks, Expressions, or CodeBehind on graphical Displays. | ||
ScriptExpression | One line of code responding to an event. | ||
ScriptTask | Code executing in reaction to an event or at specified intervals. | ||
Smart symbols | Graphical elements with dynamic properties and connections to real-time tags and templates. | ||
StorageLocation | Defines where historian variables will be archived or read for charts and calculations. | ||
Tag | Process variable representing real-time and historical data, created locally or accessed remotely. | ||
Tag Type | Defines object types in the Tag Namespace, such as Digital, Integer, or Text. | Tag Type | Defines the type of objects in the Tag Namespace: Digital, analog, text. These Tags are a class of compounds or properties accessed directly such as minimum, maximum, Value, quality. Each property is internally created as ValueType. |
Task (Script.Task) | Task program Program written in C#, VB.NET (or C #) that runs on the server or client during the runtime of a solution. The execution will be on the server or client, depending on the configuration of the domain property in the scriptor Python running during solution runtime. | ||
Time-Series | Time-Series data is a collection of data , usually a list, or a set, or a stream of data, often with one entry following after the other in time, so a "series" of data readings over some consecutive time period.A single time-series data point is usually represented as a data value, such as a temperature readingpoints, often recorded sequentially over time. Each entry typically includes a data value and a timestamp (e.g. 56) and the time at which that reading was done (a.k.a. the "time-stamp" or "timestamp"). E.g.:4/18/2024 9:45:30.015 AMIt is helpful for analysis if the timestamps from various systems use the same "clock" and "time zone", so often people use UTC time (Universal Coordinated Time) as the "common" time zone. This helps avoid the potential confusion and extra work to "align" the , temperature reading at a specific time). Using UTC time helps align data from various time zones. TManager | ||
The program that performs the configuration of a solution. | Toggle | Reverses the value of a variable. Values : values greater than zero are converted to zero; zero is converted to the value "1"become zero, and zero becomes one. | |
Trust, Partial Trust, Full Trust | Partial Trust: Environment in which an application has limited access to resources (restricted access to files from particular folders, running other applications, etc.). XBAP applications that run within a browser (e.g., Internet Explorer) should run in "Partial Trust"Limited resource access (e.g., applications in a browser). Full Trust: Environment in which an application has access to all system resources. Applications installed on a computer usually run in "Full Trust" modeFull system resource access (e.g., installed applications). | ||
Unified Namespace | A software solution that acts as a centralized repository of data , information and context where any application or device can , enabling applications or devices to consume or publish needed data needed for a specific action. FactoryStudio 9.2 fully incorporates this concept: you can create, consume or integrate to a variety of namespaces. It enhances system interoperability and simplifies data management. | ||
Users | Anyone accessing the solution, either through the Designer Tool or in runtime mode (Displays). | ||
Visibility (Tag Visibility) Refers to the tagging system; Tags can be Private, Public or Protected. In another context, the graphical objects in a display can have a visibility dynamic property to appear or not when the screen is running. The Tag Visibility can be Public, Protected or Private Public: The value of the Tag during the execution of the Runtime is available for access to external Programs via TCP / IP or OPC Server. Also, the value of Tag is necessarily global or shared in all the client stations (Server Domain). | Defines how tags can be accessed: •Public: Accessible by external programs and shared across client stations. Tags used in server modules, such as Devices and Alarms have a unique value in the system (Server Domain). . | ||
WebData, Reports WebData | Encapsulates data exchange via JSON, XML, or HTML with other applications, or saves content to a file. It can also be used in displays for interaction with web services and REST APIs | XBAP | Xaml Browser Application (XBAP) is a graphical application using the XAML technology that runs inside a web browse. This is a legacy technology no longer in use.. |
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|