@adminide-stack/clock-tik-browser 12.0.22-alpha.0 → 12.0.22-alpha.2

package/lib/templates/content/docs/hrm/dashboard.md

@@ -0,0 +1,162 @@
+---
+id: hrm-dashboard
+title: HR Dashboard
+sidebar_label: HR Dashboard
+---
+
+## HR Dashboard
+
+The **HR Dashboard** (`HRM > HR Dashboard`) gives administrators a centralized, real-time view of the organization's HR metrics. Navigate to `/hrm/dashboard` to access it.
+
+![HR Dashboard Overview](/static/img/hrm/dashboard-overview.png)
+
+---
+
+### Dashboard Tabs
+
+The dashboard features seven tabs across the top, each focused on a different aspect of HR management:
+
+| Tab | Description |
+|-----|-------------|
+| **Overview** | Summary statistics, charts, and approval category breakdown |
+| **Pending Letters** | HR letter requests awaiting action |
+| **Pending Travels** | Travel requests awaiting approval |
+| **Pending Offboarding** | Resignation / exit requests in progress |
+| **Pending Approvals** | All pending approvals across all categories |
+| **Trends & Analytics** | Historical trend charts and approval analytics |
+| **Candidates & Employees** | Candidate pipeline and employee directory |
+
+---
+
+### Overview Tab
+
+The main dashboard view displays key organizational metrics:
+
+#### Summary Cards
+
+| Metric | Description |
+|--------|-------------|
+| **Total Employees** | Total headcount in the organization |
+| **Active Employees** | Currently active employees |
+| **On Leave** | Employees currently on approved leave |
+| **Pending Approvals** | Total items awaiting approval across all categories |
+
+#### Onboarding & Training
+
+- **Active Onboarding** — Number of employees currently going through onboarding flows
+
+#### Employee Growth
+
+| Metric | Description |
+|--------|-------------|
+| Growth Rate | Workforce growth percentage |
+| New Hires | New employees added in the selected period |
+| Terminations | Employment terminations in the selected period |
+
+#### Asset Management
+
+| Metric | Description |
+|--------|-------------|
+| Total Allocated | Assets assigned to employees |
+| Pending Requests | Asset requests awaiting fulfillment |
+| Recently Delivered | Assets recently provisioned |
+
+#### Approvals by Category
+
+A breakdown of all pending approval items:
+
+| Category | Description |
+|----------|-------------|
+| Asset Request | Hardware / software allocation requests |
+| Access Grant | System access / permission requests |
+| HR Letter | Letter generation requests |
+| Travel Request | Business travel requests |
+
+---
+
+### Date Range Filter
+
+Use the **date picker** fields (From / To) at the top right of the dashboard to filter data by a specific period. Click **Refresh** to reload the dashboard with the selected range.
+
+---
+
+### Pending Letters Tab
+
+![Pending Letters](/static/img/hrm/dashboard-pending-letters.png)
+
+Displays a table of all pending HR letter requests with columns:
+
+| Column | Description |
+|--------|-------------|
+| Title | Letter request title |
+| Category | Request category (see filter list) |
+| Requester | Employee who submitted the request |
+| Priority | Request priority level |
+| Requested | Date the request was submitted |
+| Days Pending | How long the request has been waiting |
+| Actions | Approve, reject, or view actions |
+
+**Filter by category:** Asset Request, Access Grant, Training, Onboarding, Travel Request, Candidate, Leave Request, Expense Claim, HR Letter
+
+---
+
+### Pending Travels Tab
+
+Same table format as Pending Letters, filtered to show travel-related approval requests.
+
+---
+
+### Pending Offboarding Tab
+
+![Pending Offboarding](/static/img/hrm/dashboard-pending-offboarding.png)
+
+Shows all active resignation / exit requests with:
+- **Refresh** button to update the list
+- Count of total pending offboarding requests
+- Details of each request when present
+
+---
+
+### Pending Approvals Tab
+
+![Pending Approvals](/static/img/hrm/dashboard-pending-approvals.png)
+
+A unified view of **all** pending approvals across all categories, with the same table format and category filter options.
+
+---
+
+### Trends & Analytics Tab
+
+![Trends & Analytics](/static/img/hrm/dashboard-trends-analytics.png)
+
+Visual analytics for HR operations:
+
+| Metric | Description |
+|--------|-------------|
+| Total Approved | Number of approved requests |
+| Total Rejected | Number of rejected requests |
+| Approval Rate | Percentage of requests approved |
+
+#### Charts
+
+- **Approval Trends Over Time** — Line chart showing Approved, Rejected, and Pending trends
+- **Distribution by Category** — Pie chart of requests by category
+- **Daily Approval Activity** — Bar chart of daily approval volume
+- **Category Breakdown** — Detailed breakdown by category
+
+---
+
+### Candidates & Employees Tab
+
+![Candidates & Employees](/static/img/hrm/dashboard-candidates-employees.png)
+
+Manage your talent pipeline and workforce:
+
+| Filter Tab | Description |
+|------------|-------------|
+| **All** | All candidates and employees |
+| **Active** | Currently active employees |
+| **Onboarding** | Candidates in onboarding process |
+| **Completed** | Candidates who completed onboarding |
+
+Summary statistics show Total, Active, Onboarding, and Completed counts.

package/lib/templates/content/docs/hrm/hr-letters.md

@@ -0,0 +1,66 @@
+---
+id: hrm-hr-letters
+title: HR Letters
+sidebar_label: HR Letters
+---
+
+## HR Letters
+
+The **HR Letters** module (`HRM > Letter`) lets employees request official HR letters from their organization. Navigate to `/hrm/hr-letters` to access it.
+
+![HR Letters](/static/img/hrm/letter-hr-letters.png)
+
+---
+
+### Overview
+
+The HR Letters page provides a streamlined interface for requesting, tracking, and managing official employee letters.
+
+**Description:** Manage employee letter requests for address proof, bonafide, and experience letters.
+
+---
+
+### Letter Types
+
+Three types of HR letters are available:
+
+| Letter Type | Description |
+|-------------|-------------|
+| **Address Proof** | Official letter confirming your residential address for banks, visa applications, etc. |
+| **Bonafide Letter** | Letter certifying you as a current employee of the organization |
+| **Experience Letter** | Letter documenting your employment period, role, and experience |
+
+---
+
+### Request Statistics
+
+The page displays real-time counts:
+
+| Stat | Description |
+|------|-------------|
+| **Pending Requests** | Letter requests awaiting HR approval |
+| **Approved / Generated** | Letters that have been approved and generated |
+| **Rejected** | Requests that were denied |
+
+---
+
+### Creating a Letter Request
+
+1. Navigate to **HRM > Letter**
+2. Click **Add Request**
+3. Select the letter type (Address Proof, Bonafide Letter, or Experience Letter)
+4. Fill in any required details
+5. Submit the request
+
+Your request enters the HR approval workflow and can be tracked on this page.
+
+---
+
+### Approval Workflow
+
+1. **Employee** submits a letter request
+2. **HR team** reviews the request (visible in HR Dashboard > Pending Letters)
+3. HR either **approves** (generating the letter) or **rejects** (with a reason)
+4. Employee receives the generated letter or rejection notification
+
+> **Tip:** Administrators can view all pending letter requests from the **HR Dashboard > Pending Letters** tab, with filtering by category.

package/lib/templates/content/docs/hrm/hrm-overview.md

@@ -0,0 +1,50 @@
+---
+id: hrm-overview
+title: Human Resource Management (HRM)
+sidebar_label: HRM Overview
+---
+
+## HRM Module
+
+Clockbook's **HRM** (Human Resource Management) module provides a comprehensive suite of tools for managing your organization's workforce — from employee profiles and attendance to onboarding, travel, leave management, HR letters, and offboarding.
+
+### Accessing HRM
+
+Click **HRM** in the left sidebar to expand the HRM menu. The module contains the following sub-sections:
+
+![HRM Sidebar Navigation](/static/img/hrm/hrm-sidebar-expanded.png)
+
+| Sub-module | Description |
+|------------|-------------|
+| [**My Space**](/docs/hrm/my-space) | Personal employee profile, check-in/check-out, shift info |
+| [**HR Dashboard**](/docs/hrm/dashboard) | Organization-wide metrics, approvals, analytics |
+| [**Onboarding**](/docs/hrm/onboarding) | Candidate and employee onboarding flows, tasks |
+| [**Offboarding**](/docs/hrm/offboarding) | Resignation and exit request management |
+| [**HR Letters**](/docs/hrm/hr-letters) | Address proof, bonafide, experience letter requests |
+| [**Travel**](/docs/hrm/travel) | Travel request and expense management |
+| [**Time Off / Leave**](/docs/hrm/leave) | Leave requests, timeline, balance tracking |
+| [**Members & Invites**](/docs/hrm/members) | Organization members and invitation management |
+| [**Settings**](/docs/hrm/settings) | Permissions and user access control |
+
+---
+
+### Key Features at a Glance
+
+- **Self-service employee portal** — Employees manage their own profiles, attendance, and requests
+- **Check-in / Check-out** — Built-in attendance tracking integrated with the Time Tracker
+- **Approval workflows** — Travel requests, HR letters, leave requests, and offboarding all follow structured approval processes
+- **Role-based permissions** — Granular control over who can view, create, edit, and manage HR data
+- **Onboarding automation** — Define step-by-step flows for candidates and new employees
+- **HR Dashboard** — Real-time organization metrics with trend analytics
+- **Leave management** — Track time-off requests, view team timelines, and monitor balances
+
+---
+
+### How HRM Works with Other Modules
+
+The HRM module integrates with several other Clockbook features:
+
+- **Time Tracker** — The Check-in/Check-out clock in My Space uses the same timer as the [Time Tracker](/docs/timetracking) module
+- **Timesheet** — Time Logs in My Space links directly to the Timesheet Management page
+- **Members** — The organization's member list and invitation system supports HRM employee management
+- **Dashboard** — HR Dashboard approval categories track requests across travel, letters, onboarding, and more

package/lib/templates/content/docs/hrm/leave.md

@@ -0,0 +1,85 @@
+---
+id: hrm-leave
+title: Time Off / Leave Management
+sidebar_label: Time Off / Leave
+---
+
+## Time Off / Leave Management
+
+**Time Off** is accessible under **Time Tracker > Time Off** in the sidebar, and integrates with the HRM module for leave tracking and approvals. Navigate to `/time-tracker/timeoff` to access it.
+
+![Time Off - Requests](/static/img/hrm/timeoff-requests.png)
+
+---
+
+### Time Off Tabs
+
+The Time Off page has three main views:
+
+---
+
+### Requests
+
+The **Requests** tab is the default view where you can:
+
+- View your submitted leave requests and their statuses
+- Create new time-off requests
+- See your request history
+
+---
+
+### Timeline
+
+![Time Off Timeline](/static/img/hrm/timeoff-timeline.png)
+
+The **Timeline** tab provides a visual calendar view of time off across your team:
+
+- **Date range selector** — Pick Start Date and End Date to control the view range
+- **View modes** — Toggle between **Week**, **Month**, and **Year** views
+- **Today button** — Jump to the current date
+- **Team Members** — Shows each team member as a row with their leave blocks plotted on the calendar
+- **Legend:**
+  - **Approved Leave** — Confirmed time off (shown in one color)
+  - **Pending Leave** — Requests awaiting approval (shown in a different color)
+  - **Today** marker — Highlights the current date
+
+This view is especially useful for managers planning team capacity and avoiding scheduling conflicts.
+
+---
+
+### Balance
+
+![Time Off Balance](/static/img/hrm/timeoff-balance.png)
+
+The **Balance** tab shows remaining leave balances:
+
+- **Team Member selector** — Choose a specific team member to view their balance
+- **Filter by Policy** — Optionally filter by leave policy type
+- **Balance data** — Shows allocated, used, and remaining leave for each policy
+
+To check a team member's balance:
+
+1. Navigate to **Time Tracker > Time Off > Balance**
+2. Select a team member from the dropdown
+3. Optionally filter by policy
+4. View their current balance breakdown
+
+---
+
+### Leave Approval Categories
+
+Leave requests flow through the organization's approval process. In the **HR Dashboard**, leave requests appear under:
+
+- **Pending Approvals** tab with the **LEAVE REQUEST** category filter
+- Managers can approve or reject leave requests from the dashboard
+
+---
+
+### Integration with HRM
+
+The Time Off module connects with HRM in several ways:
+
+- **Employee profile** — Leave balances are tied to each employee's HRM profile
+- **Attendance tracking** — Approved leave automatically reflects in attendance records
+- **HR Dashboard** — Leave statistics appear in the "On Leave" metric on the dashboard overview
+- **Approval workflow** — Leave requests follow the same approval chain defined in the organization hierarchy (Reporting Manager)

package/lib/templates/content/docs/hrm/members.md

@@ -0,0 +1,79 @@
+---
+id: hrm-members
+title: Members & Invitations
+sidebar_label: Members & Invites
+---
+
+## Members & Invitations
+
+The **Members** page manages your organization's users and invitations. Access it via the **Members** item in the sidebar, or navigate to `/members`.
+
+![Members List](/static/img/hrm/members-list.png)
+
+---
+
+### Members Tab
+
+The **Members** tab (default view) shows:
+
+- **Members List** — All current members of the organization
+- Each member's profile, role, and status
+- Options to manage member settings and permissions
+
+---
+
+### Invites Tab
+
+![Invites](/static/img/hrm/members-invites.png)
+
+The **Invites** tab manages pending invitations:
+
+- View all sent invitations and their statuses
+- Track who has accepted, who is pending, and any expired invitations
+
+---
+
+### Inviting New Members
+
+To invite a new team member to your organization:
+
+1. Navigate to **Members** in the sidebar
+2. Switch to the **Invites** tab
+3. Use the invite form to add the new member's email address
+4. Select a role for the invited member
+5. Send the invitation
+
+The invited person will receive an email with instructions to join the organization.
+
+---
+
+### Member Roles
+
+Members can be assigned roles that determine their permissions across the platform:
+
+| Role | Description |
+|------|-------------|
+| Admin | Full access to all organization settings and data |
+| Member | Standard access to assigned modules |
+| Manager | Team management permissions with approval capabilities |
+
+For HRM-specific roles, see [HRM Settings > Permissions](/docs/hrm/settings).
+
+---
+
+### Organization Hierarchy
+
+The organization's hierarchy is defined through the **Reporting Manager** field in each employee's profile ([My Space](/docs/hrm/my-space)). This hierarchy determines:
+
+- **Approval chains** — Who approves travel, leave, and other requests
+- **Team structure** — How teams and departments are organized
+- **Dashboard visibility** — What data managers can see in the HR Dashboard
+
+The Work Information section in My Space includes:
+- **Department** — Organizational department
+- **Role** — Employee's role within the organization
+- **Location** — Office location
+- **Designation** — Job title
+- **Reporting Manager** — Direct supervisor (under Hierarchy Information)
+
+This information, combined with the Members list, effectively defines your organization's hierarchy.

package/lib/templates/content/docs/hrm/my-space.md

@@ -0,0 +1,173 @@
+---
+id: hrm-my-space
+title: My Space — Employee Profile
+sidebar_label: My Space
+---
+
+## My Space
+
+**My Space** is your personal employee hub within the HRM module. Access it via **HRM > My Space** in the sidebar, or navigate to `/hrm/overview`.
+
+![My Space Overview](/static/img/hrm/hrm-overview.png)
+
+---
+
+### Check-in / Check-out
+
+At the top of My Space, the **attendance widget** shows your current status:
+
+- **Status indicator** — Displays "Out" or "In" with a running timer (e.g., "Out 01:44:48")
+- **Check-in / Check-out button** — Click to toggle your attendance. The button label changes based on your current state
+- **Open Time Tracker** — Links to the [Time Tracker timer page](/docs/timetracking). Uses the same active timer as the Time Tracker module
+
+> **Note:** The check-in/check-out clock is shared with the Time Tracker, so starting a timer in either place reflects in both.
+
+---
+
+### Shift Information
+
+Your assigned shift schedule is displayed below the attendance widget:
+
+- **Shift name and hours** — e.g., "General (09:00 AM - 06:00 PM)"
+- **Time zone** — Your configured timezone (e.g., "(GMT+05:30)")
+
+---
+
+### Profile Photo
+
+Upload or update your profile picture:
+
+- Click **Upload photo**
+- Supported formats: **JPG, PNG, GIF, WEBP**
+- Maximum file size: **5 MB**
+
+---
+
+### About & Tags
+
+- **About** — Click the edit icon to add a short bio or description. Colleagues can see this on your profile.
+- **Tags** — Click the **+** icon to add skills, interests, or expertise tags to your profile.
+
+---
+
+### Profile Information Sections
+
+My Space organizes your employee data into several sections:
+
+#### Basic Information
+
+| Field | Description |
+|-------|-------------|
+| Employee ID | Your unique employee identifier |
+| Nick name | Optional display name |
+| First Name | Legal first name |
+| Last Name | Legal last name |
+| Email address | Work email |
+
+#### Personal Details
+
+| Field | Description |
+|-------|-------------|
+| Date of Birth | Your date of birth |
+| Ask me about / Expertise | Areas colleagues can consult you on |
+| Age | Auto-calculated from DOB |
+| Gender | Gender identity |
+| Marital Status | Marital status |
+| About Me | Extended personal description |
+
+#### Identity Information
+
+Sensitive identification fields for HR records:
+
+| Field | Description |
+|-------|-------------|
+| UAN | Universal Account Number |
+| PAN | Permanent Account Number |
+| Aadhaar | Aadhaar identification number |
+
+#### Contact Details
+
+| Field | Description |
+|-------|-------------|
+| Work Phone Number | Office phone |
+| Personal Mobile Number | Mobile number |
+| Extension | Phone extension |
+| Personal Email Address | Non-work email |
+| Seating Location | Desk / seat location |
+| Tags | Contact-related tags |
+| Present Address | Current residential address |
+| Permanent Address | Permanent address |
+
+#### Work Information
+
+| Field | Description |
+|-------|-------------|
+| Department | Your department |
+| Role | Organizational role (e.g., Admin) |
+| Location | Office / site location |
+| Employment Type | Full-time, Part-time, Contract, etc. |
+| Designation | Job title / designation |
+| Employee Status | Active, Inactive, etc. |
+| Source of Hire | Recruitment channel |
+| Date of Joining | Start date |
+| Current Experience | Tenure at this organization |
+| Total Experience | Overall career experience |
+
+#### Hierarchy Information
+
+- **Reporting Manager** — Your direct supervisor in the organization hierarchy. This determines approval chains for travel, leave, and other requests.
+
+---
+
+### Work Experience
+
+A table listing your prior employment:
+
+| Column | Description |
+|--------|-------------|
+| Company Name | Previous employer |
+| Job Title | Role held |
+| From Date | Employment start date |
+| To Date | Employment end date |
+| Job Description | Key responsibilities |
+| Relevant | Whether relevant to current role |
+
+---
+
+### Education Details
+
+| Column | Description |
+|--------|-------------|
+| Institute Name | School / University |
+| Degree / Diploma | Qualification type |
+| Specialization | Field of study |
+| Date of Completion | Graduation date |
+
+---
+
+### Dependent Details
+
+| Column | Description |
+|--------|-------------|
+| Name | Dependent's name |
+| Relationship | Relation to employee |
+| Date of Birth | Dependent's DOB |
+
+---
+
+### Profile Tabs
+
+My Space provides navigation tabs at the top of the page:
+
+| Tab | Description |
+|-----|-------------|
+| **Profile** | Main profile view (default) — all sections described above |
+| **Attendance** | View your attendance records and history |
+| **Time Logs** | Opens the [Timesheet Management](/docs/timetracking) page to view and edit timesheets |
+
+![Timesheet from HRM](/static/img/hrm/hrm-overview-time-logs.png)
+
+Additionally, the top of My Space shows quick links:
+
+- **Activities** — View recent activity feed
+- **Feeds** — View organization-wide feeds

package/lib/templates/content/docs/hrm/offboarding.md

@@ -0,0 +1,63 @@
+---
+id: hrm-offboarding
+title: Offboarding / Exit Request
+sidebar_label: Offboarding
+---
+
+## Offboarding
+
+The **Offboarding** module (`HRM > Offboarding`) manages the employee exit process through structured resignation requests. Navigate to `/hrm/offboarding` to access it.
+
+![Offboarding / Exit Request](/static/img/hrm/offboarding-full.png)
+
+---
+
+### How Offboarding Works
+
+The page is titled **Exit Request** and provides a guided, transparent process for submitting and managing resignations.
+
+When you open the Offboarding page, you'll see:
+
+1. **Confirmation message** — "Before you proceed, are you certain you want to submit your resignation?"
+2. **Value statement** — The system acknowledges your contributions and encourages discussing concerns before proceeding
+3. **Process explanation** — Submitting an exit request formally starts the offboarding workflow in your organization
+4. **HR notification** — Your request will be shared with your HR team and reporting manager for review
+
+---
+
+### Submitting a Resignation Request
+
+1. Navigate to **HRM > Offboarding**
+2. Read the confirmation information carefully
+3. Click **Add Resignation Request**
+4. Fill in the required details (reason, preferred last working day, etc.)
+5. Submit the request
+
+> **Note:** Once submitted, the request enters the organization's approval workflow. You'll be able to track its progress on this page.
+
+---
+
+### Request Tracking
+
+The offboarding page displays request information in columns:
+
+| Column | Description |
+|--------|-------------|
+| **LWD** | Last Working Day — the proposed or approved final date of employment |
+| **HR** | HR contact / status — indicates the HR representative handling the request |
+
+---
+
+### Offboarding Workflow
+
+After submission, the exit request typically follows these steps:
+
+1. **Employee submits** resignation request with preferred last working day
+2. **Reporting Manager** reviews and acknowledges the request
+3. **HR Team** reviews and initiates the formal offboarding process
+4. **Exit interview** may be scheduled
+5. **Knowledge transfer** and handover tasks are assigned
+6. **Final settlement** and documentation is processed
+7. **Account deactivation** on the last working day
+
+Administrators can view all pending offboarding requests in the **HR Dashboard > Pending Offboarding** tab.