Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
maxLevel3
stylenone


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.

Image Added


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

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.


Provider and supported databasesImage Added


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

Easy Heading Macro
headingIndent40
navigationTitleOn this page
selectorh2,h3
wrapNavigationTexttrue
navigationExpandOptiondisable-expand-collapse

Start on this line. Remove this sample content, and paste your own content.

Use this section to define and discuss the topic of the document and give any relevant information pertaining to the document.  

Heading 2 for a New Section

Sub-Section Header Using Heading 3

Below is a Horizontal Rule to help divide sections. Put these above new sections that start with a "Heading 2" Section Title. 

Section Header using Heading 2

Sub-Section Header Using Heading 3

It's essential to link from one page to another and to specific sections on a page. You can add any URL to a Confluence page and Confluence will automatically detect it and turn it into a link.

If you paste the URL for another page in your Confluence site, Confluence will display the link text as the page name and turn it into a relative link, meaning if the name of the page changes, Confluence will adjust the link so it doesn't break.

Topic Header using Heading 4

Add and Link to Anchors

The anchor macro allows you to create anchors in your documentation, which can be linked to or from anywhere. 

To add a macro and link to it from the same page:

  1. Type {anchor in the editor, select the anchor macro and give your anchor a name
  2. Select the text that'll link to the macro and hit Ctrl+K (Windows) or Cmd+K (Mac) (this opens the link dialog)
  3. Choose Advanced from the options on the left and type # followed by your anchor name

Check the Confluence documentation for more information on how to use links and anchors.

If you want to anchor or link, make sure you correctly anchor or  link to another page or to a specific line of the document. Add the anchor immediately above the corresponding section title and/or link to the correct word or section. 

Adding Images

Be sure when adding images that they are very clear, especially if they contain text, and try to only capture a close up of the important thing you are referencing.  You may need to overlay a few screenshots depending on what you are doing.  If you need help capturing what you need ask for assistance as a different capture tool may help immensely.

Use the "Insert files and images" tool at the top to insert an image.

Then, be sure to click the "Original" button, and the "Border" button.  The Original button will ensure the image is sized as the original, which should have be large enough to read clearly.  If needed, you can adjust the size after that, but larger is okay if it helps clarity.  The border button will put a box around the image to help delineate it from the white background, which is really useful on some screen shots that also have a lot of white on the edge.

Useful macros

Use macros when needed to help draw attention to particular information. Here's a few:

Tip, Note, Info, Warning, and Panel Macros

Often when creating documentation, there are elements of a page that you want to highlight or draw the the viewers' attention to. Confluence ships with the Tip, Info, Warning, Note and Panel macros, which will help you focus a viewer's attention on a particular part of your content.

Use the tip macro to give your readers handy hints!

Tip
titleTip Item

Here is an example Tip Item.

Info
titleInfo Item

Here is an example Info Item.

Warning
titleWarning Item

Here is an example Warning Item.

Note
titleNote Item

And this is a Note Item.

Panel
borderColordarkslateblue
bgColorWhite
titleColorWhite
borderWidth2
titleBGColordarkslateblue
borderStylesolid
titlePanel Title

Here is some text you want to point out. Perhaps some text the user should expect to see on the screen after performing some function or click.

Be sure to add a ">" symbol before a line that is representing a system prompt, and bold the text a user should enter such as this:

> Enter your name: Roberto

If you have a clear screen shot, add the picture in that clearly shows the relevant details.

Here is a Code Block - Specify the language you're showing (C#, VB.NET, JavaScript, Python, etc)

Code Block
titleCode Block Example
linenumberstrue
[Language: C#]


[Language: VB.NET]


Here is a table you can use.

...

In this section...

...

root@parent