Difference between revisions of "OtfProjectSharing"

From emotive
Jump to navigation Jump to search
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Open Test Framework - OTX Project Sharing}}[[Category:OTF]]
 
{{DISPLAYTITLE:Open Test Framework - OTX Project Sharing}}[[Category:OTF]]
  
−
== PTX Export Manager ==
+
== Introduction ==
  
−
"Open dialog when exporting" check box ...
+
There are 2 kinds of projects: '''Procedure Projects''' and '''Player Projects'''.
  
−
=== '''Content section''' ===
+
A '''procedure project''' is a folder containing the OTX documents and all the necessary settings supporting for design time and run time (click [[OtfProjectStructure#Procedure_Project|'''here''']] for more information). A procedure project can be exported into a PTX library for many usages. Users can exchange the test sequences to the other computers while all the environment settings are still preserved. The PTX library can be imported back into a solution as a project, or it can be used as a reference in another project. The PTX library can also be used to be executed with the OTX-Runtime API ([http://www.emotive.de/DeveloperReference/OtxRuntime DotNet OTX-Runtime API]/[http://www.emotive.de/DeveloperReference/OtxRuntimeJava Java OTX-Runtime API]).
  
−
Below are the controls in the "Content" section with their descriptions (according to their position in the bar from left-to-right and top-to-bottom):
+
A '''player project''' does not contain its own OTX documents but it contains layouts using the elements from the referred procedure projects, it also has all the necessary settings supporting for design time and run time. A player project shall be exported into a PPX library for many usages. Similar to the PTX, a PPX is used for exchanging the test sequences together with the layouts. It can be imported back into a solution as a player project but it can not be referred by any projects. The main usage of a PPX library is to run with the [https://www.emotive.de/otp-en.html Open Test Player] where the data of the test sequences can be displayed in customized graphic layouts.
 +
 
 +
You can export a project can be exported to create a PTX/PPX via the context menu of a [[OtfSolutionExplorer#Projects|project node]] in the [[OtfSolutionExplorer|Solution Explorer]]. A PTX or PPX is a zipped file contains the files in the procedure project or player project. You can select which files to be included in the PTX/PPX. You can also encrypt the PTX/PPX for the security reason. These options of exporting PTX/PPX can be configure in the related sections ([[OtfSettings#Save_-_PTX|"Save - PTX"]] and [[OtfSettings#Security_-_PTX|"Security - PTX"]]) of the [[OtfSettings|OTF global options]], or if you have already enabled the Export Manager to be displayed when exporting, you can configure these options directly in the Manager. To enable the Export Manager, please tick at the "Open dialog when exporting" check box in the General settings page of the [[OtfSettings|OTF global options]].
 +
 
 +
{{Note|Note that when you modify the options in the related sections in setting ([[OtfSettings#Save_-_PTX|"Save - PTX"]] and [[OtfSettings#Security_-_PTX|"Security - PTX"]]) in the [[OtfSettings|OTF global options]], it shall adapt the modifications to the Export Manager and vice versa.}}
 +
 
 +
<!--{{Note|When a project/player is exported into a PTX/PPX, all the referred local projects in the solution are always included in the PTX/PPX. The referred local projects shall be unzipped together with the main project/player when the PTX/PPX library is added as a project/player in a solution, all the local projects shall also be added to the solution. Also, the included referred PTX libraries are always zipped within the exported PTX/PPX. On the other hand, the external referred projects (in case you add existing external project into the solution without including it) or the external referred PTX libraries (i.e. not included) can be store in }}-->
 +
 
 +
== PTX/PPX Export Manager ==
 +
 
 +
The PTX/PPX Export Manager dialog box appears{{TooltipIcon2|The &#x00022;Open dialog when exporting&#x00022; check box in the General settings page of the OTF global options must be ticked.}} every time you export a procedure project/player project into PTX/PPX file. Here you can configure the content of the library and the method to protect the library with encryption.
 +
 
 +
{{ImageStyleCenter|OtfExportManager.png||The Export Manager allows to configure the content and the encryption of the exported file}}
 +
 
 +
Below are the sections in the dialog:
 +
 
 +
=== '''Content''' section ===
 +
 
 +
Below are the controls in the "Content" section with their descriptions (according to their position from left-to-right and top-to-bottom):
  
 
{|{{TableHeader}}
 
{|{{TableHeader}}
Line 13: Line 31:
 
| '''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; || '''Description'''  
 
| '''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; || '''Description'''  
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
| '''OTX files check box{{TooltipIcon2|(Note: This entry will be checked and disabled if all the remaining check boxes are not checked}}''' || Exports the PTX library with only an OTX folder which contains all OTX files.
+
| '''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.}} || Includes the OTX folder containing all OTX files in the PTX library (checked) or not (unchecked) when exporting a project.
 +
|-{{TableRow1}}
 +
| '''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.}} || Includes all '''emotive''' specific project settings in the PTX library (checked) or not (unchecked) when exporting a project.
 +
|-{{TableRow2}}
 +
| '''Runtime-optimized binaries for DotNet''' check box || Includes the Output folder containing the compiled and executable binaries for DotNet runtime in the PTX library (checked) or not (unchecked) when exporting a project.
 +
|-{{TableRow1}}
 +
| '''Runtime-optimized binaries for Java''' check box || Includes the Output folder containing the compiled and executable binaries for Java runtime in the PTX library (checked) or not (unchecked) when exporting a project.
 +
|}
 +
 
 +
 
 +
=== '''Security''' section ===
 +
 
 +
Below are the controls in the "Security" section with their descriptions (according to their position from left-to-right and top-to-bottom):
 +
 
 +
{|{{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;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; || '''Description'''
 +
|-{{TableRow2}}
 +
| '''Private key''' text box || Specifies a password to encrypt and/or sign the exported PTX/PPX library.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
| '''Runtime settings check box{{TooltipIcon2|(Note: This entry is always checked with one of the remaining check boxes}}''' || Exports the PTX library with all EMOTIVE specific project settings.
+
| '''Encryption''' check box''{{TooltipIcon2|This control is only enabled if the private key is not empty (i.e. there must be an input key).}} || Encrypts the entire PTX/PPX file (checked) or not (unchecked) when exporting a project. Note that once you encrypted the file, it can not be imported again into the OTF. 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}}
 
|-{{TableRow2}}
−
| '''Runtime-optimized binaries for Dotnet check box''' || Exports the PTX library with only an Output folder which contain the already compiled and executable binaries for Dotnet runtime.
+
| '''Protect content 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).}} || Protects 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}}
 
|-{{TableRow1}}
−
| '''Runtime-optimized binaries for Java check box''' || Exports the PTX library with only an JavaOutput folder which contain the already compiled and executable binaries for Java runtime.
+
| '''Checksum''' combo box''{{TooltipIcon2|This control is only enabled if the private key is not empty (i.e. there must be an input key).}} || Selects the [https://en.wikipedia.org/wiki/Cryptographic_hash_function#Cryptographic_hash_algorithms hash algorithm].
 
|}
 
|}
  
−
=== '''Security section''' ===
 
  
−
Below are the controls in the "Security" section with their descriptions (according to their position in the bar from left-to-right and top-to-bottom):
+
=== '''Actions''' section ===
 +
 
 +
Below are the controls in the "Actions" section with their descriptions (according to their position from left-to-right and top-to-bottom):
  
 
{|{{TableHeader}}
 
{|{{TableHeader}}
 
|- style="background: gray; color: white; vertical-align:top;'''"  
 
|- 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; || '''Description'''  
 
| '''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; || '''Description'''  
 +
|-{{TableRow1}}
 +
| '''Referenced projects''' combo box || Selects a behavior with the referred projects (&#x0002A; applied to projects and to PTX files which are not included):
 +
* 'Store inside PTX': The references&#x0002A; will also be exported and included in the newly created PTX file. The absolute and relative paths of the included references will be modified to adapt the inclusion.
 +
* 'Store next to PTX': The references&#x0002A; will also be exported to the same output folder of the newly created PTX file. The absolute and relative paths of the included references will stay the same.
 +
* 'No action': The references&#x0002A; will not be exported or included. The absolute and relative paths of the included references will stay the same.
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
| '''Logging switch button''' || Allows to write log files and apply the logging settings (ON) or not (OFF).
+
| '''Store APPs inside project''' check box || Copies 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}}
 
|-{{TableRow1}}
−
| '''Directory Name check box''' || Uses the default output folder for created log files.
+
| '''Append version''' check box || Appends the project version number to the exported PTX/PPX file name.
 
|}
 
|}
  
−
=== '''Actions section''' ===
 
  
−
Below are the controls in the "Actions" section with their descriptions (according to their position in the bar from left-to-right and top-to-bottom):
+
=== '''Sub (Bottom)''' section ===
 +
 
 +
Below are the controls in the "Sub" section with their descriptions (according to their positions from left to right and top to bottom):
  
 
{|{{TableHeader}}
 
{|{{TableHeader}}
 
|- style="background: gray; color: white; vertical-align:top;'''"  
 
|- 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; || '''Description'''  
 
| '''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; || '''Description'''  
 +
|-{{TableRow1}}
 +
| '''Open dialog when exporting''' check box || Enables (checked) or disables (unchecked) displaying the "PTX Export Manager" dialog when exporting the PTX/PPX file.
 +
|-{{TableRow2}}
 +
| '''Export''' button || Exports the procedure project/player project with the configured settings.
 +
|-{{TableRow1}}
 +
| '''Cancel''' button || Cancels export task and closes the manager.
 +
|}
 +
<!--
 +
== Table of the PTX/PPX content with different export options ==
 +
 +
 +
{|{{TableHeader}}
 +
|- style="background: gray; color: white; vertical-align:top;'''"
 +
| '''Control''' || '''Description'''
 +
|-{{TableRow1}}
 +
| '''Open dialog when exporting''' check box || Enables (checked) or disables (unchecked) displaying the "PTX Export Manager" dialog when exporting the PTX/PPX file.
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
| '''Logging switch button''' || Allows to write log files and apply the logging settings (ON) or not (OFF).
+
| '''Export''' button || Exports the procedure project/player project with the configured settings.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
| '''Directory Name check box''' || Uses the default output folder for created log files.
+
| '''Cancel''' button || Cancels export task and closes the manager.
 
|}
 
|}
 +
 +
 +
SUGGESTION:
 +
 +
project player OTX files Runtime settings Binaries for DotNet Birnaries for Java
 +
DatabaseAccess none - - - -
 +
HMI none - - - -
 +
i18n i18n - - - -
 +
JavaOutput none - - - -
 +
Logging Logging - - - -
 +
Measure none - - - -
 +
ODX ODX - - - -
 +
OTX none - - - -
 +
OTX-Backup none - - - -
 +
OTX-Mapping OTX-Mapping - - - -
 +
Output none - - - -
 +
PTX PTX - - - -
 +
Quantity Quantity - - - -
 +
project file (*.'''otfPrj''') none - - - -
 +
none player layout file (*.'''playLay''') - - - -
 +
none playlist file (*.'''playLst''') - - - -
 +
none player project file (*.'''playPrj''') - - - -
 +
 +
-->

Latest revision as of 04:31, 20 November 2018


Introduction

There are 2 kinds of projects: Procedure Projects and Player Projects.

A procedure project is a folder containing the OTX documents and all the necessary settings supporting for design time and run time (click here for more information). A procedure project can be exported into a PTX library for many usages. Users can exchange the test sequences to the other computers while all the environment settings are still preserved. The PTX library can be imported back into a solution as a project, or it can be used as a reference in another project. The PTX library can also be used to be executed with the OTX-Runtime API (DotNet OTX-Runtime API/Java OTX-Runtime API).

A player project does not contain its own OTX documents but it contains layouts using the elements from the referred procedure projects, it also has all the necessary settings supporting for design time and run time. A player project shall be exported into a PPX library for many usages. Similar to the PTX, a PPX is used for exchanging the test sequences together with the layouts. It can be imported back into a solution as a player project but it can not be referred by any projects. The main usage of a PPX library is to run with the Open Test Player where the data of the test sequences can be displayed in customized graphic layouts.

You can export a project can be exported to create a PTX/PPX via the context menu of a project node in the Solution Explorer. A PTX or PPX is a zipped file contains the files in the procedure project or player project. You can select which files to be included in the PTX/PPX. You can also encrypt the PTX/PPX for the security reason. These options of exporting PTX/PPX can be configure in the related sections ("Save - PTX" and "Security - PTX") of the OTF global options, or if you have already enabled the Export Manager to be displayed when exporting, you can configure these options directly in the Manager. To enable the Export Manager, please tick at the "Open dialog when exporting" check box in the General settings page of the OTF global options.

Icons Note.png Note that when you modify the options in the related sections in setting ("Save - PTX" and "Security - PTX") in the OTF global options, it shall adapt the modifications to the Export Manager and vice versa.


PTX/PPX Export Manager

The PTX/PPX Export Manager dialog box appearsExclamation.png every time you export a procedure project/player project into PTX/PPX file. Here you can configure the content of the library and the method to protect the library with encryption.

px
The Export Manager allows to configure the content and the encryption of the exported file

Below are the sections in the dialog:

Content section

Below are the controls in the "Content" section with their descriptions (according to their position from left-to-right and top-to-bottom):

Control                                                       Description
OTX files check boxExclamation.png Includes the OTX folder containing all OTX files in the PTX library (checked) or not (unchecked) when exporting a project.
Runtime settings check boxExclamation.png Includes all emotive specific project settings in the PTX library (checked) or not (unchecked) when exporting a project.
Runtime-optimized binaries for DotNet check box Includes 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 Includes the Output folder containing the compiled and executable binaries for Java runtime in the PTX library (checked) or not (unchecked) when exporting a project.


Security section

Below are the controls in the "Security" section with their descriptions (according to their position from left-to-right and top-to-bottom):

Control                                                                 Description
Private key text box Specifies a password to encrypt and/or sign the exported PTX/PPX library.
Encryption check boxExclamation.png Encrypts the entire PTX/PPX file (checked) or not (unchecked) when exporting a project. Note that once you encrypted the file, it can not be imported again into the OTF. The encrypted PTX/PPX file can only be opened by the OTX-Runtime API (DotNet/Java).
Protect content with a checksum check boxExclamation.png Protects 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).
Checksum combo boxExclamation.png Selects the hash algorithm.


Actions section

Below are the controls in the "Actions" section with their descriptions (according to their position from left-to-right and top-to-bottom):

Control                                                       Description
Referenced projects combo box Selects a behavior with the referred projects (* applied to projects and to PTX files which are not included):
  • 'Store inside PTX': The references* will also be exported and included in the newly created PTX file. The absolute and relative paths of the included references will be modified to adapt the inclusion.
  • 'Store next to PTX': The references* will also be exported to the same output folder of the newly created PTX file. The absolute and relative paths of the included references will stay the same.
  • 'No action': The references* will not be exported or included. The absolute and relative paths of the included references will stay the same.
Store APPs inside project check box Copies all the referred external applications (from the central application folder) into the PTX/PPX library (checked) or not (unchecked) when exporting a project.
Append version check box Appends the project version number to the exported PTX/PPX file name.


Sub (Bottom) section

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

Control                                                       Description
Open dialog when exporting check box Enables (checked) or disables (unchecked) displaying the "PTX Export Manager" dialog when exporting the PTX/PPX file.
Export button Exports the procedure project/player project with the configured settings.
Cancel button Cancels export task and closes the manager.
Retrieved from "http://emotive.de/wiki/index.php?title=OtfProjectSharing&oldid=9216"