Engineering Explorer Guide¶
The Engineering Explorer is the navigation layer of the BLACK ERP Engineering Portal.
Instead of searching through documents manually, developers should always start from the engineering object involved in the implementation.
The Explorer maps every important engineering artifact to the related documentation.
What can I start from?¶
Depending on the implementation, begin from one of these entry points.
| Start From | Explorer |
|---|---|
| Functional Module | By Module |
| Java Class | By Java Class |
| Database Table | By Database Table |
| ERP Process | By Process |
| ERP Window | By Window |
| Java Package | By Package |
Typical Engineering Flows¶
Modifying an ERP Window¶
Window
↓
Database Table
↓
Java Model
↓
Knowledge Base
↓
Playbook
↓
Implementation
Modifying a Database Table¶
Database Table
↓
Java Model
↓
Knowledge Base
↓
Playbook
↓
Implementation
Modifying a Java Class¶
Java Class
↓
Related Framework
↓
Knowledge Base
↓
Build
↓
Deploy
Modifying an ERP Process¶
Process
↓
Related Objects
↓
Knowledge Base
↓
Implementation
↓
Validation
Modifying a Package¶
Package
↓
Classes
↓
Framework
↓
Knowledge Base
↓
Deployment
Engineering Principles¶
Always try to navigate through the Explorer before searching documents manually.
The Engineering Explorer should answer:
- Where should I start?
- Which classes are involved?
- Which database tables are affected?
- Which business processes depend on this change?
- Which Knowledge Base documents should I read?
- Which Playbook should I execute?
Engineering Explorer Structure¶
Engineering Explorer
├── By Module
├── By Java Class
├── By Database Table
├── By Process
├── By Window
└── By Package
BLACK ERP Engineering Notes¶
The Engineering Explorer is intended to become the primary navigation layer of the BLACK ERP Engineering Portal.
As the platform evolves, every new document should become reachable from at least one Explorer entry.
This guarantees that engineering knowledge remains organized, discoverable and reusable over time.