MSL Equipment Register

Schema Document Properties

Properties

Target Namespace	https://measurement.govt.nz/equipment-register
Version	0.1.0
Schema Composition	This schema imports schema(s) from the following namespace(s): https://measurement.govt.nz/gtc/xml

Declared Namespaces

Prefix	Namespace
xml	http://www.w3.org/XML/1998/namespace
msl	https://measurement.govt.nz/equipment-register
gtc	https://measurement.govt.nz/gtc/xml
vc	http://www.w3.org/2007/XMLSchema-versioning
xsd	http://www.w3.org/2001/XMLSchema

Schema Component Representation

<xsd:schema version="0.1.0" elementFormDefault="qualified" minVersion="1.0" targetNamespace="https://measurement.govt.nz/equipment-register">
  <xsd:import namespace="https://measurement.govt.nz/gtc/xml" schemaLocation="./external/gtc.xsd"/>
...
</xsd:schema>

register

XML Instance Representation

<msl:register
 team="msl:teamEnumerationString" [1]Attribute team

                        The team that is responsible for the equipment register.
                    
 
 
>
  <!--
   Uniqueness Constraint - uniqueID
   Selector - msl:equipment/msl:id
   Field(s) - .
  -->
  Start Sequence [0..*]
    <msl:equipment> msl:equipment </msl:equipment> [1] 
  End Sequence
</msl:register>

Schema Component Representation

<xsd:element name="register">
  <xsd:complexType>
    <xsd:sequence minOccurs="0" maxOccurs="unbounded">
      <xsd:element name="equipment" type="msl:equipment"/>
    </xsd:sequence>
    <xsd:attribute name="team" type="msl:teamEnumerationString" use="required"/>
  </xsd:complexType>
  <xsd:unique name="uniqueID">
    <xsd:selector xpath="msl:equipment/msl:id"/>
    <xsd:field xpath="."/>
  </xsd:unique>
</xsd:element>

alteration

XML Instance Representation

<...
 date="xsd:date" [1]Attribute date

                            The date that the alteration was performed.
                            The date must be in the YYYY-MM-DD format (see
                            [xsd:date](https://www.w3.org/TR/xmlschema-2/#date) for details).
                        
 
 
 performedBy="msl:nonEmptyString" [1]Attribute performedBy

                            The person or company that performed the alteration.
                        
 
 
>
   msl:nonEmptyString
</...>

Schema Component Representation

<xsd:complexType name="alteration">
  <xsd:simpleContent>
    <xsd:extension base="msl:nonEmptyString">
      <xsd:attribute name="date" type="xsd:date" use="required"/>
      <xsd:attribute name="performedBy" type="msl:nonEmptyString" use="required"/>
    </xsd:extension>
  </xsd:simpleContent>
</xsd:complexType>

alterations

XML Instance Representation

<...>
  Start Sequence [0..*]
    <msl:alteration> msl:alteration </msl:alteration> [1] 
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="alterations">
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
    <xsd:element name="alteration" type="msl:alteration"/>
  </xsd:sequence>
</xsd:complexType>

any

XML Instance Representation

<...
 Allow any attributes from any namespace (lax validation).
>
  Start Sequence [0..*]
    Allow any elements from any namespace (lax validation). [1]
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="any">
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
    <xsd:any processContents="lax"/>
  </xsd:sequence>
  <xsd:anyAttribute processContents="lax"/>
</xsd:complexType>

calibrations

XML Instance Representation

<...>
  Start Sequence [0..*]
    <msl:measurand> msl:measurand 
      <!--
       Uniqueness Constraint - uniqueComponentName
       Selector - msl:component
       Field(s) - @name
      -->
    </msl:measurand> [1] 
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="calibrations">
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
    <xsd:element name="measurand" type="msl:measurand">
      <xsd:unique name="uniqueComponentName">
        <xsd:selector xpath="msl:component"/>
        <xsd:field xpath="@name"/>
      </xsd:unique>
    </xsd:element>
  </xsd:sequence>
</xsd:complexType>

comment

XML Instance Representation

<...
 date="xsd:date" [1]Attribute date

                            The date in the YYYY-MM-DD format (see
                            [xsd:date](https://www.w3.org/TR/xmlschema-2/#date) for details).
                        
 
 
>
   msl:nonEmptyString
</...>

Schema Component Representation

<xsd:complexType name="comment">
  <xsd:simpleContent>
    <xsd:extension base="msl:nonEmptyString">
      <xsd:attribute name="date" type="xsd:date" use="required"/>
    </xsd:extension>
  </xsd:simpleContent>
</xsd:complexType>

competency

XML Instance Representation

<...>
  <msl:worker> msl:nonEmptyString </msl:worker> [1] 
  <msl:checker> msl:nonEmptyString </msl:checker> [1] 
  <msl:technicalProcedure> msl:technicalProcedurePatternString </msl:technicalProcedure> [1] 
</...>

Schema Component Representation

<xsd:complexType name="competency">
  <xsd:sequence>
    <xsd:element name="worker" type="msl:nonEmptyString"/>
    <xsd:element name="checker" type="msl:nonEmptyString"/>
    <xsd:element name="technicalProcedure" type="msl:technicalProcedurePatternString"/>
  </xsd:sequence>
</xsd:complexType>

completedTask

XML Instance Representation

<...
 dueDate="xsd:date" [1]Attribute dueDate

                            The date that the planned maintenance task was due to be completed.
                            The date must be in the YYYY-MM-DD format (see
                            [xsd:date](https://www.w3.org/TR/xmlschema-2/#date) for details).
                        
 
 
 completedDate="xsd:date" [1]Attribute completedDate

                            The date that the planned maintenance task was completed.
                            The date must be in the YYYY-MM-DD format (see
                            [xsd:date](https://www.w3.org/TR/xmlschema-2/#date) for details).
                        
 
 
 performedBy="msl:nonEmptyString" [1]Attribute performedBy

                            The person or company that performed the planned maintenance task.
                        
 
 
>
   msl:nonEmptyString
</...>

Schema Component Representation

<xsd:complexType name="completedTask">
  <xsd:simpleContent>
    <xsd:extension base="msl:nonEmptyString">
      <xsd:attribute name="dueDate" type="xsd:date" use="required"/>
      <xsd:attribute name="completedDate" type="xsd:date" use="required"/>
      <xsd:attribute name="performedBy" type="msl:nonEmptyString" use="required"/>
    </xsd:extension>
  </xsd:simpleContent>
</xsd:complexType>

component

XML Instance Representation

<...
 name="xsd:string" [1]Attribute name

                    The name to associate with this `component`. The value must
                    be unique amongst the other `component` elements within
                    the _same_ `measurand` element. An empty string is permitted.

                    **Examples**

                    A digital multimeter
                    ```xml
                    {component name="Front"}
                    {component name="Rear terminal"}
                    ```
                    
                    A data acquisition (DAQ) system
                    ```xml
                    {component name="AO1"}
                    {component name="Analog In 1"}
                    {component name="PFI2"}
                    {component name="Counter 1"}
                    ```
                    
                    A scanner or multiplexer
                    ```xml
                    {component name="Ch1"}
                    {component name="Channel 2"}
                    ```
                
 
 
>
  Start Sequence [0..*]
    Start Choice [1]
      <msl:adjustment> msl:comment </msl:adjustment> [1] 
      <msl:digitalReport> msl:digitalReport </msl:digitalReport> [1] 
      <msl:performanceCheck> msl:performanceCheck </msl:performanceCheck> [1] 
      <msl:report> msl:report </msl:report> [1] 
    End Choice
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="component">
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
    <xsd:choice>
      <xsd:element name="adjustment" type="msl:comment"/>
      <xsd:element name="digitalReport" type="msl:digitalReport"/>
      <xsd:element name="performanceCheck" type="msl:performanceCheck"/>
      <xsd:element name="report" type="msl:report"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attribute name="name" type="xsd:string" use="required"/>
</xsd:complexType>

digitalReport

XML Instance Representation

<...
 comment="xsd:string" [0..1]Attribute comment

                    _Optional:_ A comment to associate with the `file`.
                
 
 
 format="msl:digitalFormatEnumerationString" [1]Attribute format

                            The format of the digital calibration report.
                        
 
 
 id="msl:nonEmptyString" [1]Attribute id

                            The report identification (also referred to as the *report number* in MSL terminology).

                            Satisfy ISO/IEC 17025:2017 Clause 7.8.2.1 \
                            d) unique identification that all its components are recognized
                               as a portion of a complete report and a clear identification of the end
                        
 
 
>
  <msl:url
   Allow any attributes from any namespace (skip validation).
  > [1]  
     msl:nonEmptyString
  </msl:url>
  <msl:sha256> xsd:string (pattern = [a-fA-F0-9]{64}) </msl:sha256> [1] 
</...>

Schema Component Representation

<xsd:complexType name="digitalReport">
  <xsd:complexContent>
    <xsd:extension base="msl:file">
      <xsd:attribute name="format" type="msl:digitalFormatEnumerationString" use="required"/>
      <xsd:attribute name="id" type="msl:nonEmptyString" use="required"/>
    </xsd:extension>
  </xsd:complexContent>
</xsd:complexType>

The calibration is expressed as an equation. Both the `value` and the `uncertainty` may be expressed as an equation. The content of the equation to parse may contain * the space (0x20) and tab (0x09) characters * integer and floating-point numbers (e.g., 100, 100.0, 1e2, 1.0E+02) * the following brackets: `(` `)` * the following (unary) operators: `+` `-` `*` `/` * the following names to represent the corresponding numerical value: - pi = 3.14159... * the following functions: - pow - sqrt - sin - asin - cos - acos - tan - atan - exp - log (natural logarithm, base _e_ ) - log10 (common logarithm, base _10_ ) Depending on the programming language that is used to parse an equation, a search and replace may need to be performed. If the programming language does not support the `pow(x,y)` function to raise `x` to the power of `y`, you may use the following [regular expression](https://en.wikipedia.org/wiki/Regular_expression) (which uses a named capture group for the `x` and `y` value) ```r pow\(\s*(?{x}[^,]+),\s*(?{y}[^)]+)\) ``` to perform a search and replace. _Attention: This XSD document validates the content of an XML document (e.g., that the `value` and `uncertainty` elements exist and the content is a [nonEmptyString](#type_nonEmptyString)). It does not attempt to validate that the equation is mathematically correct (e.g., whether the equation is missing a closing bracket). You must use another tool to validate the mathematical correctness of the equation._ **Examples** The correction to apply for a temperature `value` is expressed as a second-order polynomial and the _expanded_ `uncertainty` is specified to be 0.45 °C with a coverage factor of 2. ```xml {equation} {value variables="T"}T + (-10.66 + 1.58e-2*T + 1.212e-3*pow(T,2)){/value} {uncertainty variables=""}0.45/2{/uncertainty} {unit}°C{/unit} {ranges} {range variable="T"} {minimum}15{/minimum} {maximum}25{/maximum} {/range} {/ranges} {/equation} ```

XML Instance Representation

<...
 comment="xsd:string" [0..1]Attribute comment

                    _Optional:_ A comment to associate with the `equation`.
                
 
 
>
  <msl:value
   variables="msl:variables" [1]Attribute variables

                                        The variable(s) that are required to evaluate the `value`.
                                    
 
 
  > [1]  
     msl:nonEmptyString
  </msl:value>
  <msl:uncertainty
   variables="msl:variables" [1]Attribute variables

                                        The variable(s) that are required to evaluate the `uncertainty`.
                                    
 
 
  > [1]  
     msl:nonEmptyString
  </msl:uncertainty>
  <msl:unit> msl:nonEmptyString </msl:unit> [1] 
  <msl:ranges> msl:ranges </msl:ranges> [1] 
  <msl:degreeFreedom> xsd:double (1 <= value <= INF) </msl:degreeFreedom> [0..1] 
</...>

Schema Component Representation

<xsd:complexType name="equation">
  <xsd:sequence>
    <xsd:element name="value">
      <xsd:complexType>
        <xsd:simpleContent>
          <xsd:extension base="msl:nonEmptyString">
            <xsd:attribute name="variables" type="msl:variables" use="required"/>
          </xsd:extension>
        </xsd:simpleContent>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="uncertainty">
      <xsd:complexType>
        <xsd:simpleContent>
          <xsd:extension base="msl:nonEmptyString">
            <xsd:attribute name="variables" type="msl:variables" use="required"/>
          </xsd:extension>
        </xsd:simpleContent>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="unit" type="msl:nonEmptyString"/>
    <xsd:element name="ranges" type="msl:ranges"/>
    <xsd:element name="degreeFreedom" minOccurs="0">
      <xsd:simpleType>
        <xsd:restriction base="xsd:double">
          <xsd:minInclusive value="1"/>
          <xsd:maxInclusive value="INF"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>
  </xsd:sequence>
  <xsd:attribute name="comment" type="xsd:string"/>
</xsd:complexType>

equipment

Documentation

XML Instance Representation

<...
 alias="xsd:string" [0..1]Attribute alias

                    _Optional:_ An alternative name to associate with the equipment.
                
 
 
 keywords="msl:keywordsList" [0..1]Attribute keywords

                    _Optional:_ Keywords that describe the equipment.
                
 
 
>
  <msl:id> msl:idPatternString </msl:id> [1] 
  <msl:manufacturer> msl:tokenizedString </msl:manufacturer> [1] 
  <msl:model> msl:tokenizedString </msl:model> [1] 
  <msl:serial> msl:tokenizedString </msl:serial> [1] 
  <msl:description> msl:tokenizedString </msl:description> [1] 
  <msl:specifications> msl:any </msl:specifications> [1] 
  <msl:location> msl:labEnumerationString </msl:location> [1] 
  <msl:status> msl:statusEnumerationString </msl:status> [1] 
  <msl:loggable> xsd:boolean </msl:loggable> [1] 
  <msl:traceable> xsd:boolean </msl:traceable> [1] 
  <msl:calibrations> msl:calibrations 
    <!--
     Uniqueness Constraint - uniqueMeasurandQuantity
     Selector - msl:measurand
     Field(s) - @quantity
    -->
  </msl:calibrations> [1] 
  <msl:maintenance> msl:maintenance </msl:maintenance> [1] 
  <msl:alterations> msl:alterations </msl:alterations> [1] 
  <msl:firmware> msl:firmware </msl:firmware> [1] 
  <msl:specifiedRequirements> msl:any </msl:specifiedRequirements> [1] 
  <msl:referenceMaterials> msl:any </msl:referenceMaterials> [1] 
  <msl:qualityManual> msl:qualityManual </msl:qualityManual> [1] 
</...>

Schema Component Representation

<xsd:complexType name="equipment">
  <xsd:sequence>
    <xsd:element name="id" type="msl:idPatternString"/>
    <xsd:element name="manufacturer" type="msl:tokenizedString"/>
    <xsd:element name="model" type="msl:tokenizedString"/>
    <xsd:element name="serial" type="msl:tokenizedString"/>
    <xsd:element name="description" type="msl:tokenizedString"/>
    <xsd:element name="specifications" type="msl:any"/>
    <xsd:element name="location" type="msl:labEnumerationString"/>
    <xsd:element name="status" type="msl:statusEnumerationString"/>
    <xsd:element name="loggable" type="xsd:boolean" default="false"/>
    <xsd:element name="traceable" type="xsd:boolean"/>
    <xsd:element name="calibrations" type="msl:calibrations">
      <xsd:unique name="uniqueMeasurandQuantity">
        <xsd:selector xpath="msl:measurand"/>
        <xsd:field xpath="@quantity"/>
      </xsd:unique>
    </xsd:element>
    <xsd:element name="maintenance" type="msl:maintenance"/>
    <xsd:element name="alterations" type="msl:alterations"/>
    <xsd:element name="firmware" type="msl:firmware"/>
    <xsd:element name="specifiedRequirements" type="msl:any"/>
    <xsd:element name="referenceMaterials" type="msl:any"/>
    <xsd:element name="qualityManual" type="msl:qualityManual"/>
  </xsd:sequence>
  <xsd:attribute name="alias" type="xsd:string"/>
  <xsd:attribute name="keywords" type="msl:keywordsList"/>
</xsd:complexType>

file

Documentation

Calibration data is stored in another file. Specifying an absolute path in an equipment register should only be performed if the location of the file will remain constant for an extended period of time. This is not typically the case, as MSL has had to migrate data multiple times (i.e., a network drive, then Google Drive, then Sharepoint, then back to a network drive). One option is to think of the file-system path as a combination of two parts ```console root \ {url} ``` where, * *root*: This is not stored in an equipment register. Instead, it may be stored in a separate file (ideally in a single file) on a local hard drive. How and where this is stored is up to the individual. * *url*: This is the value of the `url` element in an equipment register. For example, consider the following absolute path ``` C:\Users\username\OneDrive - My Company Name\Length\Quality\Equipment\register.xml ``` each part could be broken down as follows * *root* = `C:\Users\username\OneDrive - My Company Name\` - this value could be stored, for example, in a file in the user's home directory or as a constant in the analysis software * *url* = `Length\Quality\Equipment\register.xml` Whenever someone needs to load the file, the `root` is read from a local file and the `url` is read from the equipment register and then the absolute path is constructed. _Attention: This XSD document validates the content of an XML document (e.g., that the `url` element exists and the content is a [nonEmptyString](#type_nonEmptyString)). It does not attempt to validate that the file exists nor if the SHA-256 checksum is correct for the file (although the general format of the checksum, i.e., has the proper length and contains only allowed characters, is validated). You must use another tool to validate the existence of the file and the validity of the checksum value._ **Examples** The data is stored in an Excel file that is located at a _relative_ path ```xml {file} {url sheet="2024-May" cell="B2:D25"}relative\path\data.xlsx{/url} {sha256}70d79d2eb24dc2515faaf4ab7fa3540e5a73ca6080181908a0ea87a309293609{/sha256} {/file} ``` The data is stored in a digital calibration certificate on a network server ```xml {file comment="calibration of second grating"} {url}file://msl-nas/Photometry/Calibrations/job123456.xml{/filename} {sha256}8392e473a047543773138653b98037956fa2086e4a54fc882d913f10cc217728{/sha256} {/file} ```

XML Instance Representation

<...
 comment="xsd:string" [0..1]Attribute comment

                    _Optional:_ A comment to associate with the `file`.
                
 
 
>
  <msl:url
   Allow any attributes from any namespace (skip validation).
  > [1]  
     msl:nonEmptyString
  </msl:url>
  <msl:sha256> xsd:string (pattern = [a-fA-F0-9]{64}) </msl:sha256> [1] 
</...>

Schema Component Representation

<xsd:complexType name="file">
  <xsd:sequence>
    <xsd:element name="url">
      <xsd:complexType>
        <xsd:simpleContent>
          <xsd:extension base="msl:nonEmptyString">
            <xsd:anyAttribute processContents="skip"/>
          </xsd:extension>
        </xsd:simpleContent>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="sha256">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
          <xsd:pattern value="[a-fA-F0-9]{64}"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>
  </xsd:sequence>
  <xsd:attribute name="comment" type="xsd:string"/>
</xsd:complexType>

financial

Documentation

XML Instance Representation

<...>
Start All [1]
    <msl:assetNumber> xsd:string </msl:assetNumber> [0..1] 
    <msl:warrantyExpirationDate> xsd:date </msl:warrantyExpirationDate> [0..1] 
    <msl:yearPurchased> xsd:gYear </msl:yearPurchased> [0..1] 
End All
</...>

Schema Component Representation

<xsd:complexType name="financial">
  <xsd:all>
    <xsd:element name="assetNumber" type="xsd:string" minOccurs="0"/>
    <xsd:element name="warrantyExpirationDate" type="xsd:date" minOccurs="0"/>
    <xsd:element name="yearPurchased" type="xsd:gYear" minOccurs="0"/>
  </xsd:all>
</xsd:complexType>

firmware

Documentation

Satisfy ISO/IEC 17025:2017 Clause 6.4.13 \ a) ... software and firmware version A distinction is made between _software_ and _firmware_ version. **Software**: May be provided by the manufacturer of the equipment and may be installed/updated by an end user on _any_ computer. The manufacturer of the equipment may provide this software as, for example, a graphical user interface (GUI) and/or as a software development kit (SDK) to interface with the equipment. Software could also refer to the version of the bespoke code that is written by a metrologist to control the equipment. Both the manufacturer and the bespoke software version are important to document, but it shall not be specified in the equipment register. It shall be documented in a different manner, e.g., as metadata in a file during data acquisition. **Firmware**: Embedded within the equipment. May be updated by either the manufacturer and/or the end user. If applicable, it shall be specified in the equipment register. The primary difference is that the _firmware_ version has a single value of truth (it is independent of where the equipment is physically located and independent of which computer is used to interface with it) whereas the _software_ version depends on which computer (perhaps even on which executable is run on the same computer) is used to interface with the equipment and therefore there may not be a single value of truth that can be defined in the equipment register. For equipment that support the `*IDN?` query, the firmware version is typically found as the fourth item in the reply: _manufacturer,model,serial,firmware_ **Examples** ```xml {firmware} {version date="2025-01-14"}1.4.0{/version} {version date="2023-06-14"}1.3.2{/version} {/firmware} ```

XML Instance Representation

<...>
  Start Sequence [0..*]
    <msl:version> msl:comment </msl:version> [1] 
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="firmware">
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
    <xsd:element name="version" type="msl:comment"/>
  </xsd:sequence>
</xsd:complexType>

<...>
  Start Sequence [0..1]
    <msl:planned    > [1]  
      Start Sequence [0..*]
        <msl:task> msl:plannedTask </msl:task> [1] 
      End Sequence
    </msl:planned>
    <msl:completed    > [1]  
      Start Sequence [0..*]
        <msl:task> msl:completedTask </msl:task> [1] 
      End Sequence
    </msl:completed>
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="maintenance">
  <xsd:sequence minOccurs="0">
    <xsd:element name="planned">
      <xsd:complexType>
        <xsd:sequence minOccurs="0" maxOccurs="unbounded">
          <xsd:element name="task" type="msl:plannedTask"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="completed">
      <xsd:complexType>
        <xsd:sequence minOccurs="0" maxOccurs="unbounded">
          <xsd:element name="task" type="msl:completedTask"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>
  </xsd:sequence>
</xsd:complexType>

<...
 quantity="msl:quantityEnumerationString" [1]Attribute quantity

                    The kind of quantity that is measured.
                
 
 
 calibrationInterval="msl:nonNegativeDecimal" [1]Attribute calibrationInterval

                    The number of years that may pass between a calibration or a performance
                    check. For equipment that do not have a required and periodic interval, but
                    are calibrated _on demand_, use the value 0.
                
 
 
>
  Start Sequence [0..*]
    <msl:component> msl:component </msl:component> [1] 
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="measurand">
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
    <xsd:element name="component" type="msl:component"/>
  </xsd:sequence>
  <xsd:attribute name="quantity" type="msl:quantityEnumerationString" use="required"/>
  <xsd:attribute name="calibrationInterval" type="msl:nonNegativeDecimal" use="required"/>
</xsd:complexType>

<...
 completedDate="xsd:date" [1]Attribute completedDate

                    The date that the performance check was completed. \
                    The date must be in the YYYY-MM-DD format (see
                    [xsd:date](https://www.w3.org/TR/xmlschema-2/#date) for details).
                
 
 
>
  <msl:competency> msl:competency </msl:competency> [1] 
  <msl:conditions> msl:any </msl:conditions> [1] 
  Start Choice [1..*]
    <msl:equation> msl:equation </msl:equation> [1] 
    <msl:file> msl:file </msl:file> [1] 
    <msl:serialised> msl:serialised </msl:serialised> [1] 
    <msl:table> msl:table </msl:table> [1] 
  End Choice
</...>

Schema Component Representation

<xsd:complexType name="performanceCheck">
  <xsd:sequence>
    <xsd:element name="competency" type="msl:competency"/>
    <xsd:element name="conditions" type="msl:any"/>
    <xsd:choice maxOccurs="unbounded">
      <xsd:element name="equation" type="msl:equation"/>
      <xsd:element name="file" type="msl:file"/>
      <xsd:element name="serialised" type="msl:serialised"/>
      <xsd:element name="table" type="msl:table"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attribute name="completedDate" type="xsd:date" use="required"/>
</xsd:complexType>

<...
 dueDate="xsd:date" [1]Attribute dueDate

                            The date that the planned maintenance task is due to be completed.
                            The date must be in the YYYY-MM-DD format (see
                            [xsd:date](https://www.w3.org/TR/xmlschema-2/#date) for details).
                        
 
 
 performedBy="xsd:string" [0..1]Attribute performedBy

                            _Optional:_ The person or company that will perform the planned maintenance task.
                        
 
 
>
   msl:nonEmptyString
</...>

Schema Component Representation

<xsd:complexType name="plannedTask">
  <xsd:simpleContent>
    <xsd:extension base="msl:nonEmptyString">
      <xsd:attribute name="dueDate" type="xsd:date" use="required"/>
      <xsd:attribute name="performedBy" type="xsd:string"/>
    </xsd:extension>
  </xsd:simpleContent>
</xsd:complexType>

<...>
Start All [0..1]
    <msl:accessories> msl:any </msl:accessories> [0..1] 
    <msl:documentation> xsd:string </msl:documentation> [0..1] 
    <msl:financial> msl:financial </msl:financial> [0..1] 
    <msl:personnelRestrictions> xsd:string </msl:personnelRestrictions> [0..1] 
    <msl:serviceAgent> xsd:string </msl:serviceAgent> [0..1] 
    <msl:technicalProcedures> msl:technicalProcedures </msl:technicalProcedures> [0..1] 
End All
</...>

Schema Component Representation

<xsd:complexType name="qualityManual">
  <xsd:all minOccurs="0">
    <xsd:element name="accessories" type="msl:any" minOccurs="0"/>
    <xsd:element name="documentation" type="xsd:string" minOccurs="0"/>
    <xsd:element name="financial" type="msl:financial" minOccurs="0"/>
    <xsd:element name="personnelRestrictions" type="xsd:string" minOccurs="0"/>
    <xsd:element name="serviceAgent" type="xsd:string" minOccurs="0"/>
    <xsd:element name="technicalProcedures" type="msl:technicalProcedures" minOccurs="0"/>
  </xsd:all>
</xsd:complexType>

<...>
  Start Sequence [0..*]
    <msl:range
     variable="msl:nonEmptyString" [1]Attribute variable

                                The variable in the `equation` that this `range` applies to.

                                _Attention: This XSD document validates the content of an XML document
                                (e.g., that the `variable` attribute exist and the content
                                is a [nonEmptyString](#type_nonEmptyString)). It does not attempt to
                                validate that the range for every `variable` is defined.
                                You must use another tool to validate that every `variable` is
                                uniquely defined._
                            
 
 
    > [1]  
      <msl:minimum> xsd:double </msl:minimum> [1] 
      <msl:maximum> xsd:double </msl:maximum> [1] 
    </msl:range>
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="ranges">
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
    <xsd:element name="range">
      <xsd:complexType>
        <xsd:sequence>
          <xsd:element name="minimum" type="xsd:double"/>
          <xsd:element name="maximum" type="xsd:double"/>
        </xsd:sequence>
        <xsd:attribute name="variable" type="msl:nonEmptyString" use="required"/>
      </xsd:complexType>
    </xsd:element>
  </xsd:sequence>
</xsd:complexType>

<...
 id="msl:nonEmptyString" [1]Attribute id

                    The report identification (also referred to as the *report number* in MSL terminology).

                    Satisfy ISO/IEC 17025:2017 Clause 7.8.2.1 \
                    d) unique identification that all its components are recognized
                       as a portion of a complete report and a clear identification of the end
                
 
 
>
  <msl:reportIssueDate> xsd:date </msl:reportIssueDate> [1] 
  <msl:measurementStartDate> xsd:date </msl:measurementStartDate> [1] 
  <msl:measurementStopDate> xsd:date </msl:measurementStopDate> [1] 
  <msl:issuingLaboratory
   person="msl:nonEmptyString" [0..1]Attribute person

                                        _Optional:_ A person at the issuing laboratory that
                                        authorised the report. The attribute does not need to be
                                        specified, but, if it is specified, the value cannot be empty.

                                        This may be useful as a means of identifying a contact person
                                        at another laboratory if the report is not from MSL.

                                        Satisfy ISO/IEC 17025:2017 Clause 7.8.2.1 \
                                        o) identification of the person(s) authorizing the report
                                    
 
 
  > [1]  
     msl:nonEmptyString
  </msl:issuingLaboratory>
  <msl:technicalProcedure> xsd:string </msl:technicalProcedure> [1] 
  <msl:conditions> msl:any </msl:conditions> [1] 
  <msl:acceptanceCriteria> msl:any </msl:acceptanceCriteria> [1] 
  Start Choice [1..*]
    <msl:equation> msl:equation </msl:equation> [1] 
    <msl:file> msl:file </msl:file> [1] 
    <msl:serialised> msl:serialised </msl:serialised> [1] 
    <msl:table> msl:table </msl:table> [1] 
  End Choice
</...>

Schema Component Representation

<xsd:complexType name="report">
  <xsd:sequence>
    <xsd:element name="reportIssueDate" type="xsd:date"/>
    <xsd:element name="measurementStartDate" type="xsd:date"/>
    <xsd:element name="measurementStopDate" type="xsd:date"/>
    <xsd:element name="issuingLaboratory">
      <xsd:complexType>
        <xsd:simpleContent>
          <xsd:extension base="msl:nonEmptyString">
            <xsd:attribute name="person" type="msl:nonEmptyString"/>
          </xsd:extension>
        </xsd:simpleContent>
      </xsd:complexType>
    </xsd:element>
    <xsd:element name="technicalProcedure" type="xsd:string"/>
    <xsd:element name="conditions" type="msl:any"/>
    <xsd:element name="acceptanceCriteria" type="msl:any"/>
    <xsd:choice maxOccurs="unbounded">
      <xsd:element name="equation" type="msl:equation"/>
      <xsd:element name="file" type="msl:file"/>
      <xsd:element name="serialised" type="msl:serialised"/>
      <xsd:element name="table" type="msl:table"/>
    </xsd:choice>
  </xsd:sequence>
  <xsd:attribute name="id" type="msl:nonEmptyString" use="required"/>
</xsd:complexType>

<...
 comment="xsd:string" [0..1]Attribute comment

                    _Optional:_ A comment to associate with the `serialised` data.
                
 
 
>
  Start Choice [1]
 gtcArchive

                        Calibration data is stored as a
                        [GUM Tree Calculator (GTC)](https://gtc.readthedocs.io/en/stable/index.html)
                        [Archive](https://gtc.readthedocs.io/en/stable/API/persistence.html#persistence.Archive)
                        in XML format.

                        If you want to serialise an `Archive` into a _string_ that can be
                        copied-pasted into an equipment-register file, you may use the
                        [dumps_xml](https://gtc.readthedocs.io/en/stable/API/persistence.html#persistence.dumps_xml)
                        function

                        ```python
                        from GTC import ureal, pr

                        # create an Archive and add items to it
                        archive = pr.Archive()
                        archive.add(x=ureal(1, 0.1))
                        archive.add(y=ureal(2, 0.2))

                        # print the archive to be able to copy-paste the output
                        print(pr.dumps_xml(
                            archive,
                            indent=4,
                            encoding="unicode",
                            xml_declaration=None
                        ))
                        ```

                        `GTC` has an XML Schema Definition file to validate the serialised format of an `Archive`.

                        **Examples**

                        ```xml
                        {serialised}
                          {gtcArchive version="1.5.0" xmlns="https://measurement.govt.nz/gtc/xml"}
                            ...
                          {/gtcArchive}
                        {/serialised}
                        ```
                    
 
    <gtc:gtcArchive> ... </gtc:gtcArchive> [1] 
    <msl:gtcArchiveJSON
     Allow any attributes from any namespace (skip validation).
    > [1]  
       xsd:string
    </msl:gtcArchiveJSON>
  End Choice
</...>

Schema Component Representation

<xsd:complexType name="serialised">
  <xsd:choice>
    <xsd:element ref="gtc:gtcArchive"/>
    <xsd:element name="gtcArchiveJSON">
      <xsd:complexType>
        <xsd:simpleContent>
          <xsd:extension base="xsd:string">
            <xsd:anyAttribute processContents="skip"/>
          </xsd:extension>
        </xsd:simpleContent>
      </xsd:complexType>
    </xsd:element>
  </xsd:choice>
  <xsd:attribute name="comment" type="xsd:string"/>
</xsd:complexType>

<...
 comment="xsd:string" [0..1]Attribute comment

                    _Optional:_ A comment to associate with the `table`.
                
 
 
>
  <msl:type> xsd:string (pattern = \s*(bool|int|double|string)\s*(,\s*(bool|int|double|string)\s*)*) </msl:type> [1] 
  <msl:unit> xsd:string </msl:unit> [1] 
  <msl:header> xsd:string (pattern = [^,]+(,[^,]+)*) </msl:header> [1] 
  <msl:data> xsd:string (pattern = [^,]+(,[^,\n][^,]*)*) </msl:data> [1] 
</...>

Schema Component Representation

<xsd:complexType name="table">
  <xsd:sequence>
    <xsd:element name="type">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
          <xsd:pattern value="\s*(bool|int|double|string)\s*(,\s*(bool|int|double|string)\s*)*"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>
    <xsd:element name="unit" type="xsd:string"/>
    <xsd:element name="header">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
          <xsd:pattern value="[^,]+(,[^,]+)*"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>
    <xsd:element name="data">
      <xsd:simpleType>
        <xsd:restriction base="xsd:string">
          <xsd:pattern value="[^,]+(,[^,\n][^,]*)*"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>
  </xsd:sequence>
  <xsd:attribute name="comment" type="xsd:string"/>
</xsd:complexType>

<...>
  Start Sequence [0..*]
    <msl:id> msl:technicalProcedurePatternString </msl:id> [1] 
  End Sequence
</...>

Schema Component Representation

<xsd:complexType name="technicalProcedures">
  <xsd:sequence minOccurs="0" maxOccurs="unbounded">
    <xsd:element name="id" type="msl:technicalProcedurePatternString"/>
  </xsd:sequence>
</xsd:complexType>

digitalFormatEnumerationString

Properties

Name	digitalFormatEnumerationString
Content	Base XSD Type: string value may be one of MSL PDF/A-3 PTB DCC

Documentation

Schema Component Representation

<xsd:simpleType name="digitalFormatEnumerationString">
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="MSL PDF/A-3"/>
    <xsd:enumeration value="PTB DCC"/>
  </xsd:restriction>
</xsd:simpleType>

idPatternString

Properties

Name	idPatternString
Content	Base XSD Type: string pattern = MSLE\.[EFHLMOPT]\.[A-Z0-9]+

Documentation

Schema Component Representation

<xsd:simpleType name="idPatternString">
  <xsd:restriction base="xsd:string">
    <xsd:pattern value="MSLE\.[EFHLMOPT]\.[A-Z0-9]+"/>
  </xsd:restriction>
</xsd:simpleType>

keywordsList

Properties

Name	keywordsList
Content	List of: Locally defined type: Base XSD Type: string value may be one of AC Balance Barometer Current DAQ DC DMM GaugeBlock Hygrometer Laser Monochromator Oscilloscope PRT Radiation ResistanceBridge Sense Source SPRT Thermocouple Thermometer Voltage Weight WeightSet

Documentation

Schema Component Representation

<xsd:simpleType name="keywordsList">
  <xsd:list>
    <xsd:simpleType>
      <xsd:restriction base="xsd:string">
        <xsd:enumeration value="AC"/>
        <xsd:enumeration value="Balance"/>
        <xsd:enumeration value="Barometer"/>
        <xsd:enumeration value="Current"/>
        <xsd:enumeration value="DAQ"/>
        <xsd:enumeration value="DC"/>
        <xsd:enumeration value="DMM"/>
        <xsd:enumeration value="GaugeBlock"/>
        <xsd:enumeration value="Hygrometer"/>
        <xsd:enumeration value="Laser"/>
        <xsd:enumeration value="Monochromator"/>
        <xsd:enumeration value="Oscilloscope"/>
        <xsd:enumeration value="PRT"/>
        <xsd:enumeration value="Radiation"/>
        <xsd:enumeration value="ResistanceBridge"/>
        <xsd:enumeration value="Sense"/>
        <xsd:enumeration value="Source"/>
        <xsd:enumeration value="SPRT"/>
        <xsd:enumeration value="Thermocouple"/>
        <xsd:enumeration value="Thermometer"/>
        <xsd:enumeration value="Voltage"/>
        <xsd:enumeration value="Weight"/>
        <xsd:enumeration value="WeightSet"/>
      </xsd:restriction>
    </xsd:simpleType>
  </xsd:list>
</xsd:simpleType>

labEnumerationString

Properties

Name	labEnumerationString
Content	Base XSD Type: string value may be one of CMM Lab Contact thermometry lab Cryogenic Radiometer Detector Responsivity Fixed point lab Flexible Optics Furnace assembly room Goniospectrophotometer Hilger Lab Kibble Balance Laser Lab Long Room Mass Standards Laboratories MI bridge resistance bath MicroK 1 resistance bath MicroK 2 resistance bath Not at MSL Photometric Bench Pressure Standards Laboratories Radiation thermometry calibration lab Radiation thermometry research lab Single Photon Spectrophotometer Thermocouple lab Underground Tape Tunnel Water lab

Documentation

Schema Component Representation

<xsd:simpleType name="labEnumerationString">
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="CMM Lab"/>
    <xsd:enumeration value="Contact thermometry lab"/>
    <xsd:enumeration value="Cryogenic Radiometer"/>
    <xsd:enumeration value="Detector Responsivity"/>
    <xsd:enumeration value="Fixed point lab"/>
    <xsd:enumeration value="Flexible Optics"/>
    <xsd:enumeration value="Furnace assembly room"/>
    <xsd:enumeration value="Goniospectrophotometer"/>
    <xsd:enumeration value="Hilger Lab"/>
    <xsd:enumeration value="Kibble Balance"/>
    <xsd:enumeration value="Laser Lab"/>
    <xsd:enumeration value="Long Room"/>
    <xsd:enumeration value="Mass Standards Laboratories"/>
    <xsd:enumeration value="MI bridge resistance bath"/>
    <xsd:enumeration value="MicroK 1 resistance bath"/>
    <xsd:enumeration value="MicroK 2 resistance bath"/>
    <xsd:enumeration value="Not at MSL"/>
    <xsd:enumeration value="Photometric Bench"/>
    <xsd:enumeration value="Pressure Standards Laboratories"/>
    <xsd:enumeration value="Radiation thermometry calibration lab"/>
    <xsd:enumeration value="Radiation thermometry research lab"/>
    <xsd:enumeration value="Single Photon"/>
    <xsd:enumeration value="Spectrophotometer"/>
    <xsd:enumeration value="Thermocouple lab"/>
    <xsd:enumeration value="Underground Tape Tunnel"/>
    <xsd:enumeration value="Water lab"/>
  </xsd:restriction>
</xsd:simpleType>

nonEmptyString

Properties

Name	nonEmptyString
Content	Base XSD Type: string pattern = .\S.

Documentation

Schema Component Representation

<xsd:simpleType name="nonEmptyString">
  <xsd:restriction base="xsd:string">
    <xsd:pattern value=".*\S.*"/>
  </xsd:restriction>
</xsd:simpleType>

nonNegativeDecimal

Properties

Name	nonNegativeDecimal
Content	Base XSD Type: decimal value >= 0

Documentation

Schema Component Representation

<xsd:simpleType name="nonNegativeDecimal">
  <xsd:restriction base="xsd:decimal">
    <xsd:minInclusive value="0"/>
  </xsd:restriction>
</xsd:simpleType>

quantityEnumerationString

Properties

Name	quantityEnumerationString
Content	Base XSD Type: string value may be one of Angle Angularity BRDF BTDF Colour Current AC Current DC Cylindricity Deviation in Length Flatness Frequency Gloss Haze Humidity Illuminance Illuminance Responsivity Length Luminance Luminance Responsivity Luminous Intensity Mass Parallelism Perpendicularity Pressure Reflectance Resistance AC Resistance DC Roundness Runout Spectral Irradiance Spectral Irradiance Responsivity Sphericity Straightness Temperature Total Runout Transmittance Variation in Length Voltage AC Voltage DC Wavelength

Documentation

Schema Component Representation

<xsd:simpleType name="quantityEnumerationString">
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="Angle"/>
    <xsd:enumeration value="Angularity"/>
    <xsd:enumeration value="BRDF"/>
    <xsd:enumeration value="BTDF"/>
    <xsd:enumeration value="Colour"/>
    <xsd:enumeration value="Current AC"/>
    <xsd:enumeration value="Current DC"/>
    <xsd:enumeration value="Cylindricity"/>
    <xsd:enumeration value="Deviation in Length"/>
    <xsd:enumeration value="Flatness"/>
    <xsd:enumeration value="Frequency"/>
    <xsd:enumeration value="Gloss"/>
    <xsd:enumeration value="Haze"/>
    <xsd:enumeration value="Humidity"/>
    <xsd:enumeration value="Illuminance"/>
    <xsd:enumeration value="Illuminance Responsivity"/>
    <xsd:enumeration value="Length"/>
    <xsd:enumeration value="Luminance"/>
    <xsd:enumeration value="Luminance Responsivity"/>
    <xsd:enumeration value="Luminous Intensity"/>
    <xsd:enumeration value="Mass"/>
    <xsd:enumeration value="Parallelism"/>
    <xsd:enumeration value="Perpendicularity"/>
    <xsd:enumeration value="Pressure"/>
    <xsd:enumeration value="Reflectance"/>
    <xsd:enumeration value="Resistance AC"/>
    <xsd:enumeration value="Resistance DC"/>
    <xsd:enumeration value="Roundness"/>
    <xsd:enumeration value="Runout"/>
    <xsd:enumeration value="Spectral Irradiance"/>
    <xsd:enumeration value="Spectral Irradiance Responsivity"/>
    <xsd:enumeration value="Sphericity"/>
    <xsd:enumeration value="Straightness"/>
    <xsd:enumeration value="Temperature"/>
    <xsd:enumeration value="Total Runout"/>
    <xsd:enumeration value="Transmittance"/>
    <xsd:enumeration value="Variation in Length"/>
    <xsd:enumeration value="Voltage AC"/>
    <xsd:enumeration value="Voltage DC"/>
    <xsd:enumeration value="Wavelength"/>
  </xsd:restriction>
</xsd:simpleType>

statusEnumerationString

Properties

Name	statusEnumerationString
Content	Base XSD Type: string value may be one of Active Damaged Disposed Dormant Lost Retired

Documentation

Schema Component Representation

<xsd:simpleType name="statusEnumerationString">
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="Active"/>
    <xsd:enumeration value="Damaged"/>
    <xsd:enumeration value="Disposed"/>
    <xsd:enumeration value="Dormant"/>
    <xsd:enumeration value="Lost"/>
    <xsd:enumeration value="Retired"/>
  </xsd:restriction>
</xsd:simpleType>

teamEnumerationString

Properties

Name	teamEnumerationString
Content	Base XSD Type: string value may be one of Electrical Humidity Length Light Mass Pressure Temperature Time

Documentation

Schema Component Representation

<xsd:simpleType name="teamEnumerationString">
  <xsd:restriction base="xsd:string">
    <xsd:enumeration value="Electrical"/>
    <xsd:enumeration value="Humidity"/>
    <xsd:enumeration value="Length"/>
    <xsd:enumeration value="Light"/>
    <xsd:enumeration value="Mass"/>
    <xsd:enumeration value="Pressure"/>
    <xsd:enumeration value="Temperature"/>
    <xsd:enumeration value="Time"/>
  </xsd:restriction>
</xsd:simpleType>

technicalProcedurePatternString

Properties

Name	technicalProcedurePatternString
Content	Base XSD Type: string pattern = MSLT\.[EFHLMOPT]\.[0-9]+(\.[0-9]+)?

Documentation

Schema Component Representation

<xsd:simpleType name="technicalProcedurePatternString">
  <xsd:restriction base="xsd:string">
    <xsd:pattern value="MSLT\.[EFHLMOPT]\.[0-9]+(\.[0-9]+)?"/>
  </xsd:restriction>
</xsd:simpleType>

tokenizedString

Properties

Name	tokenizedString
Content	Base XSD Type: string pattern = \S(\S( ?)\S+)

Documentation

Schema Component Representation

<xsd:simpleType name="tokenizedString">
  <xsd:restriction base="xsd:string">
    <xsd:pattern value="\S(\S*( ?)\S+)*"/>
  </xsd:restriction>
</xsd:simpleType>

variables

Properties

Name	variables
Content	List of: Locally defined type: Base XSD Type: string pattern = [a-zA-Z][a-zA-Z0-9_]*

Documentation

Schema Component Representation

<xsd:simpleType name="variables">
  <xsd:list>
    <xsd:simpleType>
      <xsd:restriction base="xsd:string">
        <xsd:pattern value="[a-zA-Z][a-zA-Z0-9_]*"/>
      </xsd:restriction>
    </xsd:simpleType>
  </xsd:list>
</xsd:simpleType>