@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,30 @@
1
+ ---
2
+ title: Leave Types & Leave Policies
3
+ audience: tenant
4
+ ---
5
+
6
+ # Leave Types & Leave Policies (HCM)
7
+
8
+ This page documents two shipped **Leave Management** setup screens
9
+ (`hcm-leave`). Not for plugin developers.
10
+
11
+ **Who this is for:** HR administrators setting these up, usually once
12
+ (then revisited when policy changes).
13
+
14
+ ## Leave Types
15
+
16
+ Define the kinds of leave your company offers (e.g. Annual, Sick,
17
+ Unpaid) — the foundation everything else in Leave Management is built on.
18
+
19
+ ## Leave Policies
20
+
21
+ For each leave type, configure entitlement, accrual, carry-forward,
22
+ encashment, eligibility, and approval rules — scoped to specific employee
23
+ groups if needed. Activating a policy checks for overlap with existing
24
+ policies, changes go through a real approval workflow, and each version of
25
+ a policy is kept, not overwritten.
26
+
27
+ ## Related
28
+
29
+ - [Leave Requests](./leave-requests.md)
30
+ - [Leave Balance](./leave-balance.md)
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: Team Leave & Leave Calendar
3
+ audience: tenant
4
+ ---
5
+
6
+ # Team Leave & Leave Calendar (HCM)
7
+
8
+ This page documents two shipped **who's off** screens (`hcm-leave`), for
9
+ managers and HR planning around leave. Not for plugin developers.
10
+
11
+ ## Team Leave
12
+
13
+ A manager/HR view of your team: **Team Members**, **On Leave Today**,
14
+ **Pending Approvals**, **Upcoming**, and leave balance visibility across
15
+ the whole team at a glance.
16
+
17
+ ## Leave Calendar
18
+
19
+ A month-grid view of everyone's leave, overlaid on a calendar so you can
20
+ see at a glance who's off on any given day. Currently month view only —
21
+ there's no week, day, timeline, or year view yet.
22
+
23
+ ## Related
24
+
25
+ - [Leave Requests](./leave-requests.md)
@@ -0,0 +1,61 @@
1
+ ---
2
+ title: HCM Navigation & Approvals
3
+ audience: tenant
4
+ ---
5
+
6
+ # HCM Navigation & Approvals (HCM)
7
+
8
+ This page documents the shipped **navigation shell** and **approvals**
9
+ screens (`hcm-foundation`) that every HCM user sees, regardless of which
10
+ specific module they work in. Not for plugin developers.
11
+
12
+ ## The app shell
13
+
14
+ Every HCM page shares the same header and side navigation. The side
15
+ navigation is a real menu, built from whatever HCM modules are actually
16
+ installed for your tenant — it's not hand-maintained per page, so a newly
17
+ installed module's menu items appear automatically.
18
+
19
+ ## The Apps screen
20
+
21
+ Tapping **Apps** opens a dedicated, full-screen menu of every module and
22
+ its pages, organized as icon-based tiles with submenus — similar to a
23
+ phone's home-screen app grid. This is separate from, and more thorough
24
+ than, the small "My Apps" launcher available elsewhere in the platform.
25
+
26
+ ## Approvals — three screens, two flavors each
27
+
28
+ HCM has three approval-related screens, and each one comes in two
29
+ variants depending on which part of HCM you're looking at (an
30
+ **Organization & Job Classification** variant and an **Employee &
31
+ Position** variant) — the same screen, applied to two different kinds of
32
+ requests.
33
+
34
+ ### My Requests
35
+
36
+ Everything **you've** submitted for approval — any status (pending,
37
+ approved, rejected) — with KPI counts at the top.
38
+
39
+ ### My Approvals
40
+
41
+ Everything waiting for **you** to approve, with real due dates:
42
+
43
+ - **Due Date** and **Overdue** — every request has a due date (a 3-day
44
+ turnaround target applied uniformly across every request type in HCM, not
45
+ tuned per request type).
46
+ - **Approved This Week**
47
+ - **Delegated to me** — requests someone else forwarded to you.
48
+
49
+ ### All Requests
50
+
51
+ Every request from every requester, any status — the same view as My
52
+ Requests but without the "just mine" filter, plus a **Requester** column
53
+ and a **Rejected** KPI. This is the one to check if you need to see
54
+ everyone's requests, not just your own (typically for HR staff with
55
+ broader visibility, not everyday employees).
56
+
57
+ ## Known gaps
58
+
59
+ - **The 3-day approval SLA is uniform**, not tuned per request type — a
60
+ simple leave request and a complex compensation change both get the same
61
+ due-date window today.
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: Resignation, Retirement, Termination & Exit
3
+ audience: tenant
4
+ ---
5
+
6
+ # Resignation, Retirement, Termination & Exit (HCM)
7
+
8
+ This page documents the shipped **offboarding** screens (`hcm-employee`) —
9
+ what happens when someone leaves the company, whether by choice,
10
+ retirement, or employer-initiated termination. Not for plugin developers.
11
+
12
+ > **Important — there's a second, separate Resignation/Exit implementation.**
13
+ > The `hcm-separation` module ships its own independent Resignation and
14
+ > exit-process screens on different underlying tables — see
15
+ > [Resignation & Resignation Approval (Separation module)](./separation-resignation.md).
16
+ > The two don't share data. If your company uses this Employee-module
17
+ > flow, be consistent about it rather than mixing the two.
18
+
19
+ ## The three exit types — HR admin screens
20
+
21
+ Each of the three ways someone can leave has its own full screen for HR:
22
+
23
+ ### Resignation
24
+
25
+ Notice period, multi-stage approval, the ability to withdraw a
26
+ resignation, notice-period adjustment, handover, documents, and
27
+ acknowledgements — plus an **Initiate Separation** action that hands the
28
+ case off into Exit Management once it's finalized.
29
+
30
+ ### Retirement
31
+
32
+ Age/service eligibility checking, notice period, multi-stage approval
33
+ (Manager → HR → Finance), the option to defer, a pre-retirement checklist,
34
+ knowledge transfer, and benefits/entitlements — with the same handoff into
35
+ Exit Management.
36
+
37
+ ### Termination
38
+
39
+ Employer-initiated: notice period, multi-stage approval (Manager → HR →
40
+ Finance), an exit checklist, knowledge transfer, and documents — same
41
+ handoff into Exit Management.
42
+
43
+ ## Employee self-service — "My ..." screens
44
+
45
+ Matching self-service versions for the employee themselves:
46
+
47
+ - **My Resignation** — see your own status, notice period, handover and
48
+ clearance progress, documents, and approval timeline. **Withdraw** your
49
+ resignation, or, if you don't have one on file, submit a new one.
50
+ - **My Retirement** — a read-only view of your retirement info, timeline,
51
+ checklist, knowledge transfer, and tentative benefits/entitlements.
52
+ - **My Termination** — read-only, since termination is employer-initiated:
53
+ you can see your termination ID, date, last working day, notice period,
54
+ and type, but there's no submit or withdraw action (there wouldn't be).
55
+
56
+ ## Exit Management
57
+
58
+ Once any of the three exit types is approved, this screen automatically
59
+ gets a real clearance record broken into HR, Finance, IT, Admin, Manager,
60
+ and Asset Management — each area clears the departing employee
61
+ independently, and this is where you track that.
62
+
63
+ ## Separation
64
+
65
+ The underlying, company-wide record tying an exit together — a smaller,
66
+ gated screen behind the scenes of the flows above.
67
+
68
+ ## Related
69
+
70
+ - [Employee Profile](./employee-profile.md)
71
+ - [HCM Navigation & Approvals](./navigation-and-approvals.md)
@@ -0,0 +1,43 @@
1
+ ---
2
+ title: Document Collection & Employee Verification
3
+ audience: tenant
4
+ ---
5
+
6
+ # Document Collection & Employee Verification (HCM)
7
+
8
+ This page documents two shipped **Onboarding** screens (`hcm-onboarding`).
9
+ Not for plugin developers.
10
+
11
+ ## Document Collection
12
+
13
+ Request a document from a new joiner. Uploads are real — the file lands
14
+ in your tenant's document storage (a real "HCM Onboarding Documents"
15
+ folder, created automatically) — not a placeholder. From a document's
16
+ detail view: **Verify**, **Reject**, **Request Resubmission**, **Waive**,
17
+ **Cancel**, or **Download**, each recorded in a real history log.
18
+
19
+ There's no document versioning — re-uploading a file replaces it in
20
+ place, it doesn't keep the old version alongside the new one.
21
+
22
+ ## Employee Verification
23
+
24
+ Open a verification case for a new joiner, then add individual checks
25
+ underneath it (e.g. Identity, Employment). For each check, **Record
26
+ Decision** — status, result, a failure reason if it didn't pass, who
27
+ reviewed it, and comments. As you decide checks, the case's own overall
28
+ progress % and result are recalculated automatically — you don't total it
29
+ up yourself.
30
+
31
+ ## Known gaps
32
+
33
+ - **Verification is single-reviewer** — the original design describes a
34
+ multi-party Reviewer → HR Manager → Compliance chain for high-risk
35
+ checks, but that isn't built; one person's decision closes a check.
36
+ - **No versioning on documents** — see above.
37
+ - **A check's supporting evidence is a freeform reference**, not
38
+ formally linked to Document Collection, even though you can point it at
39
+ a document by typing a reference to it.
40
+
41
+ ## Related
42
+
43
+ - [New Joiners & Onboarding Dashboard](./onboarding-overview.md)
@@ -0,0 +1,65 @@
1
+ ---
2
+ title: Orientation & Probation
3
+ audience: tenant
4
+ ---
5
+
6
+ # Orientation & Probation (HCM)
7
+
8
+ This page documents two shipped **Onboarding** screens (`hcm-onboarding`).
9
+ Not for plugin developers.
10
+
11
+ ## Orientation
12
+
13
+ Schedule an orientation session for a new joiner — 16 real session types,
14
+ 4 delivery modes. **Start** it, record real-time **Attendance** (marking
15
+ someone a No-Show automatically flips the session's own status, you don't
16
+ also have to change the status separately), **Complete** it (accepts a
17
+ partial-completion percentage — under 100% marks it Partially Completed
18
+ rather than fully Completed), or **Cancel**/**Reschedule** (both require a
19
+ reason). **Send Reminder** logs a reminder without changing status.
20
+ **Feedback** records a single overall rating and comments.
21
+
22
+ ## Probation
23
+
24
+ Start a probation period for a new joiner — duration defaults to 90 days
25
+ if you don't set one, and there's a hard rule against starting two active
26
+ probations on the same onboarding. As the period runs, **progress %** is
27
+ calculated for you from how far you are between the start date and the
28
+ current end date — no manual updates needed.
29
+
30
+ Move it through **Start Review** → **Submit Review** (recorded separately
31
+ for Manager and HR — both fields exist even though today the same person
32
+ usually completes both, so a future pass can route them to two different
33
+ people without a data model change) → **Confirm** or **Fail**. If more
34
+ time is needed, **Request Extension** (reason and number of days
35
+ required) pushes the end date out and tracks how many times it's been
36
+ extended. **Terminate** is only available once a probation has already
37
+ Failed — it's a real, deliberate boundary: this only flags the record,
38
+ the actual termination process itself belongs to
39
+ [Resignation, Retirement, Termination & Exit](./offboarding-and-exit.md).
40
+
41
+ ## Known gaps
42
+
43
+ - **No configurable probation-policy hierarchy** — duration/dates are set
44
+ directly when you start a probation (default 90 days), not resolved
45
+ from a policy based on role/department/country.
46
+ - **Probation's confirmation isn't a real routed approval workflow** —
47
+ it's a permission-gated sequence one role can complete end to end, even
48
+ though Manager and HR recommendations are tracked as separate fields
49
+ (a deliberate hook for a future real workflow, not yet used that way).
50
+ - **No reusable orientation program/session-template system** — every
51
+ session is scheduled directly, not auto-assigned from a program.
52
+ - **Manager Name on a probation record is free text**, not looked up from
53
+ a real employee search.
54
+
55
+ > **Note:** this is the onboarding-scoped probation record for a new
56
+ > joiner. There's also a separate, employee-wide
57
+ > [Confirmation](./onboarding-to-confirmation.md) screen in the Employee
58
+ > module — if you're not sure which one you need, Confirmation is the
59
+ > broader, company-wide view; this one is specifically part of a new
60
+ > joiner's onboarding journey.
61
+
62
+ ## Related
63
+
64
+ - [New Joiners & Onboarding Dashboard](./onboarding-overview.md)
65
+ - [Onboarding — Prejoining, Joining & Confirmation](./onboarding-to-confirmation.md)
@@ -0,0 +1,47 @@
1
+ ---
2
+ title: New Joiners & Onboarding Dashboard
3
+ audience: tenant
4
+ ---
5
+
6
+ # New Joiners & Onboarding Dashboard (HCM)
7
+
8
+ This page documents two shipped **Onboarding** screens (`hcm-onboarding`)
9
+ — the entry points into the whole module. Not for plugin developers.
10
+
11
+ > **Where this fits:** Onboarding is deliberately scoped to what happens
12
+ > **after** someone's first day — once they're marked active via the
13
+ > [Joining](./onboarding-to-confirmation.md) process in the Employee
14
+ > module. If you're looking for pre-hire readiness or the actual Day-1
15
+ > activation, that's Prejoining/Joining, not here.
16
+
17
+ ## New Joiners
18
+
19
+ Your operational workspace for everyone currently going through
20
+ onboarding — one row per onboarding record. Each row shows real Status
21
+ (Not Started / In Progress / At Risk / Completed / Closed / Cancelled)
22
+ and Risk (Normal / At Risk / High Risk / Critical) — risk is calculated
23
+ automatically: an overdue pending checklist item flips a record to At
24
+ Risk on its own, you don't have to notice it yourself.
25
+
26
+ Click a row to open its detail: **Start**, **Complete**, **Close**, or
27
+ **Cancel** the onboarding (each of the last three needs a reason), plus
28
+ **Generate Checklist** to create a real checklist instance from a
29
+ template. You can select multiple rows and use **Start Selected** to kick
30
+ off onboarding for several new joiners landing at once — a real, common
31
+ coordinator task.
32
+
33
+ ## Onboarding Dashboard
34
+
35
+ KPI cards: Not Started, In Progress, At Risk, Completed This Month, Total
36
+ Onboarding records, plus how many checklist items are pending/overdue
37
+ across everyone — a real-time operational view, not a static count.
38
+
39
+ ## Known gaps
40
+
41
+ - **Bulk actions are limited to Start** — Complete/Close/Cancel all need
42
+ a real reason or completion context per record, so they're deliberately
43
+ not offered as bulk operations.
44
+
45
+ ## Related
46
+
47
+ - [Onboarding Templates & Checklists](./onboarding-templates-checklists.md)
@@ -0,0 +1,48 @@
1
+ ---
2
+ title: Account Provisioning & Equipment/Assets
3
+ audience: tenant
4
+ ---
5
+
6
+ # Account Provisioning & Equipment/Assets (HCM)
7
+
8
+ This page documents two shipped **Onboarding** screens (`hcm-onboarding`)
9
+ covering what a new joiner needs before or on day one. Not for plugin
10
+ developers.
11
+
12
+ ## Account Provisioning
13
+
14
+ Request a system or account for a new joiner (14 real account types —
15
+ identity/IAM, ERP, email, and more). If you mark a request as needing
16
+ approval, **Start** is blocked until someone **Approves** it first — a
17
+ real, if simple, gate. From there: **Activate** (records the real account
18
+ name and external ID once it exists), **Fail**/**Retry** (retries are
19
+ capped by a max-attempts count, not an unlimited retry loop),
20
+ **Suspend**/**Reactivate**, **Deactivate**, **Cancel**.
21
+
22
+ ## Equipment & Assets
23
+
24
+ Request equipment for a new joiner (20 real categories). Walk it through
25
+ **Allocate** (asset tag required) → **Schedule Delivery** → **Deliver** →
26
+ **Acknowledge** (the recipient confirms receipt, condition required) →
27
+ **Return Request** → **Return** — or **Report Damage** / **Report Loss**
28
+ at any point along the way. Every step is logged to a real history.
29
+
30
+ ## Known gaps
31
+
32
+ - **Neither screen actually provisions anything for real** — there's no
33
+ IAM/SSO connector, no live account creation, no asset-inventory system
34
+ behind these. Activating an account records what you type (a name, an
35
+ external ID); allocating equipment records an asset tag you type. These
36
+ are tracking/confirmation screens for IT/Facilities to record what's
37
+ been done, not systems that do the provisioning themselves.
38
+ - **No multi-party approval routing** — Account Provisioning's single
39
+ approval toggle is the only approval concept here; there's no
40
+ Manager → Application Owner → Security chain.
41
+ - **No reusable request bundles** — a "standard new-hire laptop + badge +
42
+ email" bundle has to be requested item by item, not as one preset.
43
+ - **Nothing is auto-generated from a new joiner's role/department** —
44
+ every request starts from the dialog here, manually.
45
+
46
+ ## Related
47
+
48
+ - [New Joiners & Onboarding Dashboard](./onboarding-overview.md)
@@ -0,0 +1,38 @@
1
+ ---
2
+ title: Onboarding Reports
3
+ audience: tenant
4
+ ---
5
+
6
+ # Onboarding Reports (HCM)
7
+
8
+ This page documents the shipped **Onboarding Reports** screen
9
+ (`hcm-onboarding`) — the reporting hub for everything else in the module.
10
+ Not for plugin developers.
11
+
12
+ ## What you see
13
+
14
+ - A **Key Metrics** card — 11 real KPIs, spanning both onboarding-level
15
+ counts and cross-module completion percentages (e.g. what fraction of
16
+ documents across every active onboarding are actually verified).
17
+ - Four report cards — **Department Report**, **Onboarding Status
18
+ Breakdown**, **Overdue Onboarding**, and **Exceptions** — each pulling
19
+ real, live data.
20
+ - An **Onboarding Summary** section with its own drill-down grid over
21
+ every onboarding record; click a row for a quick detail view.
22
+
23
+ **Exceptions** surfaces overdue onboarding, rejected documents, failed
24
+ verifications, failed account provisioning, orientation no-shows, and
25
+ failed probations, all in one merged list.
26
+
27
+ ## Known gaps
28
+
29
+ - **Every number here is computed live on page load**, not cached or
30
+ scheduled — there's no saved-report, scheduled-email, or async-export
31
+ system behind this.
32
+ - **Exceptions only covers categories backed by real tracked data** —
33
+ things like "Manager Action Overdue" or "Workflow Failure" aren't
34
+ listed because nothing in this module tracks that data yet.
35
+
36
+ ## Related
37
+
38
+ - [New Joiners & Onboarding Dashboard](./onboarding-overview.md)
@@ -0,0 +1,38 @@
1
+ ---
2
+ title: Onboarding Templates & Checklists
3
+ audience: tenant
4
+ ---
5
+
6
+ # Onboarding Templates & Checklists (HCM)
7
+
8
+ This page documents two shipped **Onboarding** screens (`hcm-onboarding`)
9
+ covering how onboarding tasks are planned and tracked. Not for plugin
10
+ developers.
11
+
12
+ ## Onboarding Templates
13
+
14
+ Build a reusable checklist template: a header plus ordered items, each
15
+ with its own sequence, whether it's mandatory, an owner role, and how
16
+ many days it's due within. **Manage Items** opens a dedicated
17
+ add/edit/delete flow for the items themselves, separate from editing the
18
+ template header.
19
+
20
+ An onboarding can have several checklists running at once against
21
+ different templates (e.g. one for Employee tasks, one for IT, one for
22
+ Manager) — a template is scoped by checklist type (12 real types) and
23
+ optionally by employment type, department, or location, so the right
24
+ template gets picked automatically depending on who's onboarding.
25
+
26
+ ## Onboarding Checklists
27
+
28
+ Two things in one screen: a read-only list of templates (create new ones
29
+ from Onboarding Templates above), and each new joiner's own checklist
30
+ *instance* — the actual cloned copy of a template's items for that one
31
+ person. Mark an item **Complete** or **Skip**; either one recalculates
32
+ that checklist's own progress and status, and rolls up into the parent
33
+ onboarding's overall progress and risk status (an overdue item is what
34
+ flips an onboarding to At Risk).
35
+
36
+ ## Related
37
+
38
+ - [New Joiners & Onboarding Dashboard](./onboarding-overview.md)
@@ -0,0 +1,45 @@
1
+ ---
2
+ title: Onboarding — Prejoining, Joining & Confirmation
3
+ audience: tenant
4
+ ---
5
+
6
+ # Onboarding — Prejoining, Joining & Confirmation (HCM)
7
+
8
+ This page documents three connected shipped screens (`hcm-employee`)
9
+ covering a new hire's journey from accepting an offer through to becoming
10
+ a confirmed employee. Not for plugin developers.
11
+
12
+ ## Employee Lifecycle (overview)
13
+
14
+ The starting point: a **KPI row** (Total, New Hires, In Progress,
15
+ Transitions, Exits), six **stage cards** — Onboarding, Probation, Active,
16
+ Inactive, Transition, Exit — and a donut breakdown showing where everyone
17
+ currently sits, plus **Key Insights** and **Upcoming Actions** panels.
18
+ There's no pre-hire "Recruitment" stage shown yet, since Recruitment
19
+ doesn't have a candidate record to hand off from.
20
+
21
+ ## Prejoining
22
+
23
+ Tracks someone from **offer acceptance** through to being ready to join —
24
+ a KPI row, a grid, and a workflow/checklist panel walking through what
25
+ still needs to happen before day one.
26
+
27
+ ## Joining
28
+
29
+ Picks up once someone is marked ready to join in Prejoining, and covers
30
+ the actual joining-day process through to the employee record becoming
31
+ active.
32
+
33
+ ## Confirmation
34
+
35
+ A company-wide, read-only view of confirmation status (i.e. who's still on
36
+ probation vs. confirmed). You don't submit a new confirmation or extension
37
+ from this screen — that's done from the employee's own
38
+ [Profile](./employee-profile.md) or from the Probation Employees roster
39
+ view; this page is where you check status across everyone.
40
+
41
+ ## Related
42
+
43
+ - [Employee Profile](./employee-profile.md)
44
+ - [Employee Directory & Rosters](./employee-directory.md) (Probation
45
+ Employees view)
@@ -0,0 +1,53 @@
1
+ ---
2
+ title: Reporting Structure & Organization Structure
3
+ audience: tenant
4
+ ---
5
+
6
+ # Reporting Structure & Organization Structure (HCM)
7
+
8
+ This page documents two related but separate shipped screens
9
+ (`hcm-employee`) — one shows who reports to whom, the other shows your
10
+ department/unit hierarchy. Not for plugin developers.
11
+
12
+ ## Reporting Structure (org chart)
13
+
14
+ Shows employees as a tree by manager, starting from the top and expanding
15
+ as you click — it doesn't load your whole company's org chart at once, only
16
+ the parts you actually open.
17
+
18
+ - An **"Employees Without Manager"** count, so you can spot anyone who
19
+ isn't assigned a manager yet.
20
+ - Click any employee to see their details, including who their Reporting,
21
+ Functional, and Dotted-line managers are (by name, not just an ID).
22
+ - You can edit an employee's secondary (functional/dotted-line) managers
23
+ directly from here.
24
+ - **Changing someone's main Reporting Manager isn't done here** — drag the
25
+ employee to a new manager on the chart itself (this needs the
26
+ `employee.manager-change` permission), or use Internal Movement with
27
+ movement type "manager" for a tracked change instead.
28
+
29
+ ## Organization Structure
30
+
31
+ A separate, department-focused view: a card-based tree of your
32
+ departments/units (not people), each card showing that unit's name,
33
+ connected with lines to its parent unit.
34
+
35
+ - A **KPI bar**: Departments, Total Employees, Span of Control, Open
36
+ Positions — all real, live counts.
37
+ - Click any unit card to open a details panel with three tabs: **Details**
38
+ (unit type, location, cost center, description), **Members**, and
39
+ **Metrics**.
40
+ - A legend at the bottom explains the card coloring/icons.
41
+
42
+ ## Known gaps
43
+
44
+ - On Organization Structure: the **Chart** and **List** view modes (an
45
+ alternative to the default Tree view), **Export**, **Add Unit**, **Edit
46
+ Unit**, drag-and-drop reorganization, and **Expand All/Collapse All** are
47
+ all visible but disabled — planned, not yet built. You can browse and
48
+ view details today; you can't restructure departments from this screen
49
+ yet.
50
+
51
+ ## Related
52
+
53
+ - [Employee Directory & Rosters](./employee-directory.md)
@@ -0,0 +1,86 @@
1
+ ---
2
+ title: Org Units, Legal Entities, Business Units, Divisions, Branches, Departments, Locations, Cost Centers & Profit Centers
3
+ audience: tenant
4
+ ---
5
+
6
+ # Org Units and its typed views (HCM)
7
+
8
+ This page documents the shipped **Org Units** screen (`hcm-organization`)
9
+ and eight more screens that are all, underneath, the exact same
10
+ organizational-unit data, just pre-filtered to one type each — the same
11
+ "one real screen, several locked views" pattern as the
12
+ [Employee Directory & Rosters](./employee-directory.md). Not for plugin
13
+ developers.
14
+
15
+ ## Org Units (the general screen)
16
+
17
+ **Getting there:** Organization → Org Units.
18
+
19
+ ### What you see
20
+
21
+ - **KPI cards**: Total Units, Active Units, Departments, Employees Mapped.
22
+ - A **hierarchy tree** on the left ("Organization Hierarchy") — click a
23
+ node to scope the grid to it and its children; **Show All Units** clears
24
+ that scope.
25
+ - **Search** (by name or code) and a **Status** filter (All / Active /
26
+ Inactive / Draft / Pending Approval / Rejected) and **Unit Type** filter,
27
+ with a **Clear Filters** button.
28
+ - A grid with columns: Unit Name, Unit Code, Unit Type, Parent Unit,
29
+ Location, Cost Center, Head of Unit, Employees, Status, Effective From,
30
+ and row Actions (View / Edit / Delete).
31
+ - **Bulk actions** on selected rows: Activate, Deactivate, Delete (deleting
32
+ a unit that has child units or mapped employees/positions is skipped and
33
+ reported as a failure, not silently forced through).
34
+
35
+ ### Adding or editing a unit
36
+
37
+ **Add Organization Unit** opens a form: Unit Name, Unit Code, Unit Type
38
+ (Company / Business Unit / Department / Division / Branch / Location /
39
+ Floor / Office / Work Location / Cost Center / Profit Center / Legal
40
+ Entity / Country), Parent Unit (or "None (top level)"), Head of Unit,
41
+ Manager Position, Description, Status (starts as Draft), Effective From,
42
+ Effective To, and an optional **Apply Change On** date if you want the
43
+ change scheduled rather than immediate. A banner appears on the record if
44
+ the change is pending approval, telling you it'll apply once approved.
45
+
46
+ ### Unit detail
47
+
48
+ Click a unit to open its detail view, with three tabs — **Overview**,
49
+ **Validity**, **Workforce** — covering Organization, Business Unit,
50
+ Company, Parent Unit, Child Units, Location, Cost Center, Head of Unit,
51
+ Manager Position, Employees, Positions, Vacancies, Effective From/To,
52
+ Created By, and Last Updated By. From here: **Edit**, **View Employees**,
53
+ **View Positions**, **View Org Chart**.
54
+
55
+ ## The typed views
56
+
57
+ Eight more screens in the HCM menu are the same underlying columns and
58
+ actions as Org Units above, pre-filtered and locked to one unit type, so
59
+ each has its own focused screen instead of you filtering Org Units by
60
+ hand every time:
61
+
62
+ | Screen | Unit type |
63
+ |---|---|
64
+ | **Legal Entities** | Legal entity |
65
+ | **Business Units** | Business unit |
66
+ | **Divisions** | Division |
67
+ | **Branches** | Branch |
68
+ | **Departments** | Department |
69
+ | **Locations** | Location (and location sub-types like floor) |
70
+ | **Cost Centers** | Cost center |
71
+ | **Profit Centers** | Profit center |
72
+
73
+ Each typed view has its own grid (Name, Type, Location, Head of \<Type\>,
74
+ Employees, Status, Actions) and its own create/edit form — you don't need
75
+ to also filter by type since it's locked to the one you opened.
76
+
77
+ ## Known gaps
78
+
79
+ - **Deleting a unit is blocked, not cascaded** — a unit with children or
80
+ mapped employees/positions can't be deleted from here; you'd need to
81
+ reassign or remove those first.
82
+
83
+ ## Related
84
+
85
+ - [Organizations](./organizations.md)
86
+ - [Reporting Structure & Organization Structure](./org-structure.md)