Shumoul Business Onboarding & Smart Configuration — Developer Guide
Business Onboarding & Smart Configuration lets a new tenant answer a short smart survey the first time an admin logs in, and have Shumoul automatically configure the tenant's ERP settings based on the answers, instead of a blank system the tenant has to configure by hand.
Who it's for: Backend Developers · Angular Developers · DevOps / Operators · Future Maintainers
| Field | Value |
|---|---|
| Status | Production Ready (backend), New Subscriber E2E verified — Angular integration pending |
| Version | Phase 1.6 + Phase 8 (11 supported settings groups) + Onboarding Text & Validation Message Localization + Database-Owned Survey Content Preserved on Reseed + Stable RuleKey for Recommendation Rules |
| Last Updated | 2026-07-13 |
| Maintained By | Shumoul Engineering |
| Documentation | Official Developer Guide |
| Source of Truth | Shumoul Platform Source Code (Shumoul.Saas.MultiTenancyApi, Shumoul.Saas.Api) |
Chapters
| # | Section | File |
|---|---|---|
| 1 | Cover | 01-cover.md |
| 2 | Table of Contents | 02-table-of-contents.md |
| 3 | Overview & Business Goal | 03-overview.md |
| 4 | Architecture | 04-architecture.md |
| 5 | User Journey & First Login Flow | 05-user-journey.md |
| 6 | Backend Modules | 06-backend-modules.md |
| 7 | Database Tables | 07-database-tables.md |
| 8 | API Reference | 08-api-reference.md |
| 9 | Authentication & Authorization | 09-authentication-and-authorization.md |
| 10 | Internal Apply Bridge | 10-internal-apply-bridge.md |
| 11 | Settings Patch Engine & Supported/Unsupported Groups | 11-settings-patch-engine.md |
| 12 | Runtime Configuration | 12-runtime-configuration.md |
| 13 | Angular Integration Guide (+ Claude Code prompt) | 13-angular-integration-guide.md |
| 14 | Postman Testing Guide | 14-postman-testing-guide.md |
| 15 | Security Notes | 15-security-notes.md |
| 16 | Operational Notes | 16-operational-notes.md |
| 17 | Known Limitations | 17-known-limitations.md |
| 18 | Phase History / Implementation Status | 18-phase-history.md |
| 19 | Angular Developer Brief — Arabic / English | 19-angular-developer-brief-ar-en.md |
| 20 | Business Onboarding Survey Options | 20-survey-questions-and-recommendation-rules.md |
| 21 | Onboarding Apply Bridge — Local Setup & Live Verification | 21-apply-bridge-local-setup-and-verification.md |
Source of Truth
This guide is written directly against the platform's shipped source code
(Shumoul.Saas.MultiTenancyApi and Shumoul.Saas.Api), verified against the actual entity, controller, and
service files rather than assumed, and kept in sync with the phase-by-phase implementation history in
Chapter 18.
Export targets
Every file in this folder is plain Markdown with no proprietary formatting, so the set can be exported to PDF, static HTML, GitHub Pages, Docusaurus, Docsify, or BookStack without rewriting content — only a branding/theme pass and a build-tool configuration are needed.