This documentation provides a comprehensive guide to the OpenIMIS Frontend Payroll module. The Payment Cycle Payroll 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.
Building and Deploying
The Payment Cycle Payroll 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.
License
The Payment Cycle Payroll 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.
...
The module contributes to the OpenIMIS main menu with the "Payrolls" and PaymentPoints options
Other Contributions
The Payment Cycle Payroll 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.
...
Other Modules Listened Redux Actions
The Payment Cycle Payroll module does not listen to Redux actions from other modules.
...
The module binds to
state.core.userto access user information, including rights and other relevant data.
Configuration Options
The Payment Cycle Payroll 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.