Overview
The Solution Settings interface page provides a centralized location configuration 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-wide parameters including platform targeting, licensing, runtime options, and interpreter settings.
Access: Solution → Settings
Parent Page: Solution Module (Reference)
Settings Sections
Solution Information
Read-only information about the current solution:
| Field | Description | Example |
|---|---|---|
| Name | Solution filename | MyProject |
| File Size | Database size | 45.2 MB |
| Description | User-defined text | Production monitoring system |
| Solution Path | Full file location | C:\Solutions\MyProject.dbsln |
| Tag Count | Local tags | 1,234 |
| External Tags | From TagProviders | 567 |
| Help URL | Custom documentation | https://docs.company.com |
Target Platform and License
Core deployment configuration:
| Setting | Options | Impact |
|---|---|---|
| Target Platform | Windows Only / Multiplatform | Framework and OS support |
| Product Family | FrameworX / FactoryStudio / EdgeMachine / EdgeConnect | Feature set |
| Product Model | 150 / 300 / 500 / 1500 / 5000 / Unlimited | Point limits |
Solution Options
Runtime behavior settings:
| Option | Description | Default |
|---|---|---|
| Culture Info | Language/locale | en-US |
| Allow Client Tasks | WPF client-side execution | Unchecked |
| Diagnostics Location | Log file path | Local |
Retentive Database Settings
Click gear icon to configure:
| Field | Description | Options |
|---|---|---|
| Provider | Database type | SQLite, SQL Server, PostgreSQL |
| Database | Database name | Solution.dbRetentive |
| ServerIP | Remote server | localhost or IP |
| Password | Authentication | Optional |
Run Modules Inside Main Process
Performance optimization:
| Module | Purpose | Default |
|---|---|---|
| Script Tasks | Enable scripts | Checked |
| First Device Channel | Primary communication | Checked |
Python Interpreter
Python integration paths:
| Path Type | Description | Example |
|---|---|---|
| Local | Client machine | C:\Python39 |
| Server | Server machine | /usr/bin/python3 |
Provider Support
Database Providers
| Provider | Databases Supported | Use Case |
|---|---|---|
| ODBC | Multiple via DSN | Legacy systems |
| OleDb | Multiple via connection | Windows databases |
| SQLite | SQLite files | Embedded/local |
| SQLClient | SQL Server | Enterprise |
| PostgreSQL | PostgreSQL | Open source |
| OracleClient | Oracle | Enterprise Oracle |
Configuration Guidelines
Platform Selection
Windows Only - Choose when using:
- Windows Authentication
- OPC Classic
- Canary Historian
- Windows-specific .NET libraries
Multiplatform - Choose when:
- Deploying to Linux
- Using Docker containers
- Cross-platform requirement
- Cloud deployment
License Configuration
Must match production license:
| If License Is | Set Family To | Set Model To |
|---|---|---|
| FrameworX-5000 | FrameworX | 5000 |
| FactoryStudio-1500 | FactoryStudio | 1500 |
| EdgeMachine-300 | EdgeMachine | 300 |
Culture Info Settings
| Culture | Format Example | Use For |
|---|---|---|
| en-US | 12/31/2024, $1,234.56 | US English |
| pt-BR | 31/12/2024, R$ 1.234,56 | Brazilian Portuguese |
| de-DE | 31.12.2024, 1.234,56 € | German |
| ja-JP | 2024/12/31, ¥1,234 | Japanese |
Best Practices
Initial Setup
- Set Target Platform before development
- Configure Product Model to match license
- Set Culture Info for target locale
- Configure Python if using scripts
Retentive Database
- Use SQLite for standalone
- Use SQL Server for enterprise
- Test connection before saving
- Document connection string
Module Execution
- Enable Script Tasks if using scripts
- Enable Device Channel for communications
- Consider performance impact
- Monitor resource usage
Troubleshooting
| Issue | Cause | Solution |
|---|---|---|
| Platform grayed out | Solution has objects | Remove objects first |
| License mismatch warning | Wrong model | Match to actual license |
| Python scripts fail | Wrong path | Verify interpreter location |
| Database connection fails | Wrong credentials | Test connection |
See Also
- Solution Module (Reference) - Parent module
- Product Series - License details
- Python Integration - Script configuration
Solution Information
Includes all the basic information about your solution.
Solution information | |
|---|---|
Description | A description for the solution. |
Solution Path | Read-only path to the solution. |
Tag Count | How many tags the solution has. |
Help URL | This feature allows users to integrate additional support for their solution by adding Help URLs for knowledge bases and documentation. |
Target Platform and License
Provides an overview for understanding the capabilities and limitations of your selected solution.
Target Platform and License | |
|---|---|
Target Platform | Shows the target platform selected in the solution creation procedure. |
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. Check Managing Licenses for more information. |
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)
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
In this section:
| Page Tree | ||
|---|---|---|
|
...