Difference between revisions of "OtfSettings"

From emotive
Jump to navigation Jump to search
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Open Test Framework - OTF Settings (OTF Options menu)}}[[Category:OTF]]
 
{{DISPLAYTITLE:Open Test Framework - OTF Settings (OTF Options menu)}}[[Category:OTF]]
−
{{FontColor|red||EDITING...}}
+
 
 
== Overview ==
 
== Overview ==
−
The '''OTF Settings''' enables you to configure the default settings for the OTF working environment. <!--For example, you can establish a default save location for your OTX documents, alter the default appearance and behavior of windows, and create shortcuts for commonly used commands. There are also options specific to your development language and platform.-->
+
The '''OTF Settings''' enable you to configure the default settings for the working environment of the OTF. You can configure the general settings such as establishing the default location for your OTX solutions, or enabling the function to restore the last opened solution and procedures, or changing the development platform ect.
  
 
You can access the OTF Settings by selecting the "'''File'''" tab of the [[OtfMenuBar|Ribbon]] and then selecting the "'''Options'''" entry, the OTF Options dialog box will be displayed to configure the OTF settings. The OTF Options dialog box contains several pages that are accessed through tabs on the left-hand side. By clicking a tab on the left pane (e.g. "'''General'''", "'''OTX Runtime System'''" ect.) you can access the corresponding settings page on the right pane. You can adjust the settings in many pages and click "'''OK'''" button, and all the changes will be saved.
 
You can access the OTF Settings by selecting the "'''File'''" tab of the [[OtfMenuBar|Ribbon]] and then selecting the "'''Options'''" entry, the OTF Options dialog box will be displayed to configure the OTF settings. The OTF Options dialog box contains several pages that are accessed through tabs on the left-hand side. By clicking a tab on the left pane (e.g. "'''General'''", "'''OTX Runtime System'''" ect.) you can access the corresponding settings page on the right pane. You can adjust the settings in many pages and click "'''OK'''" button, and all the changes will be saved.
  
 
The introduction and guidelines for each settings page are described in the following sections.
 
The introduction and guidelines for each settings page are described in the following sections.
−
<!--
 
−
The Options dialog box enables you to configure the integrated development environment (IDE) to your needs. For example, you can establish a default save location for your projects, alter the default appearance and behavior of windows, and create shortcuts for commonly used commands. There are also options specific to your development language and platform
 
  
−
user comfort such as interface languages, start settings, save settings, such as which displayed language, how to load the lastest solution
+
== '''General''' settings ==
 +
{|
 +
| style="vertical-align:top; text-align:justify;"|
 +
This page contains the following sections which allows you to customize the general settings for the&nbsp;working&nbsp;environment of the&nbsp;OTF:
 +
 
 +
=== Interface language ===
 +
In this section, you can select the display language in the OTF. The default is "'''English'''". At&nbsp;present, the OTF only allows you to switch between "'''English'''" and "'''Deustch'''" (German).
 +
{{Note|The OTF must be restarted for the changes to take effect completely!}}
  
−
user comfort
+
=== Start settings ===
 +
This section allows you to configure the behavior when starting OTF and when switching between the [[OtfWorkflowDesigner|designer]] and the [[OtfOtlEditor|OTL editor]].
  
−
affect
+
Below are the options in this section:
−
-->
+
* '''Automatically load the last Solution''' check box:
 +
*: The OTF remembers the last opened solution when the OTF is closed. This check box enables (checked) or disables (unchecked) automatically loading the last opened solution when the OTF is started (checked) or not (unchecked). If no solution is opened when the OTF is closed, it shall not load any solution when it is started again.
 +
* '''Restore the last opened procedures''' check box:
 +
*: The OTF remembers the last opened tabs of a solution such as procedure tabs, OTL editor tabs, player monitor tabs, Overview tab, Instruction tab etc. This check box enables (checked) or disables (unchecked) automatically loading the last opened tabs when the solution is loaded.
 +
* '''Display warning message before clearing the Undo/Redo buffer''' check box:
 +
*: This check box allows to show a warning dialog when you make changes in an [[OtfOtlEditor|OTL editor]] and switch to another tab e.g. procedure tab. The dialog warns that the changes in the OTL shall clears all the current Undo/Redo buffers of all the [[OtfWorkflowDesigner|workflow designers]]. Unchecking this check box shall hide the warning dialog.
  
−
== "General" settings page ==
+
=== Save ===
−
{|
+
In this section, you can set the default storage location for the OTX solutions. You can also enable or disable creating copy backups of the OTX documents, see the "General" settings page of the [[OtfProjectSettings|Project Settings]]. The check box "Export old PTX-1 format" allows you to export a project into the old version PTX library to use with the older version of OTF.
−
| style="vertical-align:top; text-align:justify;"|
 
−
In this page contains the following sections which allows you to customize general settings of&nbsp;the&nbsp;OTF working environment:
 
−
* '''"Interface language"'''
 
−
:In this section, you can select the display language in the OTF. The default is "English". At&nbsp;present, the OTF only allows you to switch between "English" and "Deustch"(German).
 
−
{{Note|The OTF must be restarted to see the effect of the language change completely.}}
 
−
* '''"Start Settings"'''
 
−
:This section allows you to enable or disable loading the last loaded solution when starting the OTF. You also can enable or disable loading the last opened procedures when loading a solution.
 
  
−
* '''"Save"'''
+
{{Note|Note that if you check the "Export old PTX-1 format" check box, the "Security - PTX" section below shall be disabled, also the "Security" section of the [[OtfProjectSharing#PTX_Export_Manager|Export Manager]].}}
−
:In this section, you can set the default storage location for the OTX solutions. You can also enable or disable creating copy backup of the OTX documents, see the "General" settings page of the [[OtfProjectSettings|Project Settings]]. Here you can also configure to save the AdminData as a separate file or as inline data in the OTX documents.
 
  
−
* '''"Sequence Designer"'''
+
=== Save - PTX ===
−
:The name of the activities are optional. This section allow you to enable or disable automatically creating unique name for the new activities.
+
This section allows you to configure the settings for exporting PTX/PPX libraries.
  
−
* '''"Runtime Validation"'''
+
Below are the controls in this section with their descriptions (according to their positions from top to bottom):
−
:Everytime a procedure is executed, it shall automatically validate all the related projects (the current project i.e. the project containing the procedure, the referencing or referenced projects of the current project). If there are still any errors, the procedure shall not be executed. This section allows you to enable or disable this function of OTF.
 
  
−
* '''"XSL Stylesheet Support"'''
+
{|{{TableHeader}}
−
:An OTX document can be viewed in a web browser such as Internet Explorer or FireFox. To achieve this, you must embed a stylesheet in the documents. This section will allows you to embed (or clear) the stylesheet in all the documents of the current solution. Remember that you must first copy the "OtxDocumentXslt.zip" archive file into the global program data directory "C:\ProgramData\Emotive\Open Test Framework\" (see [[???]] for more information).
+
|- style="background: gray; color: white; vertical-align:top;'''"  
 +
| '''Control'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; || '''Description'''  
 +
|-{{TableRow1}}
 +
| '''OTX files''' check box{{TooltipIcon2|This entry shall be automatically checked and disabled (can not be unchecked) if both the binaries for Dotnet and Java check boxes are not checked.}} || Enables to include the OTX folder containing all OTX files in the PTX library (checked) or not (unchecked) when exporting a project.
 +
|-{{TableRow2}}
 +
| '''Runtime settings''' check box{{TooltipIcon2|This check box can not stand alone, it must be checked with the OTX files check box or with one of the binaries check box.}} || Enables to include all '''emotive''' specific project settings in the PTX library (checked) or not (unchecked) when exporting a project.
 +
|-{{TableRow1}}
 +
| '''Runtime-optimized binaries for DotNet''' check box || Enables to include the Output folder containing the compiled and executable binaries for DotNet runtime in the PTX library (checked) or not (unchecked) when exporting a project.
 +
|-{{TableRow2}}
 +
| '''Runtime-optimized binaries for Java''' check box || Enables to include the Output folder containing the compiled and executable binaries for Java runtime in the PTX library (checked) or not (unchecked) when exporting a project.
 +
|-{{TableRow1}}
 +
| '''Referenced projects''' combo box || Allows to select a behavior with the externally referred PTX files.
 +
|-{{TableRow2}}
 +
| '''Store APPs inside project''' check box || Enables to copy all the referred external applications (from [[OtfSettings#OTX-Mapping_section|the central application folder]]) into the PTX/PPX library (checked) or not (unchecked) when exporting a project.  
 +
|-{{TableRow1}}
 +
| '''Open dialog when exporting''' check box || Enables to display the "PTX Export Manager" dialog (checked) or not (unchecked) when exporting a project into a PTX/PPX file.
 +
|}
  
−
* '''"ODX Database"'''
+
=== Security - PTX ===
−
:In this section, you can enable or disable the "'''ODX Database Synchronization'''" function which allows you to synchronize the ODX Database of all the projects in a solution according to the startup project when the solution is loaded.  
+
This section allows you to configure the settings for PTX/PPX library encryption.
  
−
* '''"Others"'''
+
Below are the controls in this section with their descriptions (according to their positions from left to right and top to bottom):
−
:In this section, you can set the prefix for the copy of an element in the OTF (within the [[OtfSolutionExplorer|Solution Explorer]] or the [[OtfWorkflowDesigner|Workflow Designer]]). Everytime you copy and paste an element, the name of the copy element will be preceded by the prefix. If you do not prefer the prefix, just leave it empty.
 
  
−
| style="width:30px;" |
+
{|{{TableHeader}}
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsGeneral.png|450|...}}
+
|- style="background: gray; color: white; vertical-align:top;'''"
 +
| '''Control'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; || '''Description'''
 +
|-{{TableRow2}}
 +
| '''Private key''' text box || Allows to specify a password to encrypt and/or sign the exported PTX/PPX library.
 +
|-{{TableRow1}}
 +
| '''Encryption''' check box''{{TooltipIcon2|This control is only enabled if the private key is not empty (i.e. there must be an input key).}} || Enables to encrypt the entire PTX/PPX file (checked) or not (unchecked) when exporting a project. The encrypted PTX/PPX file can only be opened by the OTX-Runtime API ([http://www.emotive.de/DeveloperReference/OtxRuntime DotNet]/[http://www.emotive.de/DeveloperReference/OtxRuntimeJava Java]).
 +
|-{{TableRow2}}
 +
| '''Protect ... with a checksum''' check box''{{TooltipIcon2|This control is only enabled if the private key is not empty (i.e. there must be an input key).}} || Enables to protect the PTX/PPX file against an encrypted checksum (checked) or not (unchecked). The protected PTX/PPX file can be opened with the OTF or the OTX-Runtime API ([http://www.emotive.de/DeveloperReference/OtxRuntime DotNet]/[http://www.emotive.de/DeveloperReference/OtxRuntimeJava Java]).
 +
|-{{TableRow1}}
 +
| '''Has Algorithm''' combo box''{{TooltipIcon2|This control is only enabled if the private key is not empty (i.e. there must be an input key).}} || Allows to select the [https://en.wikipedia.org/wiki/Cryptographic_hash_function#Cryptographic_hash_algorithms hash algorithm].
 
|}
 
|}
  
−
== "OTX Runtime System" settings page ==
+
=== Temporary Files ===
−
{|
+
During the design time and run time, the OTF has to create some temporary files. This section allows you to clean up these temporary files from your computer free up lost space by using the "Clean up temporary files" button. You can also enable the function to automatically clean up these files after the OTF is closed by checking the corresponding check box below the clean up button.
−
| style="vertical-align:top; text-align:justify;"|
+
−
In this page, you can change the platform of the OTF. At present, the default and only supported platform of the OTF is DotNet (C#). The Java platform is comming.
 
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsOTXRuntimeSys.png|450|...}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OtfSetting_General.png|500|The "General" page allows for customizing general settings of&nbsp;the&nbsp;OTF working environment}}
 
|}
 
|}
  
−
== "Diagnostic Runtime System" settings page ==
+
== '''Runtime Environment''' settings ==
 
{|
 
{|
 
| style="vertical-align:top; text-align:justify;"|
 
| style="vertical-align:top; text-align:justify;"|
−
In this page, ...
+
This page allows you to set up some settings related to the run time environment. Below are the sections in this page.
 +
 
 +
=== Target Platform section ===
 +
This section allows to set the target platform for the run time of the OTF. You can select the Dotnet platform or Java platform with the "Target Platform" combo box.
 +
 
 +
=== Diagnostic Runtime System (MVCI-Server) section===
 +
Here you can find the name of the current Diagnostic Runtime System (MVCI-Server) used for the run time.
 +
 
 +
You can also open the [[OtfDiagnosicRuntimeSystem#MVCI_Server_Configuration_Program| MVCI-Server Configuration Program]] by clicking on the "Open..." button. In the [[OtfDiagnosicRuntimeSystem#MVCI_Server_Configuration_Program| MVCI-Server Configuration Program]], you can switch the current MVCI-Server to another one or modify the current MVCI-Server.
 +
 
 +
The check box of diagnostic runtime system offline working allows to execute the procedure without vehicle connection. No exceptions shall be thrown.
 +
 
 +
=== OTX Home... section ===
 +
The OTX search path (OTX-Home) determines the base directory to which all relative path specifications refer. In this section, you can enter the search path in the text box. The OTX search path can contain several directories separated by semicolons (";") and the placeholders "?" (One arbitrary character) and "*" (any characters). You can also use the placeholder "[ProjectDir]" (e.g. "[ProjectDir]/*"). Inside OTF "[ProjectDir]" corresponds to the project directory and in the OTX Runtime API to the directory in which the PTX or OTX or binary file (DLL, JAR) is located. When reading, the runtime environment takes each directory starting from the left as a base for relative paths. If the file is found, the search is canceled. The first directory is used for writing. It shall not contain wildcards. If no OTX search path is specified, the default value is "[ProjectDir];[ProjectDir]/..".
 +
 
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsDiagRuntimeSys.png|450|...}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OtfSetting_RuntimeEnvironment.png|500|The "Runtime Environment" page helps set up the target platform, the MVCI-Server and the OTX search path}}
 
|}
 
|}
  
−
== "MVCI Server of DSA GmbH" settings page ==
+
== '''Extensions''' settings ==
 
{|
 
{|
 
| style="vertical-align:top; text-align:justify;"|
 
| style="vertical-align:top; text-align:justify;"|
−
In this page, ...
+
In this page, you can find all the supported [[OtxReference#Extensions|OTX extensions]] with their licensing status. Only the full version license enables to show all of the extensions supported by the OTF.
 +
 
 +
The extensions are classified into 2 groups: the standard compliant extensions and the non-standard compliant extension (user defined extensions).
 +
 
 +
The extension settings help you hide the unused extensions in design time. To turn on or turn off an extension, please use the switch button at the left most of the corresponding extension. If an extension is turned off, the category related to that extension in the [[OtfToolbox|Toolbox]] window shall be hidden, and the related data types of the turned off extension shall not be displayed when creating or modifying a declaration, and all the entries related to that extension shall not be display in the [[OtfOtlEditor|OTL]] IntelliSense.
 +
 
 +
{{Note|The OTF still supports loading and running the OTX documents containing elements of turned off extensions. It only prevent to create new elements related to the turned off extensions.}}
 +
 
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsDSAMVCIServ.png|450|...}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OtfSetting_Extensions.png|500|The "Extensions" page helps to manage the OTX and user-defined extensions}}
 
|}
 
|}
  
−
== "MVCI Server of RAV GmbH" settings page ==
+
== '''Addins''' settings ==
 
{|
 
{|
 
| style="vertical-align:top; text-align:justify;"|
 
| style="vertical-align:top; text-align:justify;"|
−
In this page, ...
+
An addin file (*.'''ota''') is a zipped and encrypted file containing all the necessary files to validate and build PTX/PPX libraries with the specific run time version and/or target environments. The addins can only be decrypted and unzipped by the OTF. After that, the addins must be started and used with the Builder Checker program which is described below.
−
| style="width:30px;" |
+
 
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsRACMVCIServ.png|450|...}}
+
The '''Addins''' setting page consists of a command bar and a gridview displaying all the imported addins. Please not that you can only select one addin at a time, the selected addin can be handled with the buttons in the command bar.
 +
 
 +
Below are the buttons in the command bar with their descriptions (according to their positions from left to right):
 +
 
 +
{|{{TableHeader}}
 +
|- style="background: gray; color: white; vertical-align:top;'''"
 +
| '''Button'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; || '''Description'''
 +
|-{{TableRow2}}
 +
| '''Add...''' || Opens a dialog to browse and add a new addin.
 +
|-{{TableRow1}}
 +
| '''Select as default''' || Sets the selected addin as the default addin. The default addin shall be displayed in the default addin combo box in the "Runtime Environment" tab of the [[OtfMenuBar|Ribbon menu]].
 +
|-{{TableRow2}}
 +
| '''Delete''' || Deletes the selected addin.
 +
|-{{TableRow1}}
 +
| '''Open selected Addin...''' || Opens the selected addin in the Builder Checker program.
 
|}
 
|}
  
−
<!--
 
−
{{Anchor|RuntimeEnv_Pg|}}
 
−
=="Runtime Environment" settings page==
 
−
{|
 
−
| style="vertical-align:top; text-align:justify;"|
 
−
This page consists of the 3 sections as follows:
 
−
* '''"General" (setting the runtime environment for screen signature)'''
 
−
:In this section, you can select a screen mapping file which maps the screen signatures in the project to external applications (forms) at runtime. If no screen mapping file is selected, all the screen signatures are automatically mapped with the default form (the generic screen) at runtime. You can find more information about the screen mapping file in the [[#HMI_Pg|"HMI" settings page]] below.
 
  
−
* '''"Executable File" (setting the executable file generation)'''
+
=== Builder Checker program ===
−
:In this section, you can specify how the executable file of the project is created. You can determine whether the executable file is '''created''' after building the project '''or not''' via the "'''ON/OFF'''" button. You also can set which procedure to be started in the executable file by checking the check-box before the procedure. If you check the "'''After starting the executable an output trace window opens'''" check-box, an "OTX Runtime Environment" window with the output trace is opened when the executable file is started; otherwise, no window occurs.
+
The '''Builder Checker''' program is zipped inside an addin. After the addin is unzipped by the OTF, the Builder Checker program depends on the unzipped files of the addin to run that addin. In other words, a Builder Checker is associated with the addin, and can not be seperated with the addin.
 +
 
 +
With the Builder-Checker Addin, runtime-optimized PTX and PPX files can be generated and validated for a specific version and/or target environments. This is required for environments, e.g. Embedded Linux, which do not have their own code generation.
 +
 
 +
The Builder Checker program has the following controls with their descriptions (according to their positions from left to right and from top to bottom):
  
−
* '''"After Build" (setting the PTX storage location)'''
+
{|{{TableHeader}}
−
:In this section, you can specify how the PTX library of the project is created. Here you can determine whether a project is '''exported''' into a PTX library after building the project '''or not''' by checking the "Export the PTX into folder" check-box. You can also set the location path of the storage folder of the exported PTX files by inputting the location path directly or browsing the folder via the "'''Browse'''" button.
+
|- style="background: gray; color: white; vertical-align:top;'''"
 +
| '''Control'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; || '''Description'''
 +
|-{{TableRow1}}
 +
| '''(PTX/PPX files or folders)''' combo box || Users can manually input paths of the PTX/PPX libraries (or the folder containing the libraries) here to validate and build in the Builder Checker. This combo box can include many paths to libraries or to containing folders seperated with each other by the colon ";". You can also click on the dropdown button and select a recently loaded path collection.
 +
|-{{TableRow2}}
 +
| '''Add Files...''' button || Opens a browse window to add one or many PTX/PPX libraries, the new path(s) shall be appended to the current path collection of the "selected files" combo box. After adding new path(s), the list of libraries in the "PTX/PPX files" tree view shall be updated.
 +
|-{{TableRow1}}
 +
| '''Add Folder...''' button || Opens a browse window to add a folder containing libraries, the new path of the folder shall be appended to the current path collection of the "selected files" combo box. After adding new path(s), the list of libraries in the "PTX/PPX files" tree view shall be updated.
 +
|-{{TableRow2}}
 +
| '''Delete''' button || Clears the current path collection in the "selected files" combo box.
 +
|-{{TableRow1}}
 +
| '''Reload''' button || Reloads the list of libraries in the "PTX/PPX files" tree view. This button should be used when you manually add path(s) in the "selected files or folders" combo box.
 +
|-{{TableRow2}}
 +
| '''Output Folder''' text box || Users can manually input here the output folder for the output (built) PTX/PPX libraries.
 +
|-{{TableRow1}}
 +
| '''(browse ...)''' button || Opens a dialog to browse and select a folder as the '''Output Folder'''.
 +
|-{{TableRow2}}
 +
| '''Open Folder''' button || Opens the '''Output Folder''' in a new window explorer.
 +
|-{{TableRow1}}
 +
| '''Build''' button || Builds the selected PTX/PPX files into new files with the version of the addin, validates before building if the '''Validate (before build)''' is checked.
 +
|-{{TableRow2}}
 +
| '''Check''' button || Validates the selected PTX/PPX files.
 +
|-{{TableRow1}}
 +
| '''Stop''' button || Stops validating or building.
 +
|-{{TableRow2}}
 +
| '''Create Protocol...''' button''{{TooltipIcon2|The button is only enabled if there are results of at least a validating or building session in the &quot;PTX/PPX files&quot; tree view, see below.}} || Creates protocol file for the current results of validation/building.
 +
|-{{TableRow1}}
 +
| '''(open protocol)''' button || Opens a dialog to browse and open a protocol file in the internet browser.
 +
|-{{TableRow2}}
 +
| '''(PTX/PPX files)''' tree view || Displays the loaded PTX/PPX files accordings to the paths in the '''selected PTX/PPX files or folder''' combo box, the errors or warnings of each PTX/PPX file and their building result states. Here you can select the files to be validated/built by ticking on the check boxes on the left of the files; you can also expand a file to view the error and warning detail or collapse it.
 +
|-{{TableRow1}}
 +
| '''(status)''' label || Displays the current states such as ready state, compiling state etc.
 +
|-{{TableRow2}}
 +
| '''Error''' button || Shows (button activated) or hides (button deactivated) errors.
 +
|-{{TableRow1}}
 +
| '''Warning''' button || Shows (button activated) or hides (button deactivated) warnings.
 +
|-{{TableRow2}}
 +
| '''Custom Filter''' button || Opens the "Custom Filter" dialog. Here in the dialog, you can switch filter ON or OFF, and you can select which errors or warnings '''to be displayed''' by checking at combo boxes of the check rule entries.
 +
|-{{TableRow1}}
 +
| '''DotNet''' button || Creates DotNet executable files in the newly built files (button activated) or not (button deactivated).
 +
|-{{TableRow2}}
 +
| '''Java''' button || Creates Java executable files in the newly built files (button activated) or not (button deactivated).
 +
|-{{TableRow1}}
 +
| '''(include OTX files)''' button{{TooltipIcon2|This button shall be automatically activated and it can not be changed if both the binaries for Dotnet and Java check boxes are not activated.}} || Includes the OTX files in the built files (button activated) or not (button deactivated).
 +
|-{{TableRow2}}
 +
| '''(include settings)''' button || Includes the project settings files in the built files (button activated) or not (button deactivated).
 +
|-{{TableRow1}}
 +
| '''Password''' text box || Sets the password to decrypt and load the encrypted PTX/PPX files, the files can be loaded only if the input password is the same with the password of the files. Otherwise, the files are marked with error and can not be validated/built.
 +
|-{{TableRow2}}
 +
| '''ODX...''' button || Opens the "ODX Diagnostic Data Settings" dialog to configure the new ODX database settings for all the built files (refers the [[OtfProjectSettings#DiagCom_.28ODX_Diagnostic_Data.29_settings|DiagCom settings]] in the OTF, note that it does not have the PDX Converter section). If it is not configured, the built files use their own ODX database settings.
 +
|-{{TableRow1}}
 +
| '''Validate (before build)''' button || Enables to automatically validate the PTX/PPX files (button activated) or not (button deactivated) before building new files.
 +
|-{{TableRow2}}
 +
| '''(add revision number)''' button || Enables to attach revision number of the addin to the name of the built files (button activated) or not (button deactivated).
 +
|-{{TableRow1}}
 +
| '''(overwrite existing files)''' button || Enables to overwrite (without a query) the existing files having the same name with the built files (button activated) or not (button deactivated). If this button is deactivated when it build a new file into the output folder and there exists a file with the same name, it shall adds an automatically calculated number at the end "_number" to create a unique name.  
 +
|}
  
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_RuntimeEnvironment.png|450|The "Runtime Environment" page allows for setting the runtime screen mapping, and configuring the generation of the executable file and of the PTX library}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OtfSetting_Addins.png|500|The "Addins" page allows to manage the addins}}
 +
 
 +
 
 +
 
 +
{{ImageStyleCenter| BuilderChecker.png|500|The Builder Checker program allows to build and validate a PTX/PPX library with a particular addin}}
 
|}
 
|}
  
−
{{Anchor|AppID_Pg|}}
+
== '''Themes''' settings ==
−
=="External Access (APP-Id)" settings page==
 
 
{|
 
{|
 
| style="vertical-align:top; text-align:justify;"|
 
| style="vertical-align:top; text-align:justify;"|
−
This page allows you to create the application-id which maps to an external diagnostic application (e.g. a .NET Assembly) or a project within the solution. Through these application-ids, a device signature or a context variable can be mapped to the application or project at runtime.
+
The '''Themes''' settings allows for configuring the typical display settings of the player monitor in design time of the OTF and in run time of the OTP, and saving the settings as theme files (*.'''playTheme''') which can be selected and used later, or transferred to another computer.
  
−
With the "'''Device Driver'''" combo-box, you can select the supported control device driver (at present, the OTF only supports .NET Assembly).  
+
Using so-called themes, the typical look of the [[OtpReference|Open Test Player]] (OTP) can be adapted to the corporate identity of the company. Company-specific colors, fonts, icons and a logo can be set. Optionally, different icons can be defined for the switchable day and night design in the player.
  
−
To add a new application-id, please proceed as follows:
+
This settings page consists of the header section, the theme content view section and the preview section.
−
# Click "'''Add'''" button to add a new application-id.
 
−
# In the "'''Application'''" combo-box, select a project or browse an application. This step is mandatory.
 
−
# If you want set the method used in the Initialization, enter a name of a method or click the button in the "'''Intialization'''" column and check the corresponding method. This step is optional.
 
−
# To set the method used in the De-Initialization, enter a name of a method or click the button in the "'''De-Intialization'''" column and check the corresponding method. This step is optional.
 
−
# If you want a particular name, you can change the name of the application-id in the column "'''APP-ID'''". Note that you can not leave this field empty.
 
−
# To include the application in the project folder, check the check-box in the "'''Include'''" column. This step is optional.
 
  
−
To delete an application-id, select the application-id and click on the "'''Delete'''" button.
+
=== Header section ===
  
−
The application-ids in this page can be used in the [[#DeviceMapping_Pg|"Device Mapping" settings page]] or in the settings dialog box of the context variables.
+
This section contains controls to manage the themes and some elements of the themes.
  
−
{{Note|After having created an application-id in this page, you can not use it immediately in the "Device Mapping" page. You have to click "'''OK'''" button to save the application-id, then go back to the "Device Mapping" page and use the application-id.}}
+
Below are the controls in this section with their descriptions (according to their positions from left to right and from top to bottom):
  
−
| style="width:30px;" |
+
{|{{TableHeader}}
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_AppID.png|450|The "External Access (APP-Id)" page allows for creating application-ids used to map to diagnostic application}}
+
|- style="background: gray; color: white; vertical-align:top;'''"
 +
| '''Control'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; || '''Description'''
 +
|-{{TableRow2}}
 +
| '''Current Design''' combo box || Allows to select the current theme for the player in design time of the OTF.
 +
|-{{TableRow1}}
 +
| '''Import...''' button || Imports a new theme file to use.
 +
|-{{TableRow2}}
 +
| '''Save as...''' button || Saves the current theme (along with the current modifications, if any) as a new theme.
 +
|-{{TableRow1}}
 +
| '''Add icon''' button || Adds a new icon line into the Icon panel of the theme content view.
 +
|-{{TableRow2}}
 +
| '''Delete''' button || Deletes the selected icon lines in the Icon panel of the theme content view.
 +
|-{{TableRow1}}
 +
| '''Reset to default values...''' button || Resets all the current settings in the theme content view back to the default settings (defaultSilver theme).
 
|}
 
|}
  
−
=="Database Access" settings page==
+
=== Theme Content View section ===
−
{|
+
 
−
| style="vertical-align:top; text-align:justify;"|
+
This section displays all the settings of the current theme. There are 4 panels inside the content view: Colors panel, Fonts panel, Logo panel and Icons panel.
−
DESCRIPTION...
+
 
−
| style="width:30px;" |
+
==== Colors panel ====
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_AppID.png|450|The "External Access (APP-Id)" page allows for creating application-ids used to map to diagnostic application}}
+
 
−
|}
+
You can find color pickers for each elements of a monitor (this also used for the [[OtpStartPage|start page]] and the background of the OTP application). Each element has 2 color pickers corresponding to the Day view mode and Night view mode.
 +
 
 +
==== Fonts panel ====
 +
 
 +
This panel allows to configure the font settings used in the monitor design time and the OTP application.
 +
 
 +
==== Logo panel ====
 +
 
 +
Here you can customize the OTP application with your own company logo. It allows to set logos for the Day view mode and Night view mode. If you only input a logo for a view mode, the logo shall be used for the both view mode.
  
−
=="Development (Setup)" settings page==
+
{{Note|Note that only the shape of the logo can be taken and used. You should save an PNG file with shape only and with transparent background; other wise, the displayed logo shall be unexpected shape e.g only a rectangle shape if you input here a rectangle image with details inside.}}
−
{|
+
{{Note|The logo shall not be displayed with the original color but it shall be displayed with the "Base" color in the Colors panel}}
−
| style="vertical-align:top; text-align:justify;"|
 
−
This page allows for setting how the installer package (.msi) file of the project is created.
 
  
−
With the "'''ON/OFF'''" button, you can determine whether the installer is created or not when the project is built.
+
==== Icons panel ====
  
−
Here you can set the name of the installer, the name of the manufacturer, the product version, the background images of the installer, and the globally unique identifier (this can be automatically generated). If you leave these fields empty and close the project settings dialog box, these fields are automatically re-filled with the default values.
+
This panel displays all the including default icons in the current theme file which can be applied for the "Symbol" controls used in the players. Here you can delete the existing ones and add your new icon sets. It allows to set icons for the Enabled/Disabled Day view mode and Enabled/Disabled Night view mode. If you only input an icon for a view mode, the icon shall be used for the all other view modes.
  
−
You can determine to create a shortcut of the installer on the desktop after running the installer via the "'''Create Desktop Shortcut'''" check-box, or create a shortcut of the in the Start Menu of the MS Windows via the "'''Create Start Menu'''" check-box.
+
=== Preview section ===
  
−
The check-box "'''Include OTX-Runtime'''" allows you to include the "OtxRuntime.msm" in the installer. This allows you to run the executable file of the installer in any computer without installing the OTF.
+
Here you can see the general preview of the current theme settings. This helps you to observe how the modification looks in the player designer and in the OTP application immediately. However, to check the detail changes of font size, icons etc., you still have to go back to the player designer or you have to save the current theme and load it in the OTP application.
  
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_Deployment.png|450|The "Deployment (Setup)" page allows for configuring the generation of the installer package (.msi) file}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OtfSetting_Themes.png|500|The "Themes" page allows to modify or create a theme used in OTF and OTP}}
 
|}
 
|}
  
−
=="Project References" settings page==
+
== '''Error Reporting''' settings ==
 
{|
 
{|
 
| style="vertical-align:top; text-align:justify;"|
 
| style="vertical-align:top; text-align:justify;"|
−
In this page, you can specify the projects which are referenced by the current project.  
+
The '''Error Reporting''' settings help the '''emotive''' to improve the [[OtfReference|OTF]] product quality. Some OTF bugs may be difficult to reproduce but the OTF has its own traces for the activities in OTF. After the OTF has been closed unexpectedly (crashes), when you start the OTF again, it shall automatically gather all the old OTF traces files and the related Windows XML Event Log (*.'''evtx''') in a zipped file, an error report file, which is ready to be sent to '''emotive'''. With the error report from the customers, the '''emotive''' can simplified the troubleshooting.
  
−
All the projects in the current solution besides the current project will be listed here to reference. You can add or remove the reference to a project by checking the check-box before the project name.  
+
{{Note|Note that when the OTF is restarted after the crash and the Error Reporting is enabled, the current trace files shall be cut and pasted in the in the error report zipped file. The new empty trace file shall be created for the new working sessions of the OTF.}}
  
−
Normally, the OTX documents in the current project can only import documents within the same project, but after adding the references, they can also import documents within the referenced projects. Note that a document in the current project can not import the documents in another project if the imported documents has the name of the document and packages identical to the name of the document and packages in the current project.
+
Below are the controls in the page with their descriptions (according to their positions from left to right and from top to bottom):
  
−
When the current project is exported into a PTX library, all the referenced projects are included in the PTX library. The referenced projects will be unzipped together with the main project when the PTX library is added as a project in a solution.
+
{|{{TableHeader}}
 +
|- style="background: gray; color: white; vertical-align:top;'''"
 +
| '''Control'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; || '''Description'''
 +
|-{{TableRow1}}
 +
| '''Trace Level''' combo box || Allows to set the level for tracing the activities in the OTF.
 +
|-{{TableRow2}}
 +
| '''Open Trace file folder...''' button || Opens the storage folder of the trace files in a new window.
 +
|-{{TableRow1}}
 +
| '''Active Error Reporting''' switch button || Enables to create the zipped error report file with the OTF trace files and related Windows XML Event Log (*.'''evtx'''), when the OTF is closed unexpectedly (please refer the note above).
 +
|-{{TableRow2}}
 +
| '''Send e-mail...''' button || Opens new email message window with the default mail client, already input the necessary texts such as receiver (support@emotive.de), mail title and draft content. You then need to attached all the report files and trace files, and write a brief description of the error, and send the e-mail. We recommend deleting the error report files after sending.
 +
|-{{TableRow1}}
 +
| '''Open Folder...''' button || Opens the storage folder of the error report files in a new window. You can take these files to attach to the report e-mail.
 +
|-{{TableRow2}}
 +
| '''Reload''' button || Updates the list of the error report files from the storage folder in the gridview (see gridview description below).
 +
|-{{TableRow1}}
 +
| '''Delete''' button || Deletes the selected error report files in the gridview (see gridview description below).
 +
|-{{TableRow2}}
 +
| '''Include trace files''' check box || Enables to include the trace files in the zipped error report file (checked) or not (unchecked).
 +
|-{{TableRow1}}
 +
| '''Error Report''' gridview || Displays all the error report files in the storage folder with file name, created date and size. Here you can select one or more error report files (using CTRL key, or SHIFT, or mouse drag or CTRL+A) to use with the '''Delete''' button above or with the '''DEL''' key. You can also sort the error report by date by clicking on the header of the "Date" column.
 +
|}
  
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_PrjRefs.png|450|The "Project References" page allows for managing project references}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OtfSetting_ErrorReporting.png|500|The "Error Reporting" page helps to manage the error report files of the OTF}}
 
|}
 
|}
  
−
=="Libraries (PDX References)" settings page==
+
== '''Experts''' settings ==
 
{|
 
{|
 
| style="vertical-align:top; text-align:justify;"|
 
| style="vertical-align:top; text-align:justify;"|
−
Besides referencing to another projects, a project can reference to a PTX library. You can specify the PTX libraries which are referenced by the current project.
+
This page contains the following sections which allows you to customize the specialized settings for the working environment of the OTF:
 +
 
 +
=== Save section ===
 +
 
 +
Here you can determine to store the ADMIN MetaData of an OTX document as a seperated file in the same package folder or store within the OTX document by checking or unchecking the related check box. Its default state is unchecked.
 +
 
 +
=== Sequence Designer section ===
 +
 
 +
The name of the activities (OTX nodes) in the [[OtfWorkflowDesigner|Workflow Designer]] are optional. This section allows you to enable or disable the function of automatically creating unique names for the new activities in the [[OtfWorkflowDesigner|workflow designer]] by using the corresponding check box.
 +
 
 +
=== Validation section ===
 +
 
 +
Normally, the OTF validates the current project (and all the referred projects) before executing a workflow. If there are critical errors, the execution shall not run.
 +
 
 +
In this section, you can find the check box "No Validation before execution", this check box allows to turn off the validation (ignore the critical errors) in run time. However, critical errors signal that the OTX sequences are incomplete or ill-designed so turning off the validation may result in unexpected behavior in run time.
 +
 
 +
Here in this section, you can also add the additional schema for the OTX-Extensions which are not supported by the OTF to validate documents/projects while they are being imported into the OTF. You can manually input the path for the schema file in the related text box or use the "Browse" button to browse to the schema location.
  
−
In this page, you can add, delete or modify the references to the PTX libraries. You can also modify the reference by converting the reference full path to relative path, or you can include the PTX libraries inside the project folder.
+
=== XSL Stylesheet Support section ===
  
−
| style="width:30px;" |
+
This section related to the OTX-Viewer project of '''emotive''' which supports to view PTX libraries or OTX documents in the internet browser by adapting XSL Stylesheet for the OTX documents (click [[OtxViewerUserDoc|here]] for more information). This section allows to adapt or clean the XSL Stylesheet in all the available documents in the current solution with the "Adapt all documents" button and the "Clean all documents" button.  
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_PTXlibs.png|450|The "Libraries (PDX References)" page allows for managing the references to PTX libraries}}
 
−
|}
 
  
−
=="DiagCom (ODX Diagnostic Data)" settings page==
+
=== DoIP Support section ===
−
{|
 
−
| style="vertical-align:top; text-align:justify;"|
 
−
This page allows for configuring the diagnostic database used in the current project.
 
−
In this page, you can access the database part of the current MVCI Server (diagnostic runtime system). To select and configure the MVCI Server, please open the "Diagnostic Runtime System" tab in the OTF Options menu (see the [[OtfMenuBar|Ribbon]]).
 
−
To set and use the database, you must first select the database project and then select the vehicle within the project.
 
−
In case the DSA MVCI Server is used, all the PDX files (ODX data) can not be used directly and they have to be converted via the button "Convert...".
 
  
−
| style="width:30px;" |
+
This section allows to configure some settings related to the DoIP support in runtime.
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_ODXDb.png|450|The "DiagCom (ODX Diagnostic Data)" page allows for setting the ODX Diagnostic Database used within the project}}
 
−
|}
 
  
−
{{Anchor|HMI_Pg|}}
+
* '''OptionString compliant to MVCI standard''' text box<!--:
−
=="HMI" settings page==
+
*: description...............-->
−
{|
+
* '''Set ActivationLine (required by some VCIs)''' check box<!--:
−
| style="vertical-align:top; text-align:justify;"|
+
*: description...............-->
−
In this page, you can create the screen mapping files to bind the screen signatures to GUI controls of external applications.
+
* '''Waiting time after activating the ActivationLine [ms]''' text box<!--:
 +
*: description...............-->
 +
* '''Show vehicle selection dialog, even if only one interface is found''' check box<!--:
 +
*: description...............-->
  
−
To create a screen mapping file, please proceed as follows:
+
=== ODX-Database section ===
−
# Click on the "'''New'''" button.
 
−
# In the "'''1. Step*'''" section, click "'''Add*'''" button.
 
−
# Select a screen signature in the "'''1. Step**'''" section and select the application in the "'''2. Step**'''" section.
 
−
# If there is no application has been added before, click "'''Add'''" button in the "'''2. Step**'''" section, find and select an application and click "'''Open'''" button.
 
−
# If the loaded application is a WPF form, you have to select "'''WPF Window'''" in the "'''Screen Type'''" drop-down list.
 
−
# Click "'''OK**'''" button.
 
−
# After that, click "'''Add*'''" button in the "'''Step 2*'''" section.
 
−
# In the new row, click on the drop-down list in the first cell and select a screen parameter.
 
−
# Continue to select a value for the application control, the property and the event.
 
−
# Click "'''OK*'''" button.
 
−
# Enter the name for the new screen mapping file and click "'''OK'''" button.
 
−
# To use the screen mapping file, please select it in the [[#RuntimeEnv_Pg|"Runtime Environment" page]] above or in the "Runtime Environment" tab of the [[OtfMenuBar|Ribbon]].
 
−
:('''<big>*</big>''' implies that it belongs to the "'''Screen Mapping Editor'''" dialog box, '''<big>**</big>''' implies that it belongs to the "'''Signature/Screen-Mapping'''" dialog box)
 
  
−
To edit a screen mapping file, select the screen mapping file and click the "'''Edit'''" button or just double-click on the screen mapping file.
+
This section allows to configure the global settings for the ODX Database. Below are the check boxes in this section with their descriptions:
  
−
To delete a screen mapping file, select the screen mapping file and click the "'''Delete'''" button.
+
* '''ODX-Database Synchronization''' check box:
 +
** Preconditions: This check box is checked and the solution contains projects using different ODX Databases. Note that this check box has no effect on the projects  [[OtfProjectSettings#Diagnostic_Runtime_System_.28MVCI.29_section|not using the Diagnostic Runtime System]]. If all the preconditions are not satisfied, then the behaviors below shall not work.
 +
*** When you load the solution, or add a new or an existing project, or add a PTX/PPX as project, there shall be a dialog asking whether you want to adapt the used ODX Database of the Startup project for all the other projects using database in the solution. If you click Yes button all the projects using ODX Databases shall be adapted with the ODX Database of the Startup project; otherwise, if you click No button, it shall not adapt.
 +
*** When you open the [[OtfProjectSettings|project settings]] of a project [[OtfProjectSettings#Diagnostic_Runtime_System_.28MVCI.29_section|using the Diagnostic Runtime System]] (you may change the ODX Database) and click OK, the selected ODX Database (even the "None") shall be automatically adapted to all the other projects using ODX Databases; otherwise, if you click Cancel button, it shall not adapt.
 +
* '''Default value for the property 'PerformVariantSelection' of [[Extensions.DiagCom.GetComChannel|GetComChannel]] activity ''' check box:
 +
*: Normally, the default 'PerformVariantSelection' of [[Extensions.DiagCom.GetComChannel|GetComChannel]] activity is '''false'''. If this check box is checked, if you add a new [[Extensions.DiagCom.GetComChannel|GetComChannel]] activity or add a DiagCom activities already containing the [[Extensions.DiagCom.GetComChannel|GetComChannel]] term, the 'PerformVariantSelection' is always set to '''true'''.
 +
* '''Display Id of TextTable Elements''' text box:
 +
*: If this check box is checked, the ID (ByteField) shall be displayed before each TextTable element of the TextTable Request parameter in the "Diagnostic Database" category of the [[OtfToolBox|Toolbox]] and in the Request-/Respond- parameters dialog of the [[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] activity e.g. '''0F -''' MainNetwork.
  
−
| style="width:30px;" |
+
=== OTX-Mapping section ===
−
| style="vertical-align:top; text-align:justify;"|
 
−
{{ImageStyleCenter| PrjSettings_ScreenMapping.png|450|The "HMI" page allows for managing the screen mapping files}}
 
  
 +
This section allows for configure the global settings for the [[OtfOtxMapping|OTX Mapping]]. Belows are the setting controls in this section:
  
−
{{ImageStyleCenter| ScreenMappingEditor1.png|450|The "Screen Mapping Editor" dialog box and the "Signature/Screen-Mapping" dialog box}}
+
* '''APPs are stored outside the project in a central place''' check box:
−
|}
+
*: If this check box is checked, the OTX Mapping design time and run time in the OTF shall search and use the external applications in a global central folder; otherwise, the OTX Mapping in each project shall search and use the external applications in the application folder within the project folder. Note that if this check box is unchecked, all other settings in this section shall be disabled.
 +
* '''Central path for applications''' text box:
 +
*: This text box display the path of the current global central folder for the external applications. Here you can manually input or modify the path.
 +
* '''Browse''' button:
 +
*: When you click at this button, a dialog occurs for you to browse and select a folder as the global central folder, the selected folder shall be updated in the text box above.
 +
* '''Edit...''' button:
 +
*: This button allows to open the Application Folder manager dialog.
  
−
=="Logging" settings page==
+
==== Application Folder manager dialog ====
−
{|
 
−
| style="vertical-align:top; text-align:justify;"|
 
−
This page allows you to specify how the '''[[WriteLog]]''' activities in the current project write log messages to text files at runtime. Note that at each time of an execution, the old contents in the log files are cleared and the current log messages are written into the log files.
 
  
−
* '''Switch Logging ON/OFF (Runtime)'''
+
The dialog consists of a command bar and an application gridview (see the image above). The gridview displays all the available external applications in the central folder with the detailed information such as name, version, changed data and size. Here in the gridview, you can select one or many applications (using CTRL key or SHIFT key) which can be handled with the buttons in the command bar.
−
:With the "'''ON/OFF'''" button, you can turn the logging feature on and off. If this button is off, then no log messages from the WriteLog activities in this project will be written at runtime.
 
  
−
* '''"Directory Name" and "File Name"'''
+
Below are the buttons in this the command bar with their descriptions (according to their positions from left to right):
−
:Here you can input or browse for the path of the storage location for the logging files, and set the default name for the logging file. If the input value of the property "'''Target'''" of the '''[[WriteLog]]''' activity is only the file name or empty, the default storage location and default file name are used; otherwise, the path and the file name input in the "Target" property are used.
 
  
−
* '''"Maximum File Number" and "Maximum File Size"'''  
+
{|{{TableHeader}}
−
:The logging file may be too long, so it can be divided and saved in several small files. Here you can set the size of each file and limit the number of these files.
+
|- style="background: gray; color: white; vertical-align:top;'''"  
 +
| '''Button'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; || '''Description'''
 +
|-{{TableRow1}}
 +
| '''Add application...''' || Opens a dialog to browse and add a new application (*.'''dll''' or *.'''exe''') into the central folder.
 +
|-{{TableRow2}}
 +
| '''Open''' || Opens the global central folder in a new window explorer.
 +
|-{{TableRow1}}
 +
| '''Delete''' || Deletes the selected applications.
 +
|-{{TableRow2}}
 +
| '''Create application container...'''{{TooltipIcon2|This button is only enabled if at least an application is selected.}} || Creates an zipped and encrypted container file (*.'''apc''') which contains all the selected applications. The container can not be unzipped normally, it can only be decrypted and unzipped by the OTF.
 +
|-{{TableRow1}}
 +
| '''Load application container...'''{{TooltipIcon2|This button is only enabled if at least an application is selected.}} || Opens a dialog to browse for a container file (*.'''apc'''), and then extracts all its applications into the global central folder.
 +
|}
  
−
* '''"Message Format" and "Header Format"'''
+
=== Others section ===
−
:Here you can set the format of the header and the content of the log messages. In the "'''Formatting'''" section, you can find a list of place holders to use in the Message and Header format.
 
  
−
* '''"Communication Trace included"'''
+
This section allows to specify the prefix for copying and for the OTX-ID through the following text boxes:
−
:This check-box allows you to determine whether the '''diagnostic communication''' is automatically '''written''' in the log files '''or not'''.
 
  
−
* '''"WriteLog Target Resolving"'''
+
* '''Prefix for copying''' text box:
−
:If this feature is checked, when you export the current project into Ptx library, all the empty "Target" properties of all the '''[[WriteLog]]''' activities are filled with the default values. This feature is helpful when the Ptx is exchanged and used in other tools besides OTF.
+
*: Here you can input the prefix for the name of the copy of any OTX elements in an OTX document e.g. prefix 'emotive' shall be added to the copy of the 'Variable1' as 'emotiveVariable1'. Note that does not affect the existing elements.
 +
* '''OTX-ID''' button:
 +
*: Here you can input the prefix for the ID of all the newly created OTX elements in an OTX document e.g. prefix 'emotive' shall be added to the ID of the newly created 'Variable1' as 'emotive_VariableDeclaration_94b516346858438cba90fae3bfe2fee2'. Note that does not affect the existing elements.
  
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_Logging.png|450|The "Logging" page allows for configuring how the log messages are recorded at runtime}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OtfSetting_Experts.png|500|The "Experts" page allows to customize the specialized settings for the working environment of the OTF}}
 +
 
 +
 
 +
 
 +
{{ImageStyleCenter| ApplicationFolderManager.png|500|The Application Folder manager allows to manage the external applications in the central application folder}}
 
|}
 
|}
 +
<!-- OLD SETTINGS TEXTS
 +
 +
 +
 +
-----------------------
 +
Here you can also configure the OTF to save the AdminData as a separate file or as inline data in the OTX documents.
 +
 +
* '''"Sequence Designer"'''
 +
:The name of the activities (OTX nodes) in the [[OtfWorkflowDesigner|Workflow Designer]] are optional. This section allows you to enable or disable the function of automatically creating unique names for the new activities.
  
−
=="i18n" settings page==
+
* '''"Runtime Validation"'''
−
{|
+
:Everytime a procedure is executed, it shall automatically validate all the related projects (the current project which contains the executed procedure and the referencing or referenced projects of the current project). If there are still any errors, the procedure shall not be executed. This section allows you to enable or disable the automatic runtime validation of the OTF.
−
| style="vertical-align:top; text-align:justify;"|
+
 
−
In this page, you can configure the '''Text Blocks Library''' for the [[I18n|i18n extension]]. The text library is an actual storage folder for the language files. Each language file corresponds to a language and stores the data of that language. The language files have the format INI. Each section element corresponds to a category. In each property element, the name corresponds to a translation key and the value to a translated text according to the language.
+
* '''"XSL Stylesheet Support"'''
 +
:An OTX document can be viewed in a web browser such as Internet Explorer or FireFox. To achieve this, you must embed a stylesheet in the document. This section will allows you to embed (or clear) the stylesheet in all the documents of the current solution. Remember that you must first copy the "OtxDocumentXslt.zip" archive file into the global program data directory "C:\ProgramData\Emotive\Open Test Framework\" (see [[???]] for more information).
  
−
* '''"Language Folder"'''
+
* '''"ODX Database"'''
−
:Here you can input the location path of the storage folder for the language files, or browse for the folder.
+
:In this section, you can enable or disable the "'''ODX Database Synchronization'''" function which allows you to synchronize the ODX Database of all the projects in a solution according to the startup project when the solution is loaded.  
  
−
* '''"Default Language"'''
+
* '''"Others"'''
−
:This is a drop-down list displaying all the available languages in the language folder. Here you can select a language to be the default language. The '''[[Translate]]''' activities will return a localized string according to this default language.
+
:In this section, you can set the prefix for the copy of an element in the OTF (within the [[OtfSolutionExplorer|Solution Explorer]] or the [[OtfWorkflowDesigner|Workflow Designer]]). Everytime you copy and paste an element, the name of the copy element will be preceded by the prefix. If you do not prefer the prefix, just leave it empty.
 +
-----------------
  
−
* '''"Edit Text Library"'''
 
−
:This button allows you to open the "'''Editor for the text library'''" dialog box. This dialog box displays the data of all the language files in the gridview. With the command bar above the gridview, you can add a new language (it also creates a corresponding language file), a new category and a new translation key, or search for texts using keywords, translate all the texts from a language to another language via Google translator, or save the changes during editing the data ect. In the gridview, you can change the name of the categories and the translation keys, or the values of in each language by double-clicking on the corresponding cell and inputting texts.  You can also manage the categories or keys in the gridview (such as selecting many items with CTRL- or SHIFT-key, moving items with drag-and-drop, or copying keys from a category to the others with drag-and-drop and the CTRL-key). Note that if there is no language file in the language folder when you open the editor, the "Add new language" dialog box will appear first, it will help you create a new language file.
 
  
−
* "'''Include In Project'''"
 
−
:This check-box allows you to include the language folder in the project folder. This ensures that the language data is still available when the project is exported to a PTX library and it is used in another computer.
 
  
−
| style="width:30px;" |
 
−
| style="vertical-align:top; text-align:justify;"|
 
−
{{ImageStyleCenter| PrjSettings_i18n.png|450|The "i18n" page allows for configuring the Text Blocks Library for the i18n extension}}
 
  
  
−
{{ImageStyleCenter| TextBlockLibrary.png|450|The Text Block Library allows for managing and editing the language data}}
+
== "Runtime Environment" settings page ==
 +
{|
 +
| style="vertical-align:top; text-align:justify;"|
 +
In this page, you can change the platform of the OTF. The default platform of the OTF is DotNet (C#), it is also the only supported platform at present. The Java platform is comming!
 +
| style="width:30px;" |
 +
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsOTXRuntimeSys.png|500|The "OTX Runtime System" page allows for changing the OTF platform.}}
 
|}
 
|}
  
−
{{Anchor|DeviceMapping_Pg|}}
+
== "Diagnostic Runtime System" settings page ==
−
=="Device Mapping" settings page==
 
 
{|
 
{|
 
| style="vertical-align:top; text-align:justify;"|
 
| style="vertical-align:top; text-align:justify;"|
−
In this page, you can map an OTX device signature to functions of an application (a DLL) through an application-id (see the [[#AppID_Pg|"External Access (APP-Id)" page]] above). This settings page consists the namespaces of application-ids in the left pane and the names of all the documents of the current project in the right pane.  
+
This page allows you to configure the settings for the MVCI Server (Diagnostic Runtime System) used in the OTF. In this page contains the following sections:
 +
* '''"General"'''
 +
:In this section, you can select one of the available diagnostic runtime systems. The OTF only supports to work with one diagnostic runtime system each time starting the application. This section also allows you to select one of the available MCD system interfaces (APIs).
 +
{{Note|The changes set in this section will have effect only after restart the OTF.}}
  
−
To bind the public classes of a namespace to a document, please proceed as follows:
+
* '''"D-PDU-API Configuration"'''
−
# Select a namespace of an application-id in the left pane.
+
:In this section, you can configure settings for the selected interface, see section above. These settings determine how the interface communicate with a VCI.
−
# Select a document in the right pane.
 
−
# Click on the "'''Add link'''" button ("[[File:Insert16.png]]").
 
−
# Check the desired method(s).
 
−
# Click OK button.
 
−
# A corresponding device signature will be added to the selected document.
 
−
{{Note| With each public class having checked methods, a corresponding device signature will be created and with each checked method a corresponding device service signature will be created. You can link '''one document to one namespace only''', but one namespace can be mapped by many documents. If the selected document already has a device signature with the same name as the public class, and the device service signature also has the same name of the checked method but the device service signature's parameters do not corresponds to the method's parameters, the method will be displayed in red color and you can not select the method excepts that you delete, or rename, or change the parameters of the existing device service signature.}}
 
  
−
To remove the link between the device signatures of a document and the application's functions, please select the corresponding document in the right pane and click on the "'''Delete'''" button ("[[File:Remove16.png]]"). After removing the link, the '''[[ExecuteDeviceService]]''' activities input with the related device signatures shall perform nothing at the execution time.
+
* '''"Simulation file"'''
 +
:The OTF supports simulation of the VCI. Here in this section, you can add a SimFrog to support the simulation, you can also edit the sim.
 +
{{Note|The changes set in this section will have effect only after restart the OTF.}}
 +
| style="width:30px;" |
 +
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsDiagRuntimeSys.png|500|The "Diagnostic Runtime System" page allows for configure the MVCI Server and the interface to communicate with the VCI.}}
 +
|}
  
 +
== "MVCI Server of DSA GmbH" settings page ==
 +
{|
 +
| style="vertical-align:top; text-align:justify;"|
 +
You can have more than one MVCI Server of the DSA GmbH installed in your computer. This page allows you to manage these MVCI Servers. Here you can set names for each server to select in the "Diagnostic Runtime Server" settings page above. For each server, you also have to enter the paths for the runtime system/kernel (AsamDsaDCom.dll) and for the configuration file (MCD3D_SERVER.INI) of that server so that the server can be used in the OTF. The "Details" section at bottom of the page shall inform you the paths of the environment variable.
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_DeviceMapping.png|450|The "Device Mapping" page allows for mapping OTX device signatures to the functions of external applications}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsDSAMVCIServ.png|500|The "MVCI Server of DSA GmbH" page allows for managing the installed MVCI Servers of the DSA GmbH}}
 
|}
 
|}
  
−
=="Quantities" settings page==
+
== "MVCI Server of RAC GmbH" settings page ==
 
{|
 
{|
 
| style="vertical-align:top; text-align:justify;"|
 
| style="vertical-align:top; text-align:justify;"|
−
In this page, you can manage the Quantity libraries (the ODX UNIT-SPEC containers) which allow for calculating values with units.
+
In this page, you can set the name for the installed MVCI Server of the RAC GmbH to select in the "Diagnostic Runtime Server" settings page above. To use the server in the OTF, you also have to enter the path for the runtime system/kernel (Rac.Mvci.dll).
−
 
 
−
Here you can also view the detail information of all the units in the referenced libraries and filter the displayed information by using keywords.
 
−
 
 
−
A quantity library can be included in the project folder to ensure that the unit data is still available when used in another computer.
 
−
 
 
 
| style="width:30px;" |
 
| style="width:30px;" |
−
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| PrjSettings_Quantities.png|450|The "Quantities" page allows for managing the Quantity libraries}}
+
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OTFSettingsRACMVCIServ.png|500|The "MVCI Server of RAC GmbH" page allows for managing the installed MVCI Server of the RAC GmbH}}
 
|}
 
|}
 
-->
 
-->

Latest revision as of 09:40, 15 October 2018


Overview

The OTF Settings enable you to configure the default settings for the working environment of the OTF. You can configure the general settings such as establishing the default location for your OTX solutions, or enabling the function to restore the last opened solution and procedures, or changing the development platform ect.

You can access the OTF Settings by selecting the "File" tab of the Ribbon and then selecting the "Options" entry, the OTF Options dialog box will be displayed to configure the OTF settings. The OTF Options dialog box contains several pages that are accessed through tabs on the left-hand side. By clicking a tab on the left pane (e.g. "General", "OTX Runtime System" ect.) you can access the corresponding settings page on the right pane. You can adjust the settings in many pages and click "OK" button, and all the changes will be saved.

The introduction and guidelines for each settings page are described in the following sections.

General settings

This page contains the following sections which allows you to customize the general settings for the working environment of the OTF:

Interface language

In this section, you can select the display language in the OTF. The default is "English". At present, the OTF only allows you to switch between "English" and "Deustch" (German).

Icons Note.png The OTF must be restarted for the changes to take effect completely!

Start settings

This section allows you to configure the behavior when starting OTF and when switching between the designer and the OTL editor.

Below are the options in this section:

  • Automatically load the last Solution check box:
    The OTF remembers the last opened solution when the OTF is closed. This check box enables (checked) or disables (unchecked) automatically loading the last opened solution when the OTF is started (checked) or not (unchecked). If no solution is opened when the OTF is closed, it shall not load any solution when it is started again.
  • Restore the last opened procedures check box:
    The OTF remembers the last opened tabs of a solution such as procedure tabs, OTL editor tabs, player monitor tabs, Overview tab, Instruction tab etc. This check box enables (checked) or disables (unchecked) automatically loading the last opened tabs when the solution is loaded.
  • Display warning message before clearing the Undo/Redo buffer check box:
    This check box allows to show a warning dialog when you make changes in an OTL editor and switch to another tab e.g. procedure tab. The dialog warns that the changes in the OTL shall clears all the current Undo/Redo buffers of all the workflow designers. Unchecking this check box shall hide the warning dialog.

Save

In this section, you can set the default storage location for the OTX solutions. You can also enable or disable creating copy backups of the OTX documents, see the "General" settings page of the Project Settings. The check box "Export old PTX-1 format" allows you to export a project into the old version PTX library to use with the older version of OTF.

Icons Note.png Note that if you check the "Export old PTX-1 format" check box, the "Security - PTX" section below shall be disabled, also the "Security" section of the Export Manager.

Save - PTX

This section allows you to configure the settings for exporting PTX/PPX libraries.

Below are the controls in this section with their descriptions (according to their positions from top to bottom):

Control                                                                         Description
OTX files check boxExclamation.png Enables to include the OTX folder containing all OTX files in the PTX library (checked) or not (unchecked) when exporting a project.
Runtime settings check boxExclamation.png Enables to include all emotive specific project settings in the PTX library (checked) or not (unchecked) when exporting a project.
Runtime-optimized binaries for DotNet check box Enables to include the Output folder containing the compiled and executable binaries for DotNet runtime in the PTX library (checked) or not (unchecked) when exporting a project.
Runtime-optimized binaries for Java check box Enables to include the Output folder containing the compiled and executable binaries for Java runtime in the PTX library (checked) or not (unchecked) when exporting a project.
Referenced projects combo box Allows to select a behavior with the externally referred PTX files.
Store APPs inside project check box Enables to copy all the referred external applications (from the central application folder) into the PTX/PPX library (checked) or not (unchecked) when exporting a project.
Open dialog when exporting check box Enables to display the "PTX Export Manager" dialog (checked) or not (unchecked) when exporting a project into a PTX/PPX file.

Security - PTX

This section allows you to configure the settings for PTX/PPX library encryption.

Below are the controls in this section with their descriptions (according to their positions from left to right and top to bottom):

Control                                                         Description
Private key text box Allows to specify a password to encrypt and/or sign the exported PTX/PPX library.
Encryption check boxExclamation.png Enables to encrypt the entire PTX/PPX file (checked) or not (unchecked) when exporting a project. The encrypted PTX/PPX file can only be opened by the OTX-Runtime API (DotNet/Java).
Protect ... with a checksum check boxExclamation.png Enables to protect the PTX/PPX file against an encrypted checksum (checked) or not (unchecked). The protected PTX/PPX file can be opened with the OTF or the OTX-Runtime API (DotNet/Java).
Has Algorithm combo boxExclamation.png Allows to select the hash algorithm.

Temporary Files

During the design time and run time, the OTF has to create some temporary files. This section allows you to clean up these temporary files from your computer free up lost space by using the "Clean up temporary files" button. You can also enable the function to automatically clean up these files after the OTF is closed by checking the corresponding check box below the clean up button.

OtfSetting General.png
The "General" page allows for customizing general settings of the OTF working environment

Runtime Environment settings

This page allows you to set up some settings related to the run time environment. Below are the sections in this page.

Target Platform section

This section allows to set the target platform for the run time of the OTF. You can select the Dotnet platform or Java platform with the "Target Platform" combo box.

Diagnostic Runtime System (MVCI-Server) section

Here you can find the name of the current Diagnostic Runtime System (MVCI-Server) used for the run time.

You can also open the MVCI-Server Configuration Program by clicking on the "Open..." button. In the MVCI-Server Configuration Program, you can switch the current MVCI-Server to another one or modify the current MVCI-Server.

The check box of diagnostic runtime system offline working allows to execute the procedure without vehicle connection. No exceptions shall be thrown.

OTX Home... section

The OTX search path (OTX-Home) determines the base directory to which all relative path specifications refer. In this section, you can enter the search path in the text box. The OTX search path can contain several directories separated by semicolons (";") and the placeholders "?" (One arbitrary character) and "*" (any characters). You can also use the placeholder "[ProjectDir]" (e.g. "[ProjectDir]/*"). Inside OTF "[ProjectDir]" corresponds to the project directory and in the OTX Runtime API to the directory in which the PTX or OTX or binary file (DLL, JAR) is located. When reading, the runtime environment takes each directory starting from the left as a base for relative paths. If the file is found, the search is canceled. The first directory is used for writing. It shall not contain wildcards. If no OTX search path is specified, the default value is "[ProjectDir];[ProjectDir]/..".

OtfSetting RuntimeEnvironment.png
The "Runtime Environment" page helps set up the target platform, the MVCI-Server and the OTX search path

Extensions settings

In this page, you can find all the supported OTX extensions with their licensing status. Only the full version license enables to show all of the extensions supported by the OTF.

The extensions are classified into 2 groups: the standard compliant extensions and the non-standard compliant extension (user defined extensions).

The extension settings help you hide the unused extensions in design time. To turn on or turn off an extension, please use the switch button at the left most of the corresponding extension. If an extension is turned off, the category related to that extension in the Toolbox window shall be hidden, and the related data types of the turned off extension shall not be displayed when creating or modifying a declaration, and all the entries related to that extension shall not be display in the OTL IntelliSense.

Icons Note.png The OTF still supports loading and running the OTX documents containing elements of turned off extensions. It only prevent to create new elements related to the turned off extensions.
OtfSetting Extensions.png
The "Extensions" page helps to manage the OTX and user-defined extensions

Addins settings

An addin file (*.ota) is a zipped and encrypted file containing all the necessary files to validate and build PTX/PPX libraries with the specific run time version and/or target environments. The addins can only be decrypted and unzipped by the OTF. After that, the addins must be started and used with the Builder Checker program which is described below.

The Addins setting page consists of a command bar and a gridview displaying all the imported addins. Please not that you can only select one addin at a time, the selected addin can be handled with the buttons in the command bar.

Below are the buttons in the command bar with their descriptions (according to their positions from left to right):

Button                               Description
Add... Opens a dialog to browse and add a new addin.
Select as default Sets the selected addin as the default addin. The default addin shall be displayed in the default addin combo box in the "Runtime Environment" tab of the Ribbon menu.
Delete Deletes the selected addin.
Open selected Addin... Opens the selected addin in the Builder Checker program.


Builder Checker program

The Builder Checker program is zipped inside an addin. After the addin is unzipped by the OTF, the Builder Checker program depends on the unzipped files of the addin to run that addin. In other words, a Builder Checker is associated with the addin, and can not be seperated with the addin.

With the Builder-Checker Addin, runtime-optimized PTX and PPX files can be generated and validated for a specific version and/or target environments. This is required for environments, e.g. Embedded Linux, which do not have their own code generation.

The Builder Checker program has the following controls with their descriptions (according to their positions from left to right and from top to bottom):

Control                                           Description
(PTX/PPX files or folders) combo box Users can manually input paths of the PTX/PPX libraries (or the folder containing the libraries) here to validate and build in the Builder Checker. This combo box can include many paths to libraries or to containing folders seperated with each other by the colon ";". You can also click on the dropdown button and select a recently loaded path collection.
Add Files... button Opens a browse window to add one or many PTX/PPX libraries, the new path(s) shall be appended to the current path collection of the "selected files" combo box. After adding new path(s), the list of libraries in the "PTX/PPX files" tree view shall be updated.
Add Folder... button Opens a browse window to add a folder containing libraries, the new path of the folder shall be appended to the current path collection of the "selected files" combo box. After adding new path(s), the list of libraries in the "PTX/PPX files" tree view shall be updated.
Delete button Clears the current path collection in the "selected files" combo box.
Reload button Reloads the list of libraries in the "PTX/PPX files" tree view. This button should be used when you manually add path(s) in the "selected files or folders" combo box.
Output Folder text box Users can manually input here the output folder for the output (built) PTX/PPX libraries.
(browse ...) button Opens a dialog to browse and select a folder as the Output Folder.
Open Folder button Opens the Output Folder in a new window explorer.
Build button Builds the selected PTX/PPX files into new files with the version of the addin, validates before building if the Validate (before build) is checked.
Check button Validates the selected PTX/PPX files.
Stop button Stops validating or building.
Create Protocol... buttonExclamation.png Creates protocol file for the current results of validation/building.
(open protocol) button Opens a dialog to browse and open a protocol file in the internet browser.
(PTX/PPX files) tree view Displays the loaded PTX/PPX files accordings to the paths in the selected PTX/PPX files or folder combo box, the errors or warnings of each PTX/PPX file and their building result states. Here you can select the files to be validated/built by ticking on the check boxes on the left of the files; you can also expand a file to view the error and warning detail or collapse it.
(status) label Displays the current states such as ready state, compiling state etc.
Error button Shows (button activated) or hides (button deactivated) errors.
Warning button Shows (button activated) or hides (button deactivated) warnings.
Custom Filter button Opens the "Custom Filter" dialog. Here in the dialog, you can switch filter ON or OFF, and you can select which errors or warnings to be displayed by checking at combo boxes of the check rule entries.
DotNet button Creates DotNet executable files in the newly built files (button activated) or not (button deactivated).
Java button Creates Java executable files in the newly built files (button activated) or not (button deactivated).
(include OTX files) buttonExclamation.png Includes the OTX files in the built files (button activated) or not (button deactivated).
(include settings) button Includes the project settings files in the built files (button activated) or not (button deactivated).
Password text box Sets the password to decrypt and load the encrypted PTX/PPX files, the files can be loaded only if the input password is the same with the password of the files. Otherwise, the files are marked with error and can not be validated/built.
ODX... button Opens the "ODX Diagnostic Data Settings" dialog to configure the new ODX database settings for all the built files (refers the DiagCom settings in the OTF, note that it does not have the PDX Converter section). If it is not configured, the built files use their own ODX database settings.
Validate (before build) button Enables to automatically validate the PTX/PPX files (button activated) or not (button deactivated) before building new files.
(add revision number) button Enables to attach revision number of the addin to the name of the built files (button activated) or not (button deactivated).
(overwrite existing files) button Enables to overwrite (without a query) the existing files having the same name with the built files (button activated) or not (button deactivated). If this button is deactivated when it build a new file into the output folder and there exists a file with the same name, it shall adds an automatically calculated number at the end "_number" to create a unique name.
OtfSetting Addins.png
The "Addins" page allows to manage the addins


BuilderChecker.png
The Builder Checker program allows to build and validate a PTX/PPX library with a particular addin

Themes settings

The Themes settings allows for configuring the typical display settings of the player monitor in design time of the OTF and in run time of the OTP, and saving the settings as theme files (*.playTheme) which can be selected and used later, or transferred to another computer.

Using so-called themes, the typical look of the Open Test Player (OTP) can be adapted to the corporate identity of the company. Company-specific colors, fonts, icons and a logo can be set. Optionally, different icons can be defined for the switchable day and night design in the player.

This settings page consists of the header section, the theme content view section and the preview section.

Header section

This section contains controls to manage the themes and some elements of the themes.

Below are the controls in this section with their descriptions (according to their positions from left to right and from top to bottom):

Control                                             Description
Current Design combo box Allows to select the current theme for the player in design time of the OTF.
Import... button Imports a new theme file to use.
Save as... button Saves the current theme (along with the current modifications, if any) as a new theme.
Add icon button Adds a new icon line into the Icon panel of the theme content view.
Delete button Deletes the selected icon lines in the Icon panel of the theme content view.
Reset to default values... button Resets all the current settings in the theme content view back to the default settings (defaultSilver theme).

Theme Content View section

This section displays all the settings of the current theme. There are 4 panels inside the content view: Colors panel, Fonts panel, Logo panel and Icons panel.

Colors panel

You can find color pickers for each elements of a monitor (this also used for the start page and the background of the OTP application). Each element has 2 color pickers corresponding to the Day view mode and Night view mode.

Fonts panel

This panel allows to configure the font settings used in the monitor design time and the OTP application.

Logo panel

Here you can customize the OTP application with your own company logo. It allows to set logos for the Day view mode and Night view mode. If you only input a logo for a view mode, the logo shall be used for the both view mode.

Icons Note.png Note that only the shape of the logo can be taken and used. You should save an PNG file with shape only and with transparent background; other wise, the displayed logo shall be unexpected shape e.g only a rectangle shape if you input here a rectangle image with details inside.
Icons Note.png The logo shall not be displayed with the original color but it shall be displayed with the "Base" color in the Colors panel

Icons panel

This panel displays all the including default icons in the current theme file which can be applied for the "Symbol" controls used in the players. Here you can delete the existing ones and add your new icon sets. It allows to set icons for the Enabled/Disabled Day view mode and Enabled/Disabled Night view mode. If you only input an icon for a view mode, the icon shall be used for the all other view modes.

Preview section

Here you can see the general preview of the current theme settings. This helps you to observe how the modification looks in the player designer and in the OTP application immediately. However, to check the detail changes of font size, icons etc., you still have to go back to the player designer or you have to save the current theme and load it in the OTP application.

OtfSetting Themes.png
The "Themes" page allows to modify or create a theme used in OTF and OTP

Error Reporting settings

The Error Reporting settings help the emotive to improve the OTF product quality. Some OTF bugs may be difficult to reproduce but the OTF has its own traces for the activities in OTF. After the OTF has been closed unexpectedly (crashes), when you start the OTF again, it shall automatically gather all the old OTF traces files and the related Windows XML Event Log (*.evtx) in a zipped file, an error report file, which is ready to be sent to emotive. With the error report from the customers, the emotive can simplified the troubleshooting.

Icons Note.png Note that when the OTF is restarted after the crash and the Error Reporting is enabled, the current trace files shall be cut and pasted in the in the error report zipped file. The new empty trace file shall be created for the new working sessions of the OTF.

Below are the controls in the page with their descriptions (according to their positions from left to right and from top to bottom):

Control                                                     Description
Trace Level combo box Allows to set the level for tracing the activities in the OTF.
Open Trace file folder... button Opens the storage folder of the trace files in a new window.
Active Error Reporting switch button Enables to create the zipped error report file with the OTF trace files and related Windows XML Event Log (*.evtx), when the OTF is closed unexpectedly (please refer the note above).
Send e-mail... button Opens new email message window with the default mail client, already input the necessary texts such as receiver (support@emotive.de), mail title and draft content. You then need to attached all the report files and trace files, and write a brief description of the error, and send the e-mail. We recommend deleting the error report files after sending.
Open Folder... button Opens the storage folder of the error report files in a new window. You can take these files to attach to the report e-mail.
Reload button Updates the list of the error report files from the storage folder in the gridview (see gridview description below).
Delete button Deletes the selected error report files in the gridview (see gridview description below).
Include trace files check box Enables to include the trace files in the zipped error report file (checked) or not (unchecked).
Error Report gridview Displays all the error report files in the storage folder with file name, created date and size. Here you can select one or more error report files (using CTRL key, or SHIFT, or mouse drag or CTRL+A) to use with the Delete button above or with the DEL key. You can also sort the error report by date by clicking on the header of the "Date" column.
OtfSetting ErrorReporting.png
The "Error Reporting" page helps to manage the error report files of the OTF

Experts settings

This page contains the following sections which allows you to customize the specialized settings for the working environment of the OTF:

Save section

Here you can determine to store the ADMIN MetaData of an OTX document as a seperated file in the same package folder or store within the OTX document by checking or unchecking the related check box. Its default state is unchecked.

Sequence Designer section

The name of the activities (OTX nodes) in the Workflow Designer are optional. This section allows you to enable or disable the function of automatically creating unique names for the new activities in the workflow designer by using the corresponding check box.

Validation section

Normally, the OTF validates the current project (and all the referred projects) before executing a workflow. If there are critical errors, the execution shall not run.

In this section, you can find the check box "No Validation before execution", this check box allows to turn off the validation (ignore the critical errors) in run time. However, critical errors signal that the OTX sequences are incomplete or ill-designed so turning off the validation may result in unexpected behavior in run time.

Here in this section, you can also add the additional schema for the OTX-Extensions which are not supported by the OTF to validate documents/projects while they are being imported into the OTF. You can manually input the path for the schema file in the related text box or use the "Browse" button to browse to the schema location.

XSL Stylesheet Support section

This section related to the OTX-Viewer project of emotive which supports to view PTX libraries or OTX documents in the internet browser by adapting XSL Stylesheet for the OTX documents (click here for more information). This section allows to adapt or clean the XSL Stylesheet in all the available documents in the current solution with the "Adapt all documents" button and the "Clean all documents" button.

DoIP Support section

This section allows to configure some settings related to the DoIP support in runtime.

  • OptionString compliant to MVCI standard text box
  • Set ActivationLine (required by some VCIs) check box
  • Waiting time after activating the ActivationLine [ms] text box
  • Show vehicle selection dialog, even if only one interface is found check box

ODX-Database section

This section allows to configure the global settings for the ODX Database. Below are the check boxes in this section with their descriptions:

  • ODX-Database Synchronization check box:
    • Preconditions: This check box is checked and the solution contains projects using different ODX Databases. Note that this check box has no effect on the projects not using the Diagnostic Runtime System. If all the preconditions are not satisfied, then the behaviors below shall not work.
      • When you load the solution, or add a new or an existing project, or add a PTX/PPX as project, there shall be a dialog asking whether you want to adapt the used ODX Database of the Startup project for all the other projects using database in the solution. If you click Yes button all the projects using ODX Databases shall be adapted with the ODX Database of the Startup project; otherwise, if you click No button, it shall not adapt.
      • When you open the project settings of a project using the Diagnostic Runtime System (you may change the ODX Database) and click OK, the selected ODX Database (even the "None") shall be automatically adapted to all the other projects using ODX Databases; otherwise, if you click Cancel button, it shall not adapt.
  • Default value for the property 'PerformVariantSelection' of GetComChannel activity check box:
    Normally, the default 'PerformVariantSelection' of GetComChannel activity is false. If this check box is checked, if you add a new GetComChannel activity or add a DiagCom activities already containing the GetComChannel term, the 'PerformVariantSelection' is always set to true.
  • Display Id of TextTable Elements text box:
    If this check box is checked, the ID (ByteField) shall be displayed before each TextTable element of the TextTable Request parameter in the "Diagnostic Database" category of the Toolbox and in the Request-/Respond- parameters dialog of the ExecuteDiagService activity e.g. 0F - MainNetwork.

OTX-Mapping section

This section allows for configure the global settings for the OTX Mapping. Belows are the setting controls in this section:

  • APPs are stored outside the project in a central place check box:
    If this check box is checked, the OTX Mapping design time and run time in the OTF shall search and use the external applications in a global central folder; otherwise, the OTX Mapping in each project shall search and use the external applications in the application folder within the project folder. Note that if this check box is unchecked, all other settings in this section shall be disabled.
  • Central path for applications text box:
    This text box display the path of the current global central folder for the external applications. Here you can manually input or modify the path.
  • Browse button:
    When you click at this button, a dialog occurs for you to browse and select a folder as the global central folder, the selected folder shall be updated in the text box above.
  • Edit... button:
    This button allows to open the Application Folder manager dialog.

Application Folder manager dialog

The dialog consists of a command bar and an application gridview (see the image above). The gridview displays all the available external applications in the central folder with the detailed information such as name, version, changed data and size. Here in the gridview, you can select one or many applications (using CTRL key or SHIFT key) which can be handled with the buttons in the command bar.

Below are the buttons in this the command bar with their descriptions (according to their positions from left to right):

Button                                             Description
Add application... Opens a dialog to browse and add a new application (*.dll or *.exe) into the central folder.
Open Opens the global central folder in a new window explorer.
Delete Deletes the selected applications.
Create application container...Exclamation.png Creates an zipped and encrypted container file (*.apc) which contains all the selected applications. The container can not be unzipped normally, it can only be decrypted and unzipped by the OTF.
Load application container...Exclamation.png Opens a dialog to browse for a container file (*.apc), and then extracts all its applications into the global central folder.

Others section

This section allows to specify the prefix for copying and for the OTX-ID through the following text boxes:

  • Prefix for copying text box:
    Here you can input the prefix for the name of the copy of any OTX elements in an OTX document e.g. prefix 'emotive' shall be added to the copy of the 'Variable1' as 'emotiveVariable1'. Note that does not affect the existing elements.
  • OTX-ID button:
    Here you can input the prefix for the ID of all the newly created OTX elements in an OTX document e.g. prefix 'emotive' shall be added to the ID of the newly created 'Variable1' as 'emotive_VariableDeclaration_94b516346858438cba90fae3bfe2fee2'. Note that does not affect the existing elements.
OtfSetting Experts.png
The "Experts" page allows to customize the specialized settings for the working environment of the OTF


ApplicationFolderManager.png
The Application Folder manager allows to manage the external applications in the central application folder
Retrieved from "http://emotive.de/wiki/index.php?title=OtfSettings&oldid=7795"