Difference between revisions of "OtfProjectStructure"
Line 20: | Line 20: | ||
==Procedure Project== | ==Procedure Project== | ||
− | Procedure projects are used in a solution to logically manage, build and debug [[Core.Documents|Documents]] and [[OtfProjectSettings|Project Settings]]. The output of a project is usually a dynamic-link library (.dll) file or | + | Procedure projects are used in a solution to logically manage, build and debug [[Core.Documents|Documents]] and [[OtfProjectSettings|Project Settings]]. The output of a project is usually a dynamic-link library (.dll) file or Java ARchive (.jar), see project Output folder. |
OTF provides pre- or self-defined [[OtfTemplates|Project Templates]]. You can use these templates to create the basic project container and a preliminary set of items that you might need in order to develop your test application. | OTF provides pre- or self-defined [[OtfTemplates|Project Templates]]. You can use these templates to create the basic project container and a preliminary set of items that you might need in order to develop your test application. | ||
− | |||
− | |||
===PTX=== | ===PTX=== | ||
[[File:ProjectStructure.png|thumb|Project Structure]] | [[File:ProjectStructure.png|thumb|Project Structure]] | ||
− | A PTX is a project packed in a ZIP archive (Format see ISO 22901 PDX). A PTX can be used as a container for OTX file deployment or as a library for importing in other projects. | + | A PTX is a project packed in a ZIP archive (Format see ISO 22901 PDX). A PTX can be used as a container for OTX file deployment or as a library for importing in other projects. Click [[OtfProjectSharing|here]] for more information of packing a project into a PTX. |
A project can be exported to create a PTX via the context menu of a [[OtfSolutionExplorer#Projects|project node]] in the [[OtfSolutionExplorer|Solution Explorer]]. | A project can be exported to create a PTX via the context menu of a [[OtfSolutionExplorer#Projects|project node]] in the [[OtfSolutionExplorer|Solution Explorer]]. | ||
Line 37: | Line 35: | ||
|- style="background: gray; color: white; vertical-align:top;'''" | |- style="background: gray; color: white; vertical-align:top;'''" | ||
| '''Folder Name''' || '''Content''' | | '''Folder Name''' || '''Content''' | ||
+ | |-{{TableRow1}} | ||
+ | | '''DatabaseAccess''' || Settings of the DatabaseAccess-Extension. | ||
|-{{TableRow2}} | |-{{TableRow2}} | ||
| '''HMI''' || Settings of the HMI-Extension e.g. Screen-Mapping, see [[OtfProjectSettings|Project Settings]]. | | '''HMI''' || Settings of the HMI-Extension e.g. Screen-Mapping, see [[OtfProjectSettings|Project Settings]]. | ||
Line 66: | Line 66: | ||
===References=== | ===References=== | ||
− | All elements | + | All elements with the sufficient [[Core.Visibilities|Visibility]] inside an OTX Document can be used by another document. The following elements can be referred: |
# [[Core.Validities|Validities]] | # [[Core.Validities|Validities]] | ||
# [[Core.Signatures|Signatures]] | # [[Core.Signatures|Signatures]] | ||
Line 72: | Line 72: | ||
# [[Core.Procedures|Procedures]] | # [[Core.Procedures|Procedures]] | ||
− | Before a global entity can be referred the related document shall be imported, see [[Core.Imports|Imports]]. If the document is outside the project, a reference to the outside project should be added, see [[OtfProjectSettings#Project_References_settings| Project Settings]]. | + | Before a global entity can be referred, the related document shall be imported, see [[Core.Imports|Imports]]. If the document is outside the project, a reference to the outside project should be added, see [[OtfProjectSettings#Project_References_settings| Project Settings]]. |
==Player Project== | ==Player Project== | ||
Line 86: | Line 86: | ||
===Structure=== | ===Structure=== | ||
− | <!--A project consists of a project settings file '''*.otfPrj''' and the following folders: | + | <!--A project consists of a project settings file '''*.otfPrj''' and the following folders:--> |
{|{{TableHeader}} | {|{{TableHeader}} | ||
|- style="background: gray; color: white; vertical-align:top;'''" | |- style="background: gray; color: white; vertical-align:top;'''" | ||
| '''Folder Name''' || '''Content''' | | '''Folder Name''' || '''Content''' | ||
− | |||
− | |||
|-{{TableRow1}} | |-{{TableRow1}} | ||
| '''i18n''' || Settings of the I18N-Extension e.g. multilingual text library, see [[OtfProjectSettings|Project Settings]]. | | '''i18n''' || Settings of the I18N-Extension e.g. multilingual text library, see [[OtfProjectSettings|Project Settings]]. | ||
− | |||
− | |||
|-{{TableRow1}} | |-{{TableRow1}} | ||
| '''Logging''' || Settings of the Logging-Extension, see [[OtfProjectSettings|Project Settings]]. | | '''Logging''' || Settings of the Logging-Extension, see [[OtfProjectSettings|Project Settings]]. | ||
− | |||
− | |||
|-{{TableRow1}} | |-{{TableRow1}} | ||
| '''ODX''' || Settings of the DiagCom-Extension, see [[OtfProjectSettings|Project Settings]]. | | '''ODX''' || Settings of the DiagCom-Extension, see [[OtfProjectSettings|Project Settings]]. | ||
− | |||
− | |||
− | |||
− | |||
|-{{TableRow2}} | |-{{TableRow2}} | ||
| '''OTX-Mapping''' || External applications (*.exe or *.dll) using for [[OtfDeviceMapping|Device Mapping]] or [[OtfContextMapping|Context Mapping]], see [[OtfProjectSettings|Project Settings]]. | | '''OTX-Mapping''' || External applications (*.exe or *.dll) using for [[OtfDeviceMapping|Device Mapping]] or [[OtfContextMapping|Context Mapping]], see [[OtfProjectSettings|Project Settings]]. | ||
− | |||
− | |||
|-{{TableRow2}} | |-{{TableRow2}} | ||
| '''PTX''' || Contains PTX libraries used inside the project | | '''PTX''' || Contains PTX libraries used inside the project | ||
Line 117: | Line 105: | ||
|} | |} | ||
− | {{Note|The only mandatory folder of a project is the | + | {{Note|The only mandatory folder of a project is the PTX folder. All other folders can be omitted. Not specified settings will be adjust to default values.}} |
===References=== | ===References=== | ||
− | + | Some kinds of elements inside an OTX Document can be used to bound to elements in a player project. The following elements can be referred: | |
− | |||
− | |||
# [[Core.Declarations.GlobalDeclarations|Global Declarations]] | # [[Core.Declarations.GlobalDeclarations|Global Declarations]] | ||
# [[Core.Procedures|Procedures]] | # [[Core.Procedures|Procedures]] | ||
+ | # [[Core.Parameters|LocalParameters]] | ||
− | Before | + | Before an element can be referred, a reference to the related procedure project should be added, see [[OtfProjectSettings#Project_References_settings| Project Settings]]. |
Revision as of 12:57, 16 November 2018
UNDER DEVELOPMENT ...
Contents
Overview
The OTF provides two containers to help you efficiently organize and manage all items, such as Packages, Documents, Layouts and Settings. These containers are called
- Solution and
- Project.
The Solution Explorer can be used to view and manage a solution along with the projects inside and their associated items.
The picture below shows overall structure of the solution and the procedure projects in the OTF. Beginning from right hand side a solution contains one or more projects, a project contains one or more packages, a package contains one or more documents, a document contains one or more procedures and a procedure contains one or more activities. It is possible to call procedures or use global elements such as validities, signatures and global declarations inside the same document (In-Document reference), outside the document yet inside the same procedure project (Cross-Document reference) and outside the project (Cross-Project reference). References to PTX files are also counted as (Cross-Project reference).
OTF Storage Structure |
Solution
A solution contains one or more projects. Solutions group projects together which are needed for the test task as a whole. OTF automatically generates a solution when a new project is created. OTF stores the definition for a solution in two files: *.otfSln and *.otfSuo.
Procedure Project
Procedure projects are used in a solution to logically manage, build and debug Documents and Project Settings. The output of a project is usually a dynamic-link library (.dll) file or Java ARchive (.jar), see project Output folder. OTF provides pre- or self-defined Project Templates. You can use these templates to create the basic project container and a preliminary set of items that you might need in order to develop your test application.
PTX
A PTX is a project packed in a ZIP archive (Format see ISO 22901 PDX). A PTX can be used as a container for OTX file deployment or as a library for importing in other projects. Click here for more information of packing a project into a PTX.
A project can be exported to create a PTX via the context menu of a project node in the Solution Explorer.
Structure
A project consists of a project settings file *.otfPrj and the following folders:
Folder Name | Content |
DatabaseAccess | Settings of the DatabaseAccess-Extension. |
HMI | Settings of the HMI-Extension e.g. Screen-Mapping, see Project Settings. |
i18n | Settings of the I18N-Extension e.g. multilingual text library, see Project Settings. |
JavaOutput | Contains all generated JAR files for executing (click here for more information). |
Logging | Settings of the Logging-Extension, see Project Settings. |
Measure | Settings of the Measure-Extension e.g. Device Mapping, see Project Settings. |
ODX | Settings of the DiagCom-Extension, see Project Settings. |
OTX | Contains the OTX Packages or Documents. |
OTX-Backup | Contains the OTX backup files, see OTF Settings. |
OTX-Mapping | External applications (*.exe or *.dll) using for Device Mapping or Context Mapping, see Project Settings. |
Output | Contains all generated DLL files for executing (click here for more information). |
PTX | Contains PTX libraries used inside the project |
Quantity | Settings of the Quantity-Extension e.g. ODX files with UNIT-SPECS, see Project Settings |
The only mandatory folder of a project is the OTX folder. All other folders can be omitted. Not specified settings will be adjust to default values.
References
All elements with the sufficient Visibility inside an OTX Document can be used by another document. The following elements can be referred:
Before a global entity can be referred, the related document shall be imported, see Imports. If the document is outside the project, a reference to the outside project should be added, see Project Settings.
Player Project
A player project does not contain its own OTX documents but it contains layouts using the elements from the referred 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.
OTF provides pre- or self-defined Project Templates. You can use these templates to create the basic project container and a preliminary set of items that you might need in order to develop your test application.
PPX
Structure
Folder Name | Content |
i18n | Settings of the I18N-Extension e.g. multilingual text library, see Project Settings. |
Logging | Settings of the Logging-Extension, see Project Settings. |
ODX | Settings of the DiagCom-Extension, see Project Settings. |
OTX-Mapping | External applications (*.exe or *.dll) using for Device Mapping or Context Mapping, see Project Settings. |
PTX | Contains PTX libraries used inside the project |
Quantity | Settings of the Quantity-Extension e.g. ODX files with UNIT-SPECS, see Project Settings |
The only mandatory folder of a project is the PTX folder. All other folders can be omitted. Not specified settings will be adjust to default values.
References
Some kinds of elements inside an OTX Document can be used to bound to elements in a player project. The following elements can be referred:
Before an element can be referred, a reference to the related procedure project should be added, see Project Settings.