Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Navigation Profiles

A navigation profile defines the navigation structure for a specific device type. Each profile has a default home page, optional role-specific home pages, an optional login page, and a menu.

Profile Types

ProfileMDL NameDescription
Responsive webResponsiveDefault browser navigation
Tablet webTabletTablet-optimized browser navigation
Phone webPhonePhone-optimized browser navigation
Native mobileNativePhoneReact Native mobile navigation

CREATE OR REPLACE NAVIGATION

Replaces an entire navigation profile:

CREATE OR REPLACE NAVIGATION <Profile>
  HOME PAGE <Module>.<Page>
  [HOME PAGE <Module>.<Page> FOR <Module>.<Role>]
  [LOGIN PAGE <Module>.<Page>]
  [NOT FOUND PAGE <Module>.<Page>]
  [MENU (
    <menu-items>
  )]

Full Example

CREATE OR REPLACE NAVIGATION Responsive
  HOME PAGE MyModule.Home_Web
  HOME PAGE MyModule.AdminHome FOR MyModule.Administrator
  LOGIN PAGE Administration.Login
  NOT FOUND PAGE MyModule.Custom404
  MENU (
    MENU ITEM 'Home' PAGE MyModule.Home_Web;
    MENU ITEM 'Orders' PAGE Shop.Order_Overview;
    MENU 'Administration' (
      MENU ITEM 'Users' PAGE Administration.Account_Overview;
      MENU ITEM 'Settings' PAGE MyModule.Settings;
    );
  );

Minimal Example

A profile only requires a home page:

CREATE OR REPLACE NAVIGATION Phone
  HOME PAGE MyModule.Home_Phone;

DESCRIBE NAVIGATION

View the current navigation profile in MDL syntax:

-- All profiles
DESCRIBE NAVIGATION;

-- Single profile
DESCRIBE NAVIGATION Responsive;

The output is round-trippable – you can copy it, modify it, and execute it as a CREATE OR REPLACE NAVIGATION statement.

See Also