The tag builder features enable you to create new tags which will be saved on the TrendMiner server. Each created tag can be used as any other historian tag inside the TrendMiner environment.
Tag builder types
There are five types of tags available:
- Formula: To create new tags based on simple mathematics and functions using existing tags.
- Aggregation: To create moving window functions over individual tags based on certain operators. Using aggregation tags you can get the minimum or maximum value for a tag in the specified time window or average out the signal over a time window to smooth out noisy data.
- Prediction: To generate a new tag based on a multi-variable linear regression analysis. Ideal feature to create a soft sensor by combining different influencing tags.
- Machine Learning Model: To create a tag based on a PMML (Predictive Model Markup Language) model. This functionality is only available when activated in your TrendMiner license and when permissions are granted by your administrator.
- Data import: To import external data as a TrendMiner tag. Now only csv-files are supported for loading in data, using standard coding UTF-8.
Each of these types can be (de)selected separately via the tag browser filter to be included/excluded when searching for tags.
Tag Builder Workflow
Opening the Tag Builder Menu will show you all available options as listed in the previous section. From here you can choose with which tag type to proceed with for further actions.
Creating new tag
- Open the Tag Builder Menu.
- Click on the "+ Create new"-button for your tag builder type of choice. A new submenu will be shown based on the selected tag type.
- Fill out the required fields. More information about the specific fields can be found on the respective page of each tag type as linked in the previous section.
- Click the "save"-button. A new side-panel appears on the right side of your screen.
- In the "tag details"-section you need to fill out:
- Name: The name of the tag you want to create. The tag you created will be searchable with this name.
Note: Rules of limitations are applied so consider your tag name before committing the save, see below. - Description: The description of your tag.
- Location: The folder of your Work Organizer where you want to save the tag.
- Name: The name of the tag you want to create. The tag you created will be searchable with this name.
- The "tag properties overview"-sections shows a summary of how the calculated tag is set up.
- In the "tag details"-section you need to fill out:
- Click on the "save Formula/Aggregation/..."-button in the side-panel. The created tags will be added to your screen automatically and a summary (tag definitions) will be shown in the tag builder menu.
Loading tags on the chart
Any created tag can be added to your screen via the tag browser as with any other tag in TrendMiner.
Owners of a created tag also have the new tag available via the work organizer. This allows the owner to see the tag definitions, edit or copy the tag.
The tag definitions contain more detail on how the created tag has been setup such as the formula/operators used to create the output of that tag.
Other TrendMiner users will be able to consult the tag definitions once the tag is shared with them via the work organizer (see "showing tag details below").
Sharing tags
Unlike other saved items in TrendMiner, created tags are always automatically shared with all other users. Created tags are searchable and accessible via the tag browser to all other users within TrendMiner.
Note: Users can only access these tags under the condition that they have permission to the underlying (historian) tags used inside the created tag.
When sharing a tag with other users via the Work Organizer, you are not actually sharing the saved tag, but the tag definition (see "Loading tags"-section above). The added benefit of sharing tags via the work organizer is that other users will be able to consult the tag definitions and use the "save as" option to create a copy of the tag. The tag definitions are not available by accessing the tags via the tag browser.
Showing tag details
If you are the owner of a created tag you can:
- Open the Tag Builder Menu.
- Click on the "Saved Formula/Aggregation/..."-button.
- Select your desired tag from the side-panel, showing the work organizer, that appears on the right side of your screen.
- Click the "Open"-button.
- A summary of the tag details (= tag definitions) will be shown in the menu on the left including options to:
- Edit your tag.
- Save your tag. This will allow you to create a copy or rename your tag.
- Add/Remove your tag from the current view.
Alternatively, you can open the Work Organizer and select any of your saved tags instead. This option can also be used by other users when the tag definition is shared with another user.
Note: This option is only available for owners of the tag or users with whom the created tag is shared with.
Editing tags
If you are the owner of a tag, you can edit the tag as follows:
- Follow the steps from the "Showing tag details" section.
- Choose the "Edit tag" option.
- Make the desired changes.
- Click the "save"-button. A side-panel appears where you have the option to:
- Overwrite the original tag.
- Save the changes as a new tag.
Copying or Renaming Tags
- Follow the steps from the "Showing tag details"-section.
- Choose the "Save tag" option. A side-panel appears where you have the option to:
- Overwrite the original tag.
- Save the changes as a new tag.
Deleting Tags
- Open the Work Organizer.
- Search for the saved item you want to delete.
- Select the checkbox of the items you want to delete.
- Click "Actions" --> "Delete item(s)" at the top of the page.
Note: Please read the limitations on naming and deleting tags carefully at the bottom of this page before proceeding.
Accessibility and Permission
You can only access these tags under the condition that you have permission to the underlying (historian) tags used inside the created tag.
Limitations when combining different (calculated) tags
TrendMiner supports two-levels deep of inputs when creating tags. This means that any created tag that does not use any underlying calculated tag can be used as input. More levels of "nesting" are not supported. This level of nesting is conceptually shown in the image below. Formula A is allowed. Formula B is not possible, since you reach the maximum level of "nesting".
Naming and deleting tags
Deleting calculations tags will only soft delete them. Soft deleted tags will not be available anymore to users, but the tag name is still reserved and cannot be re-used.
Only owners of the created tag can delete the tag.
Editing tag names
Changing the tag name will break existing searches where that tag is being used, as the searches will still be mapped to the old name. This issue will be fixed in the future.
Only owners of the created tag can edit the tag.