User Guide Fact Check
This maintainer-only file maps public guide claims to application truth. Do not copy this file into public-facing pages.
Source Priority
| Priority | Source | Use For |
|---|---|---|
| 1 | Frontend UI code and route/sidebar configuration | Menu names, visible fields, user actions, permission-based visibility. |
| 2 | Backend controllers, models, helpers, access rules | Saved behavior, validation, import columns, report logic, permission enforcement. |
| 3 | Playwright E2E specs and audited sample import files | Flow-level verification and repeatable examples. |
| 4 | Screenshots captured from guide tenant | Visual confirmation only after labels and behavior are already verified. |
Global UI Truth
| Area | Verified Truth | Source |
|---|---|---|
| Main transaction menus | Receipt, Issue, Move, Adjustment appear directly in the sidebar when the role has the related transaction permissions. | frontend/src/containers/TheSidebar.js |
| Report menu labels | Detail Stock Card, Daily Stock Pivot, Summary Stock Card, plus either Warehouse Minimum Stock or Minimum Stock depending on settings. | frontend/src/containers/TheSidebar.js, frontend/src/routes.js, backend/core/admin/migrations/m260523_140000_complete_warehouse_translation_rollout.php |
| Minimum stock setting | activate_locator_minimum_stock: 0 = Inactive, 1 = Per Warehouse, 2 = Union. The UI still uses the setting key Activate locator minimum stock. | frontend/src/views/site/settings/FormSettings.js, backend/core/api/models/Company.php, backend/core/admin/migrations/m260523_140000_complete_warehouse_translation_rollout.php |
| Minimum stock report switching | 1 shows locator minimum behavior, 2 shows union/global minimum behavior. | frontend/src/containers/TheSidebar.js, backend/core/api/modules/v1/controllers/ReportController.php |
| Import menu labels | Import Item, Import Minimum Stock, Import Item Category, Import Warehouse, Import Unit of Measure. | frontend/src/containers/TheSidebar.js, frontend/src/routes.js, backend/core/admin/migrations/m260523_140000_complete_warehouse_translation_rollout.php |
| Manage menu labels | Settings, Users & Permissions, Transaction, Import, Custom Form, Integrations, and Others are the main Manage groups. | frontend/src/containers/TheSidebar.js |
| Role price permission UI | The role table shows a Price row. View maps to viewPrice; Update maps to editPrice. | frontend/src/views/role/CreateRole.js, frontend/src/views/role/UpdateRole.js |
| Price visibility | Price appears only when company Enable Price is active and role has viewPrice; edit needs editPrice. | frontend/src/utils/common/index.js, backend/core/api/modules/v1/helpers/CommonApiHelper.php |
| Calendar Period purpose | Calendar Period locks/unlocks transaction entry per month and transaction type. | backend/core/api/helpers/TransactionHelper.php, backend/core/api/models/Transaction.php, frontend/src/views/calendar/PeriodList.js |
| Custom Form menus | Custom Form includes Custom Fields, Item Form, Receipt Form, Issue Form, Move Form, and Adjustment Form when related permissions exist. | frontend/src/containers/TheSidebar.js, frontend/src/routes.js |
| Custom field types | Custom fields support Text, Textarea, Dropdown, Date, Time, and File. | frontend/src/views/field/CreateCustomField.js, frontend/src/views/field/UpdateCustomField.js |
| Form assignment behavior | Item Form and transaction form pages place active custom fields into selected forms and can mark them mandatory. | frontend/src/views/item/ItemForm.js, frontend/src/views/transaction/TransactionForm.js |
| Document status behavior | doc_status uses draft, complete, and void flows; complete writes stock logs and void reverses completed logs. | backend/core/api/modules/v1/controllers/TransactionController.php, backend/core/api/models/Transaction.php |
| UOM conversion behavior | Item update supports item UOM conversions, and transaction lines use conversion data when selected UOM differs from base. | frontend/src/views/item/ViewConversion.js, backend/core/api/helpers/TransactionHelper.php, backend/core/api/modules/v1/controllers/TransactionController.php |
| User profile default warehouses | User profile and user management still store default_locator_id and default_to_locator_id internally, but the UI labels are Default Warehouse and Default Destination Warehouse. | frontend/src/views/site/profile/FormProfile.js, frontend/src/views/users/CreateUser.js, backend/core/api/modules/v1/controllers/UserController.php, backend/core/admin/migrations/m260523_140000_complete_warehouse_translation_rollout.php |
| Minimum quantity notification | Company email template support includes email-minimum-quantity-notification, with recipients configured from settings. | frontend/src/views/site/settings/FormSettings.js, frontend/src/views/email/TemplateList.js, backend/core/api/helpers/EmailHelper.php |
Page-Level Evidence Matrix
| Guide Page | Status | Evidence Used |
|---|---|---|
| Overview | verified | Sidebar/routes and verified module pages. |
| Registration and Login | verified | Public account pages, login UI, added sign-in return links. |
| New Company Quick Start | verified | Uses verified required setup sequence from master data, receipt transaction, dashboard empty state, and stock reports. |
| Onboarding Wizard | verified | OnboardingController, onboarding UI flow, dashboard redirect/CTA behavior, and onboarding E2E coverage. |
| Dashboard | verified | Dashboard UI/controller behavior and Playwright dashboard smoke. |
| Company Settings | verified | Settings form, Company model, CommonApiHelper. |
| Item Category | verified | ItemCategory list/create/update UI and master-data import audit. |
| Unit of Measure | verified | UOM list/create/update UI, precision field, import audit. |
| Warehouse | verified | Warehouse routes/forms, legacy Locator model, minimum stock settings, and warehouse translation rollout. |
| Item | verified | Item create/update UI, price helpers, initial stock backend checks, UOM conversion source. |
| Item Numbering and Item Form | verified | ItemNumbering.js, TransactionHelper::generateItemNumber, ItemController::actionManageField, ItemForm.js. |
| Users | verified | Users list/create/update UI, owner/admin role normalization, profile/default warehouse source, and role-based warehouse access. |
| Roles and Permissions | verified | Role create/update UI and backend permission names. |
| Receipt | verified | Transaction create/update UI, transaction helper/store flow, E2E core transaction test. |
| Issue | verified | Transaction create/update UI, transaction helper/store flow, E2E core transaction test. |
| Move | verified | Transaction create/update UI source/destination warehouse fields, E2E core transaction test. |
| Adjustment | verified | Transaction create/update UI, adjustment/import samples, E2E core transaction test. |
| Transaction Category and Custom Fields | verified | TransactionCategory model/controller, document numbering components, custom form routes, custom field type source, item/transaction form assignment source. |
| Import Master Data | verified | Backend import controllers, sample file generator, API import audit. |
| Import Minimum Stock | verified | ItemController minimum stock import/template and API import audit for Union and Per Warehouse. |
| Import Transaction Lines | verified | Transaction import UI/E2E and API import audit for receipt/adjustment line files. |
| Detail Stock Card | verified | ReportController, report UI, pricing checks, Playwright detail toggle specs. |
| Summary Stock Card | verified | ReportSummaryStockList.js, StockSummaryResult, report smoke test. |
| Daily Stock Pivot | verified | ReportDailyStockPivotList.js, DailyStockPivotTable, report smoke test. |
| Minimum Stock Reports | verified | Sidebar switch + report controllers. |
| Pricing | verified | Company model, settings form, CommonApiHelper, item/transaction/report UI. |
| Print Templates | verified | TemplateList.js, TemplateEditor.js, PrintTemplateController, transaction category assignment. |
| Email Template | verified | TemplateList.js, UpdateTemplate.js, EmailTemplateController, EmailHelper::addDefaultEmailTemplates. |
| Calendar Period | verified | TransactionHelper, CalendarPeriodController, Transaction model, PeriodList.js. |
| API Access | verified | AccessList.js, ApiAccessController, CompanyApiToken, PublicApiHelper. |
| Troubleshooting | verified | Aggregates verified module behavior only. |
| Glossary | verified | Terms aligned to sidebar labels and source terminology. |
Known Corrections From Audit
| Previous Wording | Corrected Truth |
|---|---|
| Calendar Period organizes reporting periods. | Calendar Period locks/unlocks transaction periods by month and transaction type. |
| Minimum stock mode: global/warehouse. | UI setting is Activate locator minimum stock with Inactive, Per Warehouse, Union. |
Price permission names shown as View Price and Edit Price. | UI shows row Price with table columns View and Update. |
Stock Detail Card / Stock Summary Card. | Sidebar labels are Detail Stock Card / Summary Stock Card. |
Minimum stock sample column Warehouse. | Backend template and sample file still use Locator as the column header even though the public UI now says Warehouse. |
| UOM conversion guidance. | UOM master page documents verified Precision; Item page now documents verified item-specific UOM conversion behavior. |
| Email templates as broad company email system. | Public page now states normal company edit scope is limited to exposed templates, including minimum quantity notification. |
Recommended-Practice Content
The guide now includes business examples such as Goods Receipt Form, production issue, warehouse transfer, stock opname, and item master enrichment. These examples are marked as recommendations, not built-in fields. Their application truth is:
| Recommendation Area | Verified Application Capability | Source |
|---|---|---|
| Goods Receipt Form fields such as PO Number, Supplier, QC Status, Attachment. | Companies can create custom fields, place them into Receipt Form, make them mandatory, and include them in print/report contexts when configured. | frontend/src/views/field/CreateCustomField.js, frontend/src/views/transaction/TransactionForm.js, backend/core/api/modules/v1/controllers/TransactionController.php |
| Issue, Move, and Adjustment operational fields. | Each transaction type has its own form configuration route and selected fields are saved per transaction type. | frontend/src/containers/TheSidebar.js, frontend/src/routes.js, backend/core/api/modules/v1/controllers/TransactionController.php |
| Item operational fields such as Brand, Batch Required, Storage Rule. | Item Form can place active custom fields onto item create/update forms. | frontend/src/views/item/ItemForm.js, backend/core/api/modules/v1/controllers/ItemController.php |
| Operational admin examples for settings, roles, imports, pricing, email template, and API access. | These are recommended operating patterns built on verified menu/settings/permission behavior, not additional app features. | frontend/src/containers/TheSidebar.js, related view/controller sources listed in the page-level evidence matrix. |
| Custom Form per-form examples. | The app has separate Item, Receipt, Issue, Move, and Adjustment form configuration pages. Recommended fields are operational examples and are not created automatically. | frontend/src/containers/TheSidebar.js, frontend/src/views/item/ItemForm.js, frontend/src/views/transaction/TransactionForm.js |