Volume 10 · Article #34 (Appendix D) Licensing Server & In-App Help Deployment Route-to-Article Mapping Matrix
Administrator Deployment Guide: Publishing Articles to Your Licensing Server & In-App Contextual Help
Every article in this 10-Volume manual (`Articles #01 to #34`) is wrapped in a self-contained <div class="kx-doc-article">...</div> block using standard Bootstrap 5 and Bootstrap Icons classes. Use the reference table below to publish each article both to your **Licensing Server Documentation Portal (`keystonex.co.za/docs`)** and into your in-app **`help_articles`** database table for slide-over contextual help.
1. How the In-App Contextual Help Drawer Works (`HelpController::getContextHelp`)
When a user clicks the **`?` Help** icon in the Global Topbar on any page inside Keystone X, the browser sends an AJAX request to `Help/getContextHelp?route={current_route#active_tab}`:
- Exact Route + Tab Hash Lookup: `HelpController` first queries `SELECT title, content FROM help_articles WHERE page_route = :route LIMIT 1` (for example, `admin/settings#financial` or `Cashbook/index`).
- Base Route Fallback: If no tab-specific entry exists, it strips the `#hash` and looks up the base route (for example, `admin/settings`).
- HTML Rendering: The `content` column stores the exact `
...` HTML block from this manual and renders it directly inside the slide-over help drawer!
2. Complete 34-Article Route, Licensing Server Slug & Screenshot Count Matrix
| Art # | Article Title | Licensing Server URL Slug | In-App help_articles.page_route Key(s) |
|---|---|---|---|
| #01 | Welcome to Keystone X: Plain-English Accounting & System Flows | docs/welcome-and-accounting-101 |
help/accounting-101 |
| #02 | Authentication, Global Topbar & Sidebar Layout Studio | docs/authentication-topbar-and-sidebar |
user/login, user/profile |
| #03 | Executive Command Centre Dashboard & Field Technician Workspace | docs/executive-dashboard-and-tech-workspace |
home/index, dashboard/index |
| #04 | Notifications Command Centre & Alert Routing Studio | docs/notifications-command-centre-and-studio |
notification/index, notification/customize |
| #05 | Inventory, Multi-Warehouse Matrix, FIFO/FEFO Batches & Studio | docs/inventory-multi-warehouse-batches-and-studio |
inventory/index, inventory/warehouses, inventory/settings |
| #06 | 360° Serial Number, Warranty & RMA Command Center & Studio | docs/serial-number-warranty-and-rma-command-center |
inventory/trackSerial, inventory/serialSettings |
| #07 | Sales Pipeline, Leads & Opportunity Command Center & Studio | docs/sales-pipeline-leads-and-opportunity-studio |
lead/index, lead/add, lead/settings |
| #08 | Customer Directory, Sage-Style Onboarding & 360° Client Profile | docs/customers-onboarding-360-profile-and-studio |
customer/index, customer/add, customer/view, customer/settings |
| #09 | Commercial Proposals, Quotes & Pro-Forma Deposit Command Center | docs/quotes-proposals-and-proforma-command-center |
quote/index, quote/add, quote/view, quote/settings |
| #10 | Revenue, Tax Invoicing & Delivery Fulfillment Command Center | docs/tax-invoices-revenue-and-delivery-fulfillment |
invoice/index, invoice/add, invoice/view, invoice/settings |
| #11 | Recurring Billing, Stock Replenishment Contracts & 360° Dossier | docs/recurring-invoices-and-retainer-contracts |
recurringinvoice/index, recurringinvoice/add, recurringinvoice/settings |
| #12 | Payments Received, Treasury Clearing, Credit Wallets & Remittance | docs/payments-received-credit-wallets-and-remittance |
payment/index, payment/settings |
| #13 | Credit Notes, RMA Sales Returns & Customer Refunds Command Center | docs/credit-notes-rma-returns-and-refunds |
creditnote/index, creditnote/add, creditnote/settings |
| #14 | Customer Statements, AR Aging & Client Self-Service Portal | docs/customer-statements-and-client-self-service-portal |
customer/statement, portal/index |
| #15 | Suppliers, Price Book Contracts, SLA Scorecards & Studio | docs/suppliers-price-books-and-srm-scorecards |
vendor/index, vendor/add, vendor/view, vendor/settings |
| #16 | Purchase Orders (PO), Replenishment Radar, GRN Stock Intake & Studio | docs/purchase-orders-replenishment-and-grn-intake |
purchaseorder/index, purchaseorder/add, purchaseorder/receive, purchaseorder/settings |
| #17 | Operating Expenses, Supplier AP Bills, GL Budgets & Input VAT | docs/operating-expenses-ap-bills-and-gl-budgets |
expense/index, expense/add, expense/settings |
| #18 | Field Service Job Cards, Technician Dispatch & Touch Sign-Off | docs/field-service-job-cards-and-mobile-sign-off |
jobcard/index, jobcard/add, jobcard/view, jobcard/settings |
| #19 | Enterprise Projects Portfolio, Milestones, Capacity & PSA Financials | docs/enterprise-projects-milestones-and-psa-billing |
project/index, project/add, project/view, project/settings |
| #20 | Task Execution Command Center, Kanban, Live Timers & Studio | docs/tasks-kanban-live-timers-and-time-billing |
task/index, task/add, task/view, task/settings |
| #21 | Enterprise Helpdesk Support Tickets, SLA Triage & Escalations | docs/helpdesk-support-tickets-and-sla-triage |
ticket/index, ticket/create, ticket/view, ticket/settings |
| #22 | Contacts & Stakeholders Directory, Multi-Company Routing & Notes | docs/contacts-stakeholders-routing-and-notes |
people/index, people/view, people/settings, note/index |
| #23 | Corporate Treasury, Multi-Bank Vaults, Recon & Transfers | docs/corporate-treasury-bank-accounts-and-transfers |
bankaccount/index, bankaccount/view, bankaccount/settings, internaltransfer/index |
| #24 | Double-Entry Cashbook, General Journals, CSV Auto-Match & COA | docs/double-entry-cashbook-journals-trial-balance-and-coa |
cashbook/index, cashbook/addjournal, cashbook/import, cashbook/settings |
| #25 | Enterprise Tax Rates, SARS VAT201 Box Mapping & Section 20 Hub | docs/enterprise-tax-rates-sars-vat201-and-sku-compliance |
taxrate/index, taxrate/add, taxrate/settings |
| #26 | Enterprise Payment Terms, Credit Policy, 2/10 Net 30 & Stock Holds | docs/enterprise-payment-terms-credit-policy-and-working-capital |
paymentterm/index, paymentterm/add, paymentterm/settings |
| #27 | Enterprise Financial & BI Reports Suite, VAT201 & Audit Pack | docs/executive-bi-financial-statements-sars-vat201-and-audit-pack |
report/index, report/sales, report/sarsvat201, report/accountant, report/settings |
| #28 | System Settings, Branding, Design System, Modules & Licensing | docs/system-settings-branding-design-system-modules-and-licensing |
admin/settings |
| #29 | Workforce Identity, Warehouse Custody, RBAC, SoD & Audit Ledger | docs/users-warehouse-custody-rbac-roles-sod-and-forensic-audit-ledger |
admin/users, admin/roles, auditlog/index, auditlog/settings |
| #30 | Email Templates Studio, SMTP Outbox Queue, Cron & Backup Vault | docs/email-templates-smtp-queue-cron-automation-and-backup-vault |
admin/emailtemplates, emailqueue/index, admin/cron, backup/index |
| #31 | Day-1 Go-Live, Data Migration & Opening Balances Checklist | docs/day-1-onboarding-and-migration-checklist |
help/onboarding-checklist |
| #32 | Hardware Barcode Scanner, Mobile Touch Sign-Off & Speed Guide | docs/barcode-scanner-mobile-touch-and-efficiency-guide |
help/barcode-and-mobile-guide |
| #33 | The Complete A–Z Plain-English Accounting, SARS VAT & ERP Glossary | docs/plain-english-accounting-and-erp-glossary |
help/accounting-glossary |
| #34 | Administrator Deployment Guide: Licensing Server & In-App Help | docs/licensing-server-and-contextual-help-deployment |
help/admin-deployment |