| 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.
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 interface is the main hub for managing and organizing your solutions
This page presents information related to how to create and manage Projects.Easy Heading Macro headingIndent 40 navigationTitle On this page selector h2,h3 wrapNavigationText true navigationExpandOption disable-expand-collapse
What is a Project?
This framework is a powerful platform used to develop and deliver applications that manage real-time information. Applications built with the platform are organized into Projects.
A Project holds the configuration for the various functional Modules, such as Tags definition, Alarms, Communication, Displays and others. We refer to the tool that assist to select Project and open for editing or execution as Project Manager.
This section explains how to create, edit and execute your Projects, using the Project Manager User Interface.
Welcome Page
The Welcome page is the first interface you see when you start our platform. This interface allows you to view the Projects in your computer — or remote computers —, create new ones, open projects for editing and run them.
Each item shown in the table view or card view is a complete Project with the configuration for an application.
Some very unique and powerful features about Tatsoft tools for project management include:
include:
The platform creates a file for each solution. All configurations, including tag definitions, display drawings, images, and report templates, are stored in a single file—an encrypted SQL database with the extension
.dbsln—for
easy management.
You can open multiple
solutions simultaneously or allow multiple engineers to work on each
solution.
About your Software License
There are flexible options for licensing according to each business's needs. Read more about the license options available and how to license your software in User Guide → Installation and Licensing → Managing Licenses.
About the Project Server
The Project Server Manager workspace tab on the Welcome page allows managing the Project Server Service settings.
You have two options for Project Server: Localhost or Remote. If you select Remote, you'll need to set it up. Read more about how to do this on User Guide → Managing Projects → Project Server.
License Workspace
The License Manager workspace tab on the Welcome page presents information about the computer software license.
You can activate your license code and manage your software license in this workspace. Read more about how to get a license code in User Guide → Installation and Licensing → Managing Licenses.
Listing Projects
At Projects workspace, you have a list of the projects on your computer or on the remote computer selected at the Server tab.
Each image shown below is an independent Project. On the top right corner, you can select to use the Card View or the List View.
| Info | ||
|---|---|---|
| ||
The image used for the Project preview is the contents of the Display named MainPage in that project. |
ListView Visualization
Refresh Icon (at the low right corner): updates the projects list
CardView Visualization
TableView Visualization
Command Buttons
New Project: opens a dialog to enable the creation of a new project
Edit Project: opens the selected project for edition
View (read-only): opens the selected project in read-only mode.
Upgrade Version: if Project was created with a previous version the Upgrade button is enable
Test Project: Starts the project execution using a Testing profile.
Run Project: Starts selected project in startup production mode.
For more information on Testing Profiles and startup, go to section Running Projects
Creating New Projects
To create a project:
- Click New Project. The New Project page will open.
Enter or select any needed information.
- Select the desired Project Template.
Click Create New Project.
Field
Description
Name
Enter a name for the project.
Description
(Optional) Enter a description of the project.
Location
| 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 version of our platform. You can change this setting later, if needed.
| Info |
|---|
If you do not have a license, only the Express family will show. Even when you have a license, you may want to create Express projects to share demos and tutorials with users who do not have a license installed. |
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.
Project Templates
Pre-built Project Templates get you started faster by building the solutions you need. Some project templates are available when you install the software: Blank, Default, TrendChart, TrendChart with Alarm Pages and Alarm Footer, Redundancy projects, and Asset Viewer.
In the following, you can check the basic content descriptions of each available template:
Blank project
- Logon Dialog
- Several Themes
- Header page navigation using Industrial Icons
- Empty Main page
- Layout with Header and Main page
Default project
- Server Information page using the Dashboard page
- System information template and Scripts
- System Information Data Historian configuration
TrendChart project
- UI data template
- TrendChart page
- TrendChart data templates
TrendChart and Alarm project
Contains all in the TrendChar project - plus:
- Alarm Online and Alarm Historical page
- Alarm data template
TrendChart and Alarm Footer project
Contains all in the TrendChar and Alarm project - plus:
- Alarm Footer page
Redundancy project
Contains all in the TrendChar and Alarm project - plus:
- Redundancy Information page
Using them is the best way to check if they make sense to your need. Just select one, and run it! Then, check the available displays on each one, and explore its settings.
In addition, you can add more templates or create one on your own. See further details about how to do this in the next.
Adding new Templates
The templates presented when creating a new project are standard Project Files located in the product installation folder at Templates.
If you receive a new template from your vendor or integrators, copy it to that project.
And to add a new template, you have to create a project and save them as a Template.
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 enable multiple users to work concurrently on the same solution, follow the procedure described in the section Multi-User Collaboration.
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, is stored in single file with the extension .dbsln. That file is an encrypted embedded SQL database, with the configuration tables of the various modules, like Tags, Alarms, Scripts and Displays.
You can move, rename, duplicate, back up, and restore the solution files, working directly in the computer folders, just as you would with any other file. When moving files directly in the computer folders, you need to press the "Refresh" button to update the list content.
Other files extension for Solutions are created, when using the Publish feature, as described in the chapter Runtime Build and Publish.
| Warning | ||
|---|---|---|
| ||
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:
Open Projects for Editing or Viewing
The platform supports two ways to open projects. The View button opens a ready-only version of the Project configuration. That is always the best way to go, if you just want to put the project in execution, or check its configuration.
When opening using the Edit button, it will be possible to modify 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. If you already have a project open, select another project in the Project Selection list and open it. When a second instance of the same project is opened, the second instance will open as read-only.
In order to enable concurrent users, your project server must be licensed for multiple engineers. In the License tab, the Engineering Group Box shows the maximum number of concurrent engineering users that are allowed to access the selected server or the local computer.
Upgrading Projects
Projects retain information about the FrameworX version used to create the Project.
When opening a Project with a previous version, the platform will try to find an installation of the previous version in the computer, and use it to edit the Project.
You can bring the Project to the latest version using the Upgrade Version command button.
When Upgrading:
- A copy of the Project is executed, creating a new files with name: <project-name>-<preivous-vesion>.tproj
- A new empty Project is created with the name <project-name>.tproj
- The Previous project is imported to the new Project
After upgrading a project, you should Open it and execute a Run → Build operation, so the system verify all scripts in the new project file.
Running Projects
You can run a project in any of the following ways:
- Use the Run Project command button, or the Test Project
- Setup an Auto-Start option at the Server tab
- Start the execution manually after you open the Project for editing
Both Test Project and Run Project, will start the project execution. The difference is the Test Project will use any testing configuration created in the Project, such as alternate database connections, and other tools that simplify the development and validation cycle of the Project.
For more information, see User Guide → Running Projects.
In this section...| Page Tree | ||||
|---|---|---|---|---|
|
...