[Index]

Model: data/MenuLayout

Menu Layouts

1. Log in as provider or reseller administrator or higher.

2. Choose the hierarchy for the menu layout.

3. Navigate to the Menu Layouts menu.

4. Click Add to open the Menu Layouts input form.

5. Enter a Name and a Description for the menu layout.

6. Add (by clicking + next to Menu Items), and optionally nest Menu Items for each required menu item:

   1. Choose an Icon name from the drop-down to be displayed on the Admin Portal menu. To see the icons, refer to Business Admin Portal Interface Custom Icon Names Reference.

   2. Enter a Title.

   3. 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.

   4. Href is recommended to be used for external links only.

      Important

      The options below are for backwards compatibility use.

      Href 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: the view/ type models should not be referenced as Href.

      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/.

        Note that the view/ model types always open the "Add" form, so if used, the value should not have the /add/ endpoint. For example, as in this JSON:

        {
          "type": "view/QuickSubscriber",
          "display": "form",
          "title": "Quick Add Subscriber"
        }
        

      • External Link - the recommended use: 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

   5. Arrange the desired order of the menu items by clicking the up or down arrow to move the menu items up or down respectively.

7. 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.

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.

Model Details: data/MenuLayout