DDS Consolidated XML Syntax Avatar
  1. OMG Specification

DDS Consolidated XML Syntax — All Issues

  • Acronym: DDS-XML
  • Issues Count: 5
  • Description: All Issues
Open Closed All
All Issues

Issues Descriptions

Namespace are uncompliant with OMG Policy for XML Namespaces in OMG Specifications

  • Key: DDSXML-2
  • Status: closed  
  • Source: Real-Time Innovations ( Fernando Garcia-Aranda)
  • Summary:

    DDS-XML schema files use the http://www.omg.org/dds namespace to be consistent with the schema files it incorporated from other DDS specifications. However, this namespace is uncomplaint with the OMG Policy for Versioning of Specification URIs, File URIs, and XML Namespaces in OMG Specifications (see smsc/15-03-06 for its latest version).

    Consequently, we must replace http://www.omg.org/dds with a compliant namespace as part of this FTF. Given the rule specified in smsc/15-03-06:

    <XML Namespace URI> ::= <specification URI>[<dated version
    number>"/"][<suffix>"/"]
    

    We could define the following compliant namespaces:

  • Reported: DDS-XML 1.0b1 — Mon, 8 Jan 2018 09:53 GMT
  • Disposition: Resolved — DDS-XML 1.0
  • Disposition Summary:

    Replace targetNamespace definitions with a compliant namespace

    Replace the uncompliant namespace specified in all the building blocks defined in clause 7.3 of the specification document and all machine readable XSD files (i.e., "http://www.omg.org/dds") with a namespace compilant with smsc/15-03-06: "http://www.omg.org/spec/DDS-XML".

  • Updated: Wed, 3 Oct 2018 14:17 GMT
  • Attachments:

Fix inconsistent rules for references between elements

  • Key: DDSXML-1
  • Status: closed  
  • Source: Real-Time Innovations ( Fernando Garcia-Aranda)
  • Summary:

    The syntax in DDS-XML contains places where an object references another object (e.g., topic_ref, domain_ref, type_ref or base_name). This is done normally using an attribute with type elementNameReference defined in http://www.omg.org/spec/DDS-XML/20170301/dds-xml_domain_definitions_nonamespace.xsd

    However, this rule is not applied consistently throughout the schema files in the specification. More specifically, the XSD associated with Building Block QoS use elementName for base_name, which is incorrect.

    Therefore, the definition of elementNameReference must be moved to the QoS building block, which is a dependency of all building blocks defining references.

  • Reported: DDS-XML 1.0b1 — Mon, 8 Jan 2018 09:25 GMT
  • Disposition: Resolved — DDS-XML 1.0
  • Disposition Summary:

    Change type of all references to elementNameReference

    The proposed solution moves the definition of elementNameReference from dds-xml_domain_definitions_nonamespace.xsd to dds-xml_qos_definitions_nonamespace.xsd and changes the type of all base_name attributes from elementName to elementNameReference.

  • Updated: Wed, 3 Oct 2018 14:17 GMT
  • Attachments:

Add OMG URL to schemaLocation attributes

  • Key: DDSXML-9
  • Status: closed  
  • Source: Real-Time Innovations ( Fernando Garcia-Aranda)
  • Summary:

    SchemaLocation attributes in the machine readable XSD and XML files reference documents in the working directory. This works well then he documents are local and the documents that are being included are in the working directory. However, because these files are going to be uploaded to the OMG servers, we must add the URLs to ensure that inclusions and imports will always work.

    This FTF must generate its report in May of 2018; therefore, the URL where the XML and XSD files will end up being published will be the following: "http://www.omg.org/spec/DDS-XML/20180501/"

  • Reported: DDS-XML 1.0b1 — Sun, 13 May 2018 18:59 GMT
  • Disposition: Resolved — DDS-XML 1.0
  • Disposition Summary:

    Add updated URL to schemaLocation attributes

    The proposal is to prepend the files included and imported by XSD and XML files with the following URL: "http://www.omg.org/spec/DDS-XML/20180501/"

  • Updated: Wed, 3 Oct 2018 14:17 GMT
  • Attachments:

DDS System Block Set lacks Schema File and Example

  • Key: DDSXML-7
  • Status: closed  
  • Source: Real-Time Innovations ( Fernando Garcia-Aranda)
  • Summary:

    The DDS System Building Block defined in sub clause 8.1 lacks a properly documented schema file and an example XML file that may be reused by other specifications (e.g., DDS-XRCE).

    The RFC included a schema file (dds-xml_system_example.xsd) and an XML file (dds-xml_system_example.xml). However, these files were considered non-normative and were not linked to the specification document or the DDS System Building Block in any way.

    This FTF should:

    • move "dds-xml_system_example.xsd" to a pair of schema files following the chameleon schema patter (i.e., one without namespace and one with the standard namespace as modified by DDSXML-2).
    • update "dds-xml_system_example.xml" to reference the file with a namespace.

    Moreover, we should simplify the definition of the DDS top level element to be a choice of minOccurs="0" and maxOccurs="unbounded", which produces the same complexType with a more compact and correct syntax.

    Finally, we should update clause 8.1 to link the building block to the corresponding schema files.

  • Reported: DDS-XML 1.0b1 — Sun, 13 May 2018 10:50 GMT
  • Disposition: Resolved — DDS-XML 1.0
  • Disposition Summary:

    Create proper schema and example files for DDS Building Block Set

    This resolution applies the following changes:
    1. It creates proper schema and example files for the DDS Building Block Set defined in clause 8.1.
    2. It transforms the DDS top-level type definition into a simple choice.
    3. It adds a short paragraph at the end of clause 8.1 to reference those documents.

  • Updated: Wed, 3 Oct 2018 14:17 GMT
  • Attachments:

Minor typos, inconsistencies, and updates in specification document

  • Key: DDSXML-5
  • Status: closed  
  • Source: Real-Time Innovations ( Fernando Garcia-Aranda)
  • Summary:

    The specification includes a number of typos that should be fixed:

    • On Table 7.2, the caption should be "Supported XML Attribute Values" instead of "Supported XML Element Values"
    • In section 7.1.3.2.1 Using Schema Files with Different Namespaces fix closing tag of "datareader_qos", which is incorrectly labeled as "dateader_qos".
    • In section 7.2.3.1, the type of the "kind" element should be "historyKind" instead of "dds:historyKind".
    • In section 7.2.4.2.1, rename "Binary" simpleType as "ddsBinary" and change the value element's type to "ddsBinary".
    • In section 7.3.4.4.1.1 change the topic name from "FisrstTopic" to "FirstTopic".

    Moreover, the specification includes some inconsistencies:

    • Section 7.1.1 states that the XML representation of DDS-related resources shall use <dds> as the root of every document; however, this is incompatible with the flexibility offered by building blocks. It is also incompatible with having a root for type representation such as <types>. We should simply remove this requirement.

    Finally, some of the references are outdated and should be updated to the latest revision of the specifications:

    • Update reference to the IDL standard to version 4.2.
    • Update reference to the DDS-XTypes standard to version 1.2.
  • Reported: DDS-XML 1.0b1 — Sat, 12 May 2018 17:50 GMT
  • Disposition: Resolved — DDS-XML 1.0
  • Disposition Summary:

    Fix minor typos and update specification references

    This proposal fixes a number of typos in the specification document and updates outdated references to the latest revision of the specification they mention.

  • Updated: Wed, 3 Oct 2018 14:17 GMT