Asset Templates

Written By Nathan Kirby (Collaborator)

Updated at July 12th, 2023

Overview

Asset Templates provide a powerful solution for efficiently creating or updating assets with a known configuration in order to minimise integration configuration issues.  First create an Asset Template, based on a known correct and working Asset configuration, in order to capture a blueprint of the essential elements that should be replicated when creating or updating Assets.  The Asset Template can then be applied to an Asset to ensure that the Integrations and IP Devices of the Asset are configured correctly.

Creating an Asset Template

Asset Templates can be easily created from an existing Asset configuration.  These Asset Templates will then be made available for selection when creating or updating other Assets. 

To create an Asset Template you first need to create or locate an existing Asset that has the desired configuration (including IP Devices and enabled Integrations).  Once you have correctly configured and tested an existing Asset, you can create an Asset Template by using the ‘Click To Create’ button in the Asset Template drop down from within the Asset editor.

Once an Asset Template has been created the template configuration cannot be changed and will become readonly (apart from the Template Name and Description).  Should a different Asset Template configuration be required, simply create it from an existing tested / known-working Asset with the desired configuration.

Asset Template Drop Down - Click to Create
Asset Template Drop Down - Click to Create
 

The Create Asset Template editor will open and be pre-populated with the configuration from the selected Asset.  Enter a Name and Description to describe the Asset Template and confirm the configuration details of the Asset, Integrations and IP Devices are correct and make any adjustments as necessary.  Click the ‘Create and Close’ button to complete the creation of the Asset Template.

Create Asset Template - General Tab

General Tab

Basic Asset properties set for the Asset Template.

Template

The Template section contains the following details that are used to identify and describe the Asset Template:

  • Name - A unique Name for the Asset Template
  • Description - A short Description outlining what this Asset Template should be used for.

Asset Details

The Asset section contains the following values that will be populated when this Asset Template is applied to a new or existing Asset:

  • Type - The Asset Type of the Asset
  • Height - The Height of the Asset or the Asset Type's default height, if empty
  • Tags - A list of Tags that will be added to the Asset
  • Description - The default description for the Asset
Create Asset Template - Integrations Tab

Integrations Tab

A summary of Integrations that will be monitored for Assets using the Asset Template

IP Device Integrations 

The IP Devices Integrations section will list all the integrations that will be automatically enabled on the child IP Devices when this Asset Template is applied.

Asset Integrations

The Asset Integrations section will list all the integrations that will be automatically enabled on the Asset when this Asset Template is applied.

Note: If the Integration has the ‘Always Poll’ option available, you can configure the default state here for when the Asset Template is applied.

Create Asset Template - IP Devices Tab

IP Devices Tab

The IP Devices that will be monitored on the Asset using the Asset Template.

Displays a list of all of the IP Devices to be added to the Asset when the Asset Template is applied. Initially the list will be collapsed, click on an IP Device to show the details.  

For each IP Device the following values will be populated from the Asset Template:

  • Name - The default Name for the device. 
  • Type - The Device Type of the IP Device.
  • Description - The default description for the IP Device.
  • Tags - A list of Tags that will be added to the IP Device.
  • Integrations - The Integrations that will be automatically enabled for the IP Device. 

Note: If the Integration has the ‘Always Poll’ option available, you can configure the default state here for when the Asset Template is applied.


 Applying an Asset Template

Asset Templates can be applied when creating a new Asset or to any existing Asset.  When an Asset Template is applied, the configuration from the Asset Template will be applied to the Asset including the child IP Devices and their enabled Integrations.

New Asset

To apply an Asset Template when creating a new Asset, start by adding a new asset as normal (i.e. by clicking the ‘New Asset’ button in the Manage Tab, or from creating a new asset from within the map view). 

Apply Template - Select Asset Template

On the new Asset form

  • Enter a name for your Asset
  • Open the Asset Template drop down and select the Asset Template you want to use to create the new Asset from.

The following values will be pre-populated from the selected Asset Template:

  • Type
  • Height
  • Tags
  • Description

Click ‘Create’ to save the new Asset.

Apply Template - IP Devices (Incomplete)
Navigate to the IP Devices tab to complete the creation of all the IP Devices that have been configured on the selected Asset Template.  The IP Devices that will need to be added will be displayed in red with an add icon.  Click through each one of the devices listed to add the device from the Asset Template.
Apply Template - IP Device - General Details
Complete filling in the remaining details for the IP Device (i.e. add a unique IP Address or MAC for the device). Then click ‘Create’ to complete adding the device.
Apply Template - IP Device - Integrations

Navigate to the Integrations tab for the newly created IP Device and confirm the default Integrations have been automatically enabled from the Asset Template (there may be a slight delay while these load).

The Recommended section will list all of the Integrations that have been configured for this device based on the selected Asset Template.

The Other section will list all other integrations available in IMS that have not been recommended or enabled on the selected Asset Template.

Apply Template - IP Devices (Completed)
Repeat the creation for all the other IP Devices from the Asset Template.  Once all the IP Devices have been added, the IP Devices list for the Asset should look like this without any red highlighting.
Apply Template - Asset Integrations
Navigate to the Integrations tab of the Asset.  Notice that the required Asset Integrations have been automatically enabled based on the Asset Template.

Existing Asset

Applying an Asset Template to an existing Asset is a similar process to applying for a new Asset with the following variations

Apply Template - Existing Asset - Confirmation

A confirmation prompt will be displayed when applying or changing an Asset Template for an existing Asset.  Click ‘Confirm’ to continue with applying the Asset Template.

 

Note: Changes will be applied after confirming this prompt, regardless of if the "Save button is used later.

Apply Template - Existing Asset - General Details

The following values will be updated with the details from the applied Asset Template:

  • Type - This will be updated (if different to the template) and made read only
  • Height - This will be updated (if different to the template)
  • Tags - Any tags from the Asset Template that do not currently exist will be added.
  • Description - The description from the Asset Template will be appended to the existing description (only if the existing description does not contain the description from the template).
Apply Template - Existing Asset - IP Devices

If there are any existing IP Devices on the Asset that match one on the Asset Template (i.e. same Type), they will be updated with the device details (i.e. tags, description) and integrations as configured on the Asset template. 

Any IP Devices from the Asset Template that do not match one on the existing Asset will still need to be added.

If there are any existing IP Devices on the Asset that do not match any on the selected Asset Template then these will be listed as an Additional Device as they are not recommended from the template.  It is advised you review any Additional Devices and remove any that are no longer required.

Note: If there are multiple matching IP Devices of the same type on the Asset and Template, it will also compare the device name, tags, description and integrations for similar words to find the closest match.  

 

Managing Asset Templates

Asset Templates can be managed from within the Manage Tab in IMS from either the List Overview or Asset Template Table views. 

Manage - List Overview - All Asset Templates
Manage - Asset Template Table
View Asset Template

To view the configuration of an existing Asset Template you can click on the Asset Template from one of the Manage views above to open the selected Asset Template.  

  • The Template Name and Description can be updated here if required.
  • The Asset Height can be updated here if required.
  • All other fields will be read only and cannot be changed once an Asset Template is created. 

Note: Should a different Asset Template configuration be required, simply create it from an existing tested/known-working Asset that has the desired configuration.

The Assets tab will list all of the Assets that currently have the Asset Template applied.
Any Asset Templates that are no longer in use can be deleted from the All Asset Templates list by clicking on the Delete icon.  Only Asset Templates that are not currently being applied to any Assets will have the Delete icon enabled.