How do I create custom Main Menu entries?

Ryan Richins
  • Agilix team member
  • Updated:

Buzz allows you to add custom entries to your Main Menu, including non-default entries or external URLs that are displayed inside the Main Menu.

To add a custom entry:

  1. Open Domain Settings.
  2. Click Add under Domain Options > Menu Entries - Custom.
  3. Provide:
    • The ID associated with the entry.
    • The entry's desired placement Order in the Main Menu ("0" = top placement).
    • The entry Title as you want it to appear in the Main Menu.
    • The entry's URL if necessary. You can use the replacement variables defined below to customize this URL further.
    • The desired Icon; choose from the Font Awesome icon library. Prefix Font Awesome icon names with "fa-".
    • The pencil (edit) icon asks for:
      • An indication about whether you want to Show menu item, Open URL in external window, Require the user to choose a course, and/or Do not allow the user to choose a course.
      • The user Roles for whom the entry should appear (optional).
      • The Rights users need to access the entry (optional).
      • The Userspaces in which the entry should appear (optional).
  4. Save.

Replacement variables for custom Main Menu entries

Custom Main Menu URLs allow for dynamic replacement variables that automatically replace a variable code (options listed below) with a desired value drawn from user, course, and/or domain information.

Use any of the following replacement variables by enclosing them with double curly brackets (e.g., {{TOKEN}}, {{USERID}}, {{ADMINDOMAINID}}):

  • TOKEN: The xLi authentication token for the currently logged in user. When using this variable, the URL must be secure, starting with https.
  • USERID: The ID for the currently logged in user.
  • USERDOMAINID: The domain ID for the currently logged in user.
  • USERSPACE: The userspace for the customization domain, or the domain userspace visible in the top level URL.
  • ENROLLMENTID: The ID of the currently selected enrollment.
  • COURSEID: The ID of the course associated with the currently selected enrollment.
  • ADMINDOMAINID: The currently selected domain ID in the admin app.
  • QUERY-<param>: The value of the top page's query parameter with the case-sensitive name of <param>. The application only replaces this variable if external is not set to true.

Comments (1)

Sort by
Chris Lyles

Thanks Ryan for the info!

I would like to extend this line of thinking...

Let's say we have the following list domains and subdomains:  /Earth/Ground/Tree/Branches/Leaves... 

The courses are listed in the Leaves sub-domain.  If I make the custom menu options within the Branches domain, will they appear in the Leaves sub-domain?

Nevermind... figured it out.  The answer is YES. 

Please sign in to leave a comment.