Class: Gateway

name: Gateway
description: Gateway as a software asset can be mapped using the class. It represents
  the container bundle that is deployed on a device or virtual machine and provides
  connectivity between assets in the shopfloor and the IAH backend.
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
is_a: Asset
slots:
- asset_links
slot_usage:
  functional_object_type:
    name: functional_object_type
    equals_string: Gateway

name: Gateway
description: Gateway as a software asset can be mapped using the class. It represents
  the container bundle that is deployed on a device or virtual machine and provides
  connectivity between assets in the shopfloor and the IAH backend.
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
is_a: Asset
slot_usage:
  functional_object_type:
    name: functional_object_type
    equals_string: Gateway
attributes:
  asset_links:
    name: asset_links
    description: List of asset links that are connected to the asset gateway.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: asset_links
    owner: Gateway
    domain_of:
    - Gateway
    range: AssetLink
    multivalued: true
    inlined: true
    inlined_as_list: true
  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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    domain_of:
    - Asset
    - ConnectionPoint
    range: string
    required: true
  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: Gateway
    domain_of:
    - Asset
    range: Source
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    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: Gateway
    domain_of:
    - FunctionalObject
    range: string
    required: true
    equals_string: Gateway
  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: Gateway
    domain_of:
    - FunctionalObject
    range: uri
    required: true
    pattern: ^https://industrial-assets\.io.*$