Help Document
About the Help Module

    ABOUT THE HELP MODULE

    The Help Module is used in the Magentrix portal to provide users with help documentation in-context. The Help Module is fully integrated and is accessible to users by an inline button. The button redirects users to a specific help article pertaining to the page the user was on previously. Articles can be created within the module and organized by categories or by order.

    Users must have Help (system): Read and Help Category (system): Read permissions to see the inline button and access the help module.

    Requirements

    To create and edit help module articles, users must be assigned a security role with the following permissions:

    • All Entities, Help (system): Read, Create, Edit, Delete
    • All Entities, Help Category (system): Read, Create, Edit, Delete

    TO CREATE OR EDIT A HELP ARTICLE:

    1. Navigate to the page for which you want to open an article upon clicking the Help inline button.
    2. Click the Help inline button.
    3. If there is no article, click Add Article.
      If there is an existing article, click Edit.
      Note*: Once an article is linked to a page, it cannot be linked to another page nor unlinked. You can only delete the article.
    4. In the Title field, enter an article title.
    5. In the Category field, search and select the category for where the article will be located.
    6. In the Content rich-text editor, enter the article contents.
    7. In the Weight field, enter a number to indicate its order placing within the category.
    8. Click Save.

    TO EDIT THE HELP MODULE HOME PAGE:

    1. Navigate to the help module home page.
    2. Click the Gear button.
    3. Make your changes in the rich-text editor.
    4. Click Save.

    << About the MDF Module