OtfPlayerProjectSettings

Overview

The Player Project Settings are almost the same as the settings of a normal project. They only have differences in the "General" settings and the "External Applications" settings. The Player Project Settings shall apply for all the test sequences in all the referred projects when the generated PPX of that player project is executed with the OTP or with the Runtime Api.

To run a test sequence, both the OTX documents and the settings related to the OTX extensions used in the test sequence are taken into account. The Player Project Settings are all the settings which supports the runtime of the OTX test sequences used in the player monitors and playlists.

The Player Project Settings do not only specify the general settings such as project version and references to other projects but they also specify the detail settings which are used for specific extensions such as HMI extension, Measure extension, DiagCom extension, Logging extension, i18n extension and Quantities extension.

You can access the Player Project Settings of a player project by right-clicking on the corresponding player project node in the solution explorer and select the "Properties" menu entry, the Player Project Settings dialog box will be displayed for users to configure the player project settings. The Player Project Settings dialog box provides a centralized place for managing the player project properties and resources. It contains several pages that are accessed through tab entries on the left panel. By clicking on a tab entry on the left panel (e.g. "General", "External Applications" etc.), you can access the corresponding settings page on the right panel. You can adjust the settings in many pages and click OK button, and all the changes shall be applied.

The changes in the player project settings can not be reverted by undoing. The changes set in the sub-window e.g. OTX Mapping editor by clicking on the OK button of the sub-window can not be cancelled by clicking on the Cancel button in the main Player Project Settings dialog.

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

General settings

The player does not concern the OTX test sequence design so the general setting only contain the version number. Version Number section For the purpose of sharing the player project and tracing the modifications, you can set the version for the player 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 player project is under the version control (click here for more information).

The "General" page allows for setting the player project version

External Applications settings

This page allows to manage the OTX-Mapping which applies for each the referred project in runtime (click here for more information). All the referred projects or PTX files shall be displayed in this page, each of them has a mapping file combo box which allows you to select a mapping file used in runtime for that referred project/PTX. The mapping file combo box of a project/PTX shall not only display all the available mapping files of that project/PTX for selection to use but it also displays all the available mapping files of the current player project for selection to use. The Player Project Settings do not support to select and use the old version HMI Mapping file. At present, the OTF only supports OTX Mapping (or HMI Mapping) for runtime with Dotnet platform. All the available mapping files of the current player project are displayed in the sub-panel. 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 player 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.

The "External Access (APP-Id)" page allows for creating application-ids used to map to diagnostic application

References settings

This page allows you to add references to other projects. The referred projects can be classified into 2 types: the internal projects (the local projects in 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. For the problem that modifying elements with the same name may affect each other in design time, the OTF does not allow to add a new reference to a project which contains a first level package having the same name with a first level package of an existing referred project/PTX. Similarly, it also prevent adding reference to a PTX containing a first level package having the same name with a first level package of an existing referred project. 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 (it is not a player project) with access to all the public elements such as validities, signatures, global declarations and procedures to be used in another project (click here for more information of packing a project into a PTX library). 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. You can also import the referred PTX libraries from outside into the player 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. When the current player project is exported into a PPX, all the referred local projects in the solution are included in the PPX. The referred local projects shall be unzipped together with the main player project when the PPX library is added as a player project in a solution, all the local projects shall also be added to the solution. A player project can be exported into a PPX library. This PPX library can not be referred by a project or another player project, it can only be executed in the OTP or added to an OTX solution as a player project.

The "Project References" page allows for managing project references

DiagCom (ODX Diagnostic Data) settings

In this page, you can change the used ODX Database or set the ECU Groups used in design time validation. The settings in this page shall only be applied to all the referred projects in runtime. Unlike a normal project which can use the Diagnostic Runtime Systems or not, a player project always use the Diagnostic Runtime System. 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 player 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". After the conversion, you can select the newly converted ODX Database in the "Diagnostic Database (ODX) section" to use. 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. This section allows you to define the ECU Groups and the ECU variants in each ECU Group. The following rules are applied during validation: If an EcuVariantName is specified, it must exist in the ODX database. If the identifier is specified in the ECU variants list, all ECU variants must exist in all ECU groups in the ODX database. 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. 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. 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. Please 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 (according to their position in the bar from left to right): Button             Description Add ECU Adds an ECU (Identifier) which contains variant(s), note that an ECU (Identifier) can be added one time. Add Group Adds a Group of variant(s) in the current ECU (Identifier). Add Variant Adds a variant in the current Group. Delete Deletes the selected ECU (Identifier) / Group / variant. Move Up Moves the selected ECU (Identifier) / Group / variant up. Move Down Moves the selected ECU (Identifier) / Group / 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 ECU (Identifier) nodes to variant nodes. Collapse All Collapses all nodes, only displays the ECU (Identifier) 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.

The "DiagCom (ODX Diagnostic Data)" page allows for setting the ODX Diagnostic Database used with the referred projects of the player in runtime

Logging settings

This page allows you to specify the behavior of the explicit logging i.e. using the WriteLog activities of the Logging extension or the behavior of the implicit logging which automatically saves runtime traces, exceptions or activity IDs etc. This settings for logging behavior shall be applied for all the referred projects in runtime. 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. Below are the controls in the Logging settings page with their descriptions (according to their position in the bar from left-to-right and top-to-bottom): Control                                                       Description Logging switch button Allows to write log message in log files and apply the logging settings (ON) or not (OFF). Note that when this switch button is turned OFF, no log messages shall be written and all the control below shall be disabled, excepts for "WriteLog Target Resolving" check box. Directory Name check box Uses the default output folder for created log files. Directory Name text box Users can manually input the output location for created log files here if the users does not use the default output folder. ... (Browse) button Browses and inputs the output location for created log files in the Directory Name text box if the users does not use the default output folder. Open... button Opens the current output folder of the log files in a new window. File Name text box Defines the file name format of the created log files. Maximum File Number text box Sets the maximum number of the created log files in case the log file size exceeds the defined size in the "Maximim File Size" text box. Maximium File Size text box Sets the maximum file size (in megabytes) for the created log files. If the size of the log file increases and exceeds the maximum size, a new log file is created and the OTF continues to write the log messages in the new file. Message Format text box Users can mannually input the format of the log message here. Header Format multi-line text box Users can mannually input the format of the header of the log message here. Logging Level combo box Sets the log level for the log messages of the WriteLog activities to be written in the log file (only the message with the severity level equal or higher than the set log level shall be written in the log file). Communication Trace check box Allows to automatically write the communication traces into the log file (checked) or not (unchecked). Communication Trace combo box Sets the log level for the communication traces to be written into the log file. Variable Trace check box Allows to automatically write the variable traces into the log file (checked) or not (unchecked). Variable Trace combo box Sets the log level for the variable traces to be written into the log file. OTX-Exceptions check box Allows to automatically write the OTX exceptions into the log file (checked) or not (unchecked). OTX-Exceptions combo box Sets the log level for the OTX exceptions to be written into the log file. OTX-ID check box Allows to automatically write the IDs of the executed activities into the log file (checked) or not (unchecked). OTX-ID combo box Sets the log level for the IDs of the executed activities to be written into the log file. WriteLog Target Resolving check box Allows to automatically fill all the empty "Target" properties of all the WriteLog activities in the project with the default value (checked) or not (unchecked) when the project is exported into a PTX.

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 (*.ini). Each language file corresponds to a language and stores the data of that language. The settings shall be applied for all the referred projects in runtime. "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 combo box displaying all the available languages in the language folder. Here you can select a language to be the default language. The Translate activities shall 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 to manage all the data of the languages in the "Language Folder" (see detail in the section below). Note that if there is no language file in the language folder when you open the editor the first time, the "Add new language" dialog box shall appear first, this dialog helps you add a new language. "Include In Project" This check box allows you to include the language folder in the player project folder. This ensures that the language data is still available when the player project is exported to a PPX library and it is used in another computer (click here for more information of packing a player project into a PPX library). Text Library Editor This dialog box consists of a command bar above and a gridview displaying the data of all the language files below. Command Bar This command bar help you to edit the selected language data, below are the controls in the command bar with their descriptions (according to their position in the bar from left-to-right): Control                                                           Description New Language... button Opens the "Add new language" dialog to add a new language. In the dialog, you can select to add a language which does not exist in the Language Folder (it shall create a new language file in the Language Folder), here you can also select to base on the data of an existing language which can be automatically translated later via Google Translate. New Category button Adds a new category to contain the translation keys related to that category. New Text button Adds a translation key in the current category. Delete button Deletes the selected categories or translation keys. Sort A-Z button Sorts all the categories/translation keys in A-Z order if one or many categories/translation keys are selected. Filter text box Users can input the criteria to filter language data here. Only the translation keys containing the filter criteria shall be displayed. Translate From combo box Sets the language (one of the existing languages) to be based on when using the "Translate via 'Google Translate'" button. Translate Via "Google Translate" button Translates all texts of the based language (selected in the "Translate From" combo box) into the selected language via Google Translate. Delete The 'To Edit' Character button Deletes all the 'To Edit' characters (#) in the selected language. Open Language Folder button Opens the current language folder in a new window. Save button Saves the all current changes. Language Data gridview 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 entering new texts (or you can select one entry and press F2 key). Here you can select one or many entries of the same type (i.e. same category type, or translation key type) by using the CTRL- or SHIFT-key and mouse click. The selected entries shall be edited with the controls in the command bar above or you can also manage them directly in the gridview such as moving selected entries with drag-and-drop, or copying keys from a category to the others with drag-and-drop and the CTRL key.

The "i18n" page allows for configuring the Text Blocks Library for the i18n extension The Text Library Editor allows for managing and editing the language data

Quantities settings

In this page, you can manage unit libraries (the ODX UNIT-SPEC containers) which support in calculating values with units (see Quantities extension). The support libraries shall be applied for the all referred projects in runtime. Below are the elements in this page with their descriptions: Element                                                           Description Add button Opens a window to browse and add reference to a new unit library (*.odx or *.odx-cc). Delete button Deletes the reference to the selected unit library. Expand All button Expands all nodes in all the unit libraries. Collapse All button Collapses all nodes, only displays the library nodes. Filter text box Users can input the criteria to filter unit data here. Only the unit data containing the filter criteria shall be displayed. Unit Library tree view Displays all the referrences to the unit libraries and the detail data of each library. Here you can only select one entry at a time, and only the selected unit library node can be used with the "Delete" button (X) or with the DEL key. Stored/Imported Within Project check box Sets one or many unit libraries to be stored/imported within the player project. When the check box is checked, a check box shall appear at the left of each unit libraries, the unit libraries with the checked check box shall be imported into the player project folder. This ensures the unit data is still available when used in another computer.

The "Quantities" page allows for managing the Quantity libraries