Versions Compared

Key

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

Anchor
What is a Project?
What is a Project?
About

Projects

Solutions

Framework is a powerful platform for developing and delivering applications that handle real-time data. Applications created using this platform are structured into projectsSolutions.

A Project Solution encompasses the configuration for different functional Modules, which can include Tag definitions, Alarms, Communication, Displays, and more. Each Project can be understood as as Application, or Solution, that will be installed in a production environment. 

The tool utilized for selecting and opening a project Solution is known as Projects Solutions Management.

By using the Projects Solutions Management interface, you can easily organize your various FactoryStudio projectsSolutions, from local your local computer or remote devices, to streamline your workflow and increase productivity.

On this page:

Table of Contents
maxLevel3



Anchor
Project Manager
Project Manager

Projects

Solutions Management User Interface

The Projects Solutions Management interface is the main hub for managing and organizing your FactoryStudio projectsSolutions. From this interface, you can create new projectsSolutions, edit existing ones, and and run projects Solutions located in your computer or remote ones.

Some very unique and powerful features about project Solution management tools include:

  • This interface is product version agnostic. You can manage and open projects Solutions created with different product versions without upgrading the project Solution in the field or switching the engineering tool in your computer.
  • The platform creates a file for each projectSolution. All configuration, including tag definition, displays drawing, images and report templates is stored in a single file — an encrypted SQL database with extension .tproj — for easy management.
  • You can open multiple projects Solutions at the same time or allow multiple engineers to work on each projectSolution.
  • In order to enable multiple users to work concurrently on the same projectSolution, follow the procedure described at the section <<< Multi-User Collaboration >>>

<<< NOTA: Onde esta sendo salvas as figuras do Manual, o "Fonte" para editar as figuras? Tem que que estar em algum repositório de arquivo do próprio Confluence, ou no Egnyte

>>>>>. Apenas apague esta nota, quanto tiver um processo implementado para garantir que todos trabalhando em documento saibam e apliquem isso


Project Solution Management

Field

Type

Description

Your license

Dynamic text box

Displays the license information.

License Management

Shortcut

Click to go to the License Management page.

Find ProjectsSolutions

Dynamic text box

Displays the Project Solution Server information.Project

Solution Server

Shortcut

Click to go to the Project Solution Server settings page.

Language

Combo box

Selects the user interface language.

Project Solution List

View Selector

The Project Solution List allow the selection of a project Solution to perform actions on it.
The View ComboBox has options to visualize on the Projects Solutions in different ways:
List, Cards, or Table view.

Refresh

Icon

Refreshes the project Solution list.

Notifications

Icon

Opens the notifications box.

Help

Text box

Shows useful tips.

Search projectSolution

Search box

Searches project Solution in the Project Solution List.

New

Command button

Opens the New Project Solution wizard. See Projects Management Tool Creating New Solutions.

Edit

Command button

Opens selected project Solution for edition. See Projects Management Tool Editing or Viewing Solutions

View

Command button

Opens selected project Solution in read-only mode. See Projects Management Tool Editing or Viewing Solutions.

Run

Command button

Starts selected project Solution in startup production mode. See Running ProjectsSolutions.


Info
See Runtime Environment for detailed information on executing projectSolution, including the ability to define testing and production profiles.
Project

Solution List

The middle box is called Project Solution List and shows a list of projects Solutions on your computer or on a remote computer set previously. Click Refresh to update the projects Solutions list. 

Each item in the project Solution selector is a complete project Solution with the configuration for an application.

Each image below is an independent projectSolution. On the top right corner, you can select List, Cards or Table view.

Info

The image used for the project Solution preview is the contents of the display named MainPage in that projectSolution

List View

Projects exhibited in list

Card View

Projects exhibited as cards

Table View

Projects exhibited in a table

Your License

Your License presents information about the software license. There are flexible options for licensing according to each business' needs.

Clicking on the License Management shortcut will take you to the License Management page where you can manage your license and view your license details.

Info
See Managing Licenses for more information.
Project

Solution Server

The Projects Solutions Server section displays information about the computer and folders upon the list of presented list Projects Solutions is build.

Clicking Project Solution Server allows managing the Project Solution Server Service settings. There are two options for Project Solution Server: Localhost or Remote. If you select Remote, you will need to set it up.

Info
See Project Solution Server page more information.

Help

Clicking the Help button (blue question mark icon) opens the Are you new here? dialog box which contains some suggestions to get started. It also contain links to our, documentation and forum pages.

Notifications

The bell icon located in the bottom right corner opens the Notifications box.


The

Project

Solution Configuration file

The configuration for the entire projectSolution, is stored in single file with the extension TPROJ.

That file is an encrypted  embeded SQL database, with the configuration tables of the various modules, like Tags, Alarms, Scripts and Displays. 

You can move, rename, duplicate, backup and restore the project Solution files, working directly on the computer folders, as you'd do with any other file.

The moving or adding TProj files directly on the computer folders, you need to press the Refresh button, so the list will update the content of the folders.

Other files extension for Projects Solutions are created, when using the Publish feature, as described in the chapter <<<< Build and Publish >>>>>


Anchor
Creating New Projects
Creating New Projects
Creating New

Projects

Solutions

To create a  new projectSolution:

  1. On the Project Solution Management, click New....
  2. Select a target platform where your project Solution will be installed and click Next.

  3. Select a product family and a product model. Then, click Next.
  4. Put a name and a short description to the new projectSolution.
  5. Select a project Solution template.
  6. Click Create New Project Solution to finish.

Wizard Step 1: Target Platform selection 

When creating a new projectSolution, you will need to select a target platform. 

A Target Platform is where you intend to deploy your Project Solution for execution in production. Here are the options, with guidance for selection:

.NET Framework 4.8:  If you are going to execute your application in a Windows server or desktop, that is the best point. It doesn't matter if is a Server or Workstation, neither the Windows version, as long it supports .NET 4.8. This option allows you access full capability of the Windows systems, including Active Directory Security and Authentication, and some other resources that are specific to Windows environments, not available in other platforms.

.NET 6.0: Formerly know as .NET core, this option sets the target to be the multi-platform,  allowing to create application that can execute in Windows, Linux or any other platform support .NET 6.

Cisco Routers: We are able to deploy projects Solutions to run inside Cisco routers using docker. Typically it will act as protocol gateway, and scripts calculation for data conversion, historian collator, or alerts and notification generation. 

Universal Robots: We can run the MQTT SparkPlug B publishing engine directly on Universal Robots. Its configuration is directly at the Robot, not in the Project Solution Designer tool,  see << >> for more information

Docker container:  The Wizard doesn't present an option for Docker, as any .NET 6 project Solution can be setup to run inside a docker. 

Wizard Step 2: Selecting the FrameworX Product 

Tatsoft's FrameworX technology powers 3 products option:

FactoryStudio: scalable models  based on the number the communication points, enabling SCADA, MES, AdvancedHMI and a wide range of industrial applications. 

EdgeHMI: scalable models  based on the number communication points, with the sub-set of FactoryStudio features typically require for HMI on machines and embedded devices.

EdgeGateway: scalable models based on the number of communication points, with the features to perform data collections on field, including various protocols, data logging and scripting. 

You can keep the selection of product as FrameworX, when creating projects Solutions for Unlimited communication points, and Unlimited users.

According the selecting or the product, the various options of communications are presented. 

Info
titleProduct Models and Licenses

FrameworX configuration tools are available free or charged, but you require a license to put your project Solution in production on the field.

The Product and Model (number of points) selected when create a new ProjectSolution, should reflect the intended license to be acquired for production installation. 

You still can change those settings after creating the projectSolution, at the Project Solution Designer tool, Project Solution Settings. 

Wizard Step 3: Customizing

Project

Solution Name and other options 


New Project Solution Wizard

Field

Description

Name

Enter a name for the projectSolution.

Description

(Optional) Enter a description of the projectSolution.

Location and new folder check box

Click the"..." button to select a folder or use the check box to create a new sub-folder for the projectSolution.

Note

Remote access is configured by a projectSolution's folder. You can select where the project Solution is created. Be sure to place local projects Solutions in their own folder. Do not add them to the same folder that has projects Solutions with remote access. 


Product Model info

Depending on your license, this setting may give you options to build applications for a specific product model. The product model is connected with the number of real-time communication points you are allowed on that projectSolution.

Canary Historian combo box

Sets how many tags will be stored on Canary Historian

Template selector

Selects a project Solution template, which a pre-created project Solution with some displays and functionality. See Projects Management Tool Solution Templates for more information.


About the Folder Structure for

Projects

Solutions

FrameworX projects Solutions are created in a way that is possible to have multiple projects Solutions in one folder. 

Each project Solution file, TPROJ, has all the configuration of the projectSolution, and some files that are dynamically created, such as retentive tag databases, or user UI settings, they carry the name of the ProjectSolution

Therefore when create multiple simple projectsSolutions, typically for tests and demos,  it is easier to keep in the same folder. But, when created larger applications, or Project Solution for formal field deployment it's a good procedure to do in a new folder.r 

Canary Historian:

FrameworX applications bring the benefit to allow, at no extra cost, the usage up to 500 historian points, using the Canary Historian tools. You can upgrade to a higher tag counting.

When using that feature, even for the built-in 500 points, it's necessary to add the Canary license. See << Canary Integration >> for more information. 


Anchor
Editing or Viewing Projects
Editing or Viewing Projects
Editing and Viewing

Projects

Solutions

The View button opens a ready-only version of the project Solution configuration, which is very useful if you just want to put the project Solution in execution or check its configuration. 

The Edit button enables modifications in the projectSolution. You may need to use the Logon button in the toolbar before editing if the Security projections Solutionions were enabled to that projectSolution

Many projects Solutions can be opened at the same time. When a second instance of the same project Solution is opened, the second instance will open as read-only.

To enable concurrent users, your project Solution server must be licensed for multiple engineers. See Managing Licenses for more information.

Steps to open am existing projectSolution.

Start ProjectSolution.exe: Run the Projects Solutions application, using the ProjectSolution.exe command line, or desktop icon. 

Select Local or Remote computers: By default, the system will show the projects Solutions from the last location, or from your local computer on the first. You can modify the list of projectSolution, going the Project Solution Server page.

For remote computers, you can use the Web UI: If the remote computer has Web Server enabled, and you are in Windows computer, you can start see the projects Solutions of remote computer with the URL: <<<<<<<<<<I

Select the desired Project Solution at the List: you can use the search box or modify the options for visualization. When using Tables, you can sort by columns clicking in the tiles, or right click to switch column visibility.

Info
titleOpening in View mode

If the Project Solution file is locked, or there is another local instance of the Project Solution open, the Project Solution will open in Read-Only View mode. In that mode is still possible to Run or Export configuration, but no to edit.



Anchor
RunningProjects
RunningProjects
Running

Projects

Solutions

You can run a project Solution by:

  • Using the Run button in Project Solution Management.
  • Starting the execution manually after you open the project Solution for editing (Execute → Startup → Run Startup). 
Info
For more information, see Runtime Environment.



Anchor
Upgrading Projects
Upgrading Projects
Upgrading

Projects

Solutions

Projects Solutions retain information about the platform's version used to create the ProjectSolution.

Opening a project Solution with a previous version without upgrading it will require a platform's equivalent version installed.

Also, you can upgrade the project Solution to the latest version using the Upgrade Version command button. 

When Upgrading:

  • A copy of the project Solution is executed, creating a new file named: <project<Solution-name>-<preivous-vesion>.tproj.
  • A new empty project Solution is created named <project<Solution-name>.tproj.
  • The Previous project Solution is imported to the new projectSolution.

After upgrading, it is recommended to open the new project Solution and build it (Execute → Build and Publish → Build... operation), so the system checks all its scripts.


Anchor
Project Templates
Project Templates

Project

Solution Templates

Project Solution templates can be a great way to speed up the development process by providing pre-configured settings and modules. Templates can be customized to fit your specific needs, and can be a useful starting point for building your application. When selecting a template, consider the functionality you need and the type of application you are building. Examples of different templates available include web applications, mobile apps, and desktop applications.

Pre-built project Solution templates get you started faster by building the solutions you need. Some project Solution templates are available when you install the software, such as Blank, Default, TrendChart, TrendChart with Alarm Pages and Alarm Footer, Redundancy projectsSolutions, and Asset Viewer.

Template

Blank

Default

TrendChart

TrendChart and Alarm

TrendChart and Alarm Footer

Redundancy

Log on dialog

(tick)

(tick)(tick)(tick)(tick)(tick)

Several themes

(tick)

(tick)(tick)(tick)(tick)(tick)

Header page navigation using Industrial Icons

(tick)

(tick)(tick)(tick)(tick)(tick)

Empty main page

(tick)

(tick)(tick)(tick)(tick)(tick)

Layout with Header and Main page

(tick)

(tick)(tick)(tick)(tick)(tick)

Server Information page using the Dashboard display


(tick)

(tick)

(tick)(tick)(tick)

System information template and Scripts


(tick)

(tick)

(tick)(tick)(tick)

System Information Data Historian configuration


(tick)

(tick)

(tick)(tick)(tick)

UI data template



(tick)

(tick)

(tick)

(tick)

TrendChart display



(tick)

(tick)

(tick)

(tick)

TrendChart data templates



(tick)

(tick)

(tick)

(tick)

Alarm Online display




(tick)

(tick)

(tick)

Alarm Historical display




(tick)

(tick)

(tick)

Alarm data template




(tick)

(tick)

(tick)

Alarm Footer display





(tick)

(tick)

Redundancy Information display






(tick)


Select and run a template to check the displays available on each template, and explore its settings. By that, you can check if one of the templates meet your needs and speed up your project Solution development.

In addition, you can add or create more templates on your own.

Adding New Templates

The templates presented when creating a new project Solution are standard project Solution files located in the product installation folder in Templates

If you receive a new template from your vendor or integrators, copy it to that projectSolution.

To add a new template, create a project Solution and save it in the Template folder on the installation directory, such as the following sample path: "C:\Program Files\...\Product\Version\Templates"


In this section...

Page Tree
root@self
spacesV10

...