Difference between revisions of "OtfProjectStructure"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:Open Test Framework - Solutions and Projects}}[[Category:OTF]]
 
{{DISPLAYTITLE:Open Test Framework - Solutions and Projects}}[[Category:OTF]]
 +
'''UNDER DEVELOPMENT ...'''
 
==Overview==
 
==Overview==
The OTF provides two containers to help you efficiently organize and manage all items, such as [[Core.Packages|Packages]], [[Core.Documents|Documents]] and [[OtfProjectSettings|Settings]]. These containers are called
+
The OTF provides two containers to help you efficiently organize and manage all items, such as [[Core.Packages|Packages]], [[Core.Documents|Documents]], [[OtfSolutionExplorer#Monitors|Layouts]] and [[OtfProjectSettings|Settings]]. These containers are called
 
* '''Solution''' and
 
* '''Solution''' and
 
* '''Project'''.
 
* '''Project'''.
 +
 +
{{Note|NOTE: The OTF has 2 kinds of projects: Projects of Procedures (OTX test sequences) and Projects of Players (OTP layouts). The procedure projects contain the OTX Packages, OTX Documents, Procedures (test sequences) and Activities etc. The player projects do not contain OTX elements but they contain layouts of how the test sequences are presented in the OTP etc. The layouts contain the command buttons and controls bound to the procedures and declarations of the other procedure projects. A player project can not be referred by any other procedure projects or player projects.}}
 +
 
The [[OtfSolutionExplorer|Solution Explorer]] can be used to view and manage a solution along with the projects inside and their associated items.
 
The [[OtfSolutionExplorer|Solution Explorer]] can be used to view and manage a solution along with the projects inside and their associated items.
  
The picture below shows the overall storage structure inside the OTF. Beginning from right hand side a solution contains one ore more projects, a project contains one ore more packages, a package contains one ore more documents, a document contains one ore more procedures and a procedure contains one ore 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 project ('''Cross-Document reference''') and outside the project ('''Cross-Project reference''').
+
The picture below shows the overall storage structure inside the OTF. Beginning from right hand side a solution contains one or more projects, a procedure 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 procedure/player project ('''Cross-Project reference''').
  
 
{{ImageStyleCenter|OdfStorageStructure.png|800|OTF Storage Structure}}
 
{{ImageStyleCenter|OdfStorageStructure.png|800|OTF Storage Structure}}
  
Furthermore a project can be packed into a '''PTX'''. References to PTX files are also counted as ('''Cross-Project reference''').
+
Furthermore a procedure project can be packed into a '''PTX'''. References to PTX files are also counted as ('''Cross-Project reference'''). A player project can be packed into a '''PPX''' which can be executed in the [[OtpReference|OTP]].
  
 
==Solution==
 
==Solution==
Line 16: Line 20:
  
 
==Project==
 
==Project==
Projects are used in a solution to logically manage, build and debug [[Core.Documents|Documents]] and [[OtfProjectSettings|Project Settings]]. The executable output of a project is usually a dynamic-link library (.dll) file or a program (.exe), see project Output folder.
+
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 a program (.exe), 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.
  

Revision as of 10:11, 12 November 2018

UNDER DEVELOPMENT ...

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.
Icons Note.png NOTE: The OTF has 2 kinds of projects: Projects of Procedures (OTX test sequences) and Projects of Players (OTP layouts). The procedure projects contain the OTX Packages, OTX Documents, Procedures (test sequences) and Activities etc. The player projects do not contain OTX elements but they contain layouts of how the test sequences are presented in the OTP etc. The layouts contain the command buttons and controls bound to the procedures and declarations of the other procedure projects. A player project can not be referred by any other procedure projects or player projects.

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 the overall storage structure inside the OTF. Beginning from right hand side a solution contains one or more projects, a procedure 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 procedure/player project (Cross-Project reference).

OdfStorageStructure.png
OTF Storage Structure

Furthermore a procedure project can be packed into a PTX. References to PTX files are also counted as (Cross-Project reference). A player project can be packed into a PPX which can be executed in the OTP.

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.

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 a program (.exe), 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

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 project can be exported to create a PTX via the context menu of a project node in the Solution Explorer.

Project Structure

A project consists of a project settings file *.otfPrj and the following folders:

Folder Name Content
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
Icons Note.png 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 outside a Document

All elements inside an OTX Document can be used from another document, if the elements have a sufficient Visibility. The following elements can be referred

  1. Validities
  2. Signatures
  3. Global Declarations
  4. Procedures

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.