Home › User Guides › Administrator Guide

BORMS Administrator Guide

Introduction

Welcome to the Busoga One Radio Management System (BORMS) Administrator Guide. This document is designed for system administrators responsible for managing, configuring, and maintaining the BORMS platform. As an administrator, you have the highest level of access and responsibility for ensuring the system operates correctly and securely.

Administrator Responsibilities

The system administrator is responsible for:

  1. System setup and configuration
  2. User account management
  3. Security monitoring and enforcement
  4. Data backup and recovery
  5. System maintenance and updates
  6. Troubleshooting technical issues
  7. Role and permission management
  8. Integration with external services

Getting Started

Accessing the Admin Panel

  1. Navigate to the BORMS login page
  2. Log in with your administrator credentials
  3. Once logged in, click on "Admin Panel" in the main navigation
  4. You will be redirected to the Filament admin interface

Admin Dashboard

The admin dashboard provides a comprehensive overview of system status:

  • System Health: Server status, application status, queue status
  • Recent Activity: Latest system-wide activities
  • User Statistics: Active users, recent registrations
  • System Resources: Storage usage, database size, cache status
  • Security Alerts: Failed login attempts, suspicious activities
  • Scheduled Tasks: Status of automated background tasks

User Management

Creating New Users

  1. In the admin panel, navigate to "Users → All Users"
  2. Click "Create User" button
  3. Fill in the required fields:
    • Name
    • Email
    • Password (or "Generate Password" option)
    • Assigned role(s)
    • Department
    • Contact information
  4. Click "Create" to add the user
  5. The system will automatically send welcome email with login instructions

Managing Existing Users

  1. Go to "Users → All Users"
  2. Use the search and filter options to find specific users
  3. Click on a user to view their details
  4. Edit user information as needed
  5. Use the action buttons to:
    • Reset password
    • Disable/enable account
    • Impersonate user (for troubleshooting)
    • View activity log

Role and Permission Management

  1. Navigate to "Access Control → Roles"
  2. View existing roles or create new ones
  3. Click on a role to edit its permissions
  4. Use the permission matrix to assign specific capabilities
  5. Save changes when complete

System Configuration

General Settings

  1. Go to "Settings → General"
  2. Configure system-wide settings:
    • Application name
    • Logo and branding
    • Date and time formats
    • Default language
    • Contact information
    • Company details
    • Terms of service

Email Configuration

  1. Navigate to "Settings → Email"
  2. Configure email settings:
    • SMTP server details
    • From address and name
    • Email template settings
    • Test email functionality
    • Email queue configuration

SMS Gateway Setup

  1. Go to "Settings → Notifications → SMS"
  2. Configure SMS provider details:
    • Provider API credentials
    • Default sender ID
    • Message templates
    • Rate limiting settings

System Modules

  1. Navigate to "Settings → Modules"
  2. Enable/disable specific system modules
  3. Configure module-specific settings
  4. Set default behaviors for each module

Security Management

Authentication Settings

  1. Go to "Settings → Security → Authentication"
  2. Configure:
    • Password policies
    • Session timeouts
    • Login attempt limitations
    • Two-factor authentication requirements
    • Remember-me functionality

Audit Log

  1. Navigate to "Security → Audit Log"
  2. View comprehensive activity logs:
    • Filter by user, action, date, or module
    • Export logs for compliance purposes
    • Configure retention policies
    • Set up alerts for specific activities

Permission Audit

  1. Go to "Security → Permission Audit"
  2. Review which users have specific permissions
  3. Identify permission inconsistencies
  4. Generate permission reports

Data Management

Database Utilities

  1. Navigate to "System → Database"
  2. Access database utilities:
    • Run database optimizations
    • View table statistics
    • Perform manual backups
    • Manage database connections

Backup Management

  1. Go to "System → Backups"
  2. Configure automated backup settings:
    • Backup frequency
    • Retention policies
    • Storage locations (local/cloud)
    • Notification settings
  3. Perform manual backups when needed
  4. Test restoration processes periodically

Import/Export Tools

  1. Navigate to "System → Import/Export"
  2. Access data migration tools:
    • Import data from CSV/Excel
    • Export system data
    • Configure mapping templates
    • Schedule automated exports

System Maintenance

Cache Management

  1. Go to "System → Cache"
  2. Manage system caches:
    • View cache usage
    • Clear specific caches
    • Configure cache drivers
    • Optimize cache settings

Queue Management

  1. Navigate to "System → Queues"
  2. Monitor and manage background jobs:
    • View active, pending, and failed jobs
    • Retry failed jobs
    • Configure queue workers
    • Set job priorities

Scheduled Tasks

  1. Go to "System → Scheduled Tasks"
  2. Manage system automation:
    • View upcoming scheduled tasks
    • Run tasks manually when needed
    • Configure task frequencies
    • Monitor task history and results

System Updates

  1. Navigate to "System → Updates"
  2. Manage system version:
    • Check for available updates
    • Review update notes
    • Backup before updating
    • Apply updates through the interface
    • View update history

Integrations Management

API Configuration

  1. Go to "Integrations → API"
  2. Manage API settings:
    • Generate API keys
    • Configure API rate limits
    • Enable/disable specific endpoints
    • Monitor API usage

External Service Connections

  1. Navigate to "Integrations → Services"
  2. Configure third-party integrations:
    • Email services
    • SMS providers
    • Payment gateways
    • Cloud storage
    • Analytics services

System Monitoring

Health Checks

  1. Go to "Monitoring → Health"
  2. View system health metrics:
    • Application status
    • Database connectivity
    • Queue processing
    • Cache availability
    • Storage accessibility
    • Required services

Error Logs

  1. Navigate to "Monitoring → Logs"
  2. Access system logs:
    • Application errors
    • Server logs
    • Security incidents
    • Performance issues
    • Filter and search functionality

Performance Metrics

  1. Go to "Monitoring → Performance"
  2. Review system performance:
    • Response times
    • Resource utilization
    • Database query performance
    • Cache hit rates
    • User experience metrics

Troubleshooting Common Issues

User Access Problems

Issue Solution
User cannot log in Check account status, reset password, verify email
Missing permissions Review role assignments, clear permission cache
Session timeouts Adjust session lifetime in security settings
Two-factor issues Reset 2FA for user, verify proper time synchronization

System Performance Issues

Issue Solution
Slow page loads Check database query performance, optimize caches
Background jobs delayed Verify queue workers are running, check for backlogs
High resource usage Identify resource-intensive operations, optimize queries
Memory exhaustion Increase PHP memory limits, optimize large operations

Integration Failures

Issue Solution
Email not sending Verify SMTP settings, check email queue, test connection
SMS delivery failure Check API credentials, verify service status, review logs
API connection issues Verify endpoint URLs, check authentication, review rate limits
Payment processing errors Check gateway configuration, verify account status

Best Practices

Security Best Practices

  • Regularly review user accounts and permissions
  • Enforce strong password policies
  • Enable two-factor authentication for sensitive roles
  • Monitor audit logs for suspicious activities
  • Keep the system updated with security patches
  • Perform regular security audits

Performance Optimization

  • Schedule regular database maintenance
  • Monitor and optimize database queries
  • Configure appropriate caching strategies
  • Use queue workers for resource-intensive tasks
  • Scale resources based on usage patterns
  • Regularly clean up old data and logs

Backup Strategy

  • Implement automated daily backups
  • Store backups in multiple locations
  • Test restoration process regularly
  • Include both database and file system in backups
  • Maintain point-in-time recovery capability
  • Document recovery procedures

Advanced Administration

Command Line Interface

Advanced administrators can use the Laravel command line interface:

# Example commands

# Clear application cache
php artisan cache:clear

# Run scheduled tasks manually
php artisan schedule:run

# View available commands
php artisan list

# Optimize the application
php artisan optimize

# Run database migrations
php artisan migrate

# Create a new user
php artisan make:user

Custom Development

For customizations or extensions:

  1. Follow the development documentation
  2. Use development environments for testing
  3. Implement version control for custom code
  4. Document all customizations
  5. Test thoroughly before deploying to production

Administrator Support

If you need additional assistance:

  1. Consult the technical documentation in the /docs directory
  2. Contact the BORMS support team at [support email]
  3. Visit the administrator knowledge base at [KB URL]
  4. For emergency support, call [emergency contact]

Appendix

Glossary of Terms

Term Description
Queue Background job processing system
Cache Temporary storage to improve performance
Middleware Request/response filters in the application
Migration Database structure version control
Seeder Initial data population scripts
Artisan Laravel command-line interface

Important File Locations

Purpose Location
Configuration /config directory
Logs /storage/logs directory
Uploads /storage/app/public directory
Backups /storage/app/backups directory
Environment .env file in root directory

Default Ports and Services

Service Default Port
Web Server 80 (HTTP), 443 (HTTPS)
MySQL 3306
Redis 6379
Queue Worker N/A (Background service)
Scheduler N/A (Cron task)