| 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.
The tool utilized for selecting and opening a project is known as Projects Management.
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
The Projects Management tool the first interface you see when you start the platform, running the Projects.exe application. This user interface allows to create, open, edit and run projects located in your computer or remote ones.
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.
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 selector | Selector box | Allows choosing the user interface language. |
View selector | List view option Cards view option Table view option | Selects how project list will be exhibited. |
Refresh | Icon | Refreshes project list. |
Notifications | Icon | Opens notifications box. |
Notifications | Text box | Shows notifications. |
Help | Text box | Shows useful tips. |
Search project | Search box | Searches project in the project selector. |
New | Command button | Opens 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 Runtime Environment for more information on testing and startup profiles. |
Project View Selector
The middle box is called Project Selector 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.
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 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:
Your License
Your License presents information about the software license. There are flexible options for licensing according to each business' needs.
| Info |
|---|
| See Managing Licenses for more information. |
Find Projects
Clicking Finding Projects 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 for 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.=================================
Project Management interface
Project Management Interface
The Project 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 view project configurations.
License Information
The license information section displays your current license information, including any limitations or restrictions on the number of projects or concurrent users.
License Management
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.
Find Projects
The Find Projects section displays the Project Server information, allowing you to quickly access your projects and their configurations.
Project Server
Clicking on the Project Server shortcut will take you to the Project Server settings page where you can manage your project server settings and configurations.
Language and Project Selector
The Language and Project Selector sections allow you to choose the user interface language and select a project to work on.
View Selector
The View Selector section allows you to choose between List, Cards, and Table view options for your project list.
Refresh and Notifications
The Refresh icon allows you to refresh your project list, while the Notifications icon and text box display any notifications or alerts.
Help and Search Project
The Help text box provides useful tips, while the Search Project box allows you to search for projects in the project selector.
New, Edit, View, and Run Buttons
The New button opens the New Project wizard for creating a new project, while the Edit button opens an existing project for editing. The View button opens an existing project in read-only mode. Finally, the Run button starts the selected project in startup production mode.
By using the Project Management interface, you can easily manage and organize your FactoryStudio projects to streamline your workflow and increase productivity.
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.
New Project Wizard
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 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. See Managing Projects.
=================================
Target Platform:
When creating a new project, you will need to select a target platform. The options available are typically specific to the development environment you are working with, and may include options such as a desktop application, a web application, or a mobile app. The choice you make will depend on the type of application you are building and the platform you want to deploy it to. It is important to carefully consider which option is best for your needs, as it can impact the development process and the end user experience.
Product Family and Product Model:
After selecting a target platform, you will need to choose a product family and product model. The product family is a group of related products, and the product model refers to a specific version of a product within that family. These options are important because they determine the functionality that will be available in your application, and what features and modules can be used. Examples of different product families and models include controllers, gateways, and sensors. When selecting these options, consider the specific requirements of your application and the functionality you need to build.
Project Templates:
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.
Folder Structure:
Organizing your projects into folders is an important part of project management. It is important to keep local and remote projects separate, as this can help to prevent issues with access and security. When creating a new project, be sure to select the appropriate folder location to ensure that it is stored in the correct location. This will make it easier to manage and access your projects over time.
License Information:
The license you have for your development environment will affect the product model options available to you. Depending on the license level, there may be limitations on the number of real-time communication points you are allowed on a project. Be sure to check the license information to ensure that you are selecting the appropriate product model for your needs.
Canary Historian:
Canary Historian is a module that is used to store historical data for your application. When configuring Canary Historian, you will need to select the number of tags that will be stored. This will depend on the size of your application and the amount of data that needs to be stored. Be sure to carefully consider your data storage needs when configuring Canary Historian.
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.=================================
Opening an existing project:
To open an existing project in the Project Management interface, follow these steps:
Launch the platform and navigate to the Project Management interface.
Locate the project file you wish to open. This can be done by browsing through the folders on your local or remote file system.
Select the project file by clicking on it once.
Click the "Open" button to open the project in read-only mode, or the "Edit" button to open it for editing.
Project modes:
The platform offers two project modes: read-only and edit. The read-only mode allows you to view the project configuration without the ability to make changes, while the edit mode enables you to modify the project settings. It's important to note that read-only mode may be required in certain situations, such as when the project is in use by another engineer or when the project has security projections enabled. To switch between modes, simply click on the "Edit" or "View" buttons in the Project Management interface.
When in read-only mode, you can still perform actions such as executing the project or exporting project information to a file. In edit mode, you can make changes to project settings such as tag definitions, alarms, and displays.
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 Runtime Environment. |
Running projects:
What happens when a project is run?When a project is run, the modules and functions within the project are executed. This typically involves connecting to various data sources, processing data, and updating visual displays. The exact sequence of events will depend on the specific project configuration and the actions defined within it.Prerequisites and requirements for running a project
Before running a project, it's important to ensure that all necessary components are installed and configured correctly. This may include software modules, drivers, or other dependencies required by the project. It's also important to ensure that any required hardware, such as PLCs or sensors, are connected and configured properly.Troubleshooting tips for running a project
If a project is not running as expected, there are several troubleshooting tips to try. First, check the project logs for error messages or other warnings. These can often provide clues as to what may be causing the issue. It may also be helpful to check the system logs and event viewer for any related errors or issues.
If the problem persists, it may be necessary to troubleshoot specific modules or functions within the project. This may involve checking configuration settings, testing data sources, or reviewing code for errors.
Steps for stopping, pausing, and resuming a running projectTo stop or pause the execution of a running project, use the appropriate button in the toolbar or menu. This will typically be labeled "Stop" or "Pause". To resume the project, use the "Resume" button.
It's important to note that stopping a project may result in data loss or other unintended consequences. Before stopping a project, ensure that any necessary data is saved or backed up.
Limitations and restrictions on running projectsThere may be limitations or restrictions on the number of concurrent projects that can be executed at once. This will depend on the specific licensing agreement and system configuration. It's also important to ensure that the system hardware and software meet the minimum requirements for running projects. Failure to do so may result in performance issues or other errors.
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.
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"=================================
FactoryStudio Best Practices
FactoryStudio is a powerful platform for building industrial automation and SCADA solutions. To make the most of this software, it's important to follow best practices that can help ensure your projects are efficient, reliable, and easy to maintain. Here are some guidelines to consider when working with FactoryStudio:
Planning and Design
Before you start developing a FactoryStudio project, take the time to plan and design the system. This includes defining the scope of the project, creating a functional specification, and determining the requirements for the user interface, data collection, and alarm management.
Modularization
Modularization is an important best practice in FactoryStudio. It involves breaking down the project into smaller, more manageable modules that can be developed and tested independently. This approach makes it easier to debug and maintain the project, as well as reuse modules across different projects.
Version Control
Using version control software is essential when working on FactoryStudio projects. This allows you to track changes, revert to previous versions, and collaborate with other team members more effectively. Git is a popular version control system that integrates well with FactoryStudio.
Documentation
Creating documentation for your FactoryStudio projects is crucial for ensuring that other team members can understand and maintain the project over time. Make sure to document the project structure, module dependencies, data sources, and other important aspects of the project.
Testing and Debugging
Testing and debugging are essential steps in the development process. Make sure to thoroughly test each module and the system as a whole before deploying it. Debugging tools such as breakpoints, watches, and log files can help you identify and fix issues quickly.
Security
Security is a critical consideration when building automation and SCADA systems. Make sure to follow best practices for network security, password management, user access control, and data encryption. FactoryStudio includes built-in security features such as user authentication and role-based access control.
Performance Optimization
Optimizing the performance of your FactoryStudio projects can help ensure that they run smoothly and efficiently. Consider using techniques such as caching, indexing, and data compression to improve performance. Also, make sure to monitor system performance regularly to identify and address any issues.
By following these best practices, you can build reliable, efficient, and secure FactoryStudio projects that meet the needs of your organization.
In this section...| Page Tree | ||||
|---|---|---|---|---|
|
...