Skip to main content

Create or Edit a Module

Modules organise screens within an application and appear as navigation items in the Side Menu.

Modules organise screens within an application and appear as navigation items in the Side Menu. Setting up a module involves three steps: creating the module, adding screens to it, and configuring which roles can access it.

A module will not appear in the navigation menu until it contains at least one screen.


Create a Module

  1. Open the Configuration application and navigate to Layouts \> Modules.

  2. In the Module section, click Detail to display all fields.

  3. Click New.

  4. Enter a Module Name. This is the name that will appear in the navigation menu.

  5. Select the Application that will contain the module.

  6. Enter a From Date. This field is required.

  7. Optionally enter a To Date if the module should only be available for a specific period.

  8. Enter an Order Number to control the module's position in the menu. Lower numbers appear higher in the list.

  9. Enter an Audit Comment.

  10. Click Save and Refresh.


Add Screens to a Module

  1. Select the module you want to configure.

  2. In the Screen section, click Edit, then Add.

  3. Select the Screen to associate with the module.

  4. Enter an Order Number to control the screen's position within the module.

  5. Repeat for each screen you want to include.

  6. Enter an Audit Comment.

  7. Click Save and Refresh.

The screens added here will appear under the module in the Side Menu.


Configure Module Access

Access to modules is controlled through user roles.

  1. Select the module.

  2. In the Module Permission section, click Edit, then Add.

  3. Select the Role Name that should have access to the module.

  4. Repeat for each role that requires access.

  5. Enter an Audit Comment.

  6. Click Save and Refresh.

Only users assigned to the specified roles will see the module in the navigation menu.

Did this answer your question?