@sparkerp/plugin-sdk 0.1.0 → 1.1.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 (176) 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/docs.json +1 -0
  160. package/bundle/docs/guides/add-app-owned-roles-and-permissions.md +144 -0
  161. package/bundle/docs/guides/checkout-an-installed-plugin.md +151 -0
  162. package/bundle/docs/guides/extend-a-shipped-application.md +132 -0
  163. package/bundle/docs/guides/index.md +3 -0
  164. package/bundle/docs/reference/entity-aggregation-config.md +1 -1
  165. package/bundle/docs/reference/entity-document-generator-config.md +1 -1
  166. package/bundle/docs/tutorial/01-create-the-plugin.md +7 -1
  167. package/bundle/docs/tutorial/07-return-due-reminder-job.md +28 -5
  168. package/bundle/docs/tutorial/08-menus-i18n-publish.md +5 -5
  169. package/bundle/manifest.json +4 -4
  170. package/bundle/schemas/page.schema.json +13 -0
  171. package/bundle/schemas/plugin-manifest.schema.json +13 -0
  172. package/bundle/validators/block-engine.mjs +167 -7
  173. package/bundle/validators/page-engine.mjs +226 -21
  174. package/erp-cli/authoring-root.mjs +12 -1
  175. package/erp-cli/erp.mjs +679 -15
  176. package/package.json +1 -1
@@ -0,0 +1,36 @@
1
+ ---
2
+ title: Equity & Stock
3
+ audience: tenant
4
+ ---
5
+
6
+ # Equity & Stock (HCM)
7
+
8
+ This page documents the shipped **Equity/Stock** screen
9
+ (`hcm-compensation`) — tracking equity/stock grants to employees. Not for
10
+ plugin developers.
11
+
12
+ ## Creating a grant
13
+
14
+ **Create Equity Grant** — pick the **Employee**, the **Compensation
15
+ Cycle** it's under, and the **Equity Plan**. Set the **Instrument** type
16
+ (e.g. RSU, stock option), **Grant Date**, and **Units Granted**, then the
17
+ money side: **Grant Price**, **Exercise Price** (for options), and
18
+ **Current Fair Value / Unit** — the grant's value and its current
19
+ estimated value are both calculated from these, not manually entered.
20
+
21
+ Vesting is its own set of fields: **Vesting Start**, **Vesting Period
22
+ (Years)**, and **Cliff (Months)** — the cliff is the initial period before
23
+ any units vest at all, common for a 1-year cliff on a 4-year vest.
24
+ **Expiration Date** caps how long the grant (particularly an option) stays
25
+ exercisable.
26
+
27
+ ## Tracking what's vested
28
+
29
+ The grid shows Units Granted, Vested, and Unvested for every grant, plus
30
+ its Instrument type and Status. The KPI row (Total Grants, Active Grants,
31
+ Pending Approval, Fully Vested) gives you a quick read on how much of your
32
+ equity program has actually vested out.
33
+
34
+ ## Related
35
+
36
+ - [Bonus Plans & Incentive Plans](./compensation-bonus-incentive.md)
@@ -0,0 +1,47 @@
1
+ ---
2
+ title: Salary Planning, Salary Review & Merit Increase
3
+ audience: tenant
4
+ ---
5
+
6
+ # Salary Planning, Salary Review & Merit Increase (HCM)
7
+
8
+ This page documents three shipped **Compensation** screens
9
+ (`hcm-compensation`) covering the core process of changing what someone
10
+ earns, each tied to a [Compensation Cycle](./compensation-cycles.md). Not
11
+ for plugin developers.
12
+
13
+ ## Salary Planning
14
+
15
+ Propose a salary change: pick the **Employee** and the **Compensation
16
+ Cycle** it belongs to, set the **Increase Type**, and enter the **Manager
17
+ Increase %**. The screen shows you the employee's current salary range
18
+ (Min/Mid/Max) alongside what you're proposing, and calculates the
19
+ **Final Increase %** and resulting new salary/compa-ratio for you — you
20
+ don't have to do that math yourself. Set an **Effective Date** for when it
21
+ should take effect.
22
+
23
+ The KPI row (Total Entries, Draft, Approved, Finalized) tells you at a
24
+ glance how much of your planning is actually done vs. still in draft.
25
+
26
+ ## Salary Review
27
+
28
+ The formal review process. Pick the **Employee**, **Compensation Cycle**,
29
+ and **Review Type**, and enter a **Recommended %** increase along with a
30
+ written **Justification** — this isn't optional busywork, it's what your
31
+ approvers see when deciding whether to approve the increase. This goes
32
+ through a real multi-stage approval chain, tracked via the KPI row
33
+ (Total Reviews, Submitted, Approved, Finalized).
34
+
35
+ ## Merit Increase
36
+
37
+ A merit-based increase tied to the employee's actual **Performance
38
+ Rating**. Enter the **Manager %** you're proposing and, if your tenant
39
+ uses one, the **Matrix Recommendation %** (a suggested percentage based on
40
+ rating + position in range) for comparison — plus a **Justification**.
41
+ Goes through its own two-stage approval, tracked via KPIs (Total Merit
42
+ Increases, Submitted, Approved, Finalized).
43
+
44
+ ## Related
45
+
46
+ - [Compensation Cycles](./compensation-cycles.md)
47
+ - [Compensation Dashboard & Reports](./compensation-analytics.md)
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: Compliance Dashboard & Reports
3
+ audience: tenant
4
+ ---
5
+
6
+ # Compliance Dashboard & Reports (HCM)
7
+
8
+ This page documents two shipped **Compliance** analytics screens
9
+ (`hcm-compliance`). Not for plugin developers.
10
+
11
+ ## Compliance Dashboard
12
+
13
+ 8 real KPI cards, one per compliance area: Statutory Rules Active, Labor
14
+ Laws Active, Certifications Verified, Policies Acknowledged, Documents
15
+ Active, Audits Completed, and Calendar Events Completed/Overdue — a
16
+ single screen to check whether anything across your whole compliance
17
+ program needs attention.
18
+
19
+ ## Compliance Reports
20
+
21
+ A reporting view over the same real compliance data.
22
+
23
+ ## Related
24
+
25
+ - [Audit Management & Compliance Calendar](./compliance-audits-calendar.md)
@@ -0,0 +1,52 @@
1
+ ---
2
+ title: Audit Management & Compliance Calendar
3
+ audience: tenant
4
+ ---
5
+
6
+ # Audit Management & Compliance Calendar (HCM)
7
+
8
+ This page documents two shipped **Compliance** screens (`hcm-compliance`).
9
+ Not for plugin developers.
10
+
11
+ ## Audit Management
12
+
13
+ **New Audit** is organized into four sections:
14
+
15
+ - **Audit Identity** — Audit Name, Audit Type (14 real types: Internal,
16
+ External, Compliance, HR, Payroll, Safety, Statutory, Regulatory, Labor
17
+ Law, Process, Document, System, Vendor, Follow-Up).
18
+ - **Schedule** — Planned Start/End dates and the actual Audit Period.
19
+ - **Scope & Rating** — Objective, Priority (Low/Medium/High/Critical),
20
+ Risk (Low/Medium/High/Critical), Organization, Country, Jurisdiction.
21
+ - **Team** — Lead Auditor, Reviewer, Approver.
22
+
23
+ An audit moves through a real 12-state lifecycle: Draft → Planned →
24
+ Scheduled → In Progress → Fieldwork Completed → Report Draft → Under
25
+ Review → Report Issued → Action Required (if findings need follow-up) →
26
+ Follow-Up → Completed / Closed / Cancelled. The grid tracks Findings, Open
27
+ Actions, and Risk directly, and the KPI row (Total Audits, Planned, In
28
+ Progress, Completed, Open Actions, Critical Findings) gives you a
29
+ program-wide read on how much is still outstanding.
30
+
31
+ ## Compliance Calendar
32
+
33
+ **New Compliance Obligation** covers a wide range of deadline types (20
34
+ real event types — Statutory Filing/Payment/Report, Tax Filing/Payment,
35
+ License/Registration/Contract/Benefit Renewal, Certificate/Document
36
+ Expiry, Medical Exam, Safety Inspection/Training, Audit, Policy/
37
+ Compliance Review, Labor Law Deadline, Employee Notification, Declaration,
38
+ or Other). Each obligation records its **Source** — where it came from:
39
+ Manual entry, or auto-derived from a Labor Law, Statutory Rule, Tax Rule,
40
+ License, Registration, or Policy (system-generated ones trace back to the
41
+ actual rule that created them, not a plain manual note). Set a Due Date,
42
+ Priority, Risk, Owner, Reviewer, and Organization/Location.
43
+
44
+ The grid tracks Due Date, Type, Priority, Risk, and Status; the KPI row
45
+ (Total Obligations, Upcoming, Overdue, Completed, Critical, Scheduled)
46
+ makes overdue and critical obligations visible at a glance rather than
47
+ buried in a long list.
48
+
49
+ ## Related
50
+
51
+ - [Statutory Rules & Labor Law](./compliance-regulatory.md)
52
+ - [Compliance Dashboard & Reports](./compliance-analytics.md)
@@ -0,0 +1,41 @@
1
+ ---
2
+ title: Certifications, Policy Acknowledgement & Compliance Documents
3
+ audience: tenant
4
+ ---
5
+
6
+ # Certifications, Policy Acknowledgement & Compliance Documents (HCM)
7
+
8
+ This page documents three shipped **Compliance** screens (`hcm-compliance`)
9
+ covering what's tracked per employee. Not for plugin developers.
10
+
11
+ ## Certifications
12
+
13
+ **New Employee Certification** — Employee, Certification Name, Category,
14
+ Country, Jurisdiction, Issuing Authority, Certificate Number, Issue Date,
15
+ Expiry Date, and two checkboxes: **Mandatory** (is this required for the
16
+ role) and **Renewal Required**. The grid separately tracks Status and
17
+ Verification Status — a certification can be recorded but not yet
18
+ verified. KPIs: Total, Verified, Pending Verification, Expired.
19
+
20
+ ## Policy Acknowledgement
21
+
22
+ **New Policy Assignment** — Employee, Policy Code/Name, Policy Type,
23
+ Version Number, Country, Due Date, and whether a **Signature Required**
24
+ for acknowledgement (vs. just a click-through). Tracks Status and Version
25
+ in the grid. KPIs: Total, Acknowledged, Pending, Declined.
26
+
27
+ > **Note:** [HR Policies](./hr-policies.md) also has its own
28
+ > Acknowledgements tab covering the same kind of tracking — if you're
29
+ > looking for policy sign-off status, check both; this compliance-focused
30
+ > screen and HR Policies' own tab may show overlapping data from different
31
+ > angles.
32
+
33
+ ## Compliance Documents
34
+
35
+ **New Compliance Document** — Document Name, Category, Country,
36
+ Jurisdiction, Issue/Effective/Expiry Dates, and an Owner. KPIs: Total,
37
+ Active, Pending Review, Expired.
38
+
39
+ ## Related
40
+
41
+ - [Statutory Rules & Labor Law](./compliance-regulatory.md)
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: Statutory Rules & Labor Law
3
+ audience: tenant
4
+ ---
5
+
6
+ # Statutory Rules & Labor Law (HCM)
7
+
8
+ This page documents two shipped **Compliance** reference screens
9
+ (`hcm-compliance`) — the regulatory rules your company operates under. Not
10
+ for plugin developers.
11
+
12
+ ## Statutory Rules
13
+
14
+ **New Statutory Rule** — Rule Code, Rule Name, Rule Type, Country,
15
+ Jurisdiction, Scheme Name, a **Calculation Type** and **Rate Percent** for
16
+ rules that involve a calculation (e.g. a statutory contribution rate),
17
+ and Effective From/To dates. The grid tracks Country, Calculation Type,
18
+ and Status through a real lifecycle: Draft → Pending Review → Approved →
19
+ Scheduled → Active, with Suspended/Superseded/Expired/Archived/Repealed
20
+ as end states. KPIs: Total, Active, Pending Review, Scheduled.
21
+
22
+ ## Labor Law
23
+
24
+ **New Labor Law** — Law Code, Law Name, Short Name, Category, Country,
25
+ Jurisdiction, Issuing Authority, an Official Reference (e.g. a citation),
26
+ and Effective From/To. Same lifecycle-tracked Status column and KPI row
27
+ shape (Total, Active, Pending Review, Expired) as Statutory Rules.
28
+
29
+ ## Related
30
+
31
+ - [Audit Management & Compliance Calendar](./compliance-audits-calendar.md)
@@ -0,0 +1,33 @@
1
+ ---
2
+ title: Country Pack Admin — Packs Overview, Pack Detail & Rule Builder
3
+ audience: tenant
4
+ ---
5
+
6
+ # Country Pack Admin — Packs Overview, Pack Detail & Rule Builder (HCM)
7
+
8
+ This page documents three shipped screens in **`hcm-country-pack-core`**
9
+ — the shared admin framework every individual [Country Pack](./country-packs.md)
10
+ plugs into. Not for plugin developers.
11
+
12
+ ## Packs Overview
13
+
14
+ A browsable list of every country pack — separate from, and more
15
+ detailed than, the simple activate/retire list on
16
+ [HR Settings → Country Configuration](./hr-settings.md#country-configuration).
17
+
18
+ ## Pack Detail
19
+
20
+ Drill into one country's pack for a fuller view of what it contains.
21
+
22
+ ## Rule Builder
23
+
24
+ A basic, form-based editor for cross-entity statutory rules. This is a
25
+ deliberately scoped-down tool — not a full visual WHEN/THEN rule
26
+ designer, just a straightforward form for editing the kind of rule rows
27
+ [Country Packs](./country-packs.md) documents (PF/ESI rates, leave rules,
28
+ labor law rules, and so on).
29
+
30
+ ## Related
31
+
32
+ - [Country Packs](./country-packs.md)
33
+ - [Compliance Dashboard, Statutory Registrations & Holiday Calendar](./country-packs-compliance.md)
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: Country Pack Compliance Dashboard, Statutory Registrations & Holiday Calendar
3
+ audience: tenant
4
+ ---
5
+
6
+ # Country Pack Compliance Dashboard, Statutory Registrations & Holiday Calendar (HCM)
7
+
8
+ This page documents three shipped screens in **`hcm-country-pack-core`**.
9
+ Not for plugin developers.
10
+
11
+ ## Compliance Dashboard
12
+
13
+ A cross-country compliance overview, pulling together your active packs'
14
+ own compliance status in one view.
15
+
16
+ ## Statutory Registrations
17
+
18
+ Track your company's real statutory registrations per country (e.g. a
19
+ tax registration number, a social-security employer ID).
20
+
21
+ ## Holiday Calendar
22
+
23
+ A country-pack-aware view of holidays — distinct from the main
24
+ [Holiday Calendar](./holiday-calendar.md) in HR Settings, this one is
25
+ scoped to what each active country pack itself defines as statutory
26
+ holidays.
27
+
28
+ ## Related
29
+
30
+ - [Country Packs](./country-packs.md)
31
+ - [Master Data Formats, FX Rates & Employee Country Documents](./country-packs-localization.md)
@@ -0,0 +1,37 @@
1
+ ---
2
+ title: Master Data Formats, FX Rates & Employee Country Documents
3
+ audience: tenant
4
+ ---
5
+
6
+ # Master Data Formats, FX Rates & Employee Country Documents (HCM)
7
+
8
+ This page documents three shipped screens in **`hcm-country-pack-core`**.
9
+ Not for plugin developers.
10
+
11
+ ## Master Data Localization Formats
12
+
13
+ A read-only reference catalog of country-specific formatting
14
+ conventions: how many address lines a country expects, what its
15
+ state/province and postal code fields are called, name order (given name
16
+ first vs. family name first), and similar formatting rules — useful when
17
+ you're wondering why a form looks different for employees in different
18
+ countries.
19
+
20
+ ## FX Rate & Currency Conversion
21
+
22
+ A foreign-exchange rate reference table, plus your tenant's base currency
23
+ setting. **Important:** these are manually-seeded snapshot rates, not a
24
+ live market-data feed — don't rely on this for real-time currency
25
+ conversion; treat it as a reference point, and update it yourself when
26
+ rates need to change.
27
+
28
+ ## Employee Country Documents
29
+
30
+ Per-employee tracking of country-specific document instances — work
31
+ permits, visas, employment passes — with real expiry-date tracking, so
32
+ you can see what's coming due.
33
+
34
+ ## Related
35
+
36
+ - [Country Packs](./country-packs.md)
37
+ - [Employee Profile](./employee-profile.md)
@@ -0,0 +1,102 @@
1
+ ---
2
+ title: Country Packs
3
+ audience: tenant
4
+ ---
5
+
6
+ # Country Packs (HCM)
7
+
8
+ This page documents the shipped **Country Pack** framework — 44 country
9
+ packs (India, USA, UK, Germany, Japan, Australia, and 38 more), all built
10
+ on the exact same real, shared structure. Not for plugin developers.
11
+
12
+ **Who this is for:** HR/payroll admins operating in a specific country
13
+ who need that country's real statutory rates, tax slabs, and leave/labor
14
+ rules reflected in HCM.
15
+
16
+ ## How Country Packs work
17
+
18
+ A Country Pack is a reference-data library for one country — it doesn't
19
+ add new screens with new behavior; it adds real statutory rows that the
20
+ rest of HCM ([Payroll](./payroll-setup.md), [Leave](./leave-setup.md),
21
+ [Compliance](./compliance-regulatory.md)) reads from.
22
+
23
+ **Activating a pack:** go to [HR Settings → Country Configuration](./hr-settings.md#country-configuration),
24
+ find the country, and **Activate** it — once active, its rules become
25
+ visible and usable across the rest of HCM. Only packs your tenant has
26
+ actually installed show up there; this isn't a general "pick any country
27
+ in the world" list.
28
+
29
+ ## What every pack actually contains
30
+
31
+ The same set of statutory-rule screens repeats, country by country — the
32
+ field names below are real (taken directly from India's own pack, the
33
+ most complete one, and consistent across every other pack that ships the
34
+ same screen type):
35
+
36
+ - **PF/Provident Fund Rules** (where applicable) — Scheme Code, Employee
37
+ Rate %, Employer Rate %, Wage Ceiling, and an Effective From/To date
38
+ range — so a rate change over time is tracked, not overwritten.
39
+ - **ESI/Social Security Rules** — Employee Rate %, Employer Rate %, Wage
40
+ Threshold, Effective From/To.
41
+ - **Professional/Regional Tax Rules** — State/Region, Salary Band Min/Max,
42
+ Monthly Tax Amount, Effective From/To (for countries with sub-national
43
+ tax variation).
44
+ - **Tax Slabs** — real tax regime and bracket definitions (Tax Year,
45
+ Standard Deduction, ordered slabs), read directly by
46
+ [Tax Management](./payroll-tax.md) in Payroll — not a separate,
47
+ disconnected copy.
48
+ - **Gratuity/Bonus Rules** — Rule Type, Formula Description, Rate or
49
+ Formula, Minimum Service Years, a Cap Amount, Effective From/To.
50
+ - **Leave Rules** — Leave Type, Eligibility Condition, Entitlement Days,
51
+ Accrual Method, Carry Forward Rule, Effective From/To — the statutory
52
+ minimums this country requires, which [Leave Policies](./leave-setup.md)
53
+ can be built against.
54
+ - **Labor Law Rules** — State/Region, Rule Code/Name, Category,
55
+ Description, Effective From/To — real regulatory requirements, browsable
56
+ and filterable, feeding [Statutory Rules & Labor Law](./compliance-regulatory.md).
57
+ - **Termination Notice / Retrenchment Rules** and **Garnishment / Wage
58
+ Attachment Rules** — statutory requirements around ending employment and
59
+ court-ordered salary deductions, where applicable.
60
+ - **Working Calendar Rules**, **Statutory Form Definitions**, **Statutory
61
+ Returns**, **Employee Document Types**, and **Payroll Integration
62
+ Definitions** — supporting reference data each pack ships so the rest of
63
+ HCM knows what forms, documents, and filings apply in that country.
64
+
65
+ Every rule row carries **Source Year** and an **Effective From/To** date
66
+ range — this is real, versioned reference data, not a static snapshot; a
67
+ rate change is added as a new row with its own effective dates, never
68
+ overwriting history.
69
+
70
+ ## Why this page doesn't list each country separately
71
+
72
+ Every one of the 44 packs (Australia, Austria, Belgium, Canada, China,
73
+ Denmark, Finland, France, Germany, Hong Kong, India, Indonesia, Ireland,
74
+ Italy, Japan, Malaysia, Netherlands, Norway, New Zealand, Philippines,
75
+ Poland, Portugal, Saudi Arabia, Singapore, South Korea, Spain, Sweden,
76
+ Switzerland, Taiwan, Thailand, UAE, UK, USA, Vietnam, and more) ships this
77
+ exact same screen structure — only the actual rates, thresholds, and
78
+ rules inside them differ, country by country. Writing 44 nearly-identical
79
+ pages, each just restating this same structure with a different country
80
+ name, wouldn't tell you anything this page hasn't already — the real
81
+ content that matters is the *actual current rates and rules*, which
82
+ belong in your own tenant's live data (via each pack's own screens once
83
+ activated), not frozen into a documentation page that would go stale the
84
+ moment a real rate changes.
85
+
86
+ ## Known gaps
87
+
88
+ - **Not every pack ships every screen** — a country with no PF-equivalent
89
+ system, for example, simply won't have a PF Rules screen. Which
90
+ screens exist for your country is determined by what's actually
91
+ relevant there.
92
+ - **These are reference-data screens, not an editor for your own
93
+ statutory positions** — the shipped rules reflect the pack's own
94
+ published rates; if your company needs a genuinely custom variation,
95
+ check with your implementation team rather than editing pack data
96
+ directly.
97
+
98
+ ## Related
99
+
100
+ - [HR Settings](./hr-settings.md)
101
+ - [Payroll Dashboard, Reports & Country Rollup](./payroll-analytics.md)
102
+ - [Statutory Rules & Labor Law](./compliance-regulatory.md)
@@ -0,0 +1,38 @@
1
+ ---
2
+ title: HCM Dashboard
3
+ audience: tenant
4
+ ---
5
+
6
+ # HCM Dashboard (HCM)
7
+
8
+ This page documents the shipped **HCM Dashboard** (`hcm-foundation`) — the
9
+ landing page when you open HCM. Not for plugin developers.
10
+
11
+ **Who this is for:** anyone with access to HCM — it's the home screen.
12
+
13
+ ## Getting there
14
+
15
+ `/app/hcm/home/dashboard` — the first thing you see opening HCM.
16
+
17
+ ## What's on it
18
+
19
+ Every number and chart on this dashboard is real, live data for your
20
+ tenant — none of it is a placeholder:
21
+
22
+ - **Total Headcount**, **Present Today**, **On Leave**, **Open Positions**,
23
+ and **Attrition** KPI tiles, each with a small trend sparkline.
24
+ - An **Employee Distribution** donut, broken down by department.
25
+ - An **Attendance** gauge for today.
26
+ - A **Leave Balance** list of upcoming approved leave.
27
+ - A **Birthdays** / **Anniversaries** list, for the current month.
28
+ - A **Recruitment** funnel, showing how many candidates are in each hiring
29
+ stage.
30
+ - A short **Recommendations** list — real signals worth your attention
31
+ (e.g. from attrition-risk data), not AI-generated text.
32
+
33
+ ## Known gaps
34
+
35
+ - The three trend sparklines (headcount, open positions, attrition) only
36
+ have a few days of real history right after this feature ships for a new
37
+ tenant — they fill in over time as daily data accumulates, so don't
38
+ expect a full trend line on day one.
@@ -0,0 +1,32 @@
1
+ ---
2
+ title: Designations
3
+ audience: tenant
4
+ ---
5
+
6
+ # Designations (HCM)
7
+
8
+ This page documents the shipped **Designations** screen
9
+ (`hcm-organization`) — the job titles employees actually hold. Not for
10
+ plugin developers.
11
+
12
+ ## What you see
13
+
14
+ - **KPI cards**: Total Designations, Active Designations, Employees
15
+ Using, Without Grade (a quick way to spot designations missing a grade
16
+ assignment).
17
+ - **Search**, plus filters for Grade, Job Family, and Status (Active /
18
+ Inactive / All).
19
+ - A grid: Designation Name, Job Family, Grade, Career Level, Positions
20
+ Using, Status, Actions.
21
+
22
+ ## Creating or editing a designation
23
+
24
+ The form is organized into sections: **General** (Designation Name, Short
25
+ Name, Designation Code), **Organization** (Company / Business Unit),
26
+ **Job Structure** (Job Family, Grade, Career Level, Designation Level),
27
+ **Hierarchy** (Parent Designation), **Lifecycle** (Effective From/To,
28
+ Status), and **Description**.
29
+
30
+ ## Related
31
+
32
+ - [Job Classifications, Job Families, Job Levels & Job Grades](./job-classifications.md)
@@ -0,0 +1,27 @@
1
+ ---
2
+ title: Document Dashboard, Reports & Expiry
3
+ audience: tenant
4
+ ---
5
+
6
+ # Document Dashboard, Reports & Expiry (HCM Employee Documents)
7
+
8
+ This page documents three shipped analytics screens in the
9
+ **`hcm-employee-documents`** module. Not for plugin developers.
10
+
11
+ ## Document Dashboard
12
+
13
+ 9 real KPI cards across every document type and status in this module.
14
+
15
+ ## Document Reports
16
+
17
+ A KPI summary plus a Documents-by-Status chart.
18
+
19
+ ## Document Expiry
20
+
21
+ Every document approaching or past its expiry date, with a real **Start
22
+ Renewal** action that raises a [Document Request](./emp-documents-workflow.md)
23
+ directly from here rather than requiring a separate manual step.
24
+
25
+ ## Related
26
+
27
+ - [Employee Documents & Document Types](./emp-documents-core.md)
@@ -0,0 +1,33 @@
1
+ ---
2
+ title: Employee Documents & Document Types
3
+ audience: tenant
4
+ ---
5
+
6
+ # Employee Documents & Document Types (HCM Employee Documents)
7
+
8
+ This page documents two shipped screens in the **`hcm-employee-documents`**
9
+ module — a separate, more comprehensive document system from both
10
+ [Employee Documents](./employee-documents.md) (in `hcm-employee`) and the
11
+ [Document Management](./employee-info-documents.md) screen (in
12
+ `hcm-employee-information`). Not for plugin developers.
13
+
14
+ > **Three document screens exist across three modules.** This one is the
15
+ > most complete — real DMS-backed upload, verification lifecycle, letter
16
+ > generation, digital signatures, and expiry tracking. If your company
17
+ > uses document management heavily, this is the module to standardize on.
18
+
19
+ ## Employee Documents
20
+
21
+ The core per-employee document record — real upload (through the
22
+ platform's own document storage), with a real verification lifecycle, not
23
+ just a file listing.
24
+
25
+ ## Document Types
26
+
27
+ Master data: define the document types your company tracks, each with
28
+ its own simple administrative status.
29
+
30
+ ## Related
31
+
32
+ - [Document Templates, Requests & Verification Lookup](./emp-documents-workflow.md)
33
+ - [Offer, Salary, Experience Letters, Certificates & Contracts](./emp-documents-letters.md)
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: Offer, Salary, Experience Letters, Certificates & Contracts
3
+ audience: tenant
4
+ ---
5
+
6
+ # Offer, Salary, Experience Letters, Certificates & Contracts (HCM Employee Documents)
7
+
8
+ This page documents five shipped **document generation** screens in the
9
+ **`hcm-employee-documents`** module — each generates a real document for
10
+ an existing employee, gated by its own real approval before it's issued.
11
+ Not for plugin developers.
12
+
13
+ ## Offer Letters
14
+
15
+ Offer/appointment-style letters for an existing employee — internal
16
+ transfer, promotion, rehire, or revised terms (not a new hire's original
17
+ offer, which belongs to Recruitment).
18
+
19
+ ## Salary Letters
20
+
21
+ Salary Certificates, Revision Letters, Bank Certificates, and CTC
22
+ Letters.
23
+
24
+ ## Experience Letters
25
+
26
+ Experience Certificates, Relieving Letters, and Service Letters.
27
+
28
+ ## Certificates
29
+
30
+ General-purpose HR certificates — Employment, Service, Training,
31
+ Appreciation, Promotion, Transfer, No-Objection Certificates, and more.
32
+
33
+ ## Contracts
34
+
35
+ Employment contracts, with a full real lifecycle: Draft → Pending
36
+ Approval → Approved → Generated → Active → Revoked.
37
+
38
+ ## Related
39
+
40
+ - [Digital Signatures & Signature Providers](./emp-documents-signatures.md)
@@ -0,0 +1,24 @@
1
+ ---
2
+ title: Digital Signatures & Signature Providers
3
+ audience: tenant
4
+ ---
5
+
6
+ # Digital Signatures & Signature Providers (HCM Employee Documents)
7
+
8
+ This page documents two shipped screens in the **`hcm-employee-documents`**
9
+ module. Not for plugin developers.
10
+
11
+ ## Digital Signatures
12
+
13
+ Request an electronic signature on any of this module's HR documents. A
14
+ request only shows Completed once the real signature has actually come
15
+ back — not the moment you send it.
16
+
17
+ ## Signature Providers
18
+
19
+ An admin screen listing this module's own registered external signature
20
+ provider connections.
21
+
22
+ ## Related
23
+
24
+ - [Offer, Salary, Experience Letters, Certificates & Contracts](./emp-documents-letters.md)
@@ -0,0 +1,32 @@
1
+ ---
2
+ title: Document Templates, Requests & Verification Lookup
3
+ audience: tenant
4
+ ---
5
+
6
+ # Document Templates, Requests & Verification Lookup (HCM Employee Documents)
7
+
8
+ This page documents three shipped screens in the **`hcm-employee-documents`**
9
+ module. Not for plugin developers.
10
+
11
+ ## Document Templates
12
+
13
+ Reusable, merge-field HR document templates — the templates that Offer,
14
+ Salary, and Experience Letters (and Certificates) are actually generated
15
+ from.
16
+
17
+ ## Document Requests
18
+
19
+ Request a specific document from an employee — either raised directly by
20
+ HR, or automatically from [Document Expiry](./emp-documents-analytics.md)'s
21
+ own "Start Renewal" action when something's about to lapse.
22
+
23
+ ## Document Verification Lookup
24
+
25
+ A public-facing utility: verify a document's verification code (stamped
26
+ only on genuinely issued PDFs) against the real underlying record — this
27
+ is what lets a third party (e.g. a bank checking an experience letter) confirm
28
+ a document is real without needing system access.
29
+
30
+ ## Related
31
+
32
+ - [Employee Documents & Document Types](./emp-documents-core.md)