Skip to content

Commit

Permalink
fix indentation of titles
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremi committed Aug 21, 2024
1 parent f74621a commit efbc652
Show file tree
Hide file tree
Showing 53 changed files with 231 additions and 231 deletions.
8 changes: 4 additions & 4 deletions docs/modules/g2p_bank.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,28 @@

This document outlines the functionality of the **G2P Bank** module within the OpenSPP framework. This module extends the functionality of individual and group registries to manage their bank details.

### Purpose
## Purpose

The **G2P Bank** module aims to:

* Provide an interface for storing and managing bank account information for both individual and group registrants within the OpenSPP system.
* Ensure data consistency and accuracy by calculating and displaying IBANs based on provided bank details.
* Integrate seamlessly with existing individual and group registry views to provide a consolidated view of registrant information.

### Module Dependencies and Integration
## Module Dependencies and Integration

1. **Contacts (res.partner)**: This module directly leverages the Odoo Contacts module and its inherent bank account management features (`res.partner.bank`). This ensures consistency and avoids data redundancy by utilizing the existing framework for storing bank information.

2. **[g2p_registry_individual](g2p_registry_individual)**: This module integrates with the individual registry by extending the individual registrant view to include a dedicated page for managing bank details. This allows users to easily view and manage bank information associated with individual registrants.

3. **[g2p_registry_group](g2p_registry_group)**: Similar to its integration with the individual registry, this module extends the group registrant view to include a bank details management section. This facilitates the tracking of bank accounts associated with groups, such as cooperatives or farmer groups.

### Additional Functionality
## Additional Functionality

* **IBAN Calculation**: The module automatically calculates and displays the International Bank Account Number (IBAN) based on the entered bank account number and bank details. This feature leverages the `schwifty` Python library for accurate IBAN generation, ensuring data consistency and reducing manual errors.

* **Integrated Bank Details Views**: The module seamlessly integrates bank details management into both the individual and group registry views. This provides a unified and centralized location for managing all aspects of a registrant's profile, including their bank information.

### Conclusion
## Conclusion

The **G2P Registry: Bank Details** module enhances OpenSPP by providing a structured and efficient way to manage bank account information for both individual and group registrants. Its tight integration with existing core modules ensures data consistency, simplifies data entry, and improves the overall user experience for managing registrant information within the platform.
8 changes: 4 additions & 4 deletions docs/modules/g2p_encryption_keymanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@

This module extends the functionality of the [g2p_encryption](g2p_encryption) module by providing integration with a Keymanager service for encryption and signing operations. This allows OpenSPP to leverage external key management systems for enhanced security and compliance.

### Purpose
## Purpose

The primary purpose of this module is to:

* **Delegate encryption and signing operations to an external Keymanager service:** This offloads the burden of key management from the OpenSPP application to a dedicated, potentially more secure, external service.
* **Provide a configurable interface:** System administrators can configure various parameters of the Keymanager integration, such as API endpoints, authentication credentials, and application-specific identifiers.
* **Seamlessly integrate with the existing encryption framework:** The module extends the existing encryption provider mechanism in OpenSPP, allowing for easy switching between different encryption providers, including the Keymanager-based provider.

### Functionality
## Functionality

The [g2p_encryption_keymanager](g2p_encryption_keymanager) module provides the following features:

Expand All @@ -24,15 +24,15 @@ The [g2p_encryption_keymanager](g2p_encryption_keymanager) module provides the f
* **Keymanager Authentication and Authorization:** The module implements secure communication with the Keymanager service using OAuth 2.0 client credentials grant type for authentication and authorization.
* **Configuration Options for Keymanager Integration:** The module provides a user-friendly interface within the OpenSPP settings to configure various aspects of the Keymanager integration, including API endpoints, authentication credentials, and application-specific identifiers for encryption and signing.

### Integration with Other Modules
## Integration with Other Modules

This module directly interacts with the [g2p_encryption](g2p_encryption) module:

* It inherits and extends the `g2p.encryption.provider` model to include Keymanager-specific configuration fields and methods.
* It provides a new "Keymanager" option for the encryption provider type.
* It overrides the default encryption and signing methods to utilize the Keymanager API when selected.

### Benefits of Using Keymanager Integration
## Benefits of Using Keymanager Integration

* **Enhanced Security:** Key management is handled by a dedicated service, potentially with stronger security measures than what might be feasible within the OpenSPP application itself.
* **Centralized Key Management:** Provides a central location for managing encryption keys across different parts of the OpenSPP system or even across multiple applications.
Expand Down
12 changes: 6 additions & 6 deletions docs/modules/g2p_encryption_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@

This document provides an overview of the `g2p_encryption_rest_api` module within the OpenSPP ecosystem.

### Overview
## Overview

The `g2p_encryption_rest_api` module extends the functionality provided by the [g2p_encryption](./g2p_encryption.md) module by exposing its encryption and security functionalities through a RESTful API. This allows external systems and applications to securely interact with OpenSPP's encryption mechanisms.

### Purpose
## Purpose

The primary purpose of this module is to facilitate secure data exchange and integration with external systems that require access to OpenSPP's encryption capabilities. This could include:

- **Mobile Applications:** Allowing mobile apps used by beneficiaries or field agents to securely encrypt and decrypt data.
- **Third-party Systems:** Enabling integration with other government or partner systems that require secure communication channels.
- **Data Analytics:** Providing a secure way to extract encrypted data for analysis and reporting purposes.

### Functionality
## Functionality

The module exposes a set of REST endpoints under the `/api/v1/security/` path. These endpoints allow authorized clients to:

Expand All @@ -29,15 +29,15 @@ The module exposes a set of REST endpoints under the `/api/v1/security/` path. T
- **Verify JWT Tokens:** Verify the authenticity and integrity of JWTs received from external systems.
- **Retrieve JWKS:** Access OpenSPP's JSON Web Key Set (JWKS) for verifying JWT signatures.

### Integration
## Integration

The `g2p_encryption_rest_api` module seamlessly integrates with the [g2p_encryption](./g2p_encryption.md) module, leveraging its existing encryption provider framework and configurations. It utilizes Odoo's `base_rest` module to expose the REST API endpoints.

### Dependencies
## Dependencies

- [g2p_encryption](./g2p_encryption.md): Provides the core encryption functionalities and provider management.
- `base_rest`: Offers the framework for building RESTful APIs within Odoo.

### Security
## Security

The module inherits the security mechanisms provided by Odoo's `base_rest` module, including user authentication and authorization. Access to the API endpoints can be restricted based on user roles and permissions. Additionally, the module utilizes the encryption providers configured in the [g2p_encryption](./g2p_encryption.md) module to ensure secure data transmission.
12 changes: 6 additions & 6 deletions docs/modules/g2p_payment_phee.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@

This module extends the OpenG2P platform to integrate with the **Payment Hub Enterprise Edition (PHEE)** for disbursing payments to beneficiaries.

### Overview
## Overview

The [g2p_payment_phee](g2p_payment_phee) module provides a dedicated payment manager for interacting with the PHEE API. This manager enables automated batch creation, payment preparation, and secure transmission of payment instructions to the PHEE system.

### Key Features
## Key Features

* **PHEE Integration:** Enables seamless integration with the PHEE platform for efficient payment processing.
* **Payment Manager:** Introduces a specialized `G2PPaymentHubEEManager` model that handles PHEE-specific payment operations.
* **Automated Batch Creation:** Supports automatic creation of payment batches, streamlining the disbursement process.
* **CSV File Generation:** Generates CSV files containing payment instructions in the format required by PHEE.
* **Configuration Settings:** Allows administrators to configure PHEE API endpoints, authentication credentials, and other payment-related parameters.

### Dependencies
## Dependencies

* **[g2p_registry_base](g2p_registry_base):** Provides core registry functionality.
* **[g2p_programs](g2p_programs):** Manages social protection programs, cycles, entitlements, and payments.

### Functionality and Integration
## Functionality and Integration

This module extends the functionality of the [g2p_programs](g2p_programs) module by adding a PHEE-specific payment manager. It leverages existing data structures for programs, cycles, entitlements, and payments to generate payment instructions.

Expand All @@ -35,10 +35,10 @@ The module's payment manager automates the process of:
3. **Generating CSV Files:** Creating CSV files containing payment details in the PHEE-compliant format.
4. **Sending Payments:** Transmitting payment batches to the PHEE API for processing.

### Configuration
## Configuration

The module provides configuration settings for specifying PHEE API endpoints, authentication credentials, and other parameters. This allows administrators to tailor the integration to their specific PHEE environment.

### Usage
## Usage

Once configured, the PHEE payment manager can be used to prepare, batch, and send payments to beneficiaries. The module's automated features streamline the disbursement process, enhancing efficiency and reducing manual intervention.
8 changes: 4 additions & 4 deletions docs/modules/g2p_program_autoenrol.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

This module extends the functionality of the [g2p_programs](g2p_programs) module to enable automatic enrollment of registrants into social protection programs based on predefined criteria. This feature simplifies program management by automating the enrollment process for eligible individuals.

### Purpose
## Purpose

The main purpose of the `g2p_program_autoenrol` module is to streamline and automate the process of enrolling beneficiaries into social protection programs. It achieves this by providing the following capabilities:

Expand All @@ -16,7 +16,7 @@ The main purpose of the `g2p_program_autoenrol` module is to streamline and auto
- **Program-Specific Enrollment:** Auto-enrollment can be enabled or disabled on a per-program basis, providing flexibility in managing different types of programs.
- **Optional Removal of Ineligible Registrants:** Administrators have the option to automatically remove registrants from a program's membership list if they do not meet the defined eligibility criteria. This ensures that only eligible individuals are considered beneficiaries.

### Functionality
## Functionality

The module introduces the following key features:

Expand All @@ -33,11 +33,11 @@ The module introduces the following key features:
- **Impact on Program Statistics:**
- The module ensures that program statistics, such as the count of eligible and total beneficiaries, are updated dynamically to reflect the results of the automatic enrollment process.

### Integration
## Integration

The [g2p_program_autoenrol](g2p_program_autoenrol) module works seamlessly with the [g2p_programs](g2p_programs) module. It leverages the existing program and registrant data structures and extends their functionality.

### Benefits
## Benefits

- **Reduced Administrative Burden:** Automating the enrollment process significantly reduces the manual effort required by program administrators.
- **Improved Accuracy:** By automating enrollment based on pre-defined criteria, the module minimizes the risk of human error and ensures consistent application of eligibility rules.
Expand Down
8 changes: 4 additions & 4 deletions docs/modules/g2p_program_registrant_info_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@

This module extends the functionality of the [g2p_programs_rest_api](g2p_programs_rest_api) and [g2p_program_registrant_info](g2p_program_registrant_info) modules to expose program registrant information via a REST API. This allows external systems to interact with and manage program-specific data associated with registrants.

### Functionality:
## Functionality:

- **Exposes Program Registrant Info:** Provides API endpoints to access and manipulate program-specific information of registrants within a program. This includes data such as enrollment status, benefit level, and other custom fields defined for the program.

### Integration:
## Integration:

- **[g2p_programs_rest_api](g2p_programs_rest_api):** This module extends the existing API endpoints for managing program memberships. It adds fields to include program registrant information when retrieving or updating memberships.
- **[g2p_program_registrant_info](g2p_program_registrant_info):** This module utilizes the data models defined in `g2p_program_registrant_info` to represent and handle program-specific information.

### Data Models:
## Data Models:

- **ProgramRegistrantInfoOut:** Represents the output format of program registrant information returned by the API. It includes fields like `state` and a dictionary or list of dictionaries for `program_registrant_info`.
- **ProgramMembershipIn/Out:** Extends the existing input and output models for program memberships defined in [g2p_programs_rest_api](g2p_programs_rest_api). The `ProgramMembershipIn` model adds an optional field `program_registrant_info` for receiving program-specific data. The `ProgramMembershipOut` model includes a list of `ProgramRegistrantInfoOut` objects under the field `program_registrant_info_ids`.

### Benefits:
## Benefits:

- **Seamless Integration:** Enables external applications to access and manage program-specific registrant data directly.
- **Enhanced Data Management:** Facilitates efficient handling and updating of program-related information for individual registrants.
Expand Down
8 changes: 4 additions & 4 deletions docs/modules/g2p_programs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

This document details the **G2P Programs** module within the OpenSPP platform. This module is responsible for defining and managing the core aspects of social protection programs, including eligibility criteria, program cycles, entitlement management, and payment processing.

### Purpose
## Purpose

The **G2P Programs** module provides a comprehensive framework for:

Expand All @@ -18,7 +18,7 @@ The **G2P Programs** module provides a comprehensive framework for:
* **Facilitating Payments**: Streamlines the disbursement of benefits to beneficiaries, either through cash transfers or other delivery mechanisms.
* **Monitoring and Reporting**: Offers tools for tracking program progress, beneficiary participation, and financial transactions, facilitating program evaluation and accountability.

### Module Dependencies and Integration
## Module Dependencies and Integration

1. **G2P Registry: Base ([g2p_registry_base](g2p_registry_base))**:
* Leverages the base registry module for core registrant management functionalities.
Expand Down Expand Up @@ -56,7 +56,7 @@ The **G2P Programs** module provides a comprehensive framework for:
* Enables SMS notifications for program-related events, including enrollment confirmations, eligibility updates, payment notifications, and reminders.
* Leverages the module's SMS gateway integration for efficient and timely communication with beneficiaries.

### Additional Functionality
## Additional Functionality

* **Program Model (g2p.program)**:
* Defines the structure and attributes of social protection programs, including name, description, target type (individual or group), delivery mechanisms, and associated managers.
Expand Down Expand Up @@ -91,6 +91,6 @@ The **G2P Programs** module provides a comprehensive framework for:
* The module's flexible architecture allows administrators to define program-specific workflows, tailoring the sequence and execution of tasks like eligibility verification, entitlement generation, and payment processing.
* Supports various program models and operational requirements.

### Conclusion
## Conclusion

The **G2P Programs** module is the cornerstone of the OpenSPP platform, providing the essential tools for managing every stage of a social protection program's lifecycle. Its comprehensive functionality, integration with other core modules, and customizable workflows make it a powerful and adaptable solution for delivering social protection benefits effectively and efficiently.
6 changes: 3 additions & 3 deletions docs/modules/g2p_registry_addl_info_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

This module extends the functionality of the [g2p_registry_rest_api](g2p_registry_rest_api) and [g2p_registry_addl_info](g2p_registry_addl_info) modules by providing API endpoints for managing additional G2P (Government-to-Person) information associated with registrants and group memberships.

### Functionality and Integration
## Functionality and Integration

This module introduces two new classes:

Expand All @@ -17,13 +17,13 @@ This module introduces two new classes:

By integrating with the core registry and REST API modules, this module enables a seamless flow of additional G2P data, ensuring that external systems can access and manage this crucial information alongside the standard registry data.

### Key Features:
## Key Features:

- **API Endpoints for Additional G2P Info:** Provides dedicated API endpoints for managing additional G2P information related to individual registrants and group memberships.
- **Data Model Extension:** Extends the existing data models for registrants and group memberships to accommodate additional G2P information.
- **Seamless Integration:** Integrates smoothly with the [g2p_registry_rest_api](g2p_registry_rest_api) module, leveraging its existing infrastructure for authentication, authorization, and data handling.

### Benefits:
## Benefits:

- **Enhanced Data Management:** Enables efficient management of custom G2P data alongside standard registry information.
- **Improved Interoperability:** Facilitates data exchange with external systems that require access to additional G2P information.
Expand Down
Loading

0 comments on commit efbc652

Please sign in to comment.