SmartERP Documentation An Ashewa Technology Solutions Platform

Dashboard, quality checks and coverage

What needs attention, which rules a page breaks, and which parts of a guide each product is missing.

1. Overview & Business Value#

This comprehensive operational guide details the architecture, business workflows, configuration parameters, and execution steps for Dashboard, quality checks and coverage within SmartERP.

Module map showing dependencies between SmartERP Supply Chain Core, Tenders, Store Vouchers, Landed Costs, and WMS.
SmartERP Supply Chain and Sourcing architectural module map.

Three screens help you keep documentation true. All of them are built from real records, count only what you may read, and open the list behind every number.

2. Prerequisites & Security Access Groups#

  • Required Modules: smarterp_docs
  • Security Groups:
    • Technical Documentation Architect (Technical ID: base.group_system)
    • Enterprise User (Technical ID: base.group_user)
  • Master Data Dependencies: Markdown documentation trees, asset manifests, SVG diagram generators, and multi-language search indexes.

3. Step-by-Step Configuration & Execution#

Step 1: Navigating to the Interface#

  1. Log into your SmartERP instance at https://smarterp.et/odoo.
  2. Open the main App Switcher (grid icon in the top-left corner).
  3. Navigate to Settings → Technical.

Step 2: Operational Data Parameters & Controls#

Ensure all mandatory parameters comply with enterprise operational standards:

  • Authorized Operator: Action executed under assigned RBAC permissions (System Administrator, Certified Specialist).
  • Relational Integrity: Linked to upstream master records, approval requests, or transactional ledgers.
  • Statutory & Quality Controls: Verified against Ethiopian statutory regulations and corporate governance standards.

Step 3: Operational Execution & State Progression#

  • State Progression Gate: Advance record from Draft through Audited to Confirmed / Certified.
  • Integrated System Impact: Automatically updates real-time operational states and posts financial/inventory journal moves.
  • Audit Verification: System registers tamper-evident audit records logging user ID, timestamp, and cryptographic transaction digests.

Dashboard#

Documentation → Dashboard shows tiles in four groups:

  • Where the pages are: drafts, in review, published, needs review, deprecated, archived.
  • Needs attention: pages waiting for your review, review dates that have passed, published pages with no summary or product or Amharic translation.
  • Quality (last check): broken links, expired pages, empty pages, duplicate titles, stale pages, pages nobody links to.
  • Coverage: empty slots, and products or modules with no page at all.

A number of zero is shown calmly. Click a tile to open exactly the records it counted.

Quality checks#

The rules are fixed and explainable. A page either breaks a rule, with a reason, or it does not. There is no score.

RuleSeverityMeaning
EmptyerrorThe page has no text.
Past its expiration dateerrorThe expiration date has passed.
Links to a missing pageerrorA doc: link points at a page that does not exist or is not published.
No summarywarningThere is no one-line summary.
No product or modulewarningThe page is about nothing in the catalog.
Review date has passedwarningTime to read it again.
Same title as another pagewarningTwo pages of one product share a title.
No content typenoteThe type is not set.
No prerequisites, no expected resultnoteA step-by-step page should say what you need and what you get.
Not changed for a long timenoteStale: see smarterp_docs.stale_months.
Nothing links herenoteNo page, relation or parent leads to it.

A daily job refreshes the issues, and Documentation → Quality → Check Quality Now does it on demand. Between runs the dashboard says when it last looked. External links are not checked automatically.

Coverage#

Documentation → Quality → Coverage is a matrix: a row for every product, area and module and a column for every part of a complete guide (Overview, Getting Started, User Guide, Administrator Guide, Configuration, How-To, Troubleshooting, FAQ, Developer Guide, API, Integration, Security, Migration, Release Notes).

A published page fills a column when its content type or its section's kind says so. A row counts the pages about it and about everything inside it. Missing is a cell with nothing in it. There is no percentage, because a count of what exists is more honest than a score.

4. Advanced Configuration Points#

  • Automated Actions & Scheduled Tasks (Crons):
    • Documentation: Auto-rebuild search index (smarterp_docs.ir_cron_reindex): Runs on module upgrade to refresh full-text search indexes
  • Custom Print Templates & Reports:
    • SmartERP Technical Documentation Standards & Style Guide
    • Documentation Coverage & Visual Asset Verification Matrix
  • Multi-Company Rules: Record-level security isolation under Company 1 (Ashewa Technology Solutions S.C.), preventing cross-company ledger leakage across parent and subsidiary legal entities.

5. Comprehensive Troubleshooting Matrix#

Error Symptom / ExceptionProbable Root CauseCorrective Action / Resolution
Test Error: Broken link in documentationInternal doc link refers to non-existent section or page slug.Update link path to match valid section and page identifiers.
Test Error: Asset referenced in markdown not found in manifestDiagram or image referenced in text lacks manifest.json entry.Register asset ID and file paths in static/img/manifest.json.
Formatting Warning: Stray markdown marker detectedUnclosed bold or link brackets found in rendered HTML.Ensure all emphasis tags and links are properly closed in markdown source.
Last updated: 2026-11-15