Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.

Configure a portal header menu

Log in to subscribe to topics and get notified when content changes.

Configure a portal header menu

Service Portal is designed to allow customers to have deep control over the behavior of their portals. One of the main navigation controls for users is the header main menu. The menu options are determined by the assignment of a main menu to the portal, but the look and behavior of the menu is defined within the theme and associated header.

About this task

Configuring a portal header with a menu involves several steps:


  1. Create a header and add it to a theme.
    Until you add a theme with a header to a portal, the header menu does not display.
  2. Create a main menu with menu items and assign it to the portal.
    The main menu record is where you assign which navigation options appear in the header. For example, you can add a menu item that links to another page within your portal, such as the service catalog.


The main menu and header form a header menu when associated with a theme and a portal.

Gif showing how the header menu and the stock header combine to form the portal menu

Create a portal header menu

Create a menu with menu items to display in the header of a portal.


  1. In the Service Portal configuration page (Service Portal > Service Portal Configuration), navigate to Portal Tables > Instance with Menu and click New.
  2. Complete the fields in the menu form.
    Table 1. Menu fields
    Field Description
    Title Name of the header menu. You need to know this when you associate the menu with your portal.
    Additional options, JSON format Advanced configuration options. For example, use this field to enable the shopping cart in the header menu with the following code:
    	"enable_cart": {
    		"displayValue": "true",
    		"value": true
    Application The record scope. The header menu record and the source table must have the same application scope.
    Widget The widget that the header menu is based on. Select a menu-type widget from the list. For example, the header menu widget that is included as a base system widget.
  3. Save the form, and then click Menu Items from the related lists.
  4. Click New and complete the menu item form.
    Table 2. Menu item fields
    Field Description
    Label Name that appears for the item in the menu
    Parent menu This field should already contain the name of the menu you are adding items to. You can change the value as needed to other menus
    Parent menu item Use this field to nest menu items within other menu items
    Order Value that determines where the item appears in the menu in relation to other menu items
    Type The kind of page the item links to. Form fields vary depending on the option that you select from this list. Choose from:
    • Page: Link to another page in the Service Portal.
    • URL: Link to an external website. To have the URL open on a new browser tab or window, enter _blank in the URL target field.
    • Service Catalog: Link to the Service Catalog.
    • Catalog Category: Link to a specific catalog category within the Service Catalog.
    • Catalog Item: Link to a specific catalog item.
    • Knowledge Base: Link to the knowledge base that you previously configured as the portal's default knowledge base.
    • KB Topic: Link to a KB topic page.
    • KB Article: Link to a KB article by number.
    • KB Category: Link to a specific KB category within the knowledge base.
    • Filtered List: Set conditions to determine which page to link to.
    • Scripted List: Enter a script to determine which page to link to.
    Page Name of the portal page the item links to. This option is available if you select Page as the menu item type.
    Condition Determines what conditions are required for menu items to show in the header. For example, the condition gs.hasRole("sp_admin") restricts access to menu items to users with the sp_admin role. Hide a menu item by setting this value to false. For more information on what conditions to use in the Condition field, see Create a UI Action .
    Glyph Icon that appears beside the menu item
  5. Click Submit.
  6. After you create a menu and menu items, add the menu to a portal.
    1. Navigate to Service Portal > Portals, then open the portal you want to add a menu to.
    2. From the main menu field, click the reference lookup icon, then select the appropriate menu by name.
      Figure 1. Select a menu
      Portal form with Documentation menu selected in the Main Menu field
    3. Click Save.

What to do next

Associate the menu you created with a portal, then create a header with a theme for your menu.