mirror of
https://github.com/bringout/oca-technical.git
synced 2026-04-18 13:52:05 +02:00
Initial commit: OCA Technical packages (595 packages)
This commit is contained in:
commit
2cc02aac6e
24950 changed files with 2318079 additions and 0 deletions
32
odoo-bringout-oca-hack-payroll/doc/ARCHITECTURE.md
Normal file
32
odoo-bringout-oca-hack-payroll/doc/ARCHITECTURE.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Architecture
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
U[Users] -->|HTTP| V[Views and QWeb Templates]
|
||||
V --> C[Controllers]
|
||||
V --> W[Wizards – Transient Models]
|
||||
C --> M[Models and ORM]
|
||||
W --> M
|
||||
M --> R[Reports]
|
||||
DX[Data XML] --> M
|
||||
S[Security – ACLs and Groups] -. enforces .-> M
|
||||
|
||||
subgraph Payroll Module - payroll
|
||||
direction LR
|
||||
M:::layer
|
||||
W:::layer
|
||||
C:::layer
|
||||
V:::layer
|
||||
R:::layer
|
||||
S:::layer
|
||||
DX:::layer
|
||||
end
|
||||
|
||||
classDef layer fill:#eef8ff,stroke:#6ea8fe,stroke-width:1px
|
||||
```
|
||||
|
||||
Notes
|
||||
- Views include tree/form/kanban templates and report templates.
|
||||
- Controllers provide website/portal routes when present.
|
||||
- Wizards are UI flows implemented with `models.TransientModel`.
|
||||
- Data XML loads data/demo records; Security defines groups and access.
|
||||
3
odoo-bringout-oca-hack-payroll/doc/CONFIGURATION.md
Normal file
3
odoo-bringout-oca-hack-payroll/doc/CONFIGURATION.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Configuration
|
||||
|
||||
Refer to Odoo settings for payroll. Configure related models, access rights, and options as needed.
|
||||
3
odoo-bringout-oca-hack-payroll/doc/CONTROLLERS.md
Normal file
3
odoo-bringout-oca-hack-payroll/doc/CONTROLLERS.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Controllers
|
||||
|
||||
This module does not define custom HTTP controllers.
|
||||
7
odoo-bringout-oca-hack-payroll/doc/DEPENDENCIES.md
Normal file
7
odoo-bringout-oca-hack-payroll/doc/DEPENDENCIES.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Dependencies
|
||||
|
||||
This addon depends on:
|
||||
|
||||
- [hr_contract](../../odoo-bringout-oca-ocb-hr_contract)
|
||||
- [hr_holidays](../../odoo-bringout-oca-ocb-hr_holidays)
|
||||
- [mail](../../odoo-bringout-oca-ocb-mail)
|
||||
4
odoo-bringout-oca-hack-payroll/doc/FAQ.md
Normal file
4
odoo-bringout-oca-hack-payroll/doc/FAQ.md
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
# FAQ
|
||||
|
||||
- Q: Which Odoo version? A: 16.0 (OCA/OCB packaged).
|
||||
- Q: How to enable? A: Start server with --addon payroll or install in UI.
|
||||
7
odoo-bringout-oca-hack-payroll/doc/INSTALL.md
Normal file
7
odoo-bringout-oca-hack-payroll/doc/INSTALL.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Install
|
||||
|
||||
```bash
|
||||
pip install odoo-bringout-oca-hack-payroll"
|
||||
# or
|
||||
uv pip install odoo-bringout-oca-hack-payroll"
|
||||
```
|
||||
27
odoo-bringout-oca-hack-payroll/doc/MODELS.md
Normal file
27
odoo-bringout-oca-hack-payroll/doc/MODELS.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# Models
|
||||
|
||||
Detected core models and extensions in payroll.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
class hr_contribution_register
|
||||
class hr_payroll_structure
|
||||
class hr_payslip
|
||||
class hr_payslip_input
|
||||
class hr_payslip_line
|
||||
class hr_payslip_run
|
||||
class hr_payslip_worked_days
|
||||
class hr_rule_input
|
||||
class hr_rule_parameter
|
||||
class hr_rule_parameter_value
|
||||
class hr_salary_rule
|
||||
class hr_salary_rule_category
|
||||
class hr_contract
|
||||
class hr_employee
|
||||
class hr_salary_rule
|
||||
class res_config_settings
|
||||
```
|
||||
|
||||
Notes
|
||||
- Classes show model technical names; fields omitted for brevity.
|
||||
- Items listed under _inherit are extensions of existing models.
|
||||
6
odoo-bringout-oca-hack-payroll/doc/OVERVIEW.md
Normal file
6
odoo-bringout-oca-hack-payroll/doc/OVERVIEW.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Overview
|
||||
|
||||
Packaged Odoo addon: payroll. Provides features documented in upstream Odoo 16 under this addon.
|
||||
|
||||
- Source: OCA/OCB 16.0, addon payroll
|
||||
- License: LGPL-3
|
||||
32
odoo-bringout-oca-hack-payroll/doc/REPORTS.md
Normal file
32
odoo-bringout-oca-hack-payroll/doc/REPORTS.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Reports
|
||||
|
||||
Report definitions and templates in payroll.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
class PayslipDetailsReport
|
||||
AbstractModel <|-- PayslipDetailsReport
|
||||
class ContributionRegisterReport
|
||||
AbstractModel <|-- ContributionRegisterReport
|
||||
```
|
||||
|
||||
## Available Reports
|
||||
|
||||
### PDF/Document Reports
|
||||
- **Payslip Contribution Register Lines** (PDF/Print)
|
||||
- **Payslip** (PDF/Print)
|
||||
- **PaySlip Details** (PDF/Print)
|
||||
|
||||
|
||||
## Report Files
|
||||
|
||||
- **__init__.py** (Python logic)
|
||||
- **report_contribution_register.py** (Python logic)
|
||||
- **report_payslip_details.py** (Python logic)
|
||||
- **report.xml** (XML template/definition)
|
||||
|
||||
## Notes
|
||||
- Named reports above are accessible through Odoo's reporting menu
|
||||
- Python files define report logic and data processing
|
||||
- XML files contain report templates, definitions, and formatting
|
||||
- Reports are integrated with Odoo's printing and email systems
|
||||
42
odoo-bringout-oca-hack-payroll/doc/SECURITY.md
Normal file
42
odoo-bringout-oca-hack-payroll/doc/SECURITY.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# Security
|
||||
|
||||
Access control and security definitions in payroll.
|
||||
|
||||
## Access Control Lists (ACLs)
|
||||
|
||||
Model access permissions defined in:
|
||||
- **[ir.model.access.csv](../payroll/security/ir.model.access.csv)**
|
||||
- 16 model access rules
|
||||
|
||||
## Record Rules
|
||||
|
||||
Row-level security rules defined in:
|
||||
|
||||
## Security Groups & Configuration
|
||||
|
||||
Security groups and permissions defined in:
|
||||
- **[hr_payroll_security.xml](../payroll/security/hr_payroll_security.xml)**
|
||||
- 2 security groups defined
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph "Security Layers"
|
||||
A[Users] --> B[Groups]
|
||||
B --> C[Access Control Lists]
|
||||
C --> D[Models]
|
||||
B --> E[Record Rules]
|
||||
E --> F[Individual Records]
|
||||
end
|
||||
```
|
||||
|
||||
Security files overview:
|
||||
- **[hr_payroll_security.xml](../payroll/security/hr_payroll_security.xml)**
|
||||
- Security groups, categories, and XML-based rules
|
||||
- **[ir.model.access.csv](../payroll/security/ir.model.access.csv)**
|
||||
- Model access permissions (CRUD rights)
|
||||
|
||||
Notes
|
||||
- Access Control Lists define which groups can access which models
|
||||
- Record Rules provide row-level security (filter records by user/group)
|
||||
- Security groups organize users and define permission sets
|
||||
- All security is enforced at the ORM level by Odoo
|
||||
5
odoo-bringout-oca-hack-payroll/doc/TROUBLESHOOTING.md
Normal file
5
odoo-bringout-oca-hack-payroll/doc/TROUBLESHOOTING.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
# Troubleshooting
|
||||
|
||||
- Ensure Python and Odoo environment matches repo guidance.
|
||||
- Check database connectivity and logs if startup fails.
|
||||
- Validate that dependent addons listed in DEPENDENCIES.md are installed.
|
||||
7
odoo-bringout-oca-hack-payroll/doc/USAGE.md
Normal file
7
odoo-bringout-oca-hack-payroll/doc/USAGE.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Usage
|
||||
|
||||
Start Odoo including this addon (from repo root):
|
||||
|
||||
```bash
|
||||
python3 scripts/nix_odoo_web_server.py --db-name mydb --addon payroll
|
||||
```
|
||||
10
odoo-bringout-oca-hack-payroll/doc/WIZARDS.md
Normal file
10
odoo-bringout-oca-hack-payroll/doc/WIZARDS.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# Wizards
|
||||
|
||||
Transient models exposed as UI wizards in payroll.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
class HrPayslipChangeState
|
||||
class HrPayslipEmployees
|
||||
class PayslipLinesContributionRegister
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue