Add a Launcher Sub-Menu

Menus in the Cloud Service Management Console can be configured to launch a sub-menu. For example, in the default configuration of the Cloud Service Management Console, the Design menu launches another dashboard from which you can select a designer to use. This menu is configured with the target attribute set to dashboard and the data attribute set to the id of the sub-menu (designs). A sample sub-menu, whose id attribute is set to providerpanel, is provided.

After a menu item in the main dashboard is configured to launch a secondary dashboard, a secondary dashboard definition must be added to the dashboard configuration file. For example, in the default configuration of the Cloud Service Management Console, a sub-menu with an id of designs is defined. Information about dashboard attributes and values defined in the configuration file is included in the steps below.

To add a sub-menu, do the following:

  1. Make a backup of the CSA_HOME/jboss‑as/standalone/deployments/csa.war/dashboard/config.json dashboard configuration file (where

    CSA_HOME is the directory in which CSA is installed

    ).
  2. Edit the config.json file.

    1. Determine where you want the sub-menu (the menu that launches the launcher sub-menu) to appear in the dashboard and find the location in the configuration file. For example, if you want the sub-menu to appear between the Organizations and Resources menu in the dashboard, find the location between the Organizations and Resources menu definitions. If you want the menu to appear as the last menu, find the end of the last enabled menu definition.

      Copy the sample sub-menu definition, whose id attribute is set to providerpanel and target attribute is set to dashboard, and place it in the selected location.

      Update the content of the sub-menu (see Create a Side-Bar Menu for more information about updating the content).

    2. In the configuration file, sub-menus are defined after the main dashboard. Locate where the main or any secondary dashboard definition ends, and add a sub-menu definition within the global dashboard definition. For example, in the default dashboard configuration file, you could add another sub-menu after the predefined designs sub-menu.

      Copy the sample sub-menu definition, whose id attribute is set to providerpanel and type attribute is set to secondary, and place it in the selected location. The following is an example sub-menu definition (multiple dashboard definitions are separated by a comma):

      {
         "id": "<dashboard_id>",
         "name": "<dashboard_name>",
         "style": "<dashboard_style>",
         "type": "<dashboard_type>",
         "helptopic": "<dashboard_helptopic>",
         "roles": ["<role_1>", "<role_2>", ... , "<role_n>"],
      "permissions": ["<permission_1>", "<permission_2>" …, "<permission_n>"],
         "tiles": [ { ... } ]
      }

    3. Update the attribute values in the dashboard definition as described in the table. See Create a Side-Bar Menu for more information about menu attributes.

      Attribute Description
      id A unique identifier of the dashboard among all defined dashboards.
      name The name of the attribute in the CSA_HOME/jboss‑as/
      standalone/deployments/csa.war/dashboard/messages/dashboard/messages.properties
      file that defines the name displayed in the dashboard. If this is the primary dashboard, the name is displayed above the menus. If this is a secondary dashboard, the name is the label that is displayed next to the left-facing arrow icon or back button in the header.
      style The name of the attribute in the CSA_HOME/jboss‑as/
      standalone/deployments/csa.war/dashboard/css/base.css
      file that defines the color of the secondary dashboard's back button. For the primary dashboard, leave this value empty.
      type

      The type of dashboard. Values include:

      • primary - The dashboard that is displayed after launching CSA and successfully logging into the Cloud Service Management Console. This dashboard does not contain a back button. Only one primary dashboard can be defined.
      • secondary - A sub-dashboard that is launched from a dashboard and contains a back button. Zero, one, or multiple secondary dashboards can be defined.
      helptopic The name of the help topic that is displayed when the Assistance icon on the page is selected.
      roles

      The role required by the user in order for the dashboard to display. One or more roles may be entered. However, only one role must match the user role in order for the user to see the menu. Roles must be enclosed in quotation marks and, if more than one role is entered, separated by a comma (for example, "CSA_ADMIN", "RESOURCE_SUPPLY_MANAGER"). If no roles are specified, the menu can be seen by all users.

      Values include:

      • CONSUMER_SERVICE_ADMINISTRATOR - The Consumer Service Administrator configures and manages consumer organizations.
      • CSA_ADMIN - The Administrator has access to all functionality in the Cloud Service Management Console.
      • RESOURCE_SUPPLY_MANAGER - The Resource Supply Manager creates and manages cloud resources, such as resource providers and resource pools.
      • SERVICE_BUSINESS_MANAGER - The Service Business Manager creates and manages service offerings and service catalogs.
      • SERVICE_DESIGNER - The Service Designer designs, implements, and maintains service designs (also referred to as blueprints), component palettes, component types, component templates, and resource offerings.
      • SERVICE_OPERATIONS_MANAGER - The Service Operations Manager views and manages subscriptions and service instances.

      See the "Role Descriptions" help topic in the Cloud Service Management Console for more information about these roles (navigate to Organizations > Access Control > Role Descriptions in the online help).

      permission The user permissions required by the user in order for the menu items to display in the dashboard. If both permissions as well as roles are defined, the user must have one of the matching entries to be considered valid.
      tiles Tile definition. At least one tile must be configured. See Create a Side-Bar Menu for more information about tile attributes.
    4. Save and exit the file.
  3. Log in to the Cloud Service Management Console to view the dashboard. If you are already logged in, clear the browser cache (see Clear the web browser cache for information about how to clear the web browser cache) and refresh the browser. Clearing the browser cache is optional (a troubleshooting step).