[Index]
Overview
Menu layouts define the content and structure of menus in the Admin Portal, based on your user role at the hierarchy where you log in.
VOSS Automate allows an administrator (with appropriate permissions) to customize menu layouts for different user roles and hierarchy levels. For example, the menu layouts at Provider level of the hierarchy can be different to menu layouts at Customer or Site level. Customizing menu layouts for different user roles at each hierarchy allows you to hide or show resources appropriate for different roles.
Related Topics
Navigation - Menu and Dashboards in the Best Practices Guide
Advanced Configuration Guide
Fixed and Configurable Filters in Menus in the Core Feature Guide
HCS Dial Plan Macros in VOSS Automate in the Core Feature Guide
If a menu layout applies to the list view of a model, this list can be filtered by means of a number of filter options that apply to the displayed list. Only instances where the values of a model attribute that match the filter, are then shown. For details, see Fixed and Configurable Filters in Menus and Landing Pages
Note
To work on an existing menu layout, we recommend that you clone the menu layout and work on the clone.
Log in as hcsadmin, provider or reseller administrator.
Choose the hierarchy for the menu layout.
Choose Role Management > Menu Layouts.
Click Add to open the Menu Layouts input form.
Enter a Name and a Description for the menu layout.
Add (by clicking + next to Menu Items), and optionally nest Menu Items for each required menu item:
Choose an Icon name from the dropdown to be displayed on the GUI menu. To see the icons, refer to Business Admin Portal Interface Custom Icon Names Reference.
Enter a Title.
For a list view of a model, select from the Type drop-down list and choose List as the Display as value. For the selected model type, choose a default Field Display Policy and Configuration Template. If a User Role is associated with the menu layout, then users with this role see the model type according to these.
If List is chosen as the Display As type, then the resulting list can also be filtered. See Configurable Filters in Menus and Landing Pages.
Href is generally used for external links. It can however be used for links within the application to link directly to a form. For example, the Add Phone form would have the HREF value of api/relation/SubscriberPhone/add. In such cases, any associated Field Display Policies and Configuration Templates for the menu item can only be added by using a menu import in JSON format or on a bulk load sheet.
Note that view/ type models should not be referenced as Href - only from the Type drop down. The view/ model types always open the "Add" form - without having to use the href with /add/.
If Href is used, choose the Display as format of the item as follows:
Form - Show an input form. The Href value points to a model instance with the pkid, for example data/Countries/5331a739d0278d7893e26d2e, or ends with "/add/".
IFrame - A URL specified as the Href value opens as an IFrame for cross-launching.
External Link - A URL specified as the Href value opens as a new browser tab.
Note: pop-up blocking should be disabled on user browsers for the external link to resolve.
Tree - If available, a tree view of resource to display. Href provides the tree path.
List - List view of a resource referenced by Type or Href. A tool (tool/[toolname]) can also be presented as a list, for example
/api/tool/Transaction/?entity=data/Event&operation=execute
Wizard - Execute a wizard referenced by Href (wizard resource ends with "/0/"). For example:
/api/wizard/AddressWizard/0/
Arrange the desired order of the menu items by clicking the up or down arrow to move the menu items up or down respectively.
Click Save on the button bar when complete to create the menu layout.
To modify an existing menu layout, click the relevant menu layout name from the Menu Layouts list view and edit the appropriate fields as described above. Click Save when complete.
Updates in the menu layout are available for the user only when logging in again.
When complete, assign the menu layout to the appropriate roles.
Menu layouts define the view a user has of the menu content and structure on the GUI. This is fully customizable up to three levels deep and can be created or edited to represent the content any user needs to have access to. The association of the defined view of the menu is made with the user's role and menu layouts can be created directly on the GUI.
To refine a view of model entities for a user, a Field Display Policy (FDP) and Configuration Template (CFT) for a model can be applied. The FDP and CFT for a specific model is applied as part of the menu layout - in other words in the menu structure, the FDP and CFT are attributes of the specific model entry for that menu layout. This means that:
If a menu layout applies to the list view of a model, this list can be filtered by means of a number of filter options that apply to the displayed list. Only instances where the values of a model attribute that match the filter, are then shown.
Default menu layouts are provided with VOSS-4-UC. These include defaults for pre-defined hierarchy based user roles, namely Global Administrator, Provider Administrator, Customer Administrator and Site Administrator. The details of these default menu layouts can be viewed and easily edited to either remove or add entries, update entries (for example with an alternative FDP), change default values (for example with an alternative CFT), or change the order and groupings of the items.
The menu layout is an attribute of the user role. Each user must be assigned a User Role, thus the user will see the menu layout based on this user role. Refer to the User Role topic.
Menu layouts can also be copied via the Clone option so they can be edited or exported and re-imported.
Designers who have access to tag or version tag can apply these to a menu layout so that it can be uniquely identified to track and control changes.
Choose the hierarchy for the menu layout.
Choose System Configuration > Menu Layouts.
Click Add to open the Menu Layouts input form.
Enter a Name for the menu layout.
Add (by clicking Add adjacent to Menu Items), and optionally nest Menu Items for each required menu item:
Enter a Title.
For a list view of a model, select from the Type drop-down list and choose List as the Display as value. For the selected model type, choose a default Field Display Policy and Configuration Template. If a User Role is associated with the menu layout, then users with this role see the model type according to these.
If List is selected as the display, then the resulting list can also be filtered. Click More... in the Filter Options column to open the dialog to enter one or more filter options. More than one filter results in a logical AND of the filters.
For example, if the selected type has a name attribute to filter by and the Filter Type is Starts With, then the menu item list only shows instances where the names start with the Filter String.
If Href is used, choose the Display as format of the item as follows:
Form - Show an input form. The Href value points to a model instance with the pkid, for example data/Countries/5331a739d0278d7893e26d2e, or ends with "/add/".
IFrame - A URL specified as the Href value opens as an IFrame for cross-launching.
External Link - A URL specified as the Href value opens as a new browser tab.
Tree - If available, a tree view of resource to display. Href provides the tree path.
List - List view of a resource referenced by Type or Href. A tool (tool/[toolname]) can also be presented as a list, for example
/api/tool/Transaction/?entity=data/Event&operation=execute
Wizard - Execute a wizard referenced by Href (wizard resource ends with "/0/"). For example:
/api/wizard/AddressWizard/0/
Arrange the desired order of the menu items by clicking the up or down arrow to move the menu items up or down respectively.
Click Save on the button bar when complete to create the menu layout.
To modify an existing menu layout, click the relevant menu layout name from the Menu Layouts list view and edit the appropriate fields as described above. Click Save when complete.
Updates in the menu layout are available for the user only when logging in again.
While default menu layouts are available for a user and an administrator user, a menu layout can be created from the GUI and can then be associated with a User Role. Users that have been assigned to this role will be able to use the created menu layout.
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name * | The name that is given to the Menu Layout. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | A description of the Menu Layout. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Menu Items | The list of menu items and -sub items that belong to the Menu Layout. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Title * | The menu item title as it will show on the menu. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | The menu item description as it will show on the menu. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Condition | Only show this menu item if this condition evaluates to true. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Icon | The icon to be used for this menu entry. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Display As | Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance. Default: list |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Type | The selected model type from the Type drop-down list to associate with the Title. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Href | If a direct reference to a model type is used for the menu item, the specified path. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Field Display Policy | The selected Field Display Policy that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Configuration Template | The selected Configuration Template that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Set as default Model Type | Use this menu entry configuration as the default for this model type. The selected Field Display Policy and Configuration Template will be used for the corresponding model in cases like search, when not navigating from a menu or landing page. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Landing Page | The selected Landing Page that is associated with the Menu Item (only available on the New Admin GUI). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Dashboard | The selected Dashboard that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Fixed Filters | Filters that can't be removed by end user. Applicable to display as = 'list' |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Configurable Filters | Filters suggested to end users and my be cleared. Applicable to display as = 'list' |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Menu Items | The list of nested menu items that belong to the Menu Layout. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Title * | The nested menu item title as it will show on the menu. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | The nested menu item description as it will show on the menu. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Condition | Only show this menu item if this condition evaluates to true. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Display As | Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance. Default: list |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Type | The selected model type from the Type drop-down list to associate with the Title. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Href | If a direct reference to a model type is used for the menu item, the specified path. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Field Display Policy | The selected Field Display Policy that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Configuration Template | The selected Configuration Template that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Set as default Model Type | Use this menu entry configuration as the default for this model type. The selected Field Display Policy and Configuration Template will be used for the corresponding model in cases like search, when not navigating from a menu or landing page. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Landing Page | The selected Landing Page that is associated with the Menu Item (only available on the New Admin GUI). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Dashboard | The selected Dashboard that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Fixed Filters | Filters that can't be removed by end user. Applicable to display as = 'list' |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Configurable Filters | Filters suggested to end users and my be cleared. Applicable to display as = 'list' |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Menu Items | The list of nested menu items that belong to the Menu Layout. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Title * | The nested menu item title as it will show on the menu. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | The nested menu item description as it will show on the menu. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Condition | Only show this menu item if this condition evaluates to true. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Display As | Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance. Default: list |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Type | The selected model type from the Type drop-down list to associate with the Title. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Href | If a direct reference to a model type is used for the menu item, the specified path. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Field Display Policy | The selected Field Display Policy that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Configuration Template | The selected Configuration Template that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Set as default Model Type | Use this menu entry configuration as the default for this model type. The selected Field Display Policy and Configuration Template will be used for the corresponding model in cases like search, when not navigating from a menu or landing page. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Landing Page | The selected Landing Page that is associated with the Menu Item (only available on the New Admin GUI). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Dashboard | The selected Dashboard that is associated with the Menu Item. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Fixed Filters | Filters that can't be removed by end user. Applicable to display as = 'list' |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Configurable Filters | Filters suggested to end users and my be cleared. Applicable to display as = 'list' |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Filter By |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter Type |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Filter String |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ignore Case |
|