Application Options (DATAFLOW Designer)
by Marco Wuelser
The Application Options contain local settings for the computer the DATAFLOW Designer is installed on. These options will be used independent from any open solution.
Note: These options will not be saved inside of a solution. This allows each user of the DATAFLOW Designer to customize the application it its needs.
Open Application Options Dialog
The Dialog to edit the Application Options can be shown in the following ways:
   |
Press Ctrl + Alt + J on the Keyboard |
 |
Click the 'Options' button in the file menu |
 |
Click the 'Options' button in the View ribbon |
Dialog Actions
 |
The Dialog can be closed by pressing the ESC key on the keyboard, the Cancel button or the Cross Button in the top right corner. This will discard all changes. |
 |
|
 |
|
 |
The Confirm button will save all changes and close the dialog. |
 |
The Apply button will save all changes, but the dialog will not be closed. |
Option Groups
The Application Options are organized in groups of pages.
The following groups exist:
- Environment: Contains settings for the local DATAFLOW installation.
- Account: Manage the DATAFLOW account and license
- Package: Manage installed Runtime Packages.
Option Pages
In this section, all options for each page are explained.
General Page
The general options influence the behavior of the DATAFLOW Designer application as a whole.
Group: Environment
Required Module: DATAFLOW Designer
|
Autosave |
Enabled/Disables Autosave of the open solution. |
|
Autosave Interval |
The Autosave interval in Minutes (if Autosave is active). |
|
Default Path for New Solution |
This path will be used as a default whenever the user creates a new solution. To change the path, click the [...] button on the right of the option. |
|
DATAFLOW Server |
The DATAFLOW server, which can be changed |
|
UI Theme |
Defines the UI Theme to be used for the application. There is a light and a dark theme available. |
Editor Page
The Editor page allows to customize the behavior of the DATAFLOW Designer Editor windows.
Group: Environment
Required Module: DATAFLOW Designer
The page contains multiple groups of options which are explained below.
General
|
Build Complete Notification |
If enabled, a dialog is shown when the code generation is completed with a success or failure message. |
Tree View
|
Double Click Action |
Defines the action to be executed when an entry in a tree view is double clicked. |
|
Ctrl + Click Action |
Defines the action to be executed when an entry in a tree view is left clicked with the Ctrl key pressed at the same time. |
Diagram Editor
|
Double Click Action |
Defines the action to be executed when an entry in a tree view is double clicked. |
|
Ctrl + Click Action |
Defines the action to be executed when an entry in a tree view is left clicked with the Ctrl key pressed at the same time. |
Source Code Editor
|
Tab Size |
Defines the number of spaces used for a single tab. |
| Tabs Replaced by Spaces | Whenever a tab is inserted by the editor, a number of spaces is inserted instead (see Tab Size). |
| Use External Editor | If checked, source code is opened in an external editor instead of the build in source code editor. |
External Source Code Editor
This group is only shown when the Use External Editor checkbox is checked.
|
External Editor |
This must contain an absolute path to the external source code binary that shall be called when the user opens a source code file in DATAFLOW Designer. To change the path, click the [...] button on the right of the option. |
| Arguments | All arguments in this option will be passed to the external editor |
| Show Read Only Files |
When this checkbox is checked, all files that belong to the edited element will be opened in the external editor. When unchecked, only files meant to be changed will be opened. Any read only file will be omitted. |
Update Page
The Update page is used to check for available updates of the DATAFLOW Software.
Group: Environment
Required Module: Any
|
Check for Update URL |
Contains the URL of the JSON file to check for new updates. This option is read only for all DATAFLOW Server settings except for 'Custom'. Do not change this if not told to do so by IMT AG. |
| Installer URL |
Contains the URL of the DATAFLOW Installer binary to download and execute. This option is read only for all DATAFLOW Server settings except for 'Custom'. Do not change this if not told to do so by IMT AG. |
| Auto Check on Startup | If checked, an update check is executed whenever DATAFLOW Designer is started. |
| Check for Updates |
When this button is clicked, a check for updates is executed immediately. |
Path Macro Page
The path macro page allows the user to view and edit path macros for the Application.
Group: Environment
Required Module: DATAFLOW Designer
| Table | This table shows all path macros. System macros are read only and can not be changed. User macros can be edited using the buttons below. |
| Add | When this button is clicked, a new macro is added to the table. |
| Remove | When this button is clicked, the selected macro is removed from the table. |
| Edit |
When this button is clicked, the selected macro is shown in a dialog so that the user can modify its value. |
Create/Edit Path Macro Dialog
| Scope |
The scope of the macro defined where it will be stored. Application macros will be stored on the local machine and affect all solutions opened on this machine. Solution macros will be stored in the Solution and affect all projects in this solution. Project macros will be stored in the project (inside the solution) and will affect only a single project. |
| Name | The name of the macro. It must be unique and not be empty. |
| Is File Path |
If checked, the path must point to a file. If unchecked, the path must point to a directory instead. |
| Content |
The actual path. To change the path, click the [...] button on the right of the option. |
Presets Page
The Preset Page is used to define initial values for created elements in the editor.
Group: Environment
Required Module: DATAFLOW Designer
The page contains multiple groups of options which are explained below.
System Design
| System Component Name | This name is used as initial name for any system component created. |
| Spacer Label | This text is used as initial label for any spacer created. This can be empty to create empty spacers by default. |
| Element Width | Initial with of all created element in system and software design. |
Software Design
| Name | This name is used as initial name for any active part created. |
| Implementation Type | This value defined the initial implementation type for any active part created. |
| Priority | This value is used as the initial priority for any active part created. |
| Stack Size | This value is used as the initial stack size for any active part created. |
| Time Slice | This value is used as the initial time slice for any active part created. |
| Core Affinity | This value is used as the initial core affinity type for any active part created. |
Note: Stack Size, Time Slice and Core Affinity are only used by certain DATAFLOW Runtime types for RTOS target platforms. This value should be left on the default value when no such runtime is used.
| Name | This name is used as initial name for any active interrupt created. |
| Interrupt Handler Name |
This name is used as initial name for the interrupt handler added to a new active interrupt. |
| Name | This name is used as initial name for any active container created. |
| Routing Mode | This value defined the initial priority for any active part created. |
| Source/Sink Label |
This text is used as initial label for any source/sink created in the model by drag and drop from the toolbox. Note: When source/sink is created from an existing channel, the name of the assigned protocol is used instead. |
| Hide Terminator in Toolbox | When checked, the Terminator element is not shown in the Toolbox window. |
| Input Name | This name is used as initial name for any input port created. |
| Output Name | This name is used as initial name for any output port created. |
| Oneshot Timer Name | This name is used as initial name for any oneshot timer created. |
| Oneshot Timeout | This value is used as the initial timeout for any oneshot timer created. |
| Periodic Timer Name | This name is used as initial name for any periodic timer created. |
| Periodic Interval | This value is used as the initial interval for any periodic timer created. |
| Autostart Peridoic Timer | When checked, any periodic timer created will be set to autostart by default. |
| Variable Timer Name | This name is used as initial name for any variable timer created. |
| Hide Variable Timer in Toolbox | When checked, the variable timer element is not shown in the Toolbox window. |
Note: The DATAFLOW Designer will ensure unique component and element names. When creating multiple elements in the same parent element, a number will be appended to the name above.
Data Type Design
| Enumeration Name | This name is used as initial name for any enumeration created. |
| Custom Type Name | This name is used as initial name for any custom type created. |
| Struct Name | This name is used as initial name for any struct created. |
| Protocol Name | This name is used as initial name for any protocol created. |
| Signal Name | This name is used as initial name for any signal created. |
| Type Group Name | This name is used as initial name for any type group created. |
Note: The DATAFLOW Designer will ensure unique name. When creating multiple data types in the same type group, a number will be appended to the name above.
Account Page
The Account Page shows information on the signed in user and allows to sign out and change the password.
Group: Account
Required Module: Any
| API Endpoint URL |
Contains the URL of the API Endpoint used to sign in and retrieve DATAFLOW licenses. This option is read only for all DATAFLOW Server settings except for 'Custom'. Do not change this if not told to do so by IMT AG. |
| This field shows the E-Mail address of the signed in user according to the DATAFLOW Account used. This is read only and can only be changed by IMT AG. | |
| First name | This field shows the first name of the signed in user according to the DATAFLOW Account used. This is read only and can only be changed by IMT AG. |
| Last name | This field shows the last name of the signed in user according to the DATAFLOW Account used. This is read only and can only be changed by IMT AG. |
| Change Password |
This will show a dialog to change the DATAFLOW Account password for the current user. |
| Sign Out |
This will show a dialog to sign out the current user. This will force a restart of DATAFLOW Designer. Make sure all data is saved. |
License Page
The license page allows to manage the licenses for the signed in user.
Group: Account
Required Module: Any
| Table | This table shows all licenses found for the signed in user. |
| Activate | When this button is clicked, the given license is activated to be used on this computer. |
| Deactivate | When this button is clicked, the given license is deactivated. |
| Refresh List | When this button is clicked,the list is updated with the most recent data from the DATAFLOW Server. |
Company Licenses Page
The company license page allows to manage the floating licenses of your company.
Group: Account
Required Module: Any
This page is only shown if the signed in user account has been designated as company license manager. In this case, the user can manage floating licenses of the company using this page.
| Company Name | Shows the name of the company licenses are managed for. (Read only). |
| Table | Lists all floating licenses found with the data of the issue and las use. |
| Release | When this button is clicked, the given license is released. This will allow any user to claim this license when signing in. The current user of the license is also forced to sign in again. |
| Refresh List | When this button is clicked,the list is updated with the most recent data from the DATAFLOW Server. |
| Relase All Licenses | When this button is clicked, ALL floating licenses will be released as explained above. |
Package Page
The Package Page shows all installed Project Generator packages and allows to add and remove packages.
Group: Package
Required Module: DATAFLOW Frame
| Table | This table shows all installed packages for project generation. Packages can be sorted according to type, language, platform and version. |
| Selected Package | Shows details on the selected package. (Read only) |
| Install Packages | When this button is clicked, a file dialog allows to select one or more valid DATAFLOW packages to be installed. |
| Uninstall Selected Packages | When this button is clicked, all packages checked in the table will be removed from the application. |
Note: Add/Remove packages will affect all installations of DATAFLOW software on this computer.
This Article has been written based on V2.0.1 of the DATAFLOW Designer software.
Latest update 2022-04-09 by WUE.