Skip to main content

Modules

Modules form the foundation for organizing the system on the platform. This guide outlines how to create, list, modify, delete, and browse modules.

Creating a New Module

To create a new module, follow these steps:

  1. Open the sidebar.
  2. Navigate to the Applications section.
  3. Select "Modules".
  4. Click on the "Add Module" button.
  5. Enter the following information in the displayed screen:
    • Name: Required text field, translatable.
    • Normalized Field: Automatically generated and can be modified later.
    • Description: Optional text field, translatable.
    • Icon: Choose an appropriate icon for the module.
    • Permission Management: Specify users or groups authorized to use this module. For more details, refer to Permission Management.
  6. Click the "OK" button.
  7. Verify the green confirmation message indicating the operation's success.

Listing Modules

To display all modules available on the platform, follow these steps:

  1. Open the sidebar.
  2. Navigate to the Applications section.
  3. Select "Modules".

All available modules will be displayed. Use the search engine to find a specific module. You can also add new modules, modify existing ones, or delete them.

Modifying a Module

To modify an existing module, follow these steps:

  1. Navigate to the Modules section.
  2. Click the three dots next to the module you wish to modify.
  3. Select "Edit".
  4. Make the required changes in the displayed screen.
  5. Click the "OK" button.
  6. Verify the green confirmation message indicating the operation's success.

Deleting a Module

To delete a module, follow these steps:

  1. Navigate to the Modules section.
  2. Click the three dots next to the module you wish to delete.
  3. Select "Delete".
  4. Verify the green confirmation message indicating the operation's success.

Browsing a Module

To browse a specific module, follow these steps:

  1. Open the sidebar.
  2. Navigate to the Applications section.
  3. Select "Modules".
  4. Click on the desired module.

In the module's page, you will find four main tabs displaying different information:

  1. Dashboard: Contains summaries and statistics related to the module's entities. For more information, refer to Dashboard.
  2. Entities: Displays entities linked to the module. For more information, refer to Entities.
  3. Pages: Displays information in a visual manner. For more information, refer to Pages.
  4. Permissions: Control viewing and editing permissions for users. For more information, refer to Permissions.