| HTML |
|---|
<style>
.text-span-6 {
background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
border-radius: 50px;
padding-left: 15px;
padding-right: 15px;
}
#title-text {
display: none;
}
.panelgradient {
background-image: linear-gradient(180deg, #d5def0, whitesmoke);
border-radius: 8px;
flex-direction: column;
justify-content: center;
align-items: center;
padding: 4rem;
display: flex;
position: relative;
}
</style>
<div class ="panelgradient">
<h1 style="text-align: center;">Solutions Manager</h1>
</div> |
Introduction to the Solutions Manager
The platform is designed for creating real-time data applications, structured into solutions. A solution includes configurations for various functional modules, such as tag definitions, alarms, communication, and displays.
The Solutions Manager is the central hub for organizing and managing your solutions. It enables you to create, open, and edit solutions from your computer or remote devices, facilitating efficient workflow and productivity.
Framework is a powerful platform for developing and delivering applications that handle real-time data. Applications created using this platform are structured into projects.
A Project 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 is known as Projects Management.
By using the Projects Management interface, you can easily organize your various FactoryStudio projects, from local your local computer or remote devices, to streamline your workflow and increase productivity.
On this page:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Key Concepts and Terms
Solution File / Solution Name
The configuration of an application (solution) is saved is a file with extension .dbSln. All modules settings are stored in that file. The solution name matches the name of the configuration file.
Project File
In order to facilitate distinction with legacy product versions, Project File, refer to files with extension .tProj, a legacy configuration.
| Anchor | ||||
|---|---|---|---|---|
|
The Solutions Manager
The Projects Management interface is the main hub for managing and organizing your FactoryStudio projects. From this interface, you can create new projects, edit existing ones, and and run projects located in your computer or remote ones.solutions.
Some very unique and powerful features about project management tools include:
- This interface is product version agnostic. You can manage and open projects created with different product versions without upgrading the project in the field or switching the engineering tool in your computer.
The platform creates a file for each
projectsolution. All
configurationconfigurations, including tag
definitiondefinitions,
displays drawingdisplay drawings, images, and report templates
is, are stored in a single
file — anfile—an encrypted SQL database with the extension
tproj — for.dbsln—for easy management.You can open multiple
projects at the same timesolutions simultaneously or allow multiple engineers to work on each
project.solution.
You can access solution files located on your computer or on remote devices with the Platform Services enabled. When accessing remote devices, you can use a pure HTML5 interface without needing any local installation.
To
In order toenable multiple users to work concurrently on the same
projectsolution, follow the procedure described
atin the section
<<< >>>
<<< 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 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 Projects | Dynamic text box | Displays the Project Server information. |
Project Server | Shortcut | Click to go to the Project Server settings page. |
Language | Combo box | Selects the user interface language. |
Project List | View Selector | The Project List allow the selection of a project to perform actions on it. |
Refresh | Icon | Refreshes the project list. |
Notifications | Icon | Opens the notifications box. |
Help | Text box | Shows useful tips. |
Search project | Search box | Searches project in the Project List. |
New | Command button | Opens the New Project wizard. See Managing Projects. |
Edit | Command button | Opens selected project for edition. See Managing Projects |
View | Command button | Opens selected project in read-only mode. See Managing Projects. |
Run | Command button | Starts selected project in startup production mode. See Running Projects. |
| Info |
|---|
| See Execute, Runtime Environment for detailed information on executing project, including the ability to define testing and production profiles. |
Project List
The middle box is called Project List and shows a list of projects on your computer or on a remote computer set previously. Click Refresh to update the projects list.
Each item in the project selector is a complete project with the configuration for an application.
Each image below is an independent project. On the top right corner, you can select List, Cards or Table view.
.
Navigating the User Interface
The User Interface is composed by the following sections:
The right side contains help-only information; you can close that section if you wish.
The middle box, called the Solution List, displays a list of solutions on your computer or on a previously set remote computer.
The left side provides summary information and navigation for additional content. It includes:
- Server Information Page: Select folders, view, and manage connected servers (or local computers).
- Licensing And Activation: See and modify the license on the connected server (or local computer).
- Product Information: Displays the current version and list of installed drivers.
Selecting a Solution
The main area in the Solution Manager is where you can select a solution and execute commands on the selected solution or create a new solution.
The middle box, called the Solution List, shows a list of solutions on your computer or on a previously set remote computer. Click "Refresh" to update the solutions list in case external applications or users modify the contents of the folders.
Each item in the solution list represents a complete configuration for an application, with each image corresponding to an independent solution. The image used for the solution preview is the content of the display named "MainPage" in that solution.
In the top right corner, you can select List, Cards, or Table view.
List View
Card View
Table View
Working with Solutions
The buttons on the top of Solutions List allow to manage the select solution or create a new one.
New: go to Creating a New Solution
Edit: Open the Designer software, to configure the selected solution
View: Open the Designer software, in Read-Only mode, which is useful if you simply want to check its configuration.
Run: Starts the execution of the selected solution. It will start in Production mode using guest credentials. For more options on starting, you can use the Manage Button.
Manage: navigates to the Solution Manager page, allowing to perform various actions with the selected solution.
Solution Configuration File
The configuration for the entire solution
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 Server
The Projects Server section displays information about the computer and folders upon the list of presented list Projects is build.
Clicking Project Server allows managing the Project Server Service settings. There are two options for Project Server: Localhost or Remote. If you select Remote, you will need to set it up.
| Info |
|---|
| See Project 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 Configuration file
The configuration for the entire project, is stored in single file with the extension TPROJ.dbsln. That file is an encrypted embeded embedded SQL database, with the configuration tables of the various modules, like Tags, Alarms, Scripts and Displays.
You can move, rename, duplicate, back up, backup and restore the project solution files, working directly on in the computer folders, just as you 'd do would with any other file. The When moving or adding TProj files directly on in the computer folders, you need to press the "Refresh" button , so to update 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 <<<< Runtime Build and Publish >>>>>.
anchor| Warning |
|---|
To create a new project:
- On the Project Management, click New....
Select a target platform where your project will be installed and click Next.
- Select a product family and a product model. Then, click Next.
- Put a name and a short description to the new project.
- Select a project template.
Click Create New Project to finish.
Wizard Step 1: Target Platform selection
When creating a new project, you will need to select a target platform.
A Target Platform is where you intend to deploy your Project 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 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 Designer tool, see << >> for more information
Docker container: The Wizard doesn't present an option for Docker, as any .NET 6 project 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 for Unlimited communication points, and Unlimited users.
According the selecting or the product, the various options of communications are presented.
| Info | ||
|---|---|---|
| ||
FrameworX configuration tools are available free or charged, but you require a license to put your project in production on the field. The Product and Model (number of points) selected when create a new Project, should reflect the intended license to be acquired for production installation. You still can change those settings after creating the project, at the Project Designer tool, Project Settings. |
Wizard Step 3: Customizing Project Name and other options
| ||
Be extremely careful when renaming solution files (or solution names). There are macros and properties with the solution name that may have been used to create database files, configuration files, or other application-specific implementations. When renaming a solution that is already in production, it is necessary to address any specific configurations or external connections that might have been created using that specific name. If you want to Delete a Solution, you just need to Delete the <solutionName>.dbsln file that cantatas the solution configuration. The folder named <solutionName>-Designer contains users settings and temporary files and it can be deleted anytime. When the solution runs, it may create databases files, text files, that are application-specific implementation, and those files should be traced and deleted, similarly when you are renaming solutions. |
Upgrade from Legacy Projects
When a file with the extension .tProj is found, it appears in the Solution List with the prefix "Project." Only projects from versions 9.1 and 9.2 can be upgraded directly. For older project files, you must first use the 9.1 or 9.2 product to upgrade them to those versions.
When a legacy project is selected, the "Upgrade Version" command button is enabled.
| Info | ||
|---|---|---|
| ||
In order to Edit a legacy project, you need to use the tools for the specific version of that Project. The Solutions Manager will only handle upgrades for that project to the current solution features. |
For further details on the Upgrade process to the page Migrating Legacy Projects.
Access Solutions on Remote Computers
By default, the system will display solutions from your local computer first. You can modify the list of visible solutions by going to the Solution Server page. At that page, you can select to show the solution files from the Local Computer for from a Remote Computer.
For Remote Computers: If the remote computer has the Web Server enabled and you are using a Windows computer, you can view the solutions on the remote computer via the URL.
Select the Desired Solution: You can use the search box or modify the visualization options to find and select the solution you need.
Requirements
The Solutions Manager can access configuration files from other computers and devices through two methods: connecting to a Remote Server via Server Information or using a URL to open an interface.
Both methods require that the connected server has TWebServices running and that the necessary firewall ports are open. On Windows computers, you can set up TWebServices by opening a local instance of the Solutions Manager on the target server and configuring TWebServices on the Server Information page. For Linux and other operating systems, you need to configure TWebServices to run on startup using the OS's tools. By default, TWebServices uses port 10108.
When multiple users open the same solution from the Server, it allows Multi-User Collaboration on the solution development.
Connecting to a Remote Solution Server
On the Server Information page, simply enter the IP address or domain name of the server you want to connect to and press the Connect button.
→ Read more about the Server Information page.
Using the Solution Manager Web UI
It is possible to access solutions on a remote server without installing the product on your local computer.
Just open browser and use the url: http://<Server IP or Name>:10108/solutions. Example: http://192.169.1.1:10108/solutions
The requirements are that the remote device has TWebServices running. If the device has a security AccessKey defined, the URL shall be:
http://<ServerIPorName>:10108/solutions?accesskey=<key>
Using the Designer in Click-Once Mode
When you are using the Solutions Manager WebUI and open a solution for editing, it is not necessary to have the Designer pre-installed on your computer. The system will use ClickOnce technology (if supported by the browser) to open a Designer window, retrieving the necessary files from the remote computer. Most common browsers allow ClickOnce; check the browser's technical information to confirm ClickOnce compatibility.
In this section:
New Project Wizard
Field
Description
Name
Enter a name for the project.
Description
(Optional) Enter a description of the project.
Location and new folder check box
| Note |
|---|
Remote access is configured by a project's folder. You can select where the project is created. Be sure to place local projects in their own folder. Do not add them to the same folder that has projects with remote access. |
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 project.
Sets how many tags will be stored on Canary Historian
Selects a project template, which a pre-created project with some displays and functionality. See Managing Projects for more information.
About the Folder Structure for Projects
FrameworX projects are created in a way that is possible to have multiple projects in one folder.
Each project file, TPROJ, has all the configuration of the project, and some files that are dynamically created, such as retentive tag databases, or user UI settings, they carry the name of the Project.
Therefore when create multiple simple projects, typically for tests and demos, it is easier to keep in the same folder. But, when created larger applications, or Project 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.
The View button opens a ready-only version of the project configuration, which is very useful if you just want to put the project in execution or check its configuration.
The Edit button enables modifications in the project. You may need to use the Logon button in the toolbar before editing if the Security projections were enabled to that project.
Many projects can be opened at the same time. When a second instance of the same project is opened, the second instance will open as read-only.
To enable concurrent users, your project server must be licensed for multiple engineers. See Managing Licenses for more information.
Steps to open am existing project.
Start Project.exe: Run the Projects application, using the Project.exe command line, or desktop icon.
Select Local or Remote computers: By default, the system will show the projects from the last location, or from your local computer on the first. You can modify the list of project, going the Project 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 of remote computer with the URL: <<<<<<<<<<I
Select the desired Project 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 | ||
|---|---|---|
| ||
If the Project file is locked, or there is another local instance of the Project open, the Project will open in Read-Only View mode. In that mode is still possible to Run or Export configuration, but no to edit. |
You can run a project by:
- Using the Run button in Project Management.
- Starting the execution manually after you open the project for editing (Execute → Startup → Run Startup).
| Info |
|---|
| For more information, see Execute, Runtime Environment. |
Projects retain information about the platform's version used to create the Project.
Opening a project with a previous version without upgrading it will require a platform's equivalent version installed.
Also, you can upgrade the project to the latest version using the Upgrade Version command button.
When Upgrading:
- A copy of the project is executed, creating a new file named: <project-name>-<preivous-vesion>.tproj.
- A new empty project is created named <project-name>.tproj.
- The Previous project is imported to the new project.
After upgrading, it is recommended to open the new project and build it (Execute → Build and Publish → Build... operation), so the system checks all its scripts.
Project 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 templates get you started faster by building the solutions you need. Some project templates are available when you install the software, such as Blank, Default, TrendChart, TrendChart with Alarm Pages and Alarm Footer, Redundancy projects, and Asset Viewer.
Template
Blank
Default
TrendChart
TrendChart and Alarm
TrendChart and Alarm Footer
Redundancy
Log on dialog
Several themes
Header page navigation using Industrial Icons
Empty main page
Layout with Header and Main page
Server Information page using the Dashboard display
System information template and Scripts
System Information Data Historian configuration
UI data template
TrendChart display
TrendChart data templates
Alarm Online display
Alarm Historical display
Alarm data template
Alarm Footer display
Redundancy Information display
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 development.
In addition, you can add or create more templates on your own.
Adding New Templates
The templates presented when creating a new project are standard project files located in the product installation folder in Templates.
If you receive a new template from your vendor or integrators, copy it to that project.
To add a new template, create a project 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 | ||||
|---|---|---|---|---|
|
...