Skip to main content

Installation & Setup

This guide walks you through the complete installation and setup of the SDLC Corp HRMS Employee Dashboard module for Odoo.

Prerequisites​

Before installing, ensure you have:

  • A working Odoo instance (v17.0, v18.0, or v19.0 Community)
  • Administrator access to your Odoo instance
  • The following Odoo modules installed: HR, HR Attendance, HR Holidays (Time Off), Project
  • Developer Mode enabled (for manual installation)
  • Employee records created for users who will access the dashboard

Dependencies​

The module depends on the following Odoo modules, which are installed automatically:

ModuleTechnical NamePurpose
BasebaseCore Odoo framework (users, groups, access rights)
EmployeeshrEmployee records, departments, and the employee form
Attendanceshr_attendanceAttendance records (check-in/check-out data)
Time Offhr_holidaysLeave types, leave requests, allocations, and public holidays
ProjectprojectProject and task data for the Projects panel

Install the Module​

Step 1: Download the Module​

Download the sdlc_emp_dashboard module package from the SDLC Corp website or the Odoo App Store.

Step 2: Upload to Odoo​

Place the module folder into your Odoo addons directory. The path is typically /odoo/addons/ or a custom addons path configured in your odoo.conf.

Step 3: Update Apps List​

Go to the Apps menu in Odoo, click Update Apps List (requires Developer Mode). Confirm when prompted.

Step 4: Install​

Search for "HRMS Dashboard" in the Apps list and click Install. Odoo will automatically install all required dependencies (hr, hr_attendance, hr_holidays, project).

Odoo.sh Users

If you are using Odoo.sh, you can simply add the module to your GitHub repository and it will be detected automatically. Push to a staging branch first to test before deploying to production.

Each user who needs to access the dashboard must have their Odoo user account linked to an employee record. This must be done by an Administrator before the user can use the dashboard.

Step 1: Open the Employee Form​

Login as Admin. Go to Employees > Employees and open the employee record for the user (e.g., Marc Demo).

Step 2: Go to HR Settings Tab​

In the employee form, click on the HR Settings tab (or Work Information tab depending on your Odoo version).

Find the Related User (or User) field and select the Odoo user account that corresponds to this employee.

Step 4: Save​

Click Save. The employee is now linked to the user account. The dashboard will recognize this user automatically.

warning

If the user opens the dashboard without this link, they will see a "Configuration Required" error screen instead of the dashboard. The error will display: "Please link your user account to an employee record."

User Access Rights​

In addition to linking the employee record, the user must have the correct access rights to read HR data. Without these permissions, the dashboard will show "Failed to load attendance data".

Step 1: Open User Settings​

Login as Admin. Go to Settings > Users & Companies > Users and open the user (e.g., Marc Demo).

Step 2: Set Human Resources Access​

Under the Human Resources section, set the following permissions:

PermissionMinimum Level
Time OffOfficer
AttendancesOfficer

Step 3: Save​

Click Save. The user can now access the dashboard and all attendance, leave, and holiday data will load correctly.

Important

Without Time Off: Officer and Attendances: Officer access rights, the dashboard will fail to load even if the employee-user link is correctly set up. This is because the dashboard reads data from hr.leave, hr.attendance, resource.calendar.leaves, and hr.leave.allocation models which require these permissions.

Configuration​

tip

No additional configuration required. The dashboard automatically adapts based on the logged-in employee, company calendar, and approved attendance & leave records.

While the module works out of the box, here are the areas that affect what the dashboard displays:

Employee Linking​

Each Odoo user who wants to access the dashboard must be linked to an employee record (see above). Additionally, the user must have Time Off: Officer and Attendances: Officer access rights.

Leave Types​

The dashboard displays leave balances for all leave types that have allocations assigned to the employee:

  1. Go to Time Off > Configuration > Leave Types
  2. Set up leave types such as Casual Leave, Sick Leave, Annual Leave, etc. Ensure "Requires Allocation" is set to Yes for types you want to track balances for
  3. Go to Time Off > Managers > Allocation and create allocations for each leave type per employee

Public Holidays​

Public holidays are displayed on the calendar as purple-coded days:

  1. Go to Time Off > Configuration > Public Holidays
  2. Create holiday entries with the name and date
  3. The dashboard automatically picks these up and marks them on the calendar
info

The Joining Date field (added by this module to the Employee form) is used to calculate work anniversaries. Make sure it is filled in for employees whose anniversaries you want to display in the Celebrations panel.

Configuration Summary​

SettingWhere to ConfigureEffect on Dashboard
Employee-User LinkEmployee Form > HR Settings > Related UserDashboard will not load without this link
Leave TypesTime Off > Configuration > Leave TypesDetermines which leave balances are shown
Leave AllocationsTime Off > Managers > AllocationSets the total & remaining days per leave type
Public HolidaysTime Off > Configuration > Public HolidaysShows purple-coded holiday markers on the calendar
Joining DateEmployee Form (after Manager field)Enables work anniversary display in Celebrations
BirthdayEmployee Form > Private InformationEnables birthday display in Celebrations
Project AssignmentsProject > Tasks (assign user to tasks)Shows assigned projects in the Projects panel

Next Steps​

Need Help?

Contact SDLC Corp at sdlccorp.com/contact-us or email sales@sdlccorp.com