Configuring Menus and Groups
The navigation menus for ThingWorx Asset Management main search page and asset details page are organized in groups of menu items and arranged using a sort order and allow for custom menu groups and items to be added.
To add new menu groups or items, a helper thing must be created that implements the PTC.Asset.MenuExpansions thing shape. The PTC.Asset.MenuExpansion thing shape contains four services that can be overridden to return one or more menu groups or menu items for the main asset search page or the asset details menu:
|
Service
|
Description
|
|
GetAssetDashboardMenuGroups
|
Returns a data shape containing a list of custom menu groups and their associated sort orders for the asset details menu.
|
|
GetAssetDashboardMenuItems
|
Returns a data shape containing a list of custom menu items and their associated menu groups for the asset details menu.
|
|
GetAssetSearchMenuGroups
|
Returns a data shape containing a list of custom menu groups and their associated sort orders for the main asset search menu.
|
|
GetAssetSearchMenuItems
|
Returns a data shape containing a list of custom menu items and their associated menu groups for the main asset search menu.
|
Group names in the ThingWorx Asset Management are localization tokens within ThingWorx. Use the following information to configure the groups and menus within ThingWorx Asset Management.
|
Asset Search Menu
|
|
Group
|
Sort Order
|
|
[[PTC.Asset.Current]]
|
10
|
|
[[PTC.Asset.Searches]]
|
20
|
|
[[PTC.Asset.Collaboration]]
|
30
|
|
[[PTC.Asset.Admin]]
|
1000
|
|
[[TW.RSM.Compliance]]
|
|
This group is only available if ThingWorx Remote Access and Control is installed.
|
|
25
|
|
Asset Details and Dashboard Menu
|
|
Group
|
Sort Order
|
|
[[PTC.Asset.Current]]
|
10
|
|
[[PTC.Asset.Historical]]
|
20
|
|
[[PTC.Asset.Collaboration]]
|
30
|
|
[[TW.RSM.RemoteAcess]]
|
|
This group is only available if ThingWorx Remote Access and Control is installed.
|
|
1
|
To pick up extension menu items, a helper thing must implement the PTC.Asset.MenuExpansions thing shape. Some services from the PTC.Asset.MenuExpansions thing shape can be overridden
The following should be considered when configuring menus and groups:
• For the Asset Search and Asset Details menus, there is a core service that looks for things implementing the PTC.Asset.MenuExpansions thing shape. First, the menu groups service is used to help pre-define the groups and order, and then the menu items service.
• New groups can be defined using the menu items service but will display at the bottom of the menu.
• The groups are gathered and then sorted by sortOrder and then by group (name). However, keep in mind that a group can be a localized token. For example, if two items have the same sortOrder, they may not be appear in alphabetical order when translated.
• The Asset Details menu will display the mashups in embedded mashup (right area), however in order to retain the navigation for asset search sections the extension mashup should be assigned the PTC.Asset.Master.RemoteService.AssetSearch master.
Example
You can find an example of a custom Asset Search and Asset Details menu items in the demo data bundled with ThingWorx Utilities. The PTC.Demo.AssetManagerMRIMenuHelper thing was created to create a custom menu group (MRI Machines) and menu item (MRI DASHBOARD) for the Asset Search menu. It also adds a custom menu item (HELIUM LEVEL) to the Asset Details menu, but instead of adding it to a custom menu group, it adds it to one of the existing menu groups (Current).
The PTC.DemoAssetManager.MRIMenuHelper thing implements the PTC.AssetMenuExpansions thing shape.
The PTC.DemoAssetManager.MRIMenuHelper overrides three of the four services to create a custom menu group and menu item in the Asset Search menu and adds a custom menu item to the existing Current menu group in the Asset Details.
