Skip to content

Concept of types

Types are a new concept introduced in IIH Essentials Version 2.0. In this section the basics about types are explained. The intention is to get first inside into the functionality without going too deep into the details.

Adding an asset type

The section Types can is used to setup the type system. By default the Asset type editor is displayed. The root asset type of the type system is the asset type anchor.asset-base. It is created automatically by the system and can not be deleted or modified. All asset types are derived from this root asset type.

types

  1. To add a new asset type select its base asset type in the navigation area.
  2. Click the plus button

    A screen with the title Add asset type is opened. The only mandatory information you have to enter is the Name of the asset type and a Namespace.

  3. Click the Add button to create the asset type.

    add asset type

    The created asset type is selected in the navigation area. Its Attributes tab is opened.

    asset type created

Adding an attribute to asset type

  1. To add an attribute to an asset type first select the asset type.
  2. Open the tab Attributes.
  3. Click the button Add attribute.

    The Add attribute sidebar appears. The only mandatory information you have to enter is the Name of the attribute and the Data type of the attribute.

  4. Click the Add button to create the attribute. The Add attribute sidebar can be closed with the Cancel button.

    add attribute to asset type

    The created attribute will be displayed in the list of attributes.

    asset type attribute created

Instantiating an asset type

  1. To create an instance of the asset type navigate to the section Manage Data.
  2. Navigate to the parent asset where you want to add the new asset below and click the plus button. A screen with the title Add asset is opened.
  3. Give the asset a Name.
  4. Select the previously created asset type in the Asset type dropdown field.
  5. Click the Add button to create the asset.

    instantiate asset type

    The asset is now created based on the configuration of the asset type. All attributes which are defined at the asset type are created automatically by the system. Below the name of the asset also the name of its asset type is displayed. The link button right of this name can be used to directly jump to the aspect type.

    asset type instantiated

Locating instances of an asset type

  1. To locate all instances of a specific asset type first select the asset type.
  2. Open the Instances tab.
  3. Here a list of all existing instances of the asset type is shown. The name of each asset as well as its path in the asset hierarchy is displayed. With a link button it is possible to directly jump to the asset in the asset hierarchy.

    find asset type instance

Adding an aspect type

  1. Navigate to the section Types and open the Aspect type editor.

    The root aspect type of the type system is the aspect type anchor.aspect-base. It is created automatically by the system and can not be deleted or modified. All aspect types are derived from this base type.

    aspect types

  2. To add a new aspect type select its base aspect type in the navigation area.

  3. Click the plus button.

    A screen with the title Add aspect type is opened. The only mandatory information you have to enter is the Name of the aspect type and a Namespace.

  4. Click the Add button to create the aspect type.

    add aspect type

    The created aspect type is selected in the navigation area. Its Attributes tab is opened.

    aspect type created

Adding an attribute to aspect type

  1. To add an attribute to an aspect type first select the aspect type and open the tab Attributes.
  2. Click the button Add attribute.

    The Add attribute sidebar appears. The only mandatory information you have to enter is the Name of the attribute and the Data type of the attribute.

  3. Click the Add button to create the attribute. The Add attribute sidebar can be closed with the Cancel button.

    add aspect type attribute

    The created attribute will be displayed in the list of attributes.

    aspect type attribute added

Instantiating and aspect type

  1. To create an instance of the aspect type navigate to the section Manage Data.
  2. Select the asset to which you want to add the aspect and open its Attributes tab.
  3. Click the button Add aspect. The Add aspect sidebar appears.
  4. Give the attribute a Name. By default the system uses this name also for the aspect to create. The default type of the aspect is anchor.aspect-base. To change this click the edit button in the Value section.

    create instance

The dialog Create instance is opend. In this dialog you can define the settings of the aspect to create.

  1. Select the aspect type of your choice in the Aspect type field.
  2. Click the Save button.
  3. Click the Add button to create the attribute.

    aspect attribute created

    The created attribute will be displayed in the list of attributes. With the link button the aspect itself can be opened.

    aspect type instantiated

    The aspect is an integral part of the asset. It is not shown in the navigation area. The breadcrumb shows the current location of the opened aspect. The breadcrumb can also be used to navigate back to the owning asset. The attributes defined at the aspect type are automatically created by the system.

    picture

Adding an attribute type for aspect type

If you want to use an aspect type inside an asset type you have first to create an attribute type for the aspect type. The creation of an attribute type for an aspect types makes the handling of the aspect type easier.

  1. Navigate to the Types section and open the Attribute type editor.
  2. In the navigation area click the plus button. A screen with the title Add attribute type is opened.
  3. Specify a Name and a Namespace.
  4. As Data type select Composition.
  5. Another dropdown field appers where you need to select the aspect type.

    add composition attribute type

Instantiating an aspect type using attribute type

  1. To create an instance of the aspect type navigate to the section Manage Data.
  2. Navigate to the asset where you want to add the new aspect and open its Attributes tab.
  3. Click at the button Add aspect. The Add aspect sidebar appears.
  4. Give the attribute a Name.
  5. In the dropdown field Attribute type select the previously created attribute type.
  6. Click the Add button.

    add composition attribute

    The created attribute will be displayed in the list of attributes. The system automatically creates an aspect of the aspect type that the attribute type defines. You can use the link button to open the aspect.

    composition attribute created

Adding an aspect attribute type to asset type

picture


Except where otherwise noted, content on this site is licensed under the Siemens Inner Source License .