Specification Predefined Template for UoM for submodel elements with values (normative) Data Specification Unit of Measurement Template Specification This specification is only valid in combination with IDTA-01001-3 and IDTA-01003-a-3. Template: Unit of Measurement administration: version: 3 revision: 0 creator: IDTA id: https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3 dataSpecificationContent: DataSpecificationUoM Description (EN): Data specification template for concept descriptions for Units of Measurement. The ID of the data specification template was derived conformant to the grammar for semantic IDs for data specifications as defined in Part 1 of the document series, IDTA-01001, with the exception that the minor version was excluded because this ID is also part of the instances of Asset Administration Shells: This ID is used in hasDataSpecification/dataSpecification. This namespace has the qualifier "UoM:". Figure 1. Metamodel of Data Specification Unit of Measurement Identifikation of the Concept Description The identification of the Concept Description, conceptDescription/id, should be identical to the unique global identifier of the unit of measurement, if available. If no unique global identifier is available, the conceptDescription/id can be chosen arbitrarily. In this case the unit’s identifier as defined by the classification system must be denoted in the attribute specificUnitID (see below). Data Specification Attributes Class: DataSpecificationUoM <<Template>> Explanation: Content of data specification template for concept descriptions for Units of Measurement Inherits from: DataSpecificationContent id: https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM Attribute: ID Explanation Type Card. preferredName https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM/preferredName Preferred name of the unit in different languages as defined by the classification system Example: "millimetre" LangStringSetUoM 1 symbol https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM/symbol Symbol of the unit Example: “mm” StringUoM 1 specificUnitID https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM/specificUnitID ID of the unit defined by the classification system Note: This is relevant if the classification system references the units differently from the unique conceptDescription/id. This can e.g. be UNECE common codes or proprietary keys. Example: "MMT" StringUoM 0..1 definition https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM/definition Definition of the unit in different languages Example: "0,001 fold of the SI base unit metre"@en DefinitionTypeUoM 0..1 preferredNameQuantity https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM/preferredNameQuantity Preferred name of the unit’s quantity in different languages as defined by the classification system. preferredNameQuantity and quantityID must be consistent if both attributes are set. If the classification system lists multiple quantities for the unit, exactly one of those quantities must be selected in accordance with the properties purpose. Example: "distance" LangStringSetUoM 0..1 quantityId https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM/quantityId ID of the unit’s quantity. preferredNameQuantity and quantityID must be consistent if both attributes are set Example: 0173-1#Z4-BAJ199#002 IdentifierUoM 0..1 classificationSystem https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM/classificationSystem Name of the classification system used for the definition of units and quantities Note: The most prominent classification systems should be denoted as follows: "ECLASS", "IEC CDD", "UNECE Rec 20", "UNECE Rec 21", "BIPM", "OPC UA", "SAMM". This list is not exclusive. Example: "ECLASS Basic" StringUoM 0..1 classificationSystemVersion https://admin-shell.io/DataSpecificationTemplates/DataSpecificationUoM/3/0/DataSpecificationUoM/classificationSystemVersion Version of the classification system used for the definition of units and quantities The version shshould be denoted exactly as provided by the classification system. Example: "15.0" StringUoM 0..1 Primitive and Simple Data Types (normative) All simple data types from Part 1 [1] apply also to the specifications described in this document. Basic and Primitive Data Types Table 1 lists the Primitives used in the metamodel. Primitive data types start with a capital letter. Table 1. Primitive DataTypes Used in Metamodel Primitive Definition Value Examples LangStringSet Array of elements of type langString Note 1: langString is a RDF data type Note 2: a langString is a string value tagged with a language code The realization of a langString depends on the serialization rules for a technology as defined in Part 1 Metamodel, IDTA-01001. In xml: <aas:langString lang="EN">This is a multi-language value in English</aas:langString> <aas:langString lang="DE">Das ist ein Multi-Language-Wert in Deutsch</aas:langString> In rdf: "This is a multi-language value in English"@en ; "Das ist ein Multi-Language-Wert in Deutsch"@de In JSON: "description": [ { "language":"en", "text": "This is a multi-language value in English." }, { "language":"de", "text": "Das ist ein Multi-Language-Wert in Deutsch." } ] LangStringSetUoM LangStringSet Each langString within the array of strings has a length of maximum 256 and a minimum of 1 characters. (see examples for LangStringSet) DefinitionTypeUoM LangStringSet Each langString within the array of strings has a length of maximum 2048 and a minimum of 1 characters. "0,001 fold of the SI base unit metre"@en (also see examples for LangStringSet) StringUoM string A string with a length of maximum 256 and a minimum of 1 characters. ==== Note: string is a xsd data type ==== "OPC UA" (also see examples for LangStringSet) IdentifierUoM string A string with a length of maximum 2048 and a minimum of 1 characters. ==== Note: string is a xsd data type ==== "0173-1#02-BAA120#008" (also see examples for LangStringSet) Mappings to Data Formats to Share I4.0-Compliant Information (normative) Part 1 of this document series (IDTA-01001) introduces different serialization formats: XML, JSON and RDF. Part 1 also introduces the implementation guide for embedded data specifications. This is why the different formats are described in IDTA-01001.