OTX Reference  
OpenTestSystem.Otx.Core.Otx Class Reference

Document root More...

Inheritance diagram for OpenTestSystem.Otx.Core.Otx:
Inheritance graph

Classes

class  ExtensibleElement
 A new ExtensibleElement More...
 
class  Imports
 Contains a list of Import elements for importing other OTX documents. More...
 
class  Procedures
 A list of Procedure elements. More...
 
class  Signatures
 Interface description (Signature) More...
 
class  Validities
 A list of global scope validity terms. More...
 

Public Attributes

AdminData adminData
 Version history information More...
 
GlobalDeclarations declarations
 Element representing the global declaration block where global constants, context variables and global variables will be defined. More...
 
ExtensibleElement[] extendedElement
 Declares a general element which can be extented by new general functionality defined in new OTX extensions using the standardised extension mechanism, example: test cases for unit tests. More...
 
Imports imports
 Contains a list of Import elements for importing other OTX documents. More...
 
System.Int32 modelVersion
 This optional attribute shall contain the model version of the OTX document. The only valid value is 2022. It means that the model version is ISO 13209-2:2022. For backwards compatibility the attribute can be omitted. In this case the model version is 2022 or ISO 13209-2:2012. More...
 
PackageName package
 Name of a OTX package More...
 
Procedures procedures
 A list of Procedure elements. More...
 
Signatures signatures
 A list of Signature elements. More...
 
System.DateTime timestamp
 Timestamp of the OTX document More...
 
Validities validities
 A list of global scope validity terms. More...
 
System.String version
 Version of the OTX document More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.UniversalTypes.NamedAndSpecified
ExtensibleData[] extendedData
 Declares general data for NamedAndSpecified which can be extented by new general data defined in new OTX extensions using the standardised extension mechanism. For example it can be used to specify specification relevant content in a better structured way. More...
 
OtxId id
 Unique identifier of an element More...
 
MetaData metaData
 Additional tool-specific data More...
 
OtxName name
 Name of an element More...
 
System.String specification
 Descriptive specification More...
 

Detailed Description

Document root

This element stands for the document root (root node) of OTX documents. It serves as the "entry point" for any OTX parsing application and constitutes a kind of envelope around the test sequence logic itself. It mainly comprises header information for packaging, naming and versioning of an OTX document and about the links to other OTX documents (Import information). It is also the parent for all global entities defined in a document, namely global constants, document variables, context variables, validities, signatures and procedures.

Every OTX document starts with the document root element otx which is derived from the complex type Otx, see picture. For the transport of OTX projects consisting out of numerous interlinked OTX-files and packages, the PTX format specified by ISO 13209-4 must be used.

Note
The package name (in dotted notation) can simply be translated into a directory path or vice versa, whereas the OTX document name can be translated directly to the file name with extension *.otx. It is an analogy to the file system organisation of packages and classes recommended by Java.
OTX documents are unambiguously identified with the combination of package-name (namespace) and their own name. This allows for having equal document names in different OTX packages and avoiding ambiguity.
Global entities (global constants, procedures, validities, etc.) contained in the OTX document are unambiguously identified with the combination of package- and document-name, and their name. This allows for having equal global names in different OTX files and avoiding ambiguity.
Checker rules
CheckerRule.Core_Chk001 – Document name matches file name
CheckerRule.Core_Chk002 – Package-wide uniqueness of document names

Member Data Documentation

◆ adminData

AdminData OpenTestSystem.Otx.Core.Otx.adminData

Version history information

This optional element can be used for linking to Document history information. The history information shall be structured according to the ADMINDATA element as specified in ISO 22901 ODX. The linked information should be located in the top-level MetaData element of the document, but it may also be stored externally.

◆ declarations

GlobalDeclarations OpenTestSystem.Otx.Core.Otx.declarations

Element representing the global declaration block where global constants, context variables and global variables will be defined.

◆ extendedElement

ExtensibleElement [] OpenTestSystem.Otx.Core.Otx.extendedElement

Declares a general element which can be extented by new general functionality defined in new OTX extensions using the standardised extension mechanism, example: test cases for unit tests.

Note
IMPORTANT — The extension mechanism described here only defines the syntactic rules to which extension implementers shall obey in order to conform to ISO 13209-2. It shall be ensured that no OTX requirements are violated.

◆ imports

Imports OpenTestSystem.Otx.Core.Otx.imports

Contains a list of Import elements for importing other OTX documents.

◆ modelVersion

System.Int32 OpenTestSystem.Otx.Core.Otx.modelVersion

This optional attribute shall contain the model version of the OTX document. The only valid value is 2022. It means that the model version is ISO 13209-2:2022. For backwards compatibility the attribute can be omitted. In this case the model version is 2022 or ISO 13209-2:2012.

Note
IMPORTANT - New versions of the core data model shall be backward compatible. Thus, every OTX document that was valid in earlier OTX versions (ISO 13209-2:2012) must stay valid in the upcoming OTX version, without any need for manual or automatic migration.

◆ package

PackageName OpenTestSystem.Otx.Core.Otx.package

Name of a OTX package

OTX documents will be stored in a file system. Certain constraints on the organisation of files and folders allow a simple implementation to find OTX documents easily. The same applies to the uniqueness of file names, which is ensured automatically by the file system, because the OTX-files reside within a folder dedicated to their common package. The package name (in dotted notation) can simply be translated into a directory path or vice versa, whereas the OTX document name can be translated directly to the file name.

◆ procedures

Procedures OpenTestSystem.Otx.Core.Otx.procedures

A list of Procedure elements.

◆ signatures

Signatures OpenTestSystem.Otx.Core.Otx.signatures

A list of Signature elements.

◆ timestamp

System.DateTime OpenTestSystem.Otx.Core.Otx.timestamp

Timestamp of the OTX document

Contains the Timestamp of the OTX document. Format: "CCYYMMDDThhmmss", e.g.: "2019-12-10T06:14:02.859+01:00".

◆ validities

Validities OpenTestSystem.Otx.Core.Otx.validities

A list of global scope validity terms.

◆ version

System.String OpenTestSystem.Otx.Core.Otx.version

Version of the OTX document

Contains the version of the OTX document (for supporting versioning systems). Recommendation: "MajorVersion.MinorVersion.BranchRevision.Revision", e.g.: "1.0.0.0".