Skip to content

Add Asset#

🔒 Asset.Create

Overview#

This operation is used to create an Asset by adding it to an Asset Directory.

Setup#

No specific setup is required other than to meet the preconditions of the operation.

Preconditions#

  • The Asset Directory exists in the system.
  • The Asset name must be provided and must be unique.

Sequence of Steps#

  1. Navigate to the Data Platform menu and select the Asset Directory tile from the Asset Management section.
  2. Select the Assets tab on the left side of the screen.

  3. In the Assets group button on the top ribbon, there are two options that you can add:

    • The Asset option will start the process of creating an Asset and adding it as a top-level Asset to the Asset Directory.
    • The Child Asset option will start the process of creating an Asset and adding it as a Child Asset to the Asset currently selected in the Asset Directory.

    Info

    When creating a new Asset, navigation to other places within the Asset Directory is disabled.

  4. The Asset will be put in editing mode, no additional dialog will be displayed and the information to be filled will be on the right side panel.

Step 1: General Data#

When adding a new Asset, the default tab on which to input information is the General Data.

  1. Provide a name for the Asset.
  2. Optionally, provide a description of the Asset.

  3. Define a Class for this Asset. The list of possible values is taken from the AssetClass Lookup Table.

    Info

    If the Asset Directory that will hold the Asset is a Manufacturing Asset Directory, this Class will match one of the values contained in the AssetClass Lookup Table and the icon will change accordingly.

  4. Select the Default View to be used when the Asset is selected in the Asset Browser. The available options are:

    • Commands
    • Dashboards
    • Data
    • Events
    • Map
    • Measurements
    • Properties
    • Rules

  5. Define the Default Last Number of Hours to display in Measurement Settings for the data stored for this Asset.

  6. Choose whether to show the Asset by default.
  7. Choose whether to show the child Assets that belong to this Asset by default.
  8. Choose whether to show all the descendants of the Asset by default.

Note

Show Children By Default and Show Descendants By Default are mutually exclusive and cannot be simultaneously selected.

Screenshot showing a UI with fields for entering general data about an asset, including GERERSLDATA and PROPERTY SETTINGS.

After this information has been filled, the other tabs extend the possibilities to add further information to the Asset.

Step 2: Templates#

In this section, you can add Asset Templates to be used in this Asset.

  1. Select in the middle of the tab to add the Asset Template.
  2. Add as many Asset Templates as desired (select to add, and to remove, order the items with the and arrows) - selecting the desired Asset Template from the selection box on the right side of the dialog.
  3. Select the Add button to complete the operation.

After adding the desired Asset Templates, you can move to the next tab to add Property Definitions.

Screenshot showing a list of available Asset Templates with options to select and add them.

Note

Adding an Asset Template will also add all the Property Definitions of the Asset Template to the current Asset. You can identify these Property Definitions with a visual notation on the editor since they can only be edited in the Asset Template and not in the Asset that inherits them. Nevertheless, you can always add new Property Definitions to the Asset as you will be able to see in the next steps.

Screenshot showing a list of added Asset Property Definitions from a template.

Step 3: Property Definitions#

In this section, you can add Property Definitions to be used in this Asset.

Standard Property Definitions#

  1. Select in the middle of the tab to add the Property Definition.

  2. Starting in the Standard tab, add as many Standard Property Definitions as desired (select to add an item or a group, and to remove, order the items with the and arrows) - providing for each item the following information:

    • Name (mandatory)
    • Display Name - the name to be shown when the property is used
    • Description - a short description of the Property Definition
    • Data Type (mandatory) - can be one of the following reserved data types:
      • Boolean
      • Date
      • Datetime
      • Decimal
      • Geopoint
      • Integer
      • Long
      • String
      • Time
      • Url
    • Depending on the Data Type selected above, several other options are displayed. A short table to summarize the default values needed for each Property Definition is displayed below:
Boolean Date Datetime Decimal Geopoint Integer Long String Time Url
Default Value x x x x x x x x x x
Units x x x
Display Units x x x
Minimum Value x x x
Maximum Value x x x
Decimal Places x x x

Table: Default Values for different Property Definition Data Types

Screenshot showing a table of Standard Property Definitions.

Telemetry Property Definitions#

  1. In the same dialog you can find a different tab indicating Telemetry. Add as many Telemetry Property Definitions as desired (select to add an item or a group, and to remove, order the items with the and arrows) - providing for each item the following information:

    • Name (mandatory)
    • Display Name - the name to be shown when the property is used
    • Description - a short description of the Property Definition

    • Telemetry Type (mandatory) - can be one of the following types:

      • Location

        • Choose whether to enable a link to the Asset Location:

        Info

        Data Type will be set to Geopoint.

        Diagram showing a table with telemetry property definitions, including an asset property definition for location.

      • Sensor

        • Choose the color to visualize the Property Definition by selecting it from the color palette:

        Screenshot showing a color palette with options for visualizing Telemetry Property Definitions.

      • Setting

        • Choose the Write Access (Asset or Asset And User)
        • Data Type (mandatory) - can be one of the following reserved data types:
          • Boolean
          • Date
          • Datetime
          • Decimal
          • Geopoint
          • Integer
          • Long
          • String
          • Time
          • Url

        Info

        The same Data Type field settings described above in the Standard Property Definition apply to this section.

        Screenshot showing a UI with "Telemetry Property Definitions" heading, displaying settings for "Access", "Asset", and "Filename hint".

      • State

        • Choose any number of States to represent the Property Definition. Also choose the color to visualize each State of the Property Definition by selecting it from the color palette.
        • Choose whether Is Asset Main State is true, which allows the events to have SEMI E10 attributes.

        Info

        There can only be one Property Definition with the Is Asset Main State property set to true.

        Screenshot showing a list of telemetry property definitions, including "Telemetry Type" and a filename hint for adding asset property definitions.

    • Depending on the Telemetry Type selected above, several other options are displayed.

  2. Select the Add button to complete the operation.

Info

These Property Definitions will be displayed in the Properties tab.

Screenshot showing a list of Telemetry Property Definitions with an "Add" button selected.

Step 4: Properties#

In this section, you can set values for the available Properties defined in the previous step.

Step 5: Events#

In this section, you can add Events to be used in this Asset.

  1. Select in the middle of the tab to add the Event.
  2. Add as many Events as desired (select to add, and to remove, order the items with the and arrows) - providing the required information for each item:
    • Name (mandatory)
    • Description desired
    • IoT Event Definition
    • Choose whether the Event will be validated

Screenshot showing the "Add Asset Events" page with details on event validation and data reception.

Step 6: Dashboards#

In this section, you can add Dashboards to be used in this Asset.

  1. Select in the middle of the tab to add the Dashboard.
  2. Add as many Dashboards as desired (select to add, and to remove, order the items with the and arrows) - selecting the desired UI Page to be used as Dashboard from the selection box on the right side of the dialog.
  3. Select the Add button to complete the operation.

Screenshot showing a dashboard selection interface with an "Add Asset Dashboards" option.

Warning

For a Dashboard to be selected for an Asset, a specific property must be added to the UI Page that will serve as a dashboard. This property must be named AssetId and the type must be set to UrlParameter, as can be seen in the example below:

Screenshot showing a UI page with a property named "AssetI... Proper" added to it.

Note

If at any time during the process you want to cancel the operation without saving any changes, select the Cancel button on the top ribbon and all changes will be discarded.

Screenshot showing a dashboard with an "Asset Directory" section.

At the end of this process, select Save on the Assets group located on the top ribbon to complete the operation:

Screenshot showing a dashboard with an "Asset Directory" label.