@sparkerp/plugin-sdk 0.1.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/bundle/blocks.json +169 -0
  2. package/bundle/catalog.json +614 -5
  3. package/bundle/docs/applications/hcm/admin-access-policies.md +38 -0
  4. package/bundle/docs/applications/hcm/admin-approval-hierarchies.md +33 -0
  5. package/bundle/docs/applications/hcm/admin-data-transfer.md +40 -0
  6. package/bundle/docs/applications/hcm/admin-hcm-users.md +35 -0
  7. package/bundle/docs/applications/hcm/admin-logs.md +57 -0
  8. package/bundle/docs/applications/hcm/admin-permissions-catalog.md +64 -0
  9. package/bundle/docs/applications/hcm/ai-intelligence-overview.md +37 -0
  10. package/bundle/docs/applications/hcm/ai-intelligence-people-risk.md +33 -0
  11. package/bundle/docs/applications/hcm/ai-intelligence-recruitment.md +37 -0
  12. package/bundle/docs/applications/hcm/ai-intelligence-tools.md +39 -0
  13. package/bundle/docs/applications/hcm/analytics-operations.md +31 -0
  14. package/bundle/docs/applications/hcm/analytics-overview.md +31 -0
  15. package/bundle/docs/applications/hcm/analytics-people.md +36 -0
  16. package/bundle/docs/applications/hcm/analytics-tools.md +35 -0
  17. package/bundle/docs/applications/hcm/assets-audits.md +30 -0
  18. package/bundle/docs/applications/hcm/assets-custody.md +36 -0
  19. package/bundle/docs/applications/hcm/assets-inventory.md +34 -0
  20. package/bundle/docs/applications/hcm/assets-maintenance.md +25 -0
  21. package/bundle/docs/applications/hcm/assets-software-licenses.md +27 -0
  22. package/bundle/docs/applications/hcm/attendance-core.md +46 -0
  23. package/bundle/docs/applications/hcm/attendance-exceptions.md +33 -0
  24. package/bundle/docs/applications/hcm/attendance-location.md +25 -0
  25. package/bundle/docs/applications/hcm/attendance-policies.md +23 -0
  26. package/bundle/docs/applications/hcm/attendance-reports.md +20 -0
  27. package/bundle/docs/applications/hcm/benefits-allowances.md +39 -0
  28. package/bundle/docs/applications/hcm/benefits-analytics.md +25 -0
  29. package/bundle/docs/applications/hcm/benefits-employee-processes.md +44 -0
  30. package/bundle/docs/applications/hcm/benefits-plans.md +60 -0
  31. package/bundle/docs/applications/hcm/communications-announcements.md +31 -0
  32. package/bundle/docs/applications/hcm/communications-history.md +23 -0
  33. package/bundle/docs/applications/hcm/communications-notifications.md +31 -0
  34. package/bundle/docs/applications/hcm/communications-templates.md +35 -0
  35. package/bundle/docs/applications/hcm/compensation-allowances-benefits.md +44 -0
  36. package/bundle/docs/applications/hcm/compensation-analytics.md +30 -0
  37. package/bundle/docs/applications/hcm/compensation-bonus-incentive.md +35 -0
  38. package/bundle/docs/applications/hcm/compensation-cycles.md +49 -0
  39. package/bundle/docs/applications/hcm/compensation-equity.md +36 -0
  40. package/bundle/docs/applications/hcm/compensation-salary.md +47 -0
  41. package/bundle/docs/applications/hcm/compliance-analytics.md +25 -0
  42. package/bundle/docs/applications/hcm/compliance-audits-calendar.md +52 -0
  43. package/bundle/docs/applications/hcm/compliance-employee-tracking.md +41 -0
  44. package/bundle/docs/applications/hcm/compliance-regulatory.md +31 -0
  45. package/bundle/docs/applications/hcm/country-packs-admin.md +33 -0
  46. package/bundle/docs/applications/hcm/country-packs-compliance.md +31 -0
  47. package/bundle/docs/applications/hcm/country-packs-localization.md +37 -0
  48. package/bundle/docs/applications/hcm/country-packs.md +102 -0
  49. package/bundle/docs/applications/hcm/dashboard.md +38 -0
  50. package/bundle/docs/applications/hcm/designations.md +32 -0
  51. package/bundle/docs/applications/hcm/emp-documents-analytics.md +27 -0
  52. package/bundle/docs/applications/hcm/emp-documents-core.md +33 -0
  53. package/bundle/docs/applications/hcm/emp-documents-letters.md +40 -0
  54. package/bundle/docs/applications/hcm/emp-documents-signatures.md +24 -0
  55. package/bundle/docs/applications/hcm/emp-documents-workflow.md +32 -0
  56. package/bundle/docs/applications/hcm/employee-directory.md +55 -0
  57. package/bundle/docs/applications/hcm/employee-documents.md +51 -0
  58. package/bundle/docs/applications/hcm/employee-info-background.md +41 -0
  59. package/bundle/docs/applications/hcm/employee-info-core.md +32 -0
  60. package/bundle/docs/applications/hcm/employee-info-documents.md +31 -0
  61. package/bundle/docs/applications/hcm/employee-info-other.md +21 -0
  62. package/bundle/docs/applications/hcm/employee-movements.md +46 -0
  63. package/bundle/docs/applications/hcm/employee-reference-data.md +40 -0
  64. package/bundle/docs/applications/hcm/employee-relations-analytics.md +23 -0
  65. package/bundle/docs/applications/hcm/employee-relations-cases.md +26 -0
  66. package/bundle/docs/applications/hcm/employee-relations-conflicts-feedback.md +25 -0
  67. package/bundle/docs/applications/hcm/employee-relations-processes.md +34 -0
  68. package/bundle/docs/applications/hcm/employee-services-daily.md +32 -0
  69. package/bundle/docs/applications/hcm/employee-services-manager.md +21 -0
  70. package/bundle/docs/applications/hcm/employee-services-more.md +41 -0
  71. package/bundle/docs/applications/hcm/employee-services-overview.md +43 -0
  72. package/bundle/docs/applications/hcm/expenses-analytics.md +26 -0
  73. package/bundle/docs/applications/hcm/expenses-claims.md +47 -0
  74. package/bundle/docs/applications/hcm/expenses-self-service.md +30 -0
  75. package/bundle/docs/applications/hcm/expenses-setup.md +43 -0
  76. package/bundle/docs/applications/hcm/health-safety-analytics.md +26 -0
  77. package/bundle/docs/applications/hcm/health-safety-incidents.md +44 -0
  78. package/bundle/docs/applications/hcm/health-safety-medical.md +25 -0
  79. package/bundle/docs/applications/hcm/health-safety-training.md +29 -0
  80. package/bundle/docs/applications/hcm/helpdesk.md +28 -0
  81. package/bundle/docs/applications/hcm/holiday-calendar.md +69 -0
  82. package/bundle/docs/applications/hcm/hr-policies.md +64 -0
  83. package/bundle/docs/applications/hcm/hr-settings.md +98 -0
  84. package/bundle/docs/applications/hcm/index.md +272 -0
  85. package/bundle/docs/applications/hcm/industry-it-software.md +52 -0
  86. package/bundle/docs/applications/hcm/job-classifications.md +48 -0
  87. package/bundle/docs/applications/hcm/learning-analytics.md +21 -0
  88. package/bundle/docs/applications/hcm/learning-assessments.md +22 -0
  89. package/bundle/docs/applications/hcm/learning-catalog.md +25 -0
  90. package/bundle/docs/applications/hcm/learning-certifications.md +27 -0
  91. package/bundle/docs/applications/hcm/learning-enrollment.md +26 -0
  92. package/bundle/docs/applications/hcm/learning-instructors-providers.md +21 -0
  93. package/bundle/docs/applications/hcm/leave-accrual-and-carryforward.md +30 -0
  94. package/bundle/docs/applications/hcm/leave-balance.md +26 -0
  95. package/bundle/docs/applications/hcm/leave-dashboard-and-reports.md +32 -0
  96. package/bundle/docs/applications/hcm/leave-encashment.md +27 -0
  97. package/bundle/docs/applications/hcm/leave-requests.md +26 -0
  98. package/bundle/docs/applications/hcm/leave-setup.md +30 -0
  99. package/bundle/docs/applications/hcm/leave-team-and-calendar.md +25 -0
  100. package/bundle/docs/applications/hcm/navigation-and-approvals.md +61 -0
  101. package/bundle/docs/applications/hcm/offboarding-and-exit.md +71 -0
  102. package/bundle/docs/applications/hcm/onboarding-documents-verification.md +43 -0
  103. package/bundle/docs/applications/hcm/onboarding-orientation-probation.md +65 -0
  104. package/bundle/docs/applications/hcm/onboarding-overview.md +47 -0
  105. package/bundle/docs/applications/hcm/onboarding-provisioning-assets.md +48 -0
  106. package/bundle/docs/applications/hcm/onboarding-reports.md +38 -0
  107. package/bundle/docs/applications/hcm/onboarding-templates-checklists.md +38 -0
  108. package/bundle/docs/applications/hcm/onboarding-to-confirmation.md +45 -0
  109. package/bundle/docs/applications/hcm/org-structure.md +53 -0
  110. package/bundle/docs/applications/hcm/org-units.md +86 -0
  111. package/bundle/docs/applications/hcm/organizations.md +81 -0
  112. package/bundle/docs/applications/hcm/payroll-analytics.md +31 -0
  113. package/bundle/docs/applications/hcm/payroll-post-run.md +40 -0
  114. package/bundle/docs/applications/hcm/payroll-runs.md +30 -0
  115. package/bundle/docs/applications/hcm/payroll-setup.md +38 -0
  116. package/bundle/docs/applications/hcm/payroll-tax.md +21 -0
  117. package/bundle/docs/applications/hcm/payroll-transactions.md +43 -0
  118. package/bundle/docs/applications/hcm/performance-analytics.md +23 -0
  119. package/bundle/docs/applications/hcm/performance-appraisals.md +50 -0
  120. package/bundle/docs/applications/hcm/performance-continuous-feedback.md +23 -0
  121. package/bundle/docs/applications/hcm/performance-cycles-and-goals.md +54 -0
  122. package/bundle/docs/applications/hcm/performance-okrs.md +33 -0
  123. package/bundle/docs/applications/hcm/performance-pips.md +29 -0
  124. package/bundle/docs/applications/hcm/performance-ratings.md +25 -0
  125. package/bundle/docs/applications/hcm/positions.md +67 -0
  126. package/bundle/docs/applications/hcm/recruitment-agencies-and-sources.md +26 -0
  127. package/bundle/docs/applications/hcm/recruitment-analytics.md +25 -0
  128. package/bundle/docs/applications/hcm/recruitment-candidates.md +33 -0
  129. package/bundle/docs/applications/hcm/recruitment-offers.md +32 -0
  130. package/bundle/docs/applications/hcm/recruitment-pipeline.md +46 -0
  131. package/bundle/docs/applications/hcm/recruitment-requisitions-and-openings.md +33 -0
  132. package/bundle/docs/applications/hcm/roles-permissions.md +129 -0
  133. package/bundle/docs/applications/hcm/separation-clearance.md +33 -0
  134. package/bundle/docs/applications/hcm/separation-documents.md +28 -0
  135. package/bundle/docs/applications/hcm/separation-final-settlement.md +24 -0
  136. package/bundle/docs/applications/hcm/separation-reports.md +23 -0
  137. package/bundle/docs/applications/hcm/separation-resignation.md +43 -0
  138. package/bundle/docs/applications/hcm/settings-extensibility.md +31 -0
  139. package/bundle/docs/applications/hcm/settings-general.md +29 -0
  140. package/bundle/docs/applications/hcm/settings-integrations.md +14 -0
  141. package/bundle/docs/applications/hcm/settings-module-defaults.md +41 -0
  142. package/bundle/docs/applications/hcm/settings-process.md +28 -0
  143. package/bundle/docs/applications/hcm/shift-scheduling.md +33 -0
  144. package/bundle/docs/applications/hcm/talent-analytics.md +26 -0
  145. package/bundle/docs/applications/hcm/talent-career.md +31 -0
  146. package/bundle/docs/applications/hcm/talent-competencies-skills.md +30 -0
  147. package/bundle/docs/applications/hcm/talent-profiles.md +40 -0
  148. package/bundle/docs/applications/hcm/talent-succession.md +42 -0
  149. package/bundle/docs/applications/hcm/teams-and-tags.md +46 -0
  150. package/bundle/docs/applications/hcm/timesheets.md +33 -0
  151. package/bundle/docs/applications/hcm/travel-advances-expenses.md +34 -0
  152. package/bundle/docs/applications/hcm/travel-analytics.md +28 -0
  153. package/bundle/docs/applications/hcm/travel-bookings.md +35 -0
  154. package/bundle/docs/applications/hcm/travel-requests.md +38 -0
  155. package/bundle/docs/applications/hcm/workforce-org-design.md +22 -0
  156. package/bundle/docs/applications/hcm/workforce-planning-analytics.md +26 -0
  157. package/bundle/docs/applications/hcm/workforce-planning-core.md +36 -0
  158. package/bundle/docs/applications/hcm/workforce-planning-scenarios.md +29 -0
  159. package/bundle/docs/guides/add-app-owned-roles-and-permissions.md +144 -0
  160. package/bundle/docs/guides/extend-a-shipped-application.md +132 -0
  161. package/bundle/docs/guides/index.md +2 -0
  162. package/bundle/docs/reference/entity-aggregation-config.md +1 -1
  163. package/bundle/docs/reference/entity-document-generator-config.md +1 -1
  164. package/bundle/docs/tutorial/01-create-the-plugin.md +7 -1
  165. package/bundle/docs/tutorial/07-return-due-reminder-job.md +28 -5
  166. package/bundle/docs/tutorial/08-menus-i18n-publish.md +5 -5
  167. package/bundle/manifest.json +4 -4
  168. package/bundle/schemas/page.schema.json +13 -0
  169. package/bundle/schemas/plugin-manifest.schema.json +13 -0
  170. package/bundle/validators/block-engine.mjs +167 -7
  171. package/bundle/validators/page-engine.mjs +226 -21
  172. package/erp-cli/authoring-root.mjs +12 -1
  173. package/erp-cli/erp.mjs +334 -4
  174. package/package.json +1 -1
@@ -0,0 +1,272 @@
1
+ ---
2
+ title: HCM — user guide
3
+ audience: tenant
4
+ ---
5
+
6
+ # HCM — user guide
7
+
8
+ Real, screen-by-screen documentation for the shipped HCM application, for
9
+ the people who use it — HR admins, managers, and employees — not for
10
+ plugin developers building or extending it. 76 HCM modules ship today;
11
+ this guide is filled in module by module, most-used first.
12
+
13
+ **Building or extending on top of HCM instead?** See
14
+ [Extend a shipped application](../../guides/extend-a-shipped-application.md)
15
+ — it uses HCM as its worked example: when to reach for no-code Custom
16
+ Fields vs. a companion plugin vs. a workflow/business rule, and a real,
17
+ copy-pasteable example reading HCM's own `employee` table through a Data
18
+ View, without touching HCM's shipped code.
19
+
20
+ ## Foundation (used across every module)
21
+
22
+ - [HCM Dashboard](./dashboard.md)
23
+ - [HCM Navigation & Approvals](./navigation-and-approvals.md)
24
+ - [HCM Roles & Permissions](./roles-permissions.md)
25
+ - [HR Settings](./hr-settings.md)
26
+ - [HR Policies](./hr-policies.md)
27
+ - [Holiday Calendar](./holiday-calendar.md)
28
+
29
+ ## Employee (`hcm-employee`)
30
+
31
+ - [Employee Directory & Rosters](./employee-directory.md)
32
+ - [Employee Profile](./employee-profile.md)
33
+ - [Reporting Structure & Organization Structure](./org-structure.md)
34
+ - [Positions](./positions.md)
35
+ - [Employee Categories, Employment Types & Skills](./employee-reference-data.md)
36
+ - [Employee Documents](./employee-documents.md)
37
+ - [Onboarding — Prejoining, Joining & Confirmation](./onboarding-to-confirmation.md)
38
+ - [Promotions, Demotions, Transfers & Internal Movement](./employee-movements.md)
39
+ - [Resignation, Retirement, Termination & Exit](./offboarding-and-exit.md)
40
+
41
+ ## Attendance (`hcm-attendance`)
42
+
43
+ - [Attendance — Dashboard, Daily Attendance, Register, Biometric & Devices](./attendance-core.md)
44
+ - [Late & Early Records, Overtime & Regularization](./attendance-exceptions.md)
45
+ - [Field Work & Work From Home](./attendance-location.md)
46
+ - [Attendance Policies](./attendance-policies.md)
47
+ - [Attendance Reports](./attendance-reports.md)
48
+
49
+ ## Leave (`hcm-leave`)
50
+
51
+ - [Leave Types & Leave Policies](./leave-setup.md)
52
+ - [Leave Requests](./leave-requests.md)
53
+ - [Leave Balance](./leave-balance.md)
54
+ - [Leave Accrual & Carry Forward](./leave-accrual-and-carryforward.md)
55
+ - [Leave Encashment](./leave-encashment.md)
56
+ - [Team Leave & Leave Calendar](./leave-team-and-calendar.md)
57
+ - [Leave Dashboard & Reports](./leave-dashboard-and-reports.md)
58
+
59
+ ## Payroll (`hcm-payroll`)
60
+
61
+ - [Salary Components, Salary Structures, Earnings & Deductions](./payroll-setup.md)
62
+ - [Employee Compensation, Bonuses, Incentives, Overtime & Adjustments](./payroll-transactions.md)
63
+ - [Payroll Runs](./payroll-runs.md)
64
+ - [Payslips, Bank Transfer, Payroll Accounting & Lock](./payroll-post-run.md)
65
+ - [Tax Management](./payroll-tax.md)
66
+ - [Payroll Dashboard, Reports & Country Rollup](./payroll-analytics.md)
67
+
68
+ ## Recruitment (`hcm-recruitment`)
69
+
70
+ - [Job Requisitions, Job Openings & Careers](./recruitment-requisitions-and-openings.md)
71
+ - [Candidates, Candidate Pools & Resumes](./recruitment-candidates.md)
72
+ - [Applications, Screening, Interviews & Assessments](./recruitment-pipeline.md)
73
+ - [Offers, Offer Approvals & Background Verification](./recruitment-offers.md)
74
+ - [Recruitment Agencies & Sources](./recruitment-agencies-and-sources.md)
75
+ - [Recruitment Dashboard & Reports](./recruitment-analytics.md)
76
+
77
+ ## Organization (`hcm-organization`)
78
+
79
+ - [Organizations](./organizations.md)
80
+ - [Org Units, Legal Entities, Business Units, Divisions, Branches, Departments, Locations, Cost Centers & Profit Centers](./org-units.md)
81
+ - [Job Classifications, Job Families, Job Levels & Job Grades](./job-classifications.md)
82
+ - [Designations](./designations.md)
83
+ - [Teams & Organization Tags](./teams-and-tags.md)
84
+
85
+ ## Compensation (`hcm-compensation`)
86
+
87
+ - [Compensation Cycles](./compensation-cycles.md)
88
+ - [Salary Planning, Salary Review & Merit Increase](./compensation-salary.md)
89
+ - [Allowances & Benefits](./compensation-allowances-benefits.md)
90
+ - [Bonus Plans & Incentive Plans](./compensation-bonus-incentive.md)
91
+ - [Equity & Stock](./compensation-equity.md)
92
+ - [Compensation Dashboard & Reports](./compensation-analytics.md)
93
+
94
+ ## Performance (`hcm-performance`)
95
+
96
+ - [Performance Cycles, Goals, Goal Plans & KPIs](./performance-cycles-and-goals.md)
97
+ - [Appraisals, Self Assessment, Manager Assessment & 360 Feedback](./performance-appraisals.md)
98
+ - [Continuous Feedback](./performance-continuous-feedback.md)
99
+ - [OKRs](./performance-okrs.md)
100
+ - [Ratings](./performance-ratings.md)
101
+ - [PIPs (Performance Improvement Plans)](./performance-pips.md)
102
+ - [Performance Dashboard & Reports](./performance-analytics.md)
103
+
104
+ ## Benefits (`hcm-benefits`)
105
+
106
+ - [Benefit Plans, Health Benefits, Insurance & Retirement Benefits](./benefits-plans.md)
107
+ - [Employee Enrollment, Benefit Claims & Reimbursements](./benefits-employee-processes.md)
108
+ - [Allowances (Benefits)](./benefits-allowances.md)
109
+ - [Benefits Dashboard & Reports](./benefits-analytics.md)
110
+
111
+ ## Onboarding (`hcm-onboarding`)
112
+
113
+ - [New Joiners & Onboarding Dashboard](./onboarding-overview.md)
114
+ - [Onboarding Templates & Checklists](./onboarding-templates-checklists.md)
115
+ - [Document Collection & Employee Verification](./onboarding-documents-verification.md)
116
+ - [Account Provisioning & Equipment/Assets](./onboarding-provisioning-assets.md)
117
+ - [Orientation & Probation](./onboarding-orientation-probation.md)
118
+ - [Onboarding Reports](./onboarding-reports.md)
119
+
120
+ ## Compliance (`hcm-compliance`)
121
+
122
+ - [Statutory Rules & Labor Law](./compliance-regulatory.md)
123
+ - [Certifications, Policy Acknowledgement & Compliance Documents](./compliance-employee-tracking.md)
124
+ - [Audit Management & Compliance Calendar](./compliance-audits-calendar.md)
125
+ - [Compliance Dashboard & Reports](./compliance-analytics.md)
126
+
127
+ ## Assets (`hcm-assets`)
128
+
129
+ - [Asset Inventory & Asset Categories](./assets-inventory.md)
130
+ - [Asset Allocation & Returns](./assets-custody.md)
131
+ - [Asset Maintenance](./assets-maintenance.md)
132
+ - [Asset Audits](./assets-audits.md)
133
+ - [Software Licenses](./assets-software-licenses.md)
134
+
135
+ ## Communications (`hcm-communications`)
136
+
137
+ - [Announcements & Employee Communications](./communications-announcements.md)
138
+ - [Email Templates, SMS Templates & Push Notifications](./communications-templates.md)
139
+ - [Notifications](./communications-notifications.md)
140
+ - [Communication History](./communications-history.md)
141
+
142
+ ## Expenses (`hcm-expenses`)
143
+
144
+ - [Expense Categories & Expense Policies](./expenses-setup.md)
145
+ - [Expense Claims & Advances](./expenses-claims.md)
146
+ - [My Expenses, Team Expenses & Approvals](./expenses-self-service.md)
147
+ - [Expense Dashboard & Reports](./expenses-analytics.md)
148
+
149
+ ## Travel (`hcm-travel`)
150
+
151
+ - [Travel Policies, Travel Requests & Travel Approval](./travel-requests.md)
152
+ - [Travel Bookings & Accommodation](./travel-bookings.md)
153
+ - [Travel Advances & Travel Expenses](./travel-advances-expenses.md)
154
+ - [Travel Dashboard & Reports](./travel-analytics.md)
155
+
156
+ ## Health & Safety (`hcm-health-safety`)
157
+
158
+ - [Workplace Safety, Safety Incidents & Workplace Accidents](./health-safety-incidents.md)
159
+ - [Safety Training & Occupational Health](./health-safety-training.md)
160
+ - [Medical Exams & Medical Records](./health-safety-medical.md)
161
+ - [Health & Safety Dashboard & Reports](./health-safety-analytics.md)
162
+
163
+ ## Employee Relations (`hcm-employee-relations`)
164
+
165
+ - [Employee Cases & Investigations](./employee-relations-cases.md)
166
+ - [Grievances, Complaints & Disciplinary Actions](./employee-relations-processes.md)
167
+ - [Workplace Conflicts & Employee Feedback](./employee-relations-conflicts-feedback.md)
168
+ - [Employee Relations Dashboard & Case Reports](./employee-relations-analytics.md)
169
+
170
+ ## Employee Services (`hcm-employee-services`)
171
+
172
+ - [Employee Self Service — Overview, Requests & My Profile](./employee-services-overview.md)
173
+ - [My Attendance, My Timesheet, My Leave & My Payslips](./employee-services-daily.md)
174
+ - [My Benefits, Documents, Expenses, Goals, Training & Performance](./employee-services-more.md)
175
+ - [Manager Self Service](./employee-services-manager.md)
176
+
177
+ ## Talent (`hcm-talent`)
178
+
179
+ - [Talent Profiles, High Potential Employees & Talent Pools](./talent-profiles.md)
180
+ - [Competencies & Skills](./talent-competencies-skills.md)
181
+ - [Career Development & Career Paths](./talent-career.md)
182
+ - [Succession Planning, Successor Candidates & Talent Reviews](./talent-succession.md)
183
+ - [Talent Dashboard & Reports](./talent-analytics.md)
184
+
185
+ ## Learning (`hcm-learning`)
186
+
187
+ - [Course Catalog, Learning Paths & Training Programs](./learning-catalog.md)
188
+ - [Employee Learning, Training Requests & Training Calendar](./learning-enrollment.md)
189
+ - [Assessments & Quiz](./learning-assessments.md)
190
+ - [Certifications, Competencies & Skill Matrix](./learning-certifications.md)
191
+ - [Instructors & Training Providers](./learning-instructors-providers.md)
192
+ - [Learning Dashboard & Reports](./learning-analytics.md)
193
+
194
+ ## Workforce Planning (`hcm-workforce-planning`)
195
+
196
+ - [Headcount Planning, Demand Forecasting & Budget Planning](./workforce-planning-core.md)
197
+ - [Scenario Planning & Skill Gap Analysis](./workforce-planning-scenarios.md)
198
+ - [Org Design](./workforce-org-design.md)
199
+ - [Workforce Dashboard & Reports](./workforce-planning-analytics.md)
200
+
201
+ ## Separation (`hcm-separation`)
202
+
203
+ - [Resignation & Resignation Approval (Separation module)](./separation-resignation.md)
204
+ - [Clearance, Asset Return & Offboarding Checklist](./separation-clearance.md)
205
+ - [Exit Interviews, Experience Letter & Relieving Letter](./separation-documents.md)
206
+ - [Final Settlement](./separation-final-settlement.md)
207
+ - [Exit Reports](./separation-reports.md)
208
+
209
+ ## Settings Extended (`hcm-settings-extended`)
210
+
211
+ - [General, Organization & Employee Settings](./settings-general.md)
212
+ - [Attendance, Leave, Payroll, Performance, Recruitment & Training Settings](./settings-module-defaults.md)
213
+ - [Approval, Workflow & Notification Settings](./settings-process.md)
214
+ - [Document Settings, Custom Fields, Custom Forms & Numbering Sequences](./settings-extensibility.md)
215
+ - [Integrations](./settings-integrations.md)
216
+
217
+ ## Admin Console (`hcm-admin-console`)
218
+
219
+ - [System Logs, Audit Logs & Activity Logs](./admin-logs.md)
220
+ - [HCM Users](./admin-hcm-users.md)
221
+ - [HCM Permissions Catalog](./admin-permissions-catalog.md)
222
+ - [Access Policies](./admin-access-policies.md)
223
+ - [Approval Hierarchies](./admin-approval-hierarchies.md)
224
+ - [Data Export & Data Import](./admin-data-transfer.md)
225
+
226
+ ## Employee Information (`hcm-employee-information`)
227
+
228
+ - [Personal Information, Employment Details & Bank Accounts](./employee-info-core.md)
229
+ - [Identity Documents, Passport, Visa, Driving License & Document Management](./employee-info-documents.md)
230
+ - [Education, Work Experience, Certifications, Skills & Family Information](./employee-info-background.md)
231
+ - [Emergency Contacts & Tax Information](./employee-info-other.md)
232
+
233
+ ## Employee Documents — full system (`hcm-employee-documents`)
234
+
235
+ - [Employee Documents & Document Types](./emp-documents-core.md)
236
+ - [Document Templates, Requests & Verification Lookup](./emp-documents-workflow.md)
237
+ - [Offer, Salary, Experience Letters, Certificates & Contracts](./emp-documents-letters.md)
238
+ - [Digital Signatures & Signature Providers](./emp-documents-signatures.md)
239
+ - [Document Dashboard, Reports & Expiry](./emp-documents-analytics.md)
240
+
241
+ ## Analytics & Reports (`hcm-analytics-reports`)
242
+
243
+ - [HCM Analytics, Headcount, Attrition & Workforce Analytics](./analytics-overview.md)
244
+ - [Attendance, Leave, Payroll & Compensation Analytics](./analytics-operations.md)
245
+ - [Performance, Recruitment, Training, Productivity & Diversity Analytics](./analytics-people.md)
246
+ - [Workforce Cost & Report Builder](./analytics-tools.md)
247
+
248
+ ## AI & Intelligence (`hcm-ai-intelligence`)
249
+
250
+ - [AI Dashboard, Employee Insights & Performance Insights](./ai-intelligence-overview.md)
251
+ - [Attrition Prediction, Workforce Forecasting & Employee Sentiment](./ai-intelligence-people-risk.md)
252
+ - [Recruitment Intelligence, Candidate Matching & Resume Screening](./ai-intelligence-recruitment.md)
253
+ - [Skills Intelligence, Compensation Intelligence, AI Assistant & Recommendations](./ai-intelligence-tools.md)
254
+
255
+ ## Industry Packs
256
+
257
+ - [IT & Software Industry Pack](./industry-it-software.md)
258
+
259
+ ## Other modules
260
+
261
+ - [HR Helpdesk](./helpdesk.md) (`hcm-helpdesk`)
262
+ - [Timesheets](./timesheets.md) (`hcm-timesheets`)
263
+ - [Shifts, Scheduling & Rosters](./shift-scheduling.md) (`hcm-shift-scheduling`)
264
+
265
+ ## Country Packs (44 packs + `hcm-country-pack-core`)
266
+
267
+ - [Country Packs](./country-packs.md) — how the framework works, using India as the fully-worked real example; applies identically to all 44 packs
268
+ - [Country Pack Admin — Packs Overview, Pack Detail & Rule Builder](./country-packs-admin.md)
269
+ - [Country Pack Compliance Dashboard, Statutory Registrations & Holiday Calendar](./country-packs-compliance.md)
270
+ - [Master Data Formats, FX Rates & Employee Country Documents](./country-packs-localization.md)
271
+
272
+ **This guide now covers all 76 HCM modules.**
@@ -0,0 +1,52 @@
1
+ ---
2
+ title: IT & Software Industry Pack
3
+ audience: tenant
4
+ ---
5
+
6
+ # IT & Software Industry Pack (HCM)
7
+
8
+ This page documents the shipped **IT & Software Industry Pack**
9
+ (`hcm-industry-it-software`) — six screens for IT/software services
10
+ companies specifically (project staffing, bench management, technical
11
+ skills and certifications). Not for plugin developers.
12
+
13
+ ## Bench
14
+
15
+ Track employees currently on the bench (between projects) — Bench Start
16
+ Date, Bench Days, Bench Status, Available Date, Previous Project, and the
17
+ Preferred Role/Location they're looking for next.
18
+
19
+ ## Technology Skills
20
+
21
+ A technology-specific skill catalog — Skill Code/Name, Category,
22
+ Description, Status. Separate from the general
23
+ [Skills catalog](./employee-reference-data.md) elsewhere in HCM — this
24
+ one is scoped to technical/software skills specifically.
25
+
26
+ ## Certifications
27
+
28
+ Track technical certifications per employee — Certification Code/Name,
29
+ Issuing Organization, Credential Number, Issue/Expiry Date, Status.
30
+
31
+ ## Project Staffing
32
+
33
+ Real project resource requirements: Project Code/Name, Project Role,
34
+ Required Headcount, Required Skills, Required Certifications, Minimum
35
+ Experience Years, Location Mode (onsite/remote/hybrid), Allocation
36
+ Percentage, Billable flag, Priority, and Start/End Date.
37
+
38
+ ## Workforce Capacity
39
+
40
+ Track capacity by dimension (e.g. by project, by skill, by location) over
41
+ a period: Available Hours, Allocated Hours, Billable Hours, and Bench
42
+ Hours — a real utilization breakdown, not just a headcount.
43
+
44
+ ## Workforce Dashboard
45
+
46
+ An executive dashboard rolling up the above into one view — real
47
+ utilization, bench, and project-staffing metrics for IT/software
48
+ leadership.
49
+
50
+ ## Related
51
+
52
+ - [Employee Categories, Employment Types & Skills](./employee-reference-data.md)
@@ -0,0 +1,48 @@
1
+ ---
2
+ title: Job Classifications, Job Families, Job Levels & Job Grades
3
+ audience: tenant
4
+ ---
5
+
6
+ # Job Classifications, Job Families, Job Levels & Job Grades (HCM)
7
+
8
+ This page documents the shipped **Job Classifications** screen
9
+ (`hcm-organization`) and three more screens that are all the same
10
+ underlying job-classification data, pre-filtered by type — same pattern
11
+ as [Org Units](./org-units.md). Not for plugin developers.
12
+
13
+ ## Job Classifications (the general screen)
14
+
15
+ ### What you see
16
+
17
+ - **KPI cards**: Total Classifications, Active Classifications, Unique
18
+ Job Families, Mapped Positions.
19
+ - **Search**, plus filters for Job Family, Employment Type (Full Time /
20
+ Part Time / Contract / Intern), and Status (All / Active / Inactive /
21
+ Draft / Pending Approval / Rejected).
22
+ - A grid: Job Title, Job Code, Job Family, Job Function, Job Level, Job
23
+ Grade, Job Category, Management Level, Employment Type, Salary Range,
24
+ Mapped Positions, Status, Effective From, Actions.
25
+
26
+ ### Creating or editing a classification
27
+
28
+ The form covers: Job Title, Job Code, Job Family, Job Function, Job
29
+ Level, Job Grade, Job Category, Management Level, Employment Type,
30
+ Minimum Salary, Maximum Salary, Currency, Required Competencies
31
+ (comma-separated), Key Responsibilities (comma-separated), Description,
32
+ Status, Effective From/To, and an optional **Apply Change On** date if you
33
+ want the change scheduled instead of immediate.
34
+
35
+ ## The typed views
36
+
37
+ - **Job Families** — just the Family classifications.
38
+ - **Job Levels** — just the Level classifications.
39
+ - **Job Grades** — just the Grade classifications.
40
+
41
+ Each is a locked, filtered view of the same underlying table and form —
42
+ set these up first (they're referenced by Job Classifications itself and
43
+ by [Designations](./designations.md)).
44
+
45
+ ## Related
46
+
47
+ - [Designations](./designations.md)
48
+ - [Positions](./positions.md)
@@ -0,0 +1,21 @@
1
+ ---
2
+ title: Learning Dashboard & Reports
3
+ audience: tenant
4
+ ---
5
+
6
+ # Learning Dashboard & Reports (HCM)
7
+
8
+ This page documents two shipped **Learning** analytics screens
9
+ (`hcm-learning`). Not for plugin developers.
10
+
11
+ ## Learning Dashboard
12
+
13
+ Real KPI cards across courses, enrollments, completions, and more.
14
+
15
+ ## Learning Reports
16
+
17
+ A reporting view over the same real Learning data.
18
+
19
+ ## Related
20
+
21
+ - [Course Catalog, Learning Paths & Training Programs](./learning-catalog.md)
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: Assessments & Quiz
3
+ audience: tenant
4
+ ---
5
+
6
+ # Assessments & Quiz (HCM)
7
+
8
+ This page documents two shipped **Learning** screens (`hcm-learning`) —
9
+ the same underlying assessment data, viewed two ways. Not for plugin
10
+ developers.
11
+
12
+ ## Assessments
13
+
14
+ The full assessment record, covering every assessment type.
15
+
16
+ ## Quiz
17
+
18
+ The same underlying data as Assessments, filtered down to just quizzes.
19
+
20
+ ## Related
21
+
22
+ - [Certifications, Competencies & Skill Matrix](./learning-certifications.md)
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: Course Catalog, Learning Paths & Training Programs
3
+ audience: tenant
4
+ ---
5
+
6
+ # Course Catalog, Learning Paths & Training Programs (HCM)
7
+
8
+ This page documents three shipped **Learning** screens (`hcm-learning`)
9
+ covering what's available to learn. Not for plugin developers.
10
+
11
+ ## Course Catalog
12
+
13
+ The master catalog of courses.
14
+
15
+ ## Learning Paths
16
+
17
+ Structured sequences of courses, grouped into a path toward a goal.
18
+
19
+ ## Training Programs
20
+
21
+ Broader training programs, which can bundle courses and paths together.
22
+
23
+ ## Related
24
+
25
+ - [Employee Learning, Training Requests & Training Calendar](./learning-enrollment.md)
@@ -0,0 +1,27 @@
1
+ ---
2
+ title: Certifications, Competencies & Skill Matrix
3
+ audience: tenant
4
+ ---
5
+
6
+ # Certifications, Competencies & Skill Matrix (HCM)
7
+
8
+ This page documents three shipped **Learning** screens (`hcm-learning`).
9
+ Not for plugin developers.
10
+
11
+ ## Certifications
12
+
13
+ Track earned certifications.
14
+
15
+ ## Competencies
16
+
17
+ The skill library / competency framework master this module's other
18
+ screens (like Skill Matrix) reference.
19
+
20
+ ## Skill Matrix
21
+
22
+ An employee skill profile view, showing skill gaps calculated against the
23
+ Competencies framework.
24
+
25
+ ## Related
26
+
27
+ - [Assessments & Quiz](./learning-assessments.md)
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: Employee Learning, Training Requests & Training Calendar
3
+ audience: tenant
4
+ ---
5
+
6
+ # Employee Learning, Training Requests & Training Calendar (HCM)
7
+
8
+ This page documents three shipped **Learning** screens (`hcm-learning`)
9
+ covering the learner's side of things. Not for plugin developers.
10
+
11
+ ## Employee Learning (Assignments)
12
+
13
+ Track what's been assigned to, enrolled in, or completed by each employee.
14
+
15
+ ## Training Requests
16
+
17
+ An employee-initiated request for training — ask for a specific course or
18
+ program.
19
+
20
+ ## Training Calendar
21
+
22
+ A real, genuine calendar of scheduled training events (not a mock).
23
+
24
+ ## Related
25
+
26
+ - [Course Catalog, Learning Paths & Training Programs](./learning-catalog.md)
@@ -0,0 +1,21 @@
1
+ ---
2
+ title: Instructors & Training Providers
3
+ audience: tenant
4
+ ---
5
+
6
+ # Instructors & Training Providers (HCM)
7
+
8
+ This page documents two shipped **Learning** screens (`hcm-learning`). Not
9
+ for plugin developers.
10
+
11
+ ## Instructors
12
+
13
+ Manage the instructors who deliver your training.
14
+
15
+ ## Training Providers
16
+
17
+ Manage external training providers/vendors.
18
+
19
+ ## Related
20
+
21
+ - [Course Catalog, Learning Paths & Training Programs](./learning-catalog.md)
@@ -0,0 +1,30 @@
1
+ ---
2
+ title: Leave Accrual & Carry Forward
3
+ audience: tenant
4
+ ---
5
+
6
+ # Leave Accrual & Carry Forward (HCM)
7
+
8
+ This page documents two shipped **Leave Management** processing screens
9
+ (`hcm-leave`) — periodic, admin-run leave balance updates. Not for plugin
10
+ developers.
11
+
12
+ **Who this is for:** HR admins running these processes (typically monthly
13
+ or yearly, per your leave policies).
14
+
15
+ ## Leave Accrual
16
+
17
+ Run leave accrual for employees — **preview** what would be added to
18
+ balances before you commit it, then post it for real. If you posted an
19
+ accrual by mistake, **Reverse** undoes it. You can also drill into one
20
+ employee's own accrual detail.
21
+
22
+ ## Carry Forward
23
+
24
+ The year-end (or policy-defined period) process of carrying unused leave
25
+ forward into the next period — same preview-then-post-then-reverse-if-needed
26
+ pattern as Accrual, plus its own KPI summary and per-employee detail view.
27
+
28
+ ## Related
29
+
30
+ - [Leave Balance](./leave-balance.md)
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: Leave Balance
3
+ audience: tenant
4
+ ---
5
+
6
+ # Leave Balance (HCM)
7
+
8
+ This page documents the shipped **Leave Balance** screen (`hcm-leave`),
9
+ plus its employee self-service twin. Not for plugin developers.
10
+
11
+ ## Leave Balance (admin/manager)
12
+
13
+ Real leave balances for every employee, with the underlying transaction
14
+ history and any manual adjustments that have been made — the ledger
15
+ Leave Requests and other screens read from.
16
+
17
+ ## My Leave Balance (employee self-service)
18
+
19
+ A simpler, card-per-leave-type view of your own balances — the same real
20
+ data, presented for one person.
21
+
22
+ ## Related
23
+
24
+ - [Leave Types & Leave Policies](./leave-setup.md)
25
+ - [Leave Requests](./leave-requests.md)
26
+ - [Leave Accrual & Carry Forward](./leave-accrual-and-carryforward.md)
@@ -0,0 +1,32 @@
1
+ ---
2
+ title: Leave Dashboard & Reports
3
+ audience: tenant
4
+ ---
5
+
6
+ # Leave Dashboard & Reports (HCM)
7
+
8
+ This page documents the shipped **Leave** analytics/reporting screens
9
+ (`hcm-leave`), plus the employee's own personal dashboard. Not for plugin
10
+ developers.
11
+
12
+ ## Leave Dashboard (org-wide)
13
+
14
+ The HR/admin analytics landing page for Leave Management — a composed
15
+ overview pulling together the module's own KPIs and charts.
16
+
17
+ ## My Leave (employee self-service dashboard)
18
+
19
+ Your own personal leave dashboard — different from My Leave Requests
20
+ (the list + apply-for-leave screen) and My Leave Balance (the balance
21
+ cards) — this is the at-a-glance summary view.
22
+
23
+ ## Leave Reports
24
+
25
+ A report viewer over six predefined report types: Leave Summary, Balance,
26
+ Requests, Carry Forward, Leave Encashment, and Leave Accrual. Read-only —
27
+ pick a report type to view it, not a report builder.
28
+
29
+ ## Related
30
+
31
+ - [Leave Requests](./leave-requests.md)
32
+ - [Leave Balance](./leave-balance.md)
@@ -0,0 +1,27 @@
1
+ ---
2
+ title: Leave Encashment
3
+ audience: tenant
4
+ ---
5
+
6
+ # Leave Encashment (HCM)
7
+
8
+ This page documents the shipped **Leave Encashment** screen (`hcm-leave`)
9
+ — converting unused leave into pay — plus its employee self-service twin.
10
+ Not for plugin developers.
11
+
12
+ ## Leave Encashment (admin/HR)
13
+
14
+ Every encashment request across your company, in the same layout as Leave
15
+ Requests.
16
+
17
+ ## My Leave Encashment (employee self-service)
18
+
19
+ Shows how many of your leave days are eligible to be encashed. Fill in the
20
+ leave type and number of days and you get a live preview of the daily rate
21
+ and gross amount **before** you submit — so you know what you're asking
22
+ for, not just after the fact. Also shows your own past encashment
23
+ requests.
24
+
25
+ ## Related
26
+
27
+ - [Leave Balance](./leave-balance.md)
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: Leave Requests
3
+ audience: tenant
4
+ ---
5
+
6
+ # Leave Requests (HCM)
7
+
8
+ This page documents the shipped **Leave Requests** screen (`hcm-leave`),
9
+ plus its employee self-service twin. Not for plugin developers.
10
+
11
+ ## Leave Requests (admin/manager/HR)
12
+
13
+ Every leave request across your company, checked against each employee's
14
+ real leave balance — this is the first screen in Leave Management to
15
+ actually consume the balance ledger, not just display it.
16
+
17
+ ## My Leave Requests (employee self-service)
18
+
19
+ Your own leave requests — apply for leave and track your requests'
20
+ approval status.
21
+
22
+ ## Related
23
+
24
+ - [Leave Types & Leave Policies](./leave-setup.md)
25
+ - [Leave Balance](./leave-balance.md)
26
+ - [Team Leave & Leave Calendar](./leave-team-and-calendar.md)