Difference between revisions of "OtfProjectSharing"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:Open Test Framework - OTX Project Sharing}}[[Category:OTF]]
 
{{DISPLAYTITLE:Open Test Framework - OTX Project Sharing}}[[Category:OTF]]
  
−
UNDER DEVELOPEMENT ...
+
== Introduction ==
  
−
== PTX Export Manager ==
+
A project is a folder containing the OTX documents and all the necessary settings supporting for design time and run time (click [[OtfProjectStructure#Project|'''here''']] for more information). A 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 also can be used to be executed with the OTX-Runtime API ([http://www.emotive.de/DeveloperReference/OtxRuntime DotNet]/[http://www.emotive.de/DeveloperReference/OtxRuntimeJava Java]).
 +
 
 +
A player project does not contain the its own OTX documents but it contains layout using the elements from the referred projects, it also has all the necessary settings supporting for design time and run time. A project shall be exported into a PPX library for many usages. Similar to the PTX, a PPX is used for exchanging. 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.
 +
 
 +
The OTF supports exporting PTX/PPX file with many options. A PTX or PPX is a zipped file contains the files in the project or a player. You can select which files to be include 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]]) in the [[OtfSettings|OTF global options]], or if you have already enabled the Export Manager to be displayed when exporting, you can configure 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 ==
 +
{|
 +
| style="vertical-align:top; text-align:justify;"|
 +
The PTX/PPX Export Manager dialog box appears every time you export a project/player into PTX/PPX file. Here you can configure the content of the library and the method to protect the library with encryption.
 +
 
 +
Below are the sections in the dialog:
 +
 
 +
=== '''Content''' section ===
 +
 
 +
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):
  
 
{|{{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'''  
 +
|-{{TableRow2}}
 +
| '''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.
 +
|-{{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.}} || Enables to include 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 || 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.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
| '''Open dialog when exporting check box''' || Displays the "PTX Export Manager" dialog when exporting the PTX/PPX file.
+
| '''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.
 
|}
 
|}
  
−
=== '''Content section''' ===
 
  
−
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):
+
 
 +
=== '''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):
  
 
{|{{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;&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.
+
| '''Private key''' text box || Allows to specify 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).}} || Enables to encrypt 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).}} || 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}}
 
|-{{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).}} || Allows to select 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 in the bar 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 || Allows to select a behavior with the externally referred PTX files.
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
| '''Private key textbox''' || Specifies a password to encrypt and/or sign the PTX/PPX library.
+
| '''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}}
 
|-{{TableRow1}}
−
| '''Encrypt whole file check box{{TooltipIcon2|(Note: This control is only visible after entering the private key}}''' || Encrypts the entire PTX/PPX file and it only can be opened by OTX Runtime Api.
+
| '''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):
 +
 
 +
{|{{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; || '''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}}
−
| '''Protect content with a checksum check box{{TooltipIcon2|(Note: This control is only visible after entering the private key}}''' || Protects the PTX/PPX file against an encrypted checksum and it can be opened with the OTF or the OTX Runtime Api.
+
| '''Export''' button || Exports the project/player with the configured settings.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
| '''Checksum combo-box{{TooltipIcon2|(Note: This control is only visible if the &quot;Protect content with a checksum&quot; check box is checked }}''' || Selects the Hash algorithm.
+
| '''Cancel''' button || Cancels export task and close the manager.
 +
|}
 +
 
 +
| style="width:30px;" |
 +
| style="vertical-align:top; text-align:justify;"| {{ImageStyleCenter| OtfExportManager.png |600|The Export Manager allows to configure the content and the encryption of the exported file}}
 
|}
 
|}
  
−
=== '''Actions section''' ===
+
== Table of the PTX/PPX content with different export options ==
  
−
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):
 
  
 
{|{{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''' || '''Description'''  
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
| '''Referenced projects combo-box''' || Selects a behavior with externally referenced PTX files.
+
| '''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}}
−
| '''Store APPs inside project check box''' || Saves the external applications inside the project folder if this check box is checked.
+
| '''Export''' button || Exports the project/player with the configured settings.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
| '''Append version check box''' || Appends the project version number to the filename.
+
| '''Cancel''' button || Cancels export task and close the manager.
 
|}
 
|}

Revision as of 04:47, 14 September 2018


Introduction

A 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 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 also can be used to be executed with the OTX-Runtime API (DotNet/Java).

A player project does not contain the its own OTX documents but it contains layout using the elements from the referred projects, it also has all the necessary settings supporting for design time and run time. A project shall be exported into a PPX library for many usages. Similar to the PTX, a PPX is used for exchanging. 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.

The OTF supports exporting PTX/PPX file with many options. A PTX or PPX is a zipped file contains the files in the project or a player. You can select which files to be include 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) in the OTF global options, or if you have already enabled the Export Manager to be displayed when exporting, you can configure 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 appears every time you export a project/player into PTX/PPX file. Here you can configure the content of the library and the method to protect the library with encryption.

Below are the sections in the dialog:

Content section

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):

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.


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):

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. 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 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).
Checksum combo boxExclamation.png Allows to select the hash algorithm.


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):

Control                                                       Description
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.
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 project/player with the configured settings.
Cancel button Cancels export task and close the manager.
OtfExportManager.png
The Export Manager allows to configure the content and the encryption of the exported file

Table of the PTX/PPX content with different export options

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 project/player with the configured settings.
Cancel button Cancels export task and close the manager.
Retrieved from "http://emotive.de/wiki/index.php?title=OtfProjectSharing&oldid=6464"