Manage item tags
Assign system and custom tags to Edge Portal items, manage the tag catalogue, and resolve common tag errors.
Use item tags to identify the information represented by an item or to group related items. Tags appear as badges in the Items table and in the selected item's details.
You can assign built-in system tags or create custom tags. System tags describe device identity information such as the vendor, model, serial number, or firmware version. Custom tags can represent application-specific groups, functions, or classifications.
Before you begin
Create or open an instance that contains the item you want to tag. Tags are managed from the full item form or the selected item details. They are not available in Setup view.
Understand system and custom tags
| Tag type | Purpose | Assignment rules |
|---|---|---|
| System | Identifies a standard device property represented by the item's value. | An item can have one system tag. The same system tag can only be assigned to one item in an instance. |
| Custom | Groups or classifies items using terminology that is relevant to your application. | An item can have multiple custom tags. Custom tags can be reused on other items. |
System tags are built into the Edge Portal and cannot be renamed or deleted.
| System tag | Use it for |
|---|---|
| Vendor | The manufacturer of the asset. |
| Model | The product type or model designation. |
| Serial | A unique identifier such as a serial, batch, or type number. |
| Firmware | The firmware or software version installed on the device. |
| Hardware revision | The hardware revision of the model. |
| Product code | An order number, MLFB, or catalogue number used to identify the product. |
| Application version | The version of the application running on the device. |
Open the item tags
- Expand Instances in the sidebar.
- Open the instance that contains the item.
- Go to the Items section.
- Create a new item, open an existing item, or select an item in the table.
- Find Tags and select the add-tags button.
The Item tags dialog lists the available system and custom tags. Use Search tags or create a custom tag to filter the list.
Assign tags to an item
- Open the Item tags dialog.
- Search for the required tag or browse the System and Custom groups.
- Select each tag you want to assign. A check mark identifies a selected tag.
- Select Save tags.
The assigned tags appear as badges beside the item. Point to a badge to view its description.
When tagging a new item, select Save tags to return to the item form, then save the item. Tags assigned to an existing item are saved when you select Save tags.
If a system tag is already assigned to another item, the tag displays Used by [item name] and cannot be selected. Remove it from the other item before assigning it again.
Selecting another system tag replaces the system tag currently selected for that item. Custom tags are not removed.
Create a custom tag
- Open the Item tags dialog.
- Enter the new tag name in Search tags or create a custom tag.
- Select Create “[tag name]”.
- Select Save tags.
A custom tag name must contain 1 to 64 characters and begin with a letter or number. It can contain letters, numbers, spaces, periods, underscores, and hyphens.
A custom tag cannot use the name of an existing system or custom tag.
Edit a custom tag
- Open the Item tags dialog.
- Find the custom tag.
- Select its edit button. You can also double-click the tag.
- Change the tag name or description.
- Select Save.
The Edge Portal displays Tag updated everywhere. The new name and description are applied wherever the custom tag is used.
Remove a tag from one item
- Open the Item tags dialog.
- Find the assigned tag below the tag list.
- Select the remove button on the tag badge.
- Select Save tags.
The tag is removed from the current item. A custom tag remains available in the catalogue and can still be used by other items.
Delete a custom tag
Deleting a custom tag removes it from every item on the device. To remove it from only the current item, use the remove button on the assigned tag badge instead.
- Open the Item tags dialog.
- Find the custom tag.
- Select its delete button.
- Select Delete from all items.
The Edge Portal displays Tag deleted from all items. System tags cannot be deleted.
Troubleshoot item tags
| Message or behavior | What to do |
|---|---|
| No matching tags. | Clear or change the search. If the name is valid and is not already used, select the option to create a custom tag. |
| A system tag displays Used by [item name] | Open the named item, remove the system tag, and save the change. You can then assign the tag to another item. |
| Tag names cannot be empty. | Enter a name before saving the custom tag. |
| Custom tags may be 1-64 characters and use letters, numbers, spaces, dots, underscores, or hyphens. | Correct the tag name. Make sure its first character is a letter or number. |
| Failed to load reserved tags., Failed to load tags., or Failed to load item tags. | Refresh the item and try again. If the problem continues, verify that the gateway is available and review the system logs. |
| Failed to save item tags. | Keep the item open, refresh the tag list if necessary, and try saving the selection again. |
| Failed to update tag. | Confirm that the new name is valid and is not already used, then try again. |
| Failed to delete tag. | Refresh the tag list and try again. Review the system logs if the error continues. |