--- alias: user-guide-add-asset-template tags: - data platform description: "Create asset templates with configurable data, properties, and events for asset management" --- # Add Asset Template :lock: Asset.**Create** :lock: 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 :material-plus: 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 !["Screenshot showing an asset template general data input form."](images/add_asset_template_general_data.png) 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 :material-plus: in the middle of the tab to add the **Property Definition**. 1. Starting in the Standard tab, add as many Standard **Property Definitions** as desired (select :material-plus: to add an item or a group, and :material-trash-can: to remove, order the items with the :material-arrow-up: and :material-arrow-down: 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.](images/add_asset_property_definitions_standard.png) ### 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 :material-plus: to add an item or a group, and :material-trash-can: to remove, order the items with the :material-arrow-up: and :material-arrow-down: 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.](images/add_asset_property_definitions_telemetry_location.png) * 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.](images/add_asset_property_definitions_telemetry_sensor.png) * 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".](images/add_asset_property_definitions_telemetry_setting.png) * 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.](images/add_asset_property_definitions_telemetry_state.png) * 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.](images/add_asset_property_definitions_telemetry.png) ## Step 3: Events In this section, you can add **Events** to be used in this **Asset Template**. 1. Select :material-plus: in the middle of the tab to add the **Event**. 2. Add as many **Events** as desired (select :material-plus: to add, and :material-trash-can: to remove, order the items with the :material-arrow-up: and :material-arrow-down: arrows) - providing the required information for each item: * Name (mandatory) * Description desired * **IoT Event Definition** * Choose whether the Event will be validated ![Screenshot showing an interface for adding asset events, with options to validate and details about event handling.](images/add_asset_events.png) ## Step 4: Dashboards In this section, you can add **Dashboards** to be used in this **Asset Template**. 1. Select :material-plus: in the middle of the tab to add the **Dashboard**. 2. Add as many **Dashboards** as desired (select :material-plus: to add, and :material-trash-can: to remove, order the items with the :material-arrow-up: and :material-arrow-down: 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 "Add Asset Dashboards" and "6 Dashboard Derails" listed.](images/add_asset_dashboard.png) !!! 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 an input field for adding a specific property to enable an Asset to be selected as a Dashboard.](images/add_asset_dashboard_uipage_property.png) !!! 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.](images/add_asset_main_cancel.png) At the end of this process, select **Save** on the **Asset** group located on the top ribbon to complete the operation: ![Screenshot showing a dashboard with an "Asset Directory" and filename input fields.](images/add_asset_main_save.png)