Browse by Package¶
This index maps the most important ADempiere Java packages to their architectural responsibility, main classes, related processes and engineering documentation.
Use this page whenever development starts from a Java package or source-code area.
Engineering Workflow¶
- Identify the Java package involved.
- Review the package responsibility.
- Identify the main classes.
- Open the referenced documentation.
- Follow the corresponding Playbook.
- Build, deploy and validate.
ADempiere Core Packages¶
| Package | Responsibility | Main Classes | Related Processes | Documentation | Status |
|---|---|---|---|---|---|
org.compiere.acct |
Accounting Engine and posting logic. | Doc • Doc_Invoice • Doc_Order • Fact • FactLine • MAcctSchema |
Document Posting • Invoice Posting • Fact Generation | 📖 Accounting Engine | ✅ Certified |
org.compiere.model |
Persistent models and business objects. | PO • MInvoice • MOrder • MProduct • MBPartner • MProject |
Persistent Object Save • Model Runtime • Business Logic | 📖 PO Persistence Framework | ✅ Certified |
org.compiere.util |
Database, transactions, cache and runtime utilities. | DB • Trx • CCache • CacheMgt • Env |
PO to PostgreSQL Flow • Cache Reset • Runtime Support | 📖 PO to PostgreSQL • 📖 CCache | ✅ Certified |
org.compiere.process |
Server-side process execution framework. | SvrProcess • ProcessInfo • ProcessCtl • MPInstance |
Process Execution • Parameters • Process Logs | Process Framework (KB-215 planned) | 📋 Planned |
org.compiere.grid |
UI grid, tabs, fields and window interaction layer. | GridTab • GridField • GridController |
Window Runtime • Callouts • UI Events | Callout Framework (KB-214 planned) • Application Dictionary (KB-217 planned) | 📋 Planned |
org.compiere.apps |
Desktop client application layer. | Forms • Panels • Actions • UI Components | Window Navigation • User Interaction | Runtime Architecture (planned) | 📋 Planned |
org.compiere.print |
Printing and report rendering. | PrintFormat • Report Engine • PrintData | Reports • Documents • PDF Output | Reporting (planned) | 📋 Planned |
org.compiere.wf |
Workflow Engine. | MWFProcess • MWFActivity • MWFNode |
Workflow Execution • Approvals | Workflow Engine (KB-216 planned) | 📋 Planned |
Application Dictionary Packages¶
| Package | Responsibility | Main Classes | Related Processes | Documentation | Status |
|---|---|---|---|---|---|
org.compiere.model |
Runtime access to Application Dictionary metadata. | MTable • MColumn • MWindow • MTab • MField |
Model Generation • Window Runtime • Metadata Resolution | Application Dictionary (KB-217 planned) | 📋 Planned |
org.compiere.grid.ed |
Field editors and UI field rendering. | Editors • Lookup Fields • UI Controls | Window Runtime • Field Interaction | Application Dictionary (KB-217 planned) • Callout Framework (KB-214 planned) | 📋 Planned |
org.compiere.swing |
ADempiere Swing UI components. | Custom Swing Components | Client UI Rendering | Runtime Architecture (planned) | 📋 Planned |
BLACK ERP API Packages¶
| Package | Responsibility | Main Classes | Related Processes | Documentation | Status |
|---|---|---|---|---|---|
src/modules/auth |
Authentication and token generation for the REST API. | Auth Controller • Auth Service • Guards | Login • JWT • API Key Validation | API Architecture (KB-301 planned) | ✅ Certified |
src/modules/business-partner |
Business Partner REST services. | Business Partner Controller • Service • DTOs | Create BP • Update BP • Activate / Deactivate BP | API Architecture (KB-301 planned) | ✅ Certified |
src/modules/projects |
Project REST services. | Projects Controller • Service • DTOs | Create Project • Update Project • Project Catalogs | API Architecture (KB-301 planned) | ✅ Certified |
src/modules/catalogs |
Shared catalog endpoints. | Catalogs Controller • Catalog Services | Reference Data • Public Catalogs | API Architecture (KB-301 planned) | ✅ Certified |
src/modules/health |
API health and monitoring endpoint. | Health Controller | Health Check • Deployment Validation | API Architecture (KB-301 planned) | ✅ Certified |
BLACK ERP Localization Packages¶
| Package | Responsibility | Main Classes | Related Processes | Documentation | Status |
|---|---|---|---|---|---|
MXCFDI |
Mexican localization namespace for SAT and CFDI customizations. | SAT Catalog Tables • CFDI Fields • EntityType MXCFDI | SAT Catalog Management • CFDI Timbrado | CFDI Architecture (KB-302 planned) | 🚧 In Progress |
SAT Catalogs |
SAT fiscal catalog management. | Regimen Fiscal • Uso CFDI • Forma Pago • Metodo Pago • Unidad Medida | SAT Validation • CFDI Data Preparation | CFDI Architecture (KB-302 planned) | 🚧 In Progress |
Timbrador Service |
External CFDI timbrado integration. | Timbrado Worker • PAC Client • CFDI Response Handler | Timbrado • UUID Storage • XML Storage | CFDI Architecture (KB-302 planned) | 🚧 In Progress |
Infrastructure Packages¶
| Package | Responsibility | Main Classes | Related Processes | Documentation | Status |
|---|---|---|---|---|---|
nginx |
Reverse proxy, SSL and public routing. | Site Configs • SSL Certificates | Docs Publishing • API Proxy • ADempiere Proxy | 📖 Infrastructure | ✅ Certified |
tomcat |
ADempiere web runtime. | Webapps • Classloader • Logs | Core Deployment • Runtime Debugging | 📖 Core Debugging Guide | ✅ Certified |
postgresql |
Database engine for ADempiere and BLACK ERP data. | Schemas • Tables • Backups | Persistence • Backup • Restore | 📖 Backup Strategy | ✅ Certified |
pm2 |
Node.js API process manager. | blackerp-api process | API Deployment • Health Check | Deployment Procedure (KB-104) | ✅ Certified |
mkdocs |
Documentation portal generator. | Material for MkDocs • Markdown Files • Site Build | Documentation Publishing | Deployment Procedure (KB-104) | ✅ Certified |
BLACK ERP Engineering Notes¶
Use this Explorer when work starts from a code package, source directory or architectural namespace.
Typical navigation:
Package
↓
Main Classes
↓
Related Process
↓
Knowledge Base
↓
Playbook
↓
Implementation
↓
Build and Deployment