Asset Types Management

An asset type is a reusable set of metadata used to classify assets into categories based on their structure and intended use. Each container or asset within the asset database is an instance of an asset type. Asset types define a specific set of properties that an asset can contain, such as host name, port number, or tags. They also outline the purpose and characteristics of the asset, specifying whether it is a container, a network device, a Unix host, a Windows host, a switch or another object.

Asset Types define which protocol is to be used by the software to communicate with a host like SSH, WinRM or another. Task lists are assigned to an Asset Type and define the available list of Scripts that can be executed against the asset managed by this type.

Note

An asset type in a Space is inherited from its parent Tenant (displayed with an italic font) and therefore cannot be edited nor deleted directly from this Space. To edit a Space inherited asset type, you must navigate up to the tenant and make all necessary modifications in this location which then, through inheritance, will be reflected in all child Spaces. Space inherited asset types can only be hidden, directly from the Space.

Creating new Asset Types

To create a new Asset Type:

Log in to the Space with an Administrator or Asset Type Manager account.
Navigate to Management > Asset Types and click the Add button.
Click on the parameter name for details about each or follow the guidance provided here:
1. Name: Enter a unique, but recognizable name that will be used to refer to this asset type.
2. Description: Optionally, enter a description to add additional comments or details about this asset type.
3. Parent Asset Type: Asset types can extend other asset types by specifying a parent asset type from which they inherit properties. This parent-child relationship allows for creating an inheritance hierarchy of asset types where the hierarchy includes multiple levels of parent and child asset types. Child asset types inherit all fields defined in the parent asset type. While inherited fields cannot be edited directly in the child asset type, they can be reordered or hidden to accommodate specific asset behaviors as needed.
4. Container: Container asset types represent containers that could contain other assets and sub-containers. Select Asset for a type that will be used for endpoints or select Containers for a type that will be used to create containers (folders) used to organize assets in the Asset Database.
Click the Save button to complete this operation.

Creating Asset Type Fields

After a new Asset Type is created, whether it has a Parent Asset Type or not, you can then add new Fields to this type. An asset type Field defines a specific set of properties that an asset can contain, such as host name, port number, or tags. Creating fields in the asset type allows for additional information to be contained with each Asset in the database.

To create a new asset type Field:

Log in to the Space with an Administrator or Asset Type Manager account.
Navigate to Management > Asset Types, locate the Asset Type where the new field will be created and click use the Actions > Edit option followed by the Add Field button or choose the Actions > Add Field option directly. Note that a new field cannot be added to an inherited Asset Type, show in italic font, from a sub-Space; you must navigate up to the Tenant and add the new field in this space.
From the Add Asset Type Field page, populate the form as required clicking on the parameter name for details about each or follow the guidance provided here:
1. Name: Enter a unique, but recognizable name for this field.
2. Description: Optionally, enter a description to add additional comments or details about this asset type field.
3. Type: Select the appropriate field type:
  - Address: An IP address or IP address range.
  - Checkbox: Enable/On or Disable/Off switch.
  - Choice: A value to choose from a list of possible values.
  - Date: A date value.
  - File: A binary value from the file uploaded to this field.
  - Number: A number value.
  - String: A single line string value.
  - Taxonomy: A value to choose from the hierarchical taxonomy.
  - Text: A multi-line string value.
4. Hidden: An indicator whether this field is hidden in the asset type.
5. Secured: An indicator whether the field is secured. The software stores secured fields encrypted in the asset database. As a result, the software does not allow search to use secured fields values. The software also does not send the values of a secured fields from the asset database to the software's WEB Portal GUI or other REST API clients, unless the secured field's value is specifically requested.
6. Required: An indicator whether the field is required for the asset of this asset type.
7. Multivalued: An indicator whether the field allows multiple values to be stored in this single field. A Plus (+) indicator will appear on the inside, right side of this field. Enter a value, click this Plus (+) indicator, enter another value and repeat for each value to properly populate a multivalued field.
8. Helper: Is text that the software's WEB Portal GUI uses to help explain to users how to properly populate the field. The software might use this helper to display as an input field placeholder or to describe the field entry on the asset edit form.
9. Default Value: A default value is used in the situations when the value for the field is not defined by the user and to suggest an initial value when creating the new asset from this type. For Date fields, the possible values for the default value are the following:
  - Empty: use an empty value for a date
  - Today: use today's date as a default value for a date
  - Fixed: use a specific value for a date defined in the asset type field specification.
Click the Save button to complete the operation.

As required, repeat this process to create additional fields for this asset type. When complete, you can use the Asset Type Fields list at the bottom of the Edit Asset Type page to review all the available fields and to Edit, Hide or Delete any non-inherited fields. Inherited fields are shown in italic font and can only be hidden.

Managing Asset Types and Fields

There are several options available to manage existing Assets Types which includes Edit, Hide, Add Field, Tasks, Export and Delete. An Administrator or Asset Type Manager of a Space can choose to perform these actions on an Asset Type as described below:

Edit: using the edit option on an Asset Type allows for the type's parameter to be updated, fields to be created or updated, or the icon visible in the Asset Database can be changed.
Hide: this option will hide this asset type from the Add menu in the Asset Type.
Add Field: this will provide the ability to create a new field.
Tasks: this option will open the asset type's Tasks list where you can make changes to the available tasks including add, edit, or delete.
Export: using this option will export the asset type to a XXX file that can be later used as for import.
Delete: this will delete the asset type. Note that an Asset Type cannot be deleted if there is an existing asset using this type. You must delete the Asset(s) first, then you can delete the Asset Type.

Tip

It is also possible to perform some actions in bulk, applying it against multiple selected Asset Types using the Actions menu at the top of the Asset Types list. These bulk actions include Hide, Un-Hide, Export and Delete actions.

Managing existing Fields can only be done from the Edit Asset Type page. Begin by using the Asset Type's Edit option and then scroll down to the bottom of the page. In the Asset Type Fields list, locate the field to be managed and use its Actions menu to:

Edit: this option will open the Edit Asset Type Field page where field parameters can be updated.
Hide: this option will hide this field from the Asset Type. A required field that is hidden, will no longer be required.
Unhide: this option will unhide this hidden field from the Asset Type.
Delete: this option will delete the field.

After a field edit is complete, click the Save button.

Tip

To re-order asset type fields, navigate to the Edit Asset Type page, click on a field row and simply drag it up or down to place it in a new position.