README

The MHinspeya Employee module allows merchants to showcase their employees on the storefront and assign customers as employees. It provides an easy-to-manage employee directory with departments, employee profiles, appointment links, and Hyvä compatibility.

The module includes sample data, employee images, customer group creation, and an intuitive admin interface to manage employees and departments.

Features

• Fully compatible with Magento 2 and Hyvä Theme
• Dedicated Employee listing page
• Employee Department management
• Employee Profile management
• Customer assignment for employees
• Employee image upload and gallery support
• Department-wise employee organization
• Appointment/Termin button support
• Configurable module enable/disable from Admin
• Configurable Appointment (Termin) enable/disable
• Automatic creation of Employees customer group during installation
• Automatic installation of sample departments and employee data
• Automatic copy of sample employee images into pub/media
• Responsive frontend design
• Magento Marketplace coding standard compatible

Requirements

• Magento 2.4.6+
• PHP 8.1+
• Hyvä Theme
• MHinspeya Backend Module

Installation

Composer Installation

composer require mhinspeya/mhinspeya-employee-hyva

Enable module

bin/magento module:enable MHinspeya_Employee

Run setup

bin/magento setup:upgrade

Compile

bin/magento setup:di:compile

Deploy static content (Production Mode)

bin/magento setup:static-content:deploy -f

Flush Cache

bin/magento cache:flush

App/Code Installation

Copy module to

app/code/MHinspeya/Employee

Enable module

bin/magento module:enable MHinspeya_Employee

Run setup

bin/magento setup:upgrade

Compile

bin/magento setup:di:compile

Deploy static content (Production Mode)

bin/magento setup:static-content:deploy -f

Flush cache

bin/magento cache:flush

What happens during installation?

During installation the module automatically:

• Creates the Employees Customer Group.
• Installs sample Employee Departments.
• Installs sample Employees.
• Copies sample employee images to:

pub/media/wysiwyg/mhinspeya/employee

No manual data import is required.

Important Configuration

Navigate to

Stores
    → Configuration
        → Inspeya
            → Employee Configuration

Available options

• Enable Module on Frontend
• Enable Termin (Appointment) Button

Customer Group Assignment (Important)

The module creates a new customer group named:

Employees

To display a customer in the Employee section, the customer must belong to the Employees customer group.

Navigate to

Customers
    → All Customers
        → Edit Customer

Set

Customer Group

Employees

Only customers assigned to the Employees customer group are available for selection while creating Employee profiles.

Employee Departments

Navigate to

Content
    → Employee Department

Features

• Add Department
• Edit Department
• Delete Department
• Enable/Disable Department
• Department Email
• Appointment Status
• Custom Appointment URL
• Sort Order

Departments are used while creating Employee Profiles.

Employee Management

Navigate to

Content
    → Employee

Features

• Add Employee
• Edit Employee
• Delete Employee
• Upload Employee Image
• Select Existing Customer
• Department Assignment
• Employee Email
• Employee Description
• Sort Order
• Enable/Disable Employee

Employee Fields

Each employee contains

• Employee Name
• Department
• Customer Assignment
• Email Address
• Employee Image
• Description
• Sort Order
• Status

Frontend Features

The frontend includes

• Employee Listing
• Department Tabs
• Employee Image
• Employee Name
• Employee Description
• Appointment (Termin) Button
• Department Filtering
• Responsive Layout
• Hyvä Optimized

Configuration Options

Enable Module

Stores
→ Configuration
→ Inspeya
→ Employee Configuration

Module Enable on Frontend

Enable or disable the complete Employee section.

Appointment Button

Stores
→ Configuration
→ Inspeya
→ Employee Configuration

Enable Termin Status on Frontend

Controls whether the Appointment (Termin) button is displayed.

Sample Data

The module ships with

• 10 Sample Departments
• 25 Sample Employees
• Employee Images

These records can be edited or removed after installation.

Permissions

Make sure Magento has write permissions for

pub/media

The module copies employee images automatically during installation.

Composer Package

{
    "name": "mhinspeya/mhinspeya-employee-hyva",
    "version": "1.0.0",
    "type": "magento2-module"
}

Support

MHinspeya

Website

https://inspeya.com

License

OSL-3.0