openimis-fe-payment_cycle_js

This documentation provides a comprehensive guide to the OpenIMIS Frontend Payment Cycle module. The Payment Cycle module is a deployable module for managing payment cycles within the OpenIMIS system. Below, you will find information on building, deploying, contributions, Redux actions, state bindings, and configuration options.

1. Building and Deploying

• The Payment Cycle module is built using Rollup, a JavaScript module bundler.

• To build and deploy the module, refer to the openimis-fe_js repository and follow the instructions for development or server modes.

2. License

• The Payment Cycle module is licensed under the AGPL v3 (GNU Affero General Public License, version 3).

• Ensure compliance with the AGPL v3 license when using or modifying the module.

3. Main Menu Contributions

• The module contributes to the OpenIMIS main menu with the "Payment Cycles" option (paymentCycle.paymentCycles.page.title key) under Payments.

4. Other Contributions

• The Payment Cycle module interacts with the core.Router in the OpenIMIS client-side router by registering paymentCycles and paymentCycle routes.

5. Available Contribution Points

• Dispatched Redux Actions:

  • PAYMENT_CYCLE_PAYMENT_CYCLES_{REQ|RESP|ERR}: Triggered when fetching PaymentCycles through the searcher.

  • PAYMENT_CYCLE_PAYMENT_CYCLE_{REQ|RESP|ERR}: Triggered when fetching a chosen PaymentCycle.

  • PAYMENT_CYCLE_MUTATION_{REQ|ERR}: Sent when applying a mutation for a PaymentCycle.

6. Other Modules Listened Redux Actions

• The Payment Cycle module does not listen to Redux actions from other modules.

7. Other Modules Redux State Bindings

• The module binds to state.core.user to access user information, including rights and other relevant data.

8. Configuration Options

• The Payment Cycle module does not provide specific configuration options.

Please note that the Payment Cycle module is designed to manage payment cycles within the OpenIMIS system. For detailed implementation details, code examples, and usage guidelines, refer to the actual code files in the module's repository. Additionally, ensure compliance with the AGPL v3 license when using or distributing this module.