How to Set Up & Configure Horilla Report Module in Horilla HRMS

Horilla HRMS is designed with modularity in mind, allowing administrators and developers to plug in only the features they need. One such module is the Report Module, which provides comprehensive reporting capabilities across various HR activities. Whether you need quick overviews of attendance, leave summaries, payroll breakdowns, or recruitment analytics, the Report Module empowers HR teams to access critical insights without manual data crunching.

By default, the Report Module is optional, so it must be explicitly enabled and configured to appear within your Horilla environment. This design ensures your HRMS remains lightweight and efficient, only loading what your organization actually uses.

In this quick guide, we’ll walk you through the steps required to enable and configure the Report Module in your Horilla HRMS installation.

Step 1: Add the report to Installed Apps

The first step is to ensure the report module is recognized by Horilla or Django.

Inside your horilla/settings.py (horilla folder will be inside your base directory where Horilla is installed.)

Locate the INSTALLED_APPS list.

Add ‘report’, above the ‘notifications’ app:

Example:

# horilla/settings.py

INSTALLED_APPS = [
    ...
    'report',
    'notifications',
    ...
]

Placing the report above notifications ensures proper dependency loading, especially for UI and static files.

Step 2: Add Report to the Sidebar

To make the Report module visible in the application sidebar:

Open your horilla/horilla_apps.py file.

Locate the section where sidebars are defined.

Add an entry for the report module.

Example:

# horilla/horilla_apps.py
SIDEBARS = [
    ...
    "report",
    ...
]

This tells Horilla to include the Report section in the user interface navigation.

Step 3: Collect Static Files (For Production)

If you’re running Horilla in a production environment (e.g., using Nginx, Gunicorn, etc.), you’ll need to collect static files so the UI for the Report module renders correctly.

Run the following Django management command:

python manage.py collectstatic

This gathers all static assets (CSS, JS, etc.) into the STATIC_ROOT directory for serving via your web server.

Step 4: Restart the Application

After completing the steps above, restart your Horilla application or web server (if applicable) to apply the changes.

Example for Gunicorn:

sudo systemctl restart gunicorn

Or simply stop and start your development server if you’re in local mode.

Final Check

Log in to your Horilla HRMS dashboard. You should now see “Reports” in the sidebar.

Troubleshooting

Even after following the setup steps, you might occasionally run into minor issues. This section helps you identify and resolve the most common problems encountered during the configuration of the Horilla Report Module.

Report not showing in the sidebar?

If the Reports section doesn’t appear in the sidebar:

• Make sure the ‘report’ module is added to the SIDEBARS list in horilla_apps.py.
• Double-check for any typos or incorrect module names in the sidebar configuration.
• Try restarting the development or production server to reload sidebar definitions.

Static files not loading?

• Ensure collectstatic ran without errors.

python manage.py collectstatic

• Confirm your static files are served correctly in production.

Conclusion

By enabling the Report Module in Horilla HRMS, you unlock the power to generate actionable insights across your HR workflows. Whether you’re managing employee attendance trends, analyzing leave data, or reviewing recruitment performance, the Report Module centralizes and simplifies your access to key metrics.

The modular design of Horilla ensures you only enable what you need, so adding this reporting functionality is seamless and lightweight. Once configured, your HR team will have a powerful tool right at their fingertips, helping them make informed decisions and improve organizational efficiency.

With the Report Module now live in your system, you’re one step closer to smarter HR management.