Structure and content of telegrams

This chapter provides a comprehensive guide on how telegrams are structured which are sent to Part Traceability, with a focus on the distinction between Single Part Telegrams and Group Telegrams.

Telegram-based communication is instrumental in maintaining data integrity, traceability, and efficient information exchange between systems. Properly structuring these telegrams ensures seamless interaction and optimal functionality within the Part Traceability module.

This guide aims to:

Define the types of telegrams utilized in the Part Traceability
Explain the telegram’s purpose and significant characteristics
Emphasize the importance of adhering to the structure and format rules for accurate interpretation and processing

The main section describes the structure and content of a telegram used in the Part Traceability module. A telegram is a structured message that contains information about parts, their processing, and related data.

A telegram consists of several key objects:

XML Schema Definition (XSD)

XSD (XML Schema Definition) is used to define and validate the structure and content of a telegram. It specifies the elements, attributes, data types and relationships that a telegram XML file must adhere to - essentially serving as a blueprint or contract for telegram data. There are references provided to the XSD file for each telegram section, which provides detailed information on validation rules, data types, restrictions, and attributes.

The XSD files linked in this documentation are constantly being improved and refined. Therefore, it is recommended to always refer to the latest version of the XSD files provided in the Part Traceability module for the most up-to-date validation rules and structure definitions.

The XSD files provided in this documentation are not yet covering all possible validation rules and restrictions. They serve as a foundational reference for understanding the structure and content of telegrams. An automated validation of telegrams against these XSD files may not be fully reliable at this stage.

Sample XML telegram

Click to unfold sample XML telegram

<?xml version="1.0" encoding="UTF-8"?>
<documents contentType="QualityData">
    <document>
        <basicInfo>
            …
        </basicInfo>
        <partDetails>
            <components>
                …
            </components>
            <parameters>
                …
            </parameters>
            <errors>
                …
            </errors>
            <group>
                …
            </group>
            <references>
                …
            </references>
            <extensionDataItems>
                …
            </extensionDataItems>
        </partDetails>
        <componentTrace>
            <components>
                …
            </components>
            <batchElements>
                …
            </batchElements>
            <batchComponents>
                …
            </batchComponents>
        </componentTrace>
        <additionalInfo>
            …
        </additionalInfo>
        <packaging>
            …
        </packaging>
    </document>
    <document>
        …
    </document>
</documents>

Complete XSD file

A complete XSD file is available for download, covering all sections such as basicInfo, partDetails, componentTrace, packaging and additionalInfo can be found in the provided reference.

Click to unfold complete XSD

<?xml version="1.0" encoding="utf-8"?>
<xs:schema
  xmlns:xs="http://www.w3.org/2001/XMLSchema"
  xmlns="http://opcon.dc.modules.qualitydata/dtos"
  xmlns:bi="http://opcon.dc.modules.qualitydata/dtos/basic"
  xmlns:pd="http://opcon.dc.modules.qualitydata/dtos/part"
  xmlns:ai="http://opcon.dc.modules.qualitydata/dtos/additional"
  xmlns:ct="http://opcon.dc.modules.qualitydata/dtos/trace"
  xmlns:pk="http://opcon.dc.modules.qualitydata/dtos/pack"
  targetNamespace="http://opcon.dc.modules.qualitydata/dtos"
  elementFormDefault="qualified"
  attributeFormDefault="unqualified">

  <!-- Import module schemas (same folder as this master.xsd) -->
  <xs:import namespace="http://opcon.dc.modules.qualitydata/dtos/basic"      schemaLocation="basicInfo.xsd"/>
  <xs:import namespace="http://opcon.dc.modules.qualitydata/dtos/part"       schemaLocation="partDetails.xsd"/>
  <xs:import namespace="http://opcon.dc.modules.qualitydata/dtos/additional" schemaLocation="additionalInfo.xsd"/>
  <xs:import namespace="http://opcon.dc.modules.qualitydata/dtos/trace"      schemaLocation="componentTrace.xsd"/>
  <xs:import namespace="http://opcon.dc.modules.qualitydata/dtos/pack"       schemaLocation="packaging.xsd"/>

  <!-- Root: <documents contentType="QualityData"> -->
  <xs:element name="documents">
    <xs:complexType>
      <xs:sequence>
        <!-- multiple <document> -->
        <xs:element name="document" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <!-- Optional sections, fixed order if present -->
              <xs:element ref="bi:basicInfo"      minOccurs="0"/>
              <xs:element ref="pd:partDetails"    minOccurs="0"/>
              <xs:element ref="ai:additionalInfo" minOccurs="0"/>
              <xs:element ref="ct:componentTrace" minOccurs="0"/>
              <xs:element ref="pk:packaging"      minOccurs="0"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
      <xs:attribute name="contentType" type="xs:string" fixed="QualityData"/>
    </xs:complexType>
  </xs:element>
</xs:schema>