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

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 section from the main menu and click the Asset Directory tile on the Data Platform section.
2. Select the Asset Directory from the dropdown box on the left side of the screen.

3. In the Assets group on the top ribbon, there are two options to add an Asset:

4. The Add Asset button will start the process of creating an Asset and adding it as a top-level asset to the Asset Directory;

5. The Add Child Asset button 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.

6. 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:

5. Alerts

6. Commands
7. Dashboards
8. Data
9. Events
10. Map
11. Measurements
12. Properties

13. Rules

14. Define the default last number of hours to display in Measurement Views for the data stored for this Asset.

15. Choose whether to show the Asset by default.
16. Choose whether to show the child Assets that belong to this Asset by default.
17. Choose whether to show all the descendants of the Asset by default.

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. Press the button in the middle of the tab to add the Asset Template.
2. Add as many Asset Templates as desired (press in the top right of the grid to add, and to remove, ordering the items with the and buttons) - selecting the desired Asset Template from the selection box on the right side of the dialog.
3. Press the Add button to finish adding the Asset Templates.

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

Step 3: Property Definitions#

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

Standard Property Definitions#

1. Press the button 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 (press in the top right of the grid to add an item or a group, and to remove, ordering the items with the and buttons) - 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 (press in the top right of the grid to add an item or a group, and to remove, ordering the items with the and buttons) - 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. Press the Add button to finish adding the Property Definitions.

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. Press the button in the middle of the tab to add the Event.
2. Add as many Events as desired (press in the top right of the grid to add, and to remove, ordering the items with the and buttons) - providing the required information for each item:
3. Name (mandatory)
4. Description desired
5. IoT Event Definition
6. Choose whether the Event will be validated

Step 6: Dashboards#

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

1. Press the button in the middle of the tab to add the Dashboard.
2. Add as many Dashboards as desired (press in the top right of the grid to add, and to remove, ordering the items with the and buttons) - selecting the desired UI Page to be used as Dashboard from the selection box on the right side of the dialog.
3. Press the Add button to finish adding the Dashboards.

In the end of this process, press Save on the Asset group located on the top ribbon to complete the operation.