Module Form Guide

The Module Form allows administrators to create new business modules and update existing module details inside the Ojoo Business OS Platform. Modules serve as functional containers that organize business forms, workflows, dashboards, permissions, and automation processes under parent applications.

Overview

The Module Form screen is used for both adding new modules and editing existing module entries. It enables administrators to:

  • Link modules to parent business Applications
  • Specify module display titles and descriptions
  • Define auto-generated or custom web slugs
  • Configure FontAwesome visual icons for navigation menus
  • Set menu display order sequence
  • Manage module status (Active / Inactive)

Module Form Fields

The following fields are available in the Module Form:

Field Label Input Type Required Purpose & Description
APPLICATION Dropdown Select Yes Select the parent application (e.g. Studio Engine, System Setup) to which this module belongs.
MODULE NAME Text Box Yes Enter the official business name of the module (e.g. Application Management, Company Management).
MODULE SLUG Text Box Yes Auto-generated as you type the Module Name. Can be edited manually using lowercase letters and hyphens. Must be unique across all modules.
MODULE ICON Text Box No Enter a FontAwesome CSS icon class (e.g. fa-solid fa-cubes) for visual menu display.
MODULE DESCRIPTION Textarea No Provide a brief description explaining the usage and business scope of the module.
MODULE ORDER Number Box Yes Specify an integer position (e.g. 1, 2, 3) to determine the module's menu display sequence.
MODULE STATUS Dropdown Select Yes Select Active (1) to enable the module or Inactive (0) to disable it.
Module Form

Form Behavior & Validation Rules

The system enforces strict validation rules to ensure data consistency and prevent duplicate web links:

  • Mandatory Fields: Application, Module Name, Module Slug, Module Order, and Module Status must be filled out before submitting.
  • Auto-Generated Slug: As you type the Module Name, the system automatically creates a lowercase web slug. You can modify this slug manually if needed.
  • Duplicate Slug Protection (Create): When creating a new module, the system checks if the Module Slug is already registered. If a duplicate is found, submission halts and displays a red message: "Module Slug Already Exists!".
  • Duplicate Slug Protection (Update): When editing an existing module, the system checks if the modified slug conflicts with any other module (excluding the current record). If a conflict exists, update halts and displays: "Module Slug Already Exists!".
  • Save Process: Clicking the blue "Save Module" button validates all inputs, inserts or updates the database record, and redirects to the Modules List with a green success message.
  • Cancel / Back Process: Clicking the "Back" button cancels form input and returns to the Modules List screen.

Right-Side Help Guide Panel

The Module Form includes a right-side Help Guide panel providing instant assistance for each field:

  • Application: Explains parent application ownership.
  • Module Name: Provides instructions for unique business module names.
  • Module Slug: Explains URL-friendly naming conventions.
  • Module Icon: Gives FontAwesome icon usage examples.
  • Module Description: Explains how to document module purpose.
  • Module Order: Explains menu display sequence ordering.

Toolbar Options

Import

Import module configuration data from external files.

APIs

Access module API endpoint documentation and integration parameters.

Back

Return to the Modules List screen without saving changes.

Best Practices

  • Select the correct parent Application to maintain logical menu hierarchy.
  • Use clear, meaningful module titles that reflect their business function.
  • Ensure web slugs contain only lowercase letters, numbers, and hyphens.
  • Use standard FontAwesome icons for a clean, consistent user interface.
  • Assign sequential menu order numbers (e.g. 10, 20, 30) for flexible positioning.