Versions Compared

Key

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

Quick

Tutorial to Tatsoft's FrameworX

Start Guide

This guide

provides

walks you

steps on

through creating

new

robust, data-driven

robust

applications, from

Downloading and Installing the software

downloading and installing FrameworX to executing your first solution.

Software Download and Requirements

    •    Download FrameworX Designer for free here.
    •    FrameworX Designer includes unlimited creation and editing of solutions with unlimited tags, with no time limit, and all the product features.

On this Page

    •    Runtime execution allows two hours of resettable time. For licensing information on production contact us.
    •    Requires Windows 10 or newer. Solutions run on multiple operating systems using .NET 8.0.

Steps

  1. Download: Fill out the form and download the installer (around 2 minutes).
  2. Install: Execute the Software Installation  (less than 1 minute!).
  3. Explore the Solutions Manager and Demos (at your own pace).
  4. Create your own new Solution (around 5 minutes).
  5. Explore the Designer and Solution Settings (at your own pace).

On this page:

Table of Contents
maxLevel

3

2
stylenone


Software Installation

In order to install, just click on the MSIX file, which installs in just a couple of seconds to install FrameworX as a Windows App.

Image Added

Tip

When the application is running, you can right-click on its icon in the Windows Taskbar and select "Pin to Taskbar" to create a shortcut for easy access. Otherwise, when you want to execute it, type "FrameworX" in the Windows search box.


Warning

The first time you Edit and Run solutions after a new installation, Windows Firewall may request authorization. Just press OK if that prompt is shown.

Windows Server and Enterprise 2019 and older need update to use the new .MSIX extension. In this case, it is easier to install using the FrameworX-Setup.exe application.


Expand
titleClick here to expand, about Installing in other operating systems, data centers or production servers installations

About the MSIX installation 

MSIX is a new Microsoft standard for installations, offering significantly faster installation times. However, the installation folder is predefined by the OS (under \Program Files\WindowsApps) and it is installed only for the current user. 

MSIX requires Windows 10, version 1709 or later; or Windows Server 2022 or later. 

Using FrameworX-Setup.exe for Server Installations

For computers that do not support the MSIX standard, or when installing in production environments, such as factory-floor servers or data centers, it is preferable to have more control over the installation folder and to install for all users of the computer.

The traditional Setup.exe installation allows customization of the installation folder and installs the application for all users.

.NET and Multi-Platform Applications

To create solutions to other operating platforms like Linux, .NET 8 is required.

If you receive a warning that .NET 8 is not available on your computer, it will not prevent you from configuring solutions targeting Windows only, but it will prevent multi-platform solutions.

To install the .NET 8, follow the link in the installer message, or you can find the .NET 8 Desktop Runtime installer from Microsoft here: https://dotnet.microsoft.com/en-us/download/dotnet/8.0. Be sure to pick the version that matches your CPU architecture, which is likely x64. (And don't pick the "SDK" or ".NET Runtime" or other versions - just the ".NET 8 Desktop Runtime")



Solutions Manager and Demos

When you open the software, the first user interface you’ll see is the Solutions Manager tool, which will list the solutions on your computer and allow you to create, edit, or run them.

The list will show a few Demos that were installed with the product.

You can either use the "New" button to create your own solution, or first explore our demo solutions. You can also download additional demos and examples from Solution Examples.

Expand
titleClick here to expand about Exploring Demos...

To open a demo solution, simply select it

1. Downloading and Installing FrameworX

We commend downloading our evaluation version to start exploring our software. You can do that by filling out the form here.

When you install FrameworX for the first time, you will be prompted to choose the installation type:

  • Typical: Installs all the default program features. Recommended for most users. If you're trying out the software, we recommend choosing this option.
  • Custom: Allows users to choose which program features are installed and where they are installed. Recommended for advanced users.

Image Removed

Info

You can find more information on installation and different scenarios on Managing Installations.

2. Managing and Running Solutions

When you first open the software, you'll find a list of your current solutions. By default, you'll find all of our demos installed. Before creating your own solution, we recommend exploring our demos!

For new users, we recommend starting with the Brewery Demo. In this solution, we’ve built a brewery line from scratch, using all of the main software features. At our training site, you’ll find a free course that explains how we did this, from creating a project to adding alarming capabilities.

To Run a Solution, just select

from the list and click "Run" to

simply deploy

start executing it or "Edit" to

take a look at how we created it!

Image Removed

see how it was created. You can also double-click the solution to load it.

Image Added

In order to know what features each demo includes, check the page Demo Solutions.

When you open a Solution, you'll find the following Welcome Window:

Image Added

Navigate to Runtime, and press the Run Startup button to execute the Solution.


3.

Creating a New Solution

If you want to create your own solution, simply click "New" in the Solution Manager, and follow the wizard steps.Creating a new Solution consists of three phases. First

Image Added

Info

Our platform doesn't require a license for you to explore the engineering space! With the evaluation version, you'll be able to run the solution for only 2 hours, but there are no limitations on engineering time.


Expand
titleClick here to expand on detailed information with the wizard steps...

The first step is to select the Product that the solution is intended to use.

To facilitate multiple scenarios in a cost-effective way, FrameworX has its product line organized into families and models. More information can be found in Product Family.

Image Added

Once you've selected the product, you must choose what kind of

application

solution you'll build,

then which version of the Product Family you'll build. Finally, simply add a title and a

Windows or Multi-Platform.

Image Added

Finally, you can add a description and choose a

location on your computer

template for your solution here as well. For this example, you can select "HeaderLayout". When you're ready, simply click "Create New

Project

Solution".

Info

For more information on Managing Solutions, including types of projects you can create, please refer to Managing Solutions and Applications.

Image Removed Image RemovedImage Removed

Image Added

 

Once loading is completeOnce you edit this new project, you'll see our Home Page, that contains all of your basic information. 

Info

By default, our Project Explorer Navigation is filtered by Basic Modules Features. If you wish to work with all Modules and Features, simply change the filter in the first box.

In the homepage, to the right side, you'll also find some tips on how to start building your application.

Image Removed Image Removed

4. Creating a Unified Namespace

The Unified Namespace is the data model your solution will be using. 

This is where you'll create your tags, which represent real-time and historical data variables that modules can read, write, and subscribe to.

Tags are Local (created within FrameworX) or Remote (dynamically accessed via ExternalTags Sources connectivity). The ExternalTags Sources enable direct interaction with variables in remote systems, bypassing the need to create specific tags in the project. It establishes connections with tags sources which can be set up in a table or directly in the assets, enhancing the versatility of data access and exploration in the Unified Namespace.

Additional metadata, known as Tag Attributes (e.g., last update time, quality status, description), are automatically generated upon tag creation.

Image Removed

To start, we'll create one tag as example.

Image RemovedImage Removed

5. Using the Data Explorer 

The DataExplore tools allows you to easily perform data mining and monitoring from various data sources, including MQTT Brokers, OPC-UA, PLCs and SQL databases.  

Each Data Source has specific  features suitable that connection, but all tools share common look and fell, and similar workflows. This section will present those common workflows, and the specific features for each connection type, which include:

MQTT: Run Built-in Broker or the publisher simulator. Browse data from any broker.

OPC-UA: Run Built-in Server or simulator. Browse data from local or remote servers.

ControlLogix PLCs: Discover ControlLogix PLC in your network, connect to browse its data structure.

SQL Queries: Explore SQL database and build new queries visually.

Image Removed

6. Using Device Protocols

The Devices module implements real-item data communication with a wide variety of field devices and industrial protocols.

The Devices module supports standard interfaces like OPC-UA, OPC-DA and MQTT, Hart, and many proprietary protocols to various PLCs manufacturers.

The connectivity also includes IT protocols, like SNMP and Ping, and connection with Historian tools, such as OSIsoft PI, GE Historian, InfluxDB and Canary.

Image Removed

To maintain an organized and efficient communication structure, devices are grouped into channels based on their communication protocol and settings, and further organized into nodes representing individual devices or stations.

Channels are responsible for managing communication protocols and drivers, while Nodes handle multiple threads pointing to the configured Channels. Understanding the relationship between Channels and Nodes is essential for efficient data exchange.

  • Channels: execute processes based on communication protocols and drivers, configuring the required protocol or driver for a specific device. To create a new channel, navigate to Devices → Channels and click on "New Channel" Fill in the necessary information in the "Create New Channel" window and confirm by clicking "OK." The new channel will appear as a row in the table.
  • Nodes: perform multiple threads pointing to the Channels, ensuring efficient data exchange and minimizing latency.  To configure nodes, go to Devices → Nodes and input the required information. Columns can be added or removed by right-clicking the column heading area. Device node configuration properties include Name, Channel, PrimaryStation, BackupStation, SyncDate, SyncStation, SyncSettings, TemplateID and Description, each serving a specific purpose.

the Designer homepage, the main UI for editing your solutions.

Image Added


Info
titleEditing the Solution

Go to Solution Configuration for a step-by-step guide on adding content to your first solution.



Licensing And Registration

To deploy into production and run without time limitations, you'll need a license. Information about your license and links to activate it can be found on the Solutions Manager page, where you can choose between online and offline activation. See more about Licensing and Activation.

If you don't have a license yet, feel free to reach out at sales@tatsoft.com

Tip
titleLicense Information

Click on the "Your License" title, at the left side, to navigate to the Page License Information, with all the information about your current license, and the to tool to add or modify the license.  

Image Added

Image Added


Next Steps, Exploring More Features

With these steps, you've learned the basic on working with FrameworX and you're ready to continue your journey.

Once you're ready, we recommend you:

You can also schedule an introductory meeting with one of our onboarding specialists here


Feedback

Please provide us with feedback on our software and documentation.

Share your ideas for new features or specific training topics on our website.

We look forward to engaging with you and making progress together.

Leave feedback.


In this section:

Page Tree
root@parent

7. Mapping Tags

Image Removed

8. Create the Display to show the data

Image Removed

Image Removed

9. Running the application, .NET and HTML5 

10. Licensing And Registration

Exploring More Features

In this section...

pagetree

spacesV10