openimis-fe-payroll_js

This documentation provides a comprehensive guide to the OpenIMIS Frontend Payroll module. The Payment Cycle module is a deployable module for managing payrolls 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 "Payrolls" and PaymentPoints options

4. Other Contributions

• The Payment Cycle module interacts with the core.Router in the OpenIMIS client-side router by registering payrolls and payment points.

• Tasks Module is extended with payroll related tasks.

5. Available Contribution Points

• Dispatched Redux Actions:

  • PAYROLL_MUTATION_{CREATE|UPDATE|DELETE}_PAYMENT_POINT{REQ|RESP|ERR}:
    Triggered when payment point mutations (create, update, delete) are performed.

  • PAYROLL_PAYMENT_POINTS_{REQ|RESP|ERR}:
    Triggered when searching for payment points.

  • PAYROLL_MUTATION_{CREATE|DELETE}_PAYROLL{REQ|RESP|ERR}:
    Triggered when payroll mutations (create, delete) are initiated.

  • PAYROLL_PAYROLLS_{REQ|RESP|ERR}:
    Triggered when searching for payrolls.

  • PAYROLL_PAYMENT_POINT_{REQ|RESP|ERR}:
    Triggered when a specific payment point is fetched.

  • PAYROLL_GET_PAYROLL_{REQ|RESP|ERR}:
    Triggered when fetching payroll details.

  • PAYROLL_BENEFIT_CONSUMPTION_{REQ|RESP|ERR}:
    Triggered when retrieving benefit consumption information.

  • PAYROLL_PAYROLL_BENEFIT_CONSUMPTION_{REQ|RESP|ERR}:
    Triggered when retrieving payroll benefit consumption details.

  • PAYROLL_BENEFIT_ATTACHMENT_{REQ|RESP|ERR}:
    Triggered when retrieving benefit attachment information.

  • PAYROLL_PAYMENT_METHODS_{REQ|RESP|ERR}:
    Triggered when fetching available payment methods.

  • PAYROLL_MUTATION_CLOSE_PAYROLL_{REQ|RESP|ERR}:
    Triggered when closing a payroll.

  • PAYROLL_MUTATION_REJECT_PAYROLL_{REQ|RESP|ERR}:
    Triggered when rejecting a payroll.

  • PAYROLL_MUTATION_MAKE_PAYMENT_PAYROLL_{REQ|RESP|ERR}:
    Triggered when making a payroll payment.

  • GET_PAYROLL_PAYMENT_FILES_{REQ|RESP|ERR}:
    Triggered when retrieving payroll payment files.

  • PAYROLL_BENEFITS_SUMMARY_{REQ|RESP|ERR}:
    Triggered when fetching the summary of benefits.

  • BENEFIT_CONSUMPTION_MUTATION_DELETE_BENEFIT_CONSUMPTION_{REQ|RESP|ERR}:
    Triggered when deleting a benefit consumption entry.

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 Payroll 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.