How do I create custom Main Menu entries?

Echo 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 itemOpen URL in external windowRequire 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.

Echo is constantly being improved based on the feedback from users and we strive to keep our documentation up to date.  If this document doesn’t match what you are seeing in Echo, please let us know.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.