Asset Metadata¶
Early Access Functionality
Asset Metadata functionality is currently in an Early Access BETA state. Please contact Exosite's support for more information about getting early access to this new feature set.
Overview¶
Metadata are key-value pairs of textual information associated with an asset. They offer the ability to list information about the asset that may be helpful but that won’t change frequently or be sourced from a device. Metadata is an ideal way to store information about hardware, such as serial, model or version numbers, or service information, such as links to resources or contact information for maintenance personnel.
Metadata is stored with the asset and many pairs of metadata can be added to a single asset.
Managing an Asset's Metadata¶
Adding Metadata¶
To add a metadata pair, click the "Add Metadata" button. Enter the key, value, and type, and click "Save".
Key¶
The key is the name or category of the content. This is helpful to standardize across your application for ease in displaying in fleet views. Examples of this are "Model Number", "Maintenance Supervisor", and "Support Phone Number".
Value¶
The content, potentially unique to this asset or a set of assets. Examples of this are "RX-5000", "John Smith", and "1-800-SUPPORT".
Type¶
ExoSense currently supports the following metadata types:
| Type | Description |
|---|---|
| Text | A generic text, applicable in most cases. |
| URL | A hyperlink that will be formatted is display UI for brevity and will allow a user to click through to the provided address. |
Editing Metadata¶
To edit a metadata pair, select the 'Edit' option from the contextual menu to the right of the intended piece of metadata. From there you will be able to change the key, the value, the type, or any combination thereof. Any changes will be immediately visible anywhere the metadata is displayed in the application. Any changes to metadata are not recoverable, but you may change metadata as often as you like.
Removing Metadata¶
To remove a metadata pair, select the 'Remove' option from the contextual menu to the right of the intended piece of metadata. Removing a metadata pair is not recoverable.
Leveraging Metadata on Asset Grid¶
You can include metadata on fleet views such as the Asset Grid, just as you would a signal.
To include a metadata value, you’ll need to include it as a Metric in your asset’s Asset Type. (See more on Asset Types here)
- Edit your Asset Type, add a new metric
- Select source as metadata
- Enter in a substring that are contained in your intended key. Keep in mind that it is case-insensitive, and that the goal is to match unique criteria. For example, ‘sup’ will match values in assets in that type of both “Maintenance Supervisor” and “Support Phone #”. Additionally you may used the metadata type to narrow possible matches.
