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 shop floor and the IAH backend.
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
is_a: SoftwareArtifact
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 shop floor and the IAH backend.
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
is_a: SoftwareArtifact
slot_usage:
  functional_object_type:
    name: functional_object_type
    equals_string: Gateway
attributes:
  is_firmware:
    name: is_firmware
    description: 'Flag indicating that the software artifact is provided by a hardware
      manufacturer for one or more of its devices.

      Unlike other software artifacts, updating the firmware requires contacting the
      source specified by the device manufacturer.

      Due to this definition, firmware in IAH has a much wider scope than in some
      domains, where firmware is only meant to be close-to-the-silicon software.'
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-software-components.yaml
    rank: 1000
    alias: is_firmware
    owner: Gateway
    domain_of:
    - SoftwareArtifact
    range: boolean
  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.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.yaml
    rank: 1000
    alias: asset_operations
    owner: Gateway
    domain_of:
    - Asset
    range: AssetOperation
    multivalued: true
    inlined: true
    inlined_as_list: true
  asset_identifiers:
    name: asset_identifiers
    description: 'An asset identifier is an asset attribute that provides enough information
      to unequivocally identify the represented object.

      In some cases the ID attribute acts simultaneously as a reference for the asset
      instance and as identifier for the represented object. Otherwise at least one
      asset identifier is needed.

      There can be multiple asset_identifiers with different goals. For example, the
      information of a metal nameplate can be used by a human-being to identify a
      device represented by an asset instance, but a software certificate provided
      by a device might help a software component identify the device in the network,...

      An asset identifier might have an identifier_type, that defines its format and
      possibly even semantics.'
    title: asset identifiers
    examples:
    - value: '''Nameplate'': { ''vendor id'': ''siemens'', ''product id'': ''1FN3050-1ND00-0EA3'',
        ''serial number'': ''0011223344'' }'
      description: Object that provides a set of values that unequivocally identify
        a Siemens device.
    - value: '''Product ID'': { ''Vendor'': ''Rexroth'', ''Type Code'': ''VDP16.3DBN-D1-NN-NN'',
        ''Type Name'': ''IndraControl VPB 40.4, Control Cabinet PC''}, ''Instance
        ID'': { ''Serial Number'': ''SN:008595411'' }'
      description: Object that provides a set of values that unequivocally identify
        a Rexroth device.
    - value: 123e4567-e89b-12d3-a456-426655440000
      description: Universal Unique ID (UUID AKA GUID) that identifies an asset instance.
    - value: 'MAC-Address: 00:11:22:33:44'
      description: Identify a device by its MAC-Address, assuming that it cannot be
        changed.
    - value: '''Device Certificate'': { ''Certificate ID'': ''1wlkq3'', ''Certificate
        PubKey'': ''xxxxxxxxxxxx'' }'
      description: Information needed to challenge the certificate of a device with
        its public key.
    - value: '''ID Link'': ''https://example.com/idlink/12345'''
      description: Identify a device by a vendor-provided ID Link URL that follows
        the ID Link convention.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
    rank: 1000
    alias: asset_identifiers
    owner: Gateway
    domain_of:
    - Asset
    - RelatedAsset
    range: AssetIdentifier
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
    minimum_cardinality: 1
  asset_relations:
    name: asset_relations
    description: Relationships between this asset and other assets.
    title: Asset Relations
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base.yaml
    rank: 1000
    alias: asset_relations
    owner: Gateway
    domain_of:
    - Asset
    range: AssetRelation
    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.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.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.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.yaml
    rank: 1000
    alias: operating_mode
    owner: Gateway
    domain_of:
    - Asset
    range: OperatingMode
    inlined: true
  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: Gateway
    domain_of:
    - FunctionalObject
    - Organization
    - ConnectionPoint
    - SoftwareIdentifier
    - CustomIdentifier
    - HostBasedSoftwareIdentifier
    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.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.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.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.yaml
    rank: 1000
    alias: functional_object_schema_url
    owner: Gateway
    domain_of:
    - FunctionalObject
    range: uri
    required: true
    pattern: ^https://industrial-assets\.io.*$