Overview
The Solution Settings interface provides a centralized location for configuring various aspects of your solution. Users can adjust parameters related to licensing requirements to run the solution, Python interpreter paths, among others. This page includes Solution Information, Target Platform and License, Solution Options, Modules in Runtime Process, and Python Interpreter.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
Solution Settings User Interface
Access the Solution Settings through Solution → Settings to tailor your solutions to specific requirements and ensure seamless integration with external systems. Here, you'll find the configuration options that apply to the entire solution and you can view and change the solution settings that you configured when you created the solution.
Solution Information: Includes solution information (read-only), such name, file size, description, solution path and tag counters for local and external.
Target Platform and License: Includes options to modify the solution's target platform and enables license customization, allowing you to select the best family and product model for your solution. You can also customize the historian license.
Solution Options: Defines runtime behavior, including language settings in "Culture Info," enabling client-side tasks for WPF applications, and activating diagnostic logging for system analysis.
Run Modules inside main Runtime process: Checkboxes allow the use of script-based tasks and enable the primary communication channel utilized for device interactions.
Python Interpreter: Users must specify the location of the Python interpreter when running Python scripts and tasks within the application. There are two options available: "Local," which refers to a Python installation on the user's machine, and "Server," which points to a Python installation on a remote server.
Settings Configuration
The Solution Settings navigation on Solution Explorer has general settings that applies to the entire Solution to assist the creating and maintenance of the solution. It includes:
Solution Information
Includes all the basic information about your solution.
Solution information |
|---|
About Project Settings and Utilties
Key Concepts and Terminology
* Target Platform* Target License* Categories* PlugIns
How to Use the Project Settings and Utilities
Verify the Target Platform Customize Settings, if needed Define Categories on large applications Import Tag Definions, when applicable Manage Project Plugins, when applicable Export the Project ConfigurationAccess the Project History
Configuring Project Settings
Configuring Categories
Working with the Utilities
Using Import WizardsManaging PlugInsExporting Project ContensUnderstaing the Project HistoryTroubleshooting and Best Practices
* Common Issues and Solutions* Best Practices and RecommendationsThe Project Settings page (Project → Settings) has the configuration options that applies to the entire project.
You can view and change the project settings that you configured when you created the project.
Project information | ||
|---|---|---|
Field | Description||
Description | A description for the projectsolution. | |
Project Solution Path | Read-only path to the projectsolution. | |
Tag Count | How many tags the project solution has. | Communication Points |
Help URL | This feature allows users to integrate additional support for their solution by adding Help URLs for knowledge bases and documentationHow many communication points the project has. | |
Target Platform and License
Provides an overview for understanding the capabilities and limitations of your selected solution.
Target Platform and License | Field | Description|||
|---|---|---|---|---|
Target Platform | Shows the target platform selected in the project solution creation procedure. | |||
Product Family | A basic description of the product families is Enterprise — Complete FactoryStudio functionality Edge HMI — Use for smaller applications and embedded systems. Express — Use only for test or demonstration purposes. IIoT Gateway — Create a project to work as an OPC server or Data Acquisition Gateway, providing data to other applications from the native protocol drivers. Changing the family settings may cause some configurations to be invalid. For example, some features are only available in the Enterprise version. | |||
ProductFamily and ProductModel | Go to Product Series for information about the options available. When deployment this solution to product, the Product Family and Model select must match your license. | Product Model | The product model is connected with the maximum number of real-time communication points you are allowed on that project. | Canary Historian |
Project Options | Field | Description|||
Solution Options
Here, the users can fine-tune the following configurations:
Solution Options | |
|---|---|
Culture Info | Select the target language for the runtime application. This setting controls the formatting of dates, numbers, and other information so they are in compliance with the selected language. It is possible to change this setting later. |
Allow Client Tasks (WPF only) | |
Enable Diagnostics Logging
Run Modules inside main Runtime process
Field
Description
Script Tasks
First Device Channel
Python Interpreter
Field
Description
Local
Server
This checkbox allows the execution of client-side tasks in WPF. | |
Diagnostics Log Files Location | This dropdown let's you define the location of diagnostic data, aiding in system analysis and troubleshooting. |
Retentive Database Settings
In the Solution Option, click on the gear icon next to the Retentive Database to open the Edit Database Connection popup window.
Edit Database Connection Popup window | |
|---|---|
Name | Defines the database connection name. |
Description | A brief overview informing the purpose or specifications of the database connection. |
Provider | Data providers serve as bridges between applications and specific types of databases. While some providers like ODBC and OleDb offer multi-database support, others like OracleClient, SQLClient, SQLite, and PostgreSQL are specialized for their respective databases. |
Database | The databases you can connect to will vary depending on the selected Provider. |
ServerIP | If the database you want to connect to isn't on the local computer, the ServerIP should be the IP address or network name of the computer with the database. If a tunneling service is required to access the remote computer, the TWebServices utility must be enabled and running on the remote computer. |
Test button | To test the connection. |
DataSource | Displays the configuration string used to connect to the SQLite database. This string specifies the file path and name of the database file, directing the system to the correct database location. The format typically follows "Data Source =ExecutionPathAndName.dbRetentive". |
Password | The security key to authenticate and access the database. |
Run Modules Inside Main Runtime Process
Here, the users configure the solution settings related to module executions.
Solution Options | |
|---|---|
Script Tasks | Enables script-based tasks on the solution. |
First Device Channel | Selects the primary route for communication between a software application and connected devices, ensuring a stable and reliable exchange of data and commands. |
Python Interpreter
Specifies the folder where the Python interpreter is installed.
Python Interpreter | |
|---|---|
Local | Defines the path for Python installation folder on the local machine. |
Server | Defines the path for Python installation folder on the remote server. |
In this section:
| Page Tree |
|---|
One interesting feature in the software platform is the ability to use Categories to organize and group items on runtime, such as variables, alarms, and trends. Here is how you can use Categories:
Create a Category
To create a category, go to the Project Explorer, right-click on the Categories folder, and select "Add Category". Give the category a name and description, then click OK.
Assign Items to Categories
To assign items to a category, select the item in the Project Explorer, go to the Properties window, and select the Category tab. From there, you can select the category you want to assign the item to.
Display Categories on the runtime
To display categories on the runtime, you can use the Category Navigator widget. To add the Category Navigator widget, go to the Toolbox, select the Category Navigator widget, and drag and drop it onto the runtime screen.
Organize the Display of Categories
You can customize the display of categories on the runtime by adjusting the properties of the Category Navigator widget. For example, you can set the width and height of the widget, change the font size and color, and specify the order in which categories are displayed.
By using Categories you can organize and group items on runtime, making it easier to manage and navigate through large and complex projects.
You can create a dictionary of Categories to allow classification of engineering objects. Most configuration tables have the Category column, where you can apply one or more categories to that object.
Create user-defined categories labels that you can use as tag metadata. Categories are useful for filtering when creating the project and during runtime.
- Go to Project → Categories.
- Add and edit the desired categories for this project.
In order to apply a Category to a Tag or any other object:
- Open the DataGrid Configuration Table for that object.
- Set the column Category to be visible.
- Edit the contents of that column. It is possible to select multiple rows.
Using Categories on Runtime
The object categories can also be accessed during runtime for filtering and other custom applications from Category.
A list of all the categories that are defined in the project during runtime is available in the property Server.Categories.
In this section...
| Page Tree | expandCollapseAll | true|
|---|---|---|
|