Schema Reference

This reference covers the XML document types used to configure a VxWorks 653 module.

The document types listed are defined in a two XML schemas. The VxWorks 653 Configuration Schema defines document types for configuration documents that are used to create the system configuration record. The VxWorks 653 Shared Library API Schema defines document types for documents used to configure shared library interfaces.

In both cases, the mutiple document types defined by each schema are combined, either inline or by reference, to form a single configuration document. For instance, a PartitionDescription document, which describes to configurartion of a partition, must be included in a Module configuration document in order to configure a complete module. You can create the PatitionDescription document as a separate file and include it in the Module configuration document using an XInclude xi:include element in the Partition element of the Module document. Alternately, you can write it inline as a PartitionDescription element inside the Partition. Because VxWorks 653 is designed to support indpendent modular builds, the normal method is to include configuration files by reference rather than inline. This documentation uses the include by reference method exclusively. For the same reason, this reference is organized by individual document types. Each topic in the reference treats one element in a document type and lists and describes each of the attributes belonging to that element.

NOTE: None of the document types used to configure VxWorks 653 includes any configuration information as data content of an element. All configuration information is contained in attribute values.

   

Reference fields

The following fields are used in the reference entries for elements:

Document type

The XML document type to which the element belongs.

Document XPath

The XPath expression that describes the location of the element in its document type. This is the XPath expression that would be used to refere to the element by and XML editor during document authoring.

Schema XPath

Each schema has one element that lies at the root of the tree of document types that makes up the virtual configuration document. This field gives the XPath expression that described the location of the element in that root document type. This is the XPath expression used to refer to this element in the build tools.

Description

A description of the element.

Use

The usage rules for the element within its parent element. Each element is labeled as either “required” or “optional”. This refers to whether an attribute is required or optional in the element to which it belongs. That element may itself be optional or required, and its ancestor elements may be optional or required. Thus, an element that is labeled “required” here may still not occur in a valid configuration document if it is part of an optional element structure.

Elements that may occur an unlimited number of times are labeled as “unbounded”. Note that elements sometimes occur in the schema as part of a grouping structure such as an xs:choice group. An element labeled here as “required” or “optional” but not “unbounded” may still be effectively unbounded if it is part of a group structure that is unbounded. See the schema for exact information.

Children

A list of the child elements of the current element.

Attributes

A list of the attributes belonging to the current element. Each item in the list links to a full description of each attribute later in the topic.

Restrictions

A list of any restrictions that apply to the content of the element (other than those expressed by the schema itself). Most of these restrictions are enforced by build tools during the build process. For a list of the checks performed by the VerIMAx tool, see the VerIMAx documentation.

The following fields are used in the reference entries for each attribute of an element:

Document XPath

The XPath expression that describes the location of the attribute in its document type. This is the XPath expression that would be used to refere to the attribute by and XML editor during document authoring.

Schema XPath

Each schema has one element that lies at the root of the tree of document types that makes up the virtual configuration document. This field gives the XPath expression that described the location of the attribute in that root document type. This is the XPath expression used to refer to this attribute in the build tools.

Description

A description of the attribute.

Use

The usage rules for the attribute within the element. Each attribute is labeled as either “required” or “optional”.

Target Location

The location on the target where the information in the attribute is placed by the build tools.

XML data type

The data type of the attribute value as defined by the schema.

Destination data type

The data type that the attribute value will be expressed at in its final destination (for example, the data type of the attribute in a field in the system configuration record).

Behavior if not specified

The behavior of the system if no value is given for this attribute. This item does not apply to attributes that are required.

Values with special meanings

The behavior that will result if values with special meanings (such as 0xffffffff or a symbolic constant) is specified.

Restrictions

A list of any restrictions that apply to the content of the attribute (other than those expressed by the schema itself). Most of these restrictions are enforced by build tools during the build process. For a list of the checks performed by the VerIMAx tool, see the VerIMAx documentation.




Generated on 2007-10-15 17:17:22.