Menus node

The Menus node is a child of the Controls node in the Mobile configuration. It defines the menus that will be available to different users in the mobile app. This node can have one or more Category nodes, one or more Menu nodes, and one or more Groupings node as children.

You can use Category nodes to organize your menus. A Category node can have one or more Menu nodes, one or more Groupings nodes, and one or more other Category nodes as children. Each Category node can have these attributes:

Attribute Description
Description Description of the category.
Id Identifier for the category.

Menu

Menu nodes can be children of the root Menus node, or of Category nodes. Each Menu node can have these attributes:

Attribute Description
Description Description of the menu.
ID Identifier for the menu.
RenderWithQuery If set to True, the menu will automatically load its default query when it opens.

GroupReference

Each Menu node has one or more GroupReference nodes as children. Each GroupReference node specifies a grouping that is displayed on the menu. The Id attribute of the GroupReference node identifies a grouping defined under the Groupings node. A GroupReference node can have these attributes:

Attribute Description
AccessItem List of permissions in Access Control that control access to this group reference. Enter one or more access IDs in a comma-separated list.
Icon Icon that is displayed next to the group reference in the mobile app. You can use this to override the icon defined on the Grouping node.
Id ID of the grouping. The value must match the ID of a grouping defined under a Groupings node.
DisplayName Display name of the group reference. This is the name that is displayed in the menu. You can use this to override the display name defined on the Grouping node.

Groupings

Each Groupings node has one or more Grouping nodes as children. Each Grouping node defines a list of menu items that will be available when the user selects the grouping. You use GroupReference nodes to add groupings to specific menus.

Attribute Description
AccessItem List of permissions in Access Control that control access to this grouping. Enter one or more access IDs in a comma-separated list.
DisplayName Display name of the grouping. This is the name that is displayed in the menu.
Icon Icon that is displayed next to the grouping in the mobile app.
Id Unique identifier for the grouping.
Profiles Profiles that will have access to this grouping. You can enter multiple profile IDs in a comma-separated list.
RenderWithQuery If set to True, the grouping will automatically load its default query when the user selects it.
SearchAction Action to complete when the user searches after selecting this grouping.
SearchHintText Default text that is displayed in the search field when a user selects this grouping. The search field is displayed at the top of the mobile app.

Item

Each Grouping node has one or more Item nodes as children. Each item represents a query defined under the Queries node. An Item node can have these attributes:

Attribute Description
AccessItem List of permissions in Access Control that control access to this item. Enter one or more access IDs in a comma-separated list.
Default Indicates whether this is the initial default query for the grouping.
Description Description of the menu item.
DisplayAction Action to perform when the user shows this query.
DisplayMode Display mode for the menu item. You can enter one of these values:
  • Always: The item is always displayed. Always is the default.
  • Connected: The item is displayed only if the work mode in the mobile app is set to Connected.
  • Disconnected: The item is displayed only if the work mode in the mobile app is set to Disconnected.
  • Never: The item is never displayed.
If a menu item is not displayed, the query that is associated with it will still be executed. The purpose is to download data to the mobile device so that the app can operate without an Internet connection.
DisplayName Display name for the menu item. This is the name that is displayed in the mobile app.
Id Unique identifier for the item.
OtherCategory Indicates whether this menu item should be grouped in the Other category.
Profiles Profiles that will have access to this menu item. You can enter multiple profile IDs in a comma-separated list.
QueryId ID of the query to show when the menu item is selected. The value must match the ID of a query defined under the Queries node.
ResultCode Code indicating that a result has been entered for an inspection. The only value that is currently supported is IsResulted. The mobile app uses this value to mark resulted inspections in the query results.
SearchAction Action to complete when the user searches after selecting this menu item.
SearchHintText Default text that is displayed in the search field when a user selects this item.
SelectAction Action to perform when the user selects one of the records returned by the query.

Menu Groups

Each Item node can have one or more Menu Groups nodes as children. Menu groups can be used to create mixed work lists, such as a group that combines work orders, service requests, and asset inspections.

See Mixed work lists.

A Menu Groups node has one or more Menu Group nodes as children. Each Menu Group node assigns the parent menu item to the menu group identified by the Id attribute. A Menu Group node can have these attributes:

Attribute Description
CreateMenuId Id of the menu item that is used to create a new record of this type. Must match the Id of an existing menu item.
Default Indicates whether the parent item will be selected by default when a user selects the menu group.
Description Description of the menu group.
Id Display name of the menu group.
OverridePage Can be used to override the standard page used to show records.
OverrideTitle Can be used to override the title of the parent menu item in a mixed work list.