Add Asset Template#

Asset.Create

AssetTemplate.Edit

Overview#

This operation is used to create an Asset Template.

Setup#

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

Preconditions#

• The Asset Template name must be provided and must be unique.

Sequence of Steps#

1. Navigate to the Data Platform menu and select the Asset Directory tile on the Asset Management section.
2. In the left side panel, select the Template Library tab and select to add a new Asset Template. The Asset Template 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 Template.
2. Optionally, provide a description of the Asset Template.
3. 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

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

Step 2: Property Definitions#

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

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:

Table: Default Values for different Property Definition Data Types

Telemetry Property Definitions#

1. In the same dialog you can find a different tab indicating Telemetry property definitions. 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.

       

     • Sensor

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

       

     • 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.

       

     • 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.

       

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

2. Select the Add button to complete the operation.

Step 3: Events#

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

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

Step 4: Dashboards#

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

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.

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