Skip to content

Class: Asset

An asset is the representation of a functional object with a technical function that is known to Industrial Asset Hub (IAH). Industrial Asset Hub (IAH) might want to manage the asset, model its relationships with other assets, or it might know the asset and ignore it,...

An asset instance might represent a physical object (like a Raspberry Pi or an application running on a system) or a virtual object (like a router in a network topology, no matter which physical device it is).

URI: base:Asset

 classDiagram
    class Asset
    click Asset href "../Asset/"
      FunctionalObject <|-- Asset
        click FunctionalObject href "../FunctionalObject/"


      Asset <|-- Device
        click Device href "../Device/"
      Asset <|-- Gateway
        click Gateway href "../Gateway/"
      Asset <|-- SoftwareArtifact
        click SoftwareArtifact href "../SoftwareArtifact/"


      Asset : access_group

      Asset : asset_operations





        Asset --> "*" AssetOperation : asset_operations
        click AssetOperation href "../AssetOperation/"



      Asset : connection_points





        Asset --> "*" ConnectionPoint : connection_points
        click ConnectionPoint href "../ConnectionPoint/"



      Asset : custom_properties





        Asset --> "1..*" CustomProperty : custom_properties
        click CustomProperty href "../CustomProperty/"



      Asset : description

      Asset : functional_object_schema_url

      Asset : functional_object_type

      Asset : id

      Asset : instance_annotations





        Asset --> "*" InstanceAnnotation : instance_annotations
        click InstanceAnnotation href "../InstanceAnnotation/"



      Asset : last_modified_timestamp

      Asset : location





        Asset --> "*" AssetLocation : location
        click AssetLocation href "../AssetLocation/"



      Asset : management_state





        Asset --> "1" ManagementState : management_state
        click ManagementState href "../ManagementState/"



      Asset : name

      Asset : operating_mode





        Asset --> "0..1" OperatingMode : operating_mode
        click OperatingMode href "../OperatingMode/"



      Asset : product_instance_information





        Asset --> "0..1" ProductInstanceInformation : product_instance_information
        click ProductInstanceInformation href "../ProductInstanceInformation/"



      Asset : reachability_state





        Asset --> "0..1" ReachabilityState : reachability_state
        click ReachabilityState href "../ReachabilityState/"



      Asset : responsible

      Asset : software_components





        Asset --> "*" SoftwareComponent : software_components
        click SoftwareComponent href "../SoftwareComponent/"



      Asset : source





        Asset --> "1" SourceClass : source
        click SourceClass href "../SourceClass/"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
connection_points *
ConnectionPoint		 An asset might have a connection point that can be used to connect with the a... direct
asset_operations *
AssetOperation		 List of device management operations supported by an asset direct
product_instance_information 0..1
ProductInstanceInformation		 Information about the product instance direct
software_components *
SoftwareComponent		 An asset can host software artifacts that might want to be tracked direct
location *
AssetLocation		 Possible ways to know where an asset is located direct
operating_mode 0..1
OperatingMode		 The current operating mode of the asset direct
management_state 1
ManagementState		 A manage state is an attribute of an asset that specifies how an asset is bei... direct
reachability_state 0..1
ReachabilityState		 A slot to track the last observed reachability state and when it was observed direct
id 1
String		 The unique identifier of an asset direct
source 1
SourceClass		 The source of the asset data direct
responsible 1
String		 The person inside the organization responsible for the asset direct
access_group 1
String		 The access group of an asset direct
last_modified_timestamp 1
Datetime		 The timestamp when the asset was last modified direct
custom_properties 1..*
CustomProperty		 A list of custom properties that can be used to store additional information ... direct
name 0..1
String		 The name of the item FunctionalObject
description 0..1
String		 A textual description of the item's purpose and use FunctionalObject
instance_annotations *
InstanceAnnotation		 Metadata associated with an object FunctionalObject
functional_object_type 1
String		 Type designator that supports polymorphism using functional parts FunctionalObject
functional_object_schema_url 1
Uri		 URL of the schema that defines the functional object type FunctionalObject

Examples

Value
Device
PCI-card
USB-stick
Production line
Factory

Identifier and Mapping Information

Schema Source

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

Mappings

Mapping Type Mapped Value
self base:Asset
native base:Asset
close sietechas:TechnicalAsset

LinkML Source

Direct

name: Asset
description: 'An asset is the representation of a functional object with a technical
  function that is known to Industrial Asset Hub (IAH). Industrial Asset Hub (IAH)
  might want to manage the asset, model its relationships with other assets, or it
  might know the asset and ignore it,...

  An asset instance might represent a physical object (like a Raspberry Pi or an application
  running on a system) or a virtual object (like a router in a network topology, no
  matter which physical device it is).'
examples:
- value: Device
- value: PCI-card
- value: USB-stick
- value: Production line
- value: Factory
in_subset:
- MostRelevant
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
close_mappings:
- sietechas:TechnicalAsset
is_a: FunctionalObject
slots:
- connection_points
- asset_operations
- product_instance_information
- software_components
- location
- operating_mode
- management_state
- reachability_state
- id
- source
- responsible
- access_group
- last_modified_timestamp
- custom_properties
slot_usage:
  functional_object_type:
    name: functional_object_type
    equals_string: Asset
  management_state:
    name: management_state
    required: true

Induced

name: Asset
description: 'An asset is the representation of a functional object with a technical
  function that is known to Industrial Asset Hub (IAH). Industrial Asset Hub (IAH)
  might want to manage the asset, model its relationships with other assets, or it
  might know the asset and ignore it,...

  An asset instance might represent a physical object (like a Raspberry Pi or an application
  running on a system) or a virtual object (like a router in a network topology, no
  matter which physical device it is).'
examples:
- value: Device
- value: PCI-card
- value: USB-stick
- value: Production line
- value: Factory
in_subset:
- MostRelevant
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
close_mappings:
- sietechas:TechnicalAsset
is_a: FunctionalObject
slot_usage:
  functional_object_type:
    name: functional_object_type
    equals_string: Asset
  management_state:
    name: management_state
    required: true
attributes:
  connection_points:
    name: connection_points
    description: An asset might have a connection point that can be used to connect
      with the asset. In the case of devices, at least one connection point is required.
      It might be a connection point needed for AssetManagement for interaction with
      the asset, or for other connections of the asset related to the asset function
      but not to device management.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: connection_points
    owner: Asset
    domain_of:
    - Asset
    range: ConnectionPoint
    multivalued: true
    inlined: true
    inlined_as_list: true
  asset_operations:
    name: asset_operations
    description: List of device management operations supported by an asset. Each
      operation type might appear only once.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: asset_operations
    owner: Asset
    domain_of:
    - Asset
    range: AssetOperation
    multivalued: true
    inlined: true
    inlined_as_list: true
  product_instance_information:
    name: product_instance_information
    description: Information about the product instance.
    title: product instance information
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: product_instance_information
    owner: Asset
    domain_of:
    - Asset
    range: ProductInstanceInformation
  software_components:
    name: software_components
    description: An asset can host software artifacts that might want to be tracked.
      This can be used simply to keep track of the firmware version or to keep a full-blown
      Software Bill of Material (SBOM).
    title: Software Components
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: software_components
    owner: Asset
    domain_of:
    - Asset
    range: SoftwareComponent
    multivalued: true
    inlined: true
    inlined_as_list: true
  location:
    name: location
    description: Possible ways to know where an asset is located.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: location
    owner: Asset
    domain_of:
    - Asset
    range: AssetLocation
    multivalued: true
  operating_mode:
    name: operating_mode
    description: The current operating mode of the asset.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: operating_mode
    owner: Asset
    domain_of:
    - Asset
    range: OperatingMode
    inlined: true
  management_state:
    name: management_state
    description: 'A manage state is an attribute of an asset that specifies how an
      asset is being regarded by an asset management system (is it being regarded
      or ignored). Some assets might be known to the Industrial Asset Hub (for example,
      discovered through a network scan), but want to be ignored for different reasons.

      The goals of this attribute are: to avoid rediscovering assets being ignored
      and to focus management activities on those assets being regarded.

      Assets that can be discovered, but not supported, might evolve from an "ignored"
      to a "regarded" state, once supported.'
    title: management state
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: management_state
    owner: Asset
    domain_of:
    - Asset
    range: ManagementState
    required: true
  reachability_state:
    name: reachability_state
    description: A slot to track the last observed reachability state and when it
      was observed.
    title: reachability state
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: reachability_state
    owner: Asset
    domain_of:
    - Asset
    range: ReachabilityState
  id:
    name: id
    description: The unique identifier of an asset. It is a string that can be used
      to identify an asset in the Industrial Asset Hub.
    title: id
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    identifier: true
    alias: id
    owner: Asset
    domain_of:
    - Asset
    - ConnectionPoint
    range: string
  source:
    name: source
    description: The source of the asset data.
    title: source
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: source
    owner: Asset
    domain_of:
    - Asset
    range: SourceClass
    required: true
    inlined: true
  responsible:
    name: responsible
    description: The person inside the organization responsible for the asset. This
      value is set to the user who onboarded the asset into the inventory, but can
      be updated later on if needed.
    title: responsible
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: responsible
    owner: Asset
    domain_of:
    - Asset
    range: string
    required: true
  access_group:
    name: access_group
    description: The access group of an asset. It is a string that can be used to
      group assets together for access control purposes.
    title: access group
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: access_group
    owner: Asset
    domain_of:
    - Asset
    range: string
    required: true
  last_modified_timestamp:
    name: last_modified_timestamp
    description: The timestamp when the asset was last modified. It is a datetime
      value that can be used to track when an asset was last updated in the inventory.
    title: last modified timestamp
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: last_modified_timestamp
    owner: Asset
    domain_of:
    - Asset
    range: datetime
    required: true
  custom_properties:
    name: custom_properties
    description: A list of custom properties that can be used to store additional
      information about an asset that is not covered by the predefined slots.
    title: custom properties
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: custom_properties
    owner: Asset
    domain_of:
    - Asset
    range: CustomProperty
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
  name:
    name: name
    description: The name of the item.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: Asset
    domain_of:
    - FunctionalObject
    - Organization
    - ConnectionPoint
    range: string
  description:
    name: description
    description: A textual description of the item's purpose and use.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    slot_uri: linkml:description
    alias: description
    owner: Asset
    domain_of:
    - FunctionalObject
    range: string
  instance_annotations:
    name: instance_annotations
    description: Metadata associated with an object.
    title: instance annotations
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: instance_annotations
    owner: Asset
    domain_of:
    - FunctionalObject
    range: InstanceAnnotation
    multivalued: true
    inlined: true
    inlined_as_list: true
  functional_object_type:
    name: functional_object_type
    description: Type designator that supports polymorphism using functional parts.
      This type is used for validation of the provided functional objects.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    designates_type: true
    alias: functional_object_type
    owner: Asset
    domain_of:
    - FunctionalObject
    range: string
    required: true
    equals_string: Asset
  functional_object_schema_url:
    name: functional_object_schema_url
    description: URL of the schema that defines the functional object type.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: functional_object_schema_url
    owner: Asset
    domain_of:
    - FunctionalObject
    range: uri
    required: true
    pattern: ^https://industrial-assets\.io.*$

Any questions left?

Ask the community