Document lifecycle, locking, and version control
File check-out locking, revision tracking, cryptographic SHA-256 digests, and one-click rollback.
1. Overview & Business Value#
This comprehensive operational guide details the architecture, business workflows, configuration parameters, and execution steps for Document lifecycle, locking, and version control within SmartERP.

Document integrity is critical when collaborating across distributed teams. SmartERP Documents Enterprise provides formal check-out locking, immutable version tracking, and cryptographic integrity verification.
2. Prerequisites & Security Access Groups#
- Required Modules:
documents, smarterp_dms - Security Groups:
Documents User(Technical ID:documents.group_documents_user)Documents Administrator(Technical ID:documents.group_documents_manager)
- Master Data Dependencies: Workspace hierarchies, document tags, automated actions, OCR rule definitions, and retention policies.
3. Step-by-Step Configuration & Execution#
Step 1: Navigating to the Interface#
- Log into your SmartERP instance at
https://smarterp.et/odoo. - Open the main App Switcher (grid icon in the top-left corner).
- 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.
Check-out and check-in locking#
To prevent conflicting edits when an officer downloads an agreement or spreadsheet for editing:
sequenceDiagram
autonumber
actor Alice as Officer (Alice)
participant DMS as SmartERP Documents
actor Bob as Officer (Bob)
Alice->>DMS: Click 'Check Out' on Contract.docx
DMS->>DMS: Set lock flag (locked_by: Alice, lock_date: Now)
Bob->>DMS: Attempts to edit or upload new version
DMS-->>Bob: Blocked: 'Document is locked by Alice since 10:15 AM'
Alice->>DMS: Uploads modified Contract.docx & clicks 'Check In'
DMS->>DMS: Releases lock & increments version from v1.2 to v1.3
DMS->>Bob: Document unlocked & available for editing
Immutable version history#
Every new file upload or modification creates a new entry in documents.document.history:
- Version Numbering: Automatically increments major/minor versions (e.g.,
1.0$\rightarrow$1.1$\rightarrow$2.0). - Revision Rationale: Prompts the user to enter a required change summary.
- SHA-256 Digest: Records a 64-character hexadecimal checksum calculated at moment of storage.
- Author & Timestamp: Preserves full audit accountability.
Rollback to prior version#
If an error is discovered in a newly uploaded version:
- Open the document detail panel.
- Navigate to the Versions tab.
- Locate the desired previous version (e.g.,
v1.2). - Click Restore Version.
- The system archives the current state and restores the selected historical binary as the active document, maintaining a complete audit trail of the restoration event.
4. Advanced Configuration Points#
- Automated Actions & Scheduled Tasks (Crons):
Documents: Run OCR field extraction(documents.ir_cron_ocr_process): Runs every 15 minutes to process incoming scanned document textDocuments: Archive expired records(documents.ir_cron_retention): Runs weekly to enforce statutory document retention schedules
- Custom Print Templates & Reports:
- Document Audit Trail & Access Log
- Workspace Document Storage & Activity Ledger
- 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 / Exception | Probable Root Cause | Corrective Action / Resolution |
|---|---|---|
Access Rights Error: Workspace access restricted | User lacks permissions for confidential legal or HR workspace. | Request workspace access clearance from Documents Administrator. |
OCR Extraction Failure: Low scan resolution | Scanned image DPI is below minimum threshold for optical character recognition. | Upload document at minimum 300 DPI resolution with clear contrast. |
Upload Blocked: File size exceeds maximum limit | File exceeds system maximum attachment size. | Compress file or upload via secure external cloud link. |