Configuring the Help menu

You can add custom menu links to the Maximo® Manage Help menu from Maximo Manage version 8.5 onwards.

Before you begin

Before you begin:

  • Verify you are using Maximo Application Suite version 8.5 or later.
  • Ensure you have administrative access to the Maximo Application Framework Configuration tool.
  • For Maximo Application Suite 8.x and 9.x deployments, confirm that the Application Framework docker image is running and accessible.
Important: These instructions apply to Maximo Application Suite 8.5 and later. If you are using an earlier version or Maximo Asset Management 7.6.x, the Help menu configuration process is different. Contact your system administrator for guidance.

Procedure

  1. From your deployment environment, verify the Maximo Application Framework docker image is running.
    Use your container management tool (such as Docker or Kubernetes) to confirm the image status.
  2. Log in to Maximo Application Suite and launch Maximo Manage.

    In the Maximo Application Framework Configuration tool, the Application list page displays the applications that you are authorized to configure.

  3. From the Application list, click MANAGE-SHELL to open it in the Editor page.
  4. In the Editor, locate and modify the menus.xml file to add your custom Help menu links.
    Example menu entry for adding custom links to the Help menu: 
    <menu id="MASHELP">
  <menuitem event="loadlink" id="customhelp1" label="Support Portal" link="https://www.ibm.com/support"/>
  <menuitem event="loadlink" id="customhelp2" label="Documentation" link="https://www.ibm.com/docs"/>
</menu>
    Tip:
    • The menu ID must be MASHELP (uppercase).
    • Each menuitem must have a unique ID.
    • The event attribute must be loadlink.
    • The link attribute must contain a valid URL.
  5. Click Save.
  6. Click Preview to test your changes in a preview environment.
    Verify that your custom Help menu links appear correctly and navigate to the intended destinations.
  7. After confirming the changes work correctly, click Publish to apply them to your production environment.
    Your custom Help menu links are now available to all users.