Appearance

Module Settings ​

The Module Settings allow you to enable or disable modules, manage module ordering, configure module-specific settings, and view module statistics. This centralized control panel helps you customize which features are available in your application.

Table of Contents ​

  1. Overview
  2. Accessing Module Settings
  3. Module Management
  4. Enabling/Disabling Modules
  5. Module Ordering
  6. Module-Specific Settings
  7. Module Statistics
  8. Best Practices

Overview ​

Features ​

  • ✅ Enable/disable modules
  • ✅ Module ordering
  • ✅ Module-specific configurations
  • ✅ Module statistics
  • ✅ Cache management
  • ✅ Module status overview

Admin Routes ​

  • Module Settings: /admin/module-settings
  • Module Details: /admin/module-settings/{key}
  • Module Statistics: /admin/module-settings/stats

Accessing Module Settings ​

From Admin Panel ​

  1. Log in to admin panel
  2. Navigate to Settings → Module Settings
  3. Or go directly to: /admin/module-settings

Permissions Required ​

  • Manage Settings: manage-settings permission

Module Management ​

Available Modules ​

Core Modules ​

  • Settings: System settings management
  • Users: User management
  • Pages: Page builder and management
  • Media: Media library

Content Management Modules ​

  • Posts (Blog): Blog posts and categories
  • Testimonials: Customer testimonials
  • FAQs: Frequently asked questions
  • Knowledge Base: Knowledge base articles

E-Commerce Modules ​

  • Products: Product catalog
  • Pricing Plans: Subscription plans
  • Services: Service offerings

Learning Modules ​

  • Courses: Online courses and learning

Project & Portfolio Modules ​

  • Projects: Project portfolio
  • Case Studies: Case study management
  • Events: Event management

Support Modules ​

  • Tickets: Support ticket system

Business Modules ​

  • Quotes: Quote management
  • Causes: Cause and donation management
  • Appointments: Appointment booking
  • Jobs: Job board

Productivity Modules ​

  • Task Manager: Task and project management

Enabling/Disabling Modules ​

Module Status ​

Enabled Modules ​

Features:

  • Visible in Menu: Appears in admin navigation
  • Routes Active: All routes accessible
  • Features Available: All features functional
  • Data Accessible: Data can be managed

Disabled Modules ​

Features:

  • Hidden from Menu: Not shown in navigation
  • Routes Inactive: Routes return 404
  • Features Unavailable: Cannot access features
  • Data Preserved: Data remains in database

Toggling Module Status ​

Enable Module ​

  1. Navigate to Module Settings:

    • Go to Module Settings page
    • Find module in list

  2. Enable Module:

    • Click Enable button
    • Or toggle switch to ON
    • Module enabled immediately

  3. Verify:

    • Check menu appears
    • Verify routes work
    • Test features

Disable Module ​

  1. Navigate to Module Settings:

    • Go to Module Settings page
    • Find module in list

  2. Disable Module:

    • Click Disable button
    • Or toggle switch to OFF
    • Confirm action

  3. Verify:

    • Check menu hidden
    • Verify routes return 404
    • Data preserved

Bulk Operations ​

Enable Multiple Modules ​

  1. Select multiple modules
  2. Click Bulk Actions → Enable
  3. All selected modules enabled

Disable Multiple Modules ​

  1. Select multiple modules
  2. Click Bulk Actions → Disable
  3. All selected modules disabled

Module Ordering ​

Changing Module Order ​

Drag and Drop ​

  1. Access Module Settings:

    • Go to Module Settings page
    • View module list

  2. Reorder:

    • Click and hold module
    • Drag to new position
    • Drop in desired location
    • Order saved automatically

Manual Ordering ​

  1. Edit Module:

    • Click Edit on module
    • Or go to module details

  2. Set Order:

    • Enter order number
    • Lower numbers appear first
    • Example: 1 = first, 2 = second

  3. Save:

    • Click Update Order
    • Order saved
    • Menu updates

Order Impact ​

  • Order Determines: Position in admin menu
  • Lower Numbers: Appear first
  • Higher Numbers: Appear later
  • Grouped: By module category

User Experience ​

  • Important Modules: Place first
  • Logical Grouping: Group related modules
  • Easy Access: Frequently used modules first

Module-Specific Settings ​

Accessing Module Settings ​

Module Details Page ​

Route: /admin/module-settings/{key}

  1. Navigate to Module:

    • Go to Module Settings
    • Click on module name
    • Or click Configure button

  2. View Settings:

    • Module-specific options
    • Configuration options
    • Feature toggles

Common Module Settings ​

General Settings ​

Available Options:

  • Module Name: Display name
  • Description: Module description
  • Status: Enabled/Disabled
  • Order: Display order

Feature Settings ​

Examples:

  • Posts Module:

    • Comments enabled
    • Featured posts
    • Post scheduling

  • Products Module:

    • Inventory tracking
    • Variants enabled
    • Digital products

  • Courses Module:

    • Enrollment type
    • Progress tracking
    • Certificates

Integration Settings ​

Examples:

  • Payment Integration: Payment methods
  • Email Integration: Email templates
  • Notification Integration: Notification types

Saving Settings ​

  1. Make Changes:

    • Modify settings
    • Toggle features
    • Update configurations

  2. Save:

    • Click Save or Update
    • Settings saved
    • Changes applied immediately

  3. Clear Cache:

    • Click Clear Cache (if needed)
    • Ensures changes take effect
    • Refreshes module state

Module Statistics ​

Accessing Statistics ​

Route: /admin/module-settings/stats

  1. Navigate to Statistics:
    • Go to Module Settings
    • Click Statistics tab
    • Or navigate directly

Available Statistics ​

Module Overview ​

Displayed Information:

  • Total Modules: Number of modules
  • Enabled Modules: Active modules count
  • Disabled Modules: Inactive modules count
  • Module Usage: Usage statistics

Per-Module Statistics ​

For Each Module:

  • Status: Enabled/Disabled
  • Record Count: Number of records
  • Last Activity: Last update time
  • Usage: How often used

Content Statistics ​

Examples:

  • Posts Module:

    • Total posts
    • Published posts
    • Draft posts
    • Categories count

  • Products Module:

    • Total products
    • Active products
    • Out of stock
    • Categories count

  • Users Module:

    • Total users
    • Active users
    • Roles count

Statistics Refresh ​

Manual Refresh ​

  1. Click Refresh:
    • Click Refresh Statistics button
    • Statistics updated
    • Latest data shown

Auto-Refresh ​

  • Automatic Updates: Statistics refresh periodically
  • Real-Time: Some stats update in real-time
  • Cached: Some stats cached for performance

Best Practices ​

Module Management ​

  1. Enable Only Needed Modules:

    • Don't enable unused modules
    • Reduces complexity
    • Improves performance
    • Cleaner interface

  2. Logical Ordering:

    • Group related modules
    • Place important modules first
    • Organize by category
    • Easy navigation

  3. Regular Review:

    • Review enabled modules
    • Disable unused modules
    • Update module order
    • Check statistics

Module Configuration ​

  1. Configure Before Use:

    • Set up module settings
    • Configure features
    • Test functionality
    • Document configurations

  2. Test After Changes:

    • Test after enabling
    • Verify features work
    • Check integrations
    • Review statistics

  3. Monitor Usage:

    • Check module statistics
    • Review usage patterns
    • Identify unused modules
    • Optimize configuration

Performance ​

  1. Disable Unused Modules:

    • Improves performance
    • Reduces database queries
    • Faster page loads
    • Cleaner codebase

  2. Clear Cache:

    • Clear cache after changes
    • Ensures updates apply
    • Refreshes module state
    • Improves performance

Troubleshooting ​

Module Not Appearing ​

Solutions:

  1. Verify module is enabled
  2. Check module order
  3. Clear cache
  4. Refresh page
  5. Check permissions

Module Not Working ​

Solutions:

  1. Verify module enabled
  2. Check module settings
  3. Review error logs
  4. Test module features
  5. Clear cache

Settings Not Saving ​

Solutions:

  1. Verify permissions
  2. Check form validation
  3. Review error messages
  4. Clear cache
  5. Try again

Last Updated: [Date will be updated during final review]

Released under the MIT License.

Copyright © 2024 OmniSuite CMS