OtfPlayerProjectSettings

From emotive
Revision as of 07:37, 2 September 2018 by Nb (talk | contribs) (Created page with "{{DISPLAYTITLE:Open Test Framework - Player Project Settings}}Category:OTF ==Overview== <!--The '''Project Settings''' specify how the backup files are stored, how a proj...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


Overview

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

General settings

Backups section

In this section, you can set the location path of the storage folder for the backup OTX documents. Each time you start a sequence in the project or build the project, all the OTX documents including the contain OTX packages are copied to the storage folder. This helps in case the OTX documents are unexpectedly changed, damaged or deleted at design-time. You can input the location path directly or browse for the folder via the "Browse" button.

Version Number section

For the purpose of sharing the project and tracing the modifications, you can set the version for the project manually by enter a number into each digit text box, or it can be done automatically by checking the "Bind last digit to SVN revision number" check box if the current project is under the version control (click here for more information).

Import MetaData Layout section

Here you can select a Meta-Data layout (*.xml) used in the project. You can then add the template Meta-Data for the documents, procedures or activites from the added layout. You can input the path of the Meta-Data layout file directly or browse for the folder via the "Browse" button. If you want to import the layout file into the project folder for exchanging the project, you can check the "Import inside the project" check box.

After Build section

Here you can input the location path for the PTX storage folder directly or browse for the folder via the "Browse" button.


OtfPrjSetting General.png
The "General" page allows for setting the backup OTX documents location, the project version, the used Meta-Data layout and PTX storage folder


External Applications settings

This page allows to manage the OTX-Mapping of the current project (click here for more information). There can be many mapping files stored in the project but only one mapping file can be used at a time. Here you can select to use the OTX Mapping or HMI MappingExclamation.png by checking on the corresponding radio button. After selecting OTX Mapping or HMI Mapping, you can select a mapping file which shall be used for the current project in runtime through the corresponding combo box.

Icons Note.png At present, the OTF only supports OTX Mapping (or HMI Mapping) for runtime with Dotnet platform.

All the available mapping files of the current project are displayed in the sub-panel (the old HMI Mapping files are not displayed here but they can be still selected in the HMI Mapping combo box). You can use the buttons below the sub-panel to manage the mapping files. Please note that you can only select and edit one mapping file at a time.


Below are the descriptions of the buttons to manage the mapping files:

Button Description
Rename Renames the selected mapping file.
Import... Imports an existing mapping file from outside of the project.
New... Creates a new mapping file.
Edit... Opens the selected mapping file in the OTX Mapping editor for editing.
Delete Deletes the selected mapping file.
OtfPrjSetting ExtApps.png
The "External Access (APP-Id)" page allows for creating application-ids used to map to diagnostic application


References settings

Normally, the OTX documents in the current project can only import documents within the same project (Cross-Document reference). To import and use the global elements from the documents in another project, you need to add reference to that project (Cross-Project reference). Click here for more information about reference.

The referred projects can be classified into 2 types: the internal projects (the local projects of the current solution) and the external projects (the PTX libraries). Here in this page you can find the 2 sections with sub-panels corresponding to the 2 types of referred projects.

Internal Projects section

Here you can find all the available local projects of the current solution, each having a check box. You can add or delete a reference to a project by checking or unchecking the corresponding check box. When this settings page is loaded, the check boxes of the referred projects are already checked.

External Projects section

A PTX library is a zipped OTX project with access to all the public elements such as validities, signatures, global declarations and procedures to be used in another project. In this section, you can see all the referred PTX libraries displayed in the sub-panel. Above the sub-panel, you can find the Add (+) button to add reference to more PTX libraries, or the Delete button (X) to delete the selected PTX references in the sub-panel , or the "Convert to relative Path" button to convert a PTX reference path into relative path (conversion to relative path only has effect on references with absolute path having the same disk partition with the current project). You can also import the referred PTX libraries from outside into the project folder by using the "The libraries are stored inside the project folder" check box under the sub-panel. When the check box is checked, a check box shall appear at the left of each PTX entries, the PTX libraries with the checked check box shall be imported into the project folder.

Icons Note.png Note that a document in the current project can not import a documents in another project with the same document and package name.
Icons Note.png When the current project is exported into a PTX, all the referred local projects in the solution are included in the PTX. The referred local projects shall be unzipped together with the main project when the PTX library is added as a project in a solution, all the local projects shall also be added to the solution.
OtfPrjSetting References.png
The "Project References" page allows for managing project references


DiagCom (ODX Diagnostic Data) settings

In this page, you can determine whether the current project uses the Diagnostic Runtime System or not, change the used ODX Database or set the ECU Groups used in design time validation.

Diagnostic Runtime System (MVCI) section

You can use the switch button to turn ON/OFF using the Diagnostic Runtime System. When it is switched OFF, all the sections below this section shall be hidden. If a project does not use the Diagnostic Runtime System, it can be used and executed even in a machine with the Diagnostic Runtime System.

When the switch button is ON, the current Diagnostic Runtime System (MVCI) selected in the MVCI Configuration application shall be used and its ODX Databases shall be updated in the

Diagnostic Database (ODX) section

In this section, you can access the database part of the current Diagnostic Runtime System (MVCI). To select and configure the MVCI Server, please open the MVCI Configuration program by clicking on the corresponding button in the Status Bar (or clicking on the "Open" Configuration Program button in the "Diagnostic Runtime System" tab of the OTF Options menu).

To set and use an ODX Database in the project, you must first select the database project through the "Project" combo box and then select the vehicle within the database project through the "Vehicle" combo box.

PDX Converter (DSA MVCI Server) section

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...". The result of the PDX file conversion shall be displayed in the Output panel. The "Additional Optional Arguments" text box allows you to add the arguments used in PDX conversion, its default value is "-consoletrace 1 -ignoreerror 0" which means "write console trace = yes, ignore error = no".

ECU Groups section

In variant identification, the actual ECU variant is known only at runtime. In order for the process to be validated at design time, all possible ECU variants can be specified in groups. The following rules are applied during validation:

  1. If an EcuVariantName is specified, it must exist in the ODX database.
  2. If the identifier is specified in the ECU variants list, all ECU variants must exist in all ECU groups in the ODX database.
  3. An element (DiagServiceName, DiagServiceSemantik, FlashSessionName, Request/Response parameters, ParameterValue) is valid, if it exists in all variants of all ECU groups of the related Identifier.
    1. If an element does not appear in any variant of an ECU group AND the same element is present in all variants of at least one other ECU group, the previous error is neutralized.

Note The behavior of the Access path property is also taken into account.

This section contains a menu bar and a panel displaying the specified ECU groups. Note that all the controls in this section are disabled if the ODX Database has not been selected yet i.e. "None".

Menu Bar

Below are the buttons with their descriptions:

Button             Description
Add ECU Adds a Logical Link (Identifier) which contains ECU variant(s), note that a Logical Link can be added one time.
Add Group Adds a Group of ECU variant(s) in the current Logical Link.
Add Variant Adds an ECU variant in the current Group.
Delete Deletes the selected Logical Link / Group / ECU variant.
Move Up Moves the selected Logical Link / Group / ECU variant up.
Move Down Moves the selected Logical Link / Group / ECU variant down.
Import Imports the ECU variant list from existing DiagCom project settings (*.otfDiag).
Export Exports the ECU variant list to DiagCom project settings (*.otfDiag).
Expand All Expands all nodes from Logical Links nodes to ECU variant nodes.
Collapse All Collapses all nodes, only displays the Logical Link nodes.

ECU Variant List panel

This panel displays the specified ECU variant list existed in the DiagCom project settings file (*.otfDiag). Here you can only select one element at a time, this element can be modified with the menu bar above.

OtfPrjSetting DiagCom.png
The "DiagCom (ODX Diagnostic Data)" page allows for setting the ODX Diagnostic Database used within the project


Logging settings

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)
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"
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"
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.
  • "Message Format" and "Header Format"
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 check-box allows you to determine whether the diagnostic communication is automatically written in the log files or not.
  • "WriteLog Target Resolving"
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.
OtfPrjSetting Logging.png
The "Logging" page allows for configuring how the log messages are recorded at runtime

i18n settings

In this page, you can configure the Text Blocks Library for the 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.

  • "Language Folder"
Here you can input the location path of the storage folder for the language files, or browse for the folder.
  • "Default Language"
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.
  • "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.
OtfPrjSetting i18n.png
The "i18n" page allows for configuring the Text Blocks Library for the i18n extension


TextBlockLibrary.png
The Text Block Library allows for managing and editing the language data


Quantities settings

In this page, you can manage the Quantity libraries (the ODX UNIT-SPEC containers) which allow for calculating values with units.

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.

OtfPrjSetting Quantities.png
The "Quantities" page allows for managing the Quantity libraries