Skip to content

Class: Identifier

An element that provides an unambiguous identification of an item.

It can be an object, in which case the combination of the attributes specified as "unique keys" must be unique.

  • NOTE: this is an abstract class and should not be instantiated directly

URI: base:Identifier

 classDiagram
    class Identifier
    click Identifier href "../Identifier/"
      Identifier <|-- AssetIdentifier
        click AssetIdentifier href "../AssetIdentifier/"

      Identifier : identifier_type





        Identifier --> "0..1" IdentifierType : identifier_type
        click IdentifierType href "../IdentifierType/"



      Identifier : identifier_uncertainty

Inheritance

Slots

Name Cardinality and Range Description Inheritance
identifier_type 0..1
IdentifierType		 Type of an items identifier direct
identifier_uncertainty 0..1
Integer		 Number that indicates how uncertain an identifier is compared to other identi... direct

Examples

Value
The combination of the 'manufacturer' 'Siemens' and the 'order ID' '6DR5513-0NG00-0AA0'.
a combination of the values "vendor", "product ID" and "serial number"
a MAC-address (can be modified on some systems, but might be considered static on certain environments)

Identifier and Mapping Information

Schema Source

  • from schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml

Mappings

Mapping Type Mapped Value
self base:Identifier
native base:Identifier
close sieiot:ThingIdentifier

LinkML Source

Direct

name: Identifier
description: 'An element that provides an unambiguous identification of an item.

  It can be an object, in which case the combination of the attributes specified as
  "unique keys" must be unique.'
examples:
- value: The combination of the 'manufacturer' 'Siemens' and the 'order ID' '6DR5513-0NG00-0AA0'.
- value: a combination of the values "vendor", "product ID" and "serial number"
- value: a MAC-address (can be modified on some systems, but might be considered static
    on certain environments)
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
close_mappings:
- sieiot:ThingIdentifier
abstract: true
slots:
- identifier_type
- identifier_uncertainty

Induced

name: Identifier
description: 'An element that provides an unambiguous identification of an item.

  It can be an object, in which case the combination of the attributes specified as
  "unique keys" must be unique.'
examples:
- value: The combination of the 'manufacturer' 'Siemens' and the 'order ID' '6DR5513-0NG00-0AA0'.
- value: a combination of the values "vendor", "product ID" and "serial number"
- value: a MAC-address (can be modified on some systems, but might be considered static
    on certain environments)
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
close_mappings:
- sieiot:ThingIdentifier
abstract: true
attributes:
  identifier_type:
    name: identifier_type
    description: Type of an items identifier.
    title: identifier type
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
    rank: 1000
    alias: identifier_type
    owner: Identifier
    domain_of:
    - Identifier
    range: IdentifierType
  identifier_uncertainty:
    name: identifier_uncertainty
    description: 'Number that indicates how uncertain an identifier is compared to
      other identifiers provided by an Asset Link. The higher the number, the more
      uncertain the identification must be considered. This number must be considered
      relative to the other identifiers for the same element. The default value is
      0, meaning no uncertainty.

      This index helps to decide which identifiers are better suited for deduplication
      across Asset Links. The identifier provided by two different Asset Links with
      the lowest uncertainty should be chosen for deduplication purposes.'
    title: identifier uncertainty
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
    rank: 1000
    alias: identifier_uncertainty
    owner: Identifier
    domain_of:
    - Identifier
    range: integer

Any questions left?

Ask the community