Skip to content

Class: CustomIdentifier

Identifier especially for assets that are imported from external sources and do not provide a native identifier. The 'name' is used to specify the external source or type of the identifier. The 'value' is used to provide the actual identifier value within that context.

URI: base:CustomIdentifier

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

      CustomIdentifier : asset_identifier_type

      CustomIdentifier : identifier_type





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



      CustomIdentifier : identifier_uncertainty

      CustomIdentifier : name

      CustomIdentifier : value

Inheritance

Slots

Name Cardinality and Range Description Inheritance
name 1
String		 The name of the item direct
value 1
String		 The value of the custom identifier direct
asset_identifier_type 1
String		 Type designator that supports polymorphism using asset identifiers AssetIdentifier
identifier_type 0..1
IdentifierType		 Type of an items identifier Identifier
identifier_uncertainty 0..1
Integer		 Number that indicates how uncertain an identifier is compared to other identi... Identifier

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:CustomIdentifier
native base:CustomIdentifier

LinkML Source

Direct

name: CustomIdentifier
description: Identifier especially for assets that are imported from external sources
  and do not provide a native identifier. The 'name' is used to specify the external
  source or type of the identifier. The 'value' is used to provide the actual identifier
  value within that context.
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
is_a: AssetIdentifier
slots:
- name
slot_usage:
  asset_identifier_type:
    name: asset_identifier_type
    equals_string: CustomIdentifier
  identifier_uncertainty:
    name: identifier_uncertainty
    ifabsent: int(1006)
  name:
    name: name
    required: true
attributes:
  value:
    name: value
    description: 'The value of the custom identifier. '
    title: identifier value
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-asset-identifiers.yaml
    domain_of:
    - InstanceAnnotation
    - CustomIdentifier
    range: string
    required: true
    pattern: ^[A-Za-z0-9._~!$&'()*+,;=:/?@%-]{1,256}$

Induced

name: CustomIdentifier
description: Identifier especially for assets that are imported from external sources
  and do not provide a native identifier. The 'name' is used to specify the external
  source or type of the identifier. The 'value' is used to provide the actual identifier
  value within that context.
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
is_a: AssetIdentifier
slot_usage:
  asset_identifier_type:
    name: asset_identifier_type
    equals_string: CustomIdentifier
  identifier_uncertainty:
    name: identifier_uncertainty
    ifabsent: int(1006)
  name:
    name: name
    required: true
attributes:
  value:
    name: value
    description: 'The value of the custom identifier. '
    title: identifier value
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-asset-identifiers.yaml
    alias: value
    owner: CustomIdentifier
    domain_of:
    - InstanceAnnotation
    - CustomIdentifier
    range: string
    required: true
    pattern: ^[A-Za-z0-9._~!$&'()*+,;=:/?@%-]{1,256}$
  name:
    name: name
    description: The name of the item.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: CustomIdentifier
    domain_of:
    - FunctionalObject
    - Organization
    - ConnectionPoint
    - SoftwareIdentifier
    - CustomIdentifier
    range: string
    required: true
  asset_identifier_type:
    name: asset_identifier_type
    description: Type designator that supports polymorphism using asset identifiers.
    title: asset identifier type
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
    rank: 1000
    designates_type: true
    alias: asset_identifier_type
    owner: CustomIdentifier
    domain_of:
    - AssetIdentifier
    range: string
    required: true
    equals_string: CustomIdentifier
  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: CustomIdentifier
    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
    ifabsent: int(1006)
    alias: identifier_uncertainty
    owner: CustomIdentifier
    domain_of:
    - Identifier
    range: integer

Any questions left?

Ask the community