Core.Documents

From emotive
Revision as of 04:43, 27 November 2014 by Nb (talk | contribs)
Jump to navigation Jump to search

Classification

Name Documents
Short Description XML file which contain all OTX elements
Class OTX Core
Pre-Conditions -
Specified by ISO 13209-2

Introduction

An OTX document is an XML file contains all OTX elements. It contains header information like the document name, meta-data or imports and other global scope information like global declarations and validities followed by a list of signatures and a list of OTX procedures.

OtxDocumentStorageStructure.png
Package/Document Structure

Semantics

  • Id
This represents the Otx element's id (Otx element is the root element of the OTX document). It shall be unique among all other ids in a document.
  • Name
This attribute shall contain the name of the OTX document and it must match the OTX document file name. Among all the OTX documents defined within the same package, the document name must be unique to avoid ambiguities.
  • Package
This attribute shall represent the package which the OTX document belongs to.
  • Version
This attribute shall contain the version of the OTX document (for supporting versioning systems).
  • Timestamp
This attribute shall contain the document creation timestamp.
  • MetaData
This optional element shall contain meta information concerning the OTX document as a whole.
  • Specification
The static string content of this optional element shall be used to describe the purpose of the OTX document in simple prose.
  • AdminData
This optional element shall be used for linking to document history information. The linked information should be located in the top-level MetaData element of the OTX document (see above), but it may also be stored externally.
  • Imports
Contains a list of Import elements for importing other OTX documents.
  • Declarations
Element representing the global declaration block where global constants, context variables and global variables shall be defined.
  • Validities
A list of global scope validity terms shall be defined here.
  • Signatures
This optional element shall contain a list of Signature elements.
  • Procedures
This optional element shall contain a list of Procedure elements.

Checker rules

Core_Chk001 Document name matches file name
Core_Chk002 Package-wide uniqueness of document names

See also

​​Naming Conventions
Imports
Validities
Global Declarations
Signatures
Procedures
Validation (OTX-Checker)