Administering Application Menus and Modules

From ServiceNow Wiki
Home > Administer > Core Configuration > Navigation and UI > Administering Application Menus and Modules
Jump to: navigation, search
Navigation and UI Configuration
Related Topics
Note
Note: This article applies to Fuji. For more current information, see Application Navigator at http://docs.servicenow.com

The ServiceNow Wiki is no longer being updated. Visit http://docs.servicenow.com for the latest product documentation.


1 Overview

Administrators can define application menus, which group modules of related information and functionality under one name in the application navigator. Administrators can also restrict access to application and module listings.

Note
Note: Users may refer to an application menu as simply an application (see Navigating Applications). For administrators, an application is a packaged set of configuration records that provide a business solution, while an application menu is a way to make application features accessible to users.


2 Enabling and Disabling Application Menus or Modules

To enable (show) or disable (hide) an application menu or module in the application navigator:

  1. Navigate to System Definition > Application Menus.
  2. If you are enabling an application menu, click All in the breadcrumbs to display both active and inactive application menus (remove the default active = true filter condition).
  3. Click the desired title. The application menu record opens and the Modules related list shows the modules that appear in the application navigator.
  4. Enable or disable the application menu and modules as desired:
    • To enable or disable a specific module in the application, double-click the Active field beside the module name in the Modules related list. Set Active to true (show) or false (hide).
    • To enable or disable multiple modules at the same time, select the check boxes next to the module names, and select Change active state from the Actions choice list.
    • To enable or disable the entire application menu (for example, Incident or Service Catalog), select or clear the Active check box.
    • To restrict the application menu to specific roles, use the Roles field.
  5. Click Update.
    When you change application menus or modules, the application navigator automatically refreshes to display the changes.

3 Modifying Menu Categories

Menu categories allow administrators to change the appearance of application menu labels. Use menu categories to make certain application menus stand out. The type of customizations you can apply to menu categories depends on the version of the UI. Menu category customizations are not supported in UI14.

To enable menu category customizations in UI15, you must first add a property with the following specifications:

  • Name: glide.ui14.navigator.use_border_color
  • Type: true | false
  • Value: true


To define a menu category:

  1. Navigate to System Definition > Menu Categories.
  2. Click New or open an existing menu category.
  3. Customize the appearance of the menu category based on your version of the UI:
    • UI15: In the Style field, define the border-color using an HTML color name, hexidecimal (hex) value, or RGB color value. For example, enter border-color: blue. In UI15, border-color is the only supported CSS style.
      The color appears as a vertical bar next to the application menu label.
    • UI11 / Classic: In the Style field, define CSS styles such as border-color, text color, and background-color. For example, enter border-color: blue; background-color: #e3f3ff; color: white.
  4. [Optional] Enter a Default order. If you create an application menu without specifying an order, the default order of the menu category is used to determine the relative position in the application navigator.
Note
Note: You may need to clear the instance cache and refresh the page after saving the menu category to see CSS or color changes.


To add an application menu to a category, use one of the following methods:

  • In the category record, add the application menu in the Application Menus related list.
  • In the application menu record, enter the category in the Category field.

4 Creating Application Menus

  1. Navigate to System Definition > Application Menus.
  2. Click New.
  3. Define the application menu by completing the fields on the form (see table).
  4. Click Submit.
  5. Create modules to appear in the application menu.
    Only application menus that contain modules appear in the application navigator.
The Incident application menu

Note
Note: You might need to configure the form to see all the fields below.
Field Description
Title Defines the display name of the application menu.
Roles Restricts access to the specified roles. All users can view the application menu when it is active.
Category Specifies the menu category that defines the navigation menu style (default value is Custom Applications).
Hint Defines the text that appears in a tooltip when a user points to this application menu.
Active Select the check box to activate the application menu. Only active application menus appear in the application navigator.
Description Provide a more detailed explanation of what this application does.
Other fields
Order Defines the relative position of the application menu in the application navigator. If you do not specify an order, the default order of the menu category is used.
Default device type For instances that use the smartphone interface only, this field is not used. You can define application menus for mobile devices in a separate table. See Defining Mobile Application Menus and Modules (Smartphone Interface).

For instances that do not use the smartphone interface, defines whether related modules without a specified device type are available through the standard browser interface, on mobile devices, or on any device. See Defining Mobile Application Menus and Modules (Legacy mobile UI).

5 Creating Modules

  1. Open the application menu record using one of the following methods.
    • Navigate to System Definition > Application Menus and select the application menu from the list.
    • Right-click the application label in the application navigator and select Edit Application.
  2. Scroll down to the Modules related list and click New.
  3. Define the module by completing the fields on the form (see table).
  4. Click Submit.
The Create New module for the Incident application

Note
Note: You might need to configure the form to see all the fields below.
Field Description
Title Defines the module name. Choose a title that clearly identifies the module.
Application menu Specifies the name of the application menu under which the module appears.
Image Specifies an icon to appear next to the module title in the navigator. Module images are supported in UI11 and the classic interface only. Favorites replace module images in UI14 and UI15.
Hint Defines the tool tip that appears when a user points to the module name.
Visibility
Roles Restricts module access to the specified roles. If this field is left blank, the module is visible to all users who have access to the application menu.
Active Defines whether the module appears in the application navigator.
Override application menu roles Allows users to access this module even if they do not have permission to view the containing application menu. Users must still meet the role requirements for this module. This field is available starting with the Fuji release.
Link Type
Link type Specifies what type of link this module opens. You must specify additional information based on the link type. See Module Link Types.
Table Specifies the table used by the module.


Note
Note: The list shows only tables and database views that are in the same scope as the module (starting with the Fuji release).
Other fields
Order Specifies the order in which the modules appear under the application.

5.1 Module Link Types

The Link type field specifies what type of link the module opens.

Link Type Description
Assessment Links to the assessment-based survey you select in the Assessment reference field (starting with the Eureka release). See Creating a Survey Module.
Content Page Displays the content page you select in the Content page reference field. See Creating a Content Page.
Homepage Displays the homepage you select in the Homepage reference field.
HTML (from Arguments) Places HTML in the application navigator. This link type is used for more complicated links, where a flat URL is not customizable enough.

Note: You must enter a value for the Arguments field.

List Filter Displays an unpopulated list view for the table you select in the Table field. Allows users to specify a filter without loading the list first. Use the Filter field to define the default filter for the list. Use the View name field to specify a view. The list filter icon The list filter icon is added next to the module link in the application menu.
List of Records Displays the list view for the table you select in the Table field. Use the Filter field to define the default filter for the list. Use the View name field to specify a view.
Map Page Displays the map page you select in the Map page reference field. See Creating Map Page Modules.
New Record Displays a form for creating a new record in the table you select in the Table field.
Run a Report Runs the saved report you select in the Report field.
Script (from Arguments) Runs a script, as defined in the Arguments field.

Note: You must enter a value for the Arguments field.

Search Screen Link that displays a blank form for searching records in the table. Use the View name field to specify a view.

Note:

  • Use the parameter &sysparm_result_view=view_name to define the view the results are rendered in.
  • All searches use a starts with query to search for matching text. Other query types are not supported in search screens.
Separator Creates a division between modules. Enter a name in the appropriate field for your version to add a section name that users can collapse or expand.
  • Eureka or later: Title
  • Dublin or earlier: Arguments
Single Record Displays a form for a single record on the table. Use the View name field to specify a view.
Survey Links to the legacy survey you select in the Survey reference field. Use the Survey overwrite check box to determine whether the survey can be taken multiple times. See Making a Survey Public.

Note: The Survey link type is for use with legacy surveys only, which assessment-based surveys replace starting with the Eureka release. Select the Assessment link type to link the module to an assessment-based survey.

Timeline Page Displays the timeline page you select in the Timeline Page reference field. See Timeline Pages.
URL (from Arguments) Opens any URL, as defined in the Arguments field.

[Optional] Use the Window name field to define a link that opens in a new window.

Note:

  • For internal links, always use a relative link such as ./catalog_home.do?sysparm_view=catalog_default or catalog_home.do?sysparm_view=catalog_default. Do not use an absolute link to a ServiceNow instance. It creates problems when you move an update set from a development instance to a production instance because the URL still references the development instance.
  • You must enter a value for the Arguments field.

5.2 Additional Queries

For List of Records link types, you can append additional queries to the module to further define the filter for the returned list. For example, to filter active incidents that are assigned to the currently logged in user, use the following argument query:

active=true^assigned_to=javascript:gs.user_id()

5.3 Example: URL Module that Opens in New Window

To configure a module to open an external URL in a new browser window:

  1. If the Window name field is not displayed, configure the form and add this field.
  2. Select URL (from Arguments) from the Link type list.
  3. Add the complete web address to the Arguments field.
  4. Select an icon for the module in the Image field.
  5. Enter _blank in the Window name field.
    If this field is empty, the page opens in the content frame, which is the default behavior.
    Opening a module in a new window

5.4 Example: URL Module that Opens a List with a Custom Filter

To create a module that opens a list with a custom filter, sort order, and grouping, use a link type of URL (from Arguments) and create a link to a custom URL. Use this shortcut to determine the arguments for your custom URL:

  1. Navigate to the list by URL, without loading it in the standard interface. For example, navigate to the Incident list by entering:
    <base URL>/incident_list.do
  2. Apply the desired filter, sort order, and grouping.
  3. Copy the resulting URL from the browser address bar. For example, if you apply a filter of active=true with an ascending sort on priority, a descending sort on opened_on, and grouped by assignment_group, the address bar reads:
    incident_list.do?sysparm_query=active=true^EQ^ORDERBYpriority^ORDERBYDESCopened_at^GROUPBYassignment_group
    Note: Do not copy the base URL (the http://instance_name.service-now.com/ portion). Always use a relative link to prevent problems when you move an update set from a development instance to a production instance.
  4. Define a module with a Link type of URL (from Arguments).
  5. Paste the custom URL from step 3 into the Arguments field.
  6. Click Submit.
    The module now opens the custom list in the content frame.

6 Enhancements

6.1 Fuji

  • Administrators can visually distinguish menu categories in UI15 by defining a border color for each one.
  • The Override application menu roles field on the Module form allows users to view the module even if they cannot normally view the containing application menu.

6.2 Eureka

6.3 Dublin

  • For existing instances that are upgraded to Dublin, administrators can activate the smartphone interface, which disables all application menus or modules that are defined for mobile devices.
  • For instances that use the smartphone interface, administrators define application menus and modules for mobile devices in a separate table from menus and modules for the standard browser interface.
  • For instances that do not use the smartphone interface, administrators can define application menus and modules that are available through both the standard browser interface and on mobile devices.
Was this article helpful?
Yes, I found what I needed
No, I need more assistance