BLACK ERP Engineering Portal¶
The permanent technical memory of BLACK ERP
This portal exists to reduce the time required to understand, modify, build and deploy BLACK ERP safely.
Start Here¶
Use the portal based on the type of work you are doing.
| I need to... | Start Here |
|---|---|
| Modify a Java class | Engineering Explorer → By Java Class |
| Modify a database table | Engineering Explorer → By Database Table |
| Modify an ERP process | Engineering Explorer → By Process |
| Modify an ERP window | Engineering Explorer → By Window |
| Work by module | Engineering Explorer → By Module |
| Work by Java package | Engineering Explorer → By Package |
| Follow a certified procedure | Playbooks |
| Review Core documentation | Reference Manuals |
Engineering Explorer¶
The Engineering Explorer is the primary navigation layer of the portal.
Start from the technical object involved in the task.
Module
↓
Process
↓
Window
↓
Database Table
↓
Java Class
↓
Package
↓
Knowledge Base
↓
Playbook
↓
Implementation
Open the guide:
Quick Access¶
Frequently used engineering references.
| Area | Link |
|---|---|
| Core Development Lifecycle | KB-208 — Core Development Lifecycle |
| Accounting Engine | KB-212 — Accounting Engine |
| Document Posting Patterns | KB-212 Chapter 10 — Document Posting Patterns |
| PO Persistence Framework | KB-212 Chapter 13 — PO Persistence Framework |
| Cache Architecture | KB-212 Chapter 15 — CCache |
| Infrastructure | KB-101 — Infrastructure |
| Backup Strategy | KB-103 — Backup Strategy |
| Deployment Procedure | KB-104 — Deployment Procedure |
Current Engineering Focus¶
| Area | Status | Notes |
|---|---|---|
| REST API | ✅ Active | Business Partner and Projects services implemented. |
| Business Partners | ✅ Completed | API and accounting defaults validated. |
| Projects API | ✅ Completed | Create, update and catalog endpoints available. |
| SAT Localization | 🚧 In Progress | SAT catalogs and product fiscal fields under implementation. |
| CFDI Timbrado | 🚧 In Progress | Architecture and workflow under design. |
| BLACK ERP Architecture | 📋 Planned | KB-300 series reserved. |
| AI Engineering | 📋 Planned | Future engineering layer. |
Engineering Areas¶
🏗 Engineering Standards¶
Certified engineering procedures.
Includes:
- Development Lifecycle
- Build & Compilation
- Deployment Standards
- Packaging
- Troubleshooting
📖 Reference Manuals¶
Deep technical documentation.
Includes:
- ADempiere Core
- Accounting Engine
- Runtime Architecture
- Internal Frameworks
🏢 Functional Documentation¶
Business-oriented documentation.
Includes:
- Sales
- Purchasing
- Projects
- Accounting
- BlackNet
🚀 BLACK ERP¶
Architecture of the BLACK ERP platform.
Includes:
- Platform Architecture
- REST API
- CFDI
- Mexican Localization
- Integrations
- AI
🛠 Playbooks¶
Operational engineering procedures.
Examples:
- Add ADempiere Column
- Modify ADempiere Window
- Modify Java Process
- Build & Deploy Core
- Deploy API
- Emergency Restore
🖥 Infrastructure¶
Infrastructure and operational platform.
Includes:
- Ubuntu Server
- PostgreSQL
- Tomcat
- Nginx
- MkDocs
- SSL
- Backup Strategy
- Disaster Recovery
Engineering Rule¶
Every new document created for BLACK ERP must be reachable through at least one Engineering Explorer entry.
The Explorer is the primary navigation mechanism of the Engineering Portal.
Documentation should never become a collection of isolated documents.
Engineering Philosophy¶
The purpose of this portal is not simply to store documentation.
Its purpose is to preserve engineering knowledge.
When a future development starts, engineers should spend their time implementing solutions instead of rediscovering how the platform works.
Knowledge is considered part of the product.
Build software once. Build knowledge forever.