openimis-fe-social_protection_js

This documentation provides a comprehensive guide to the OpenIMIS Frontend Social Protection module. The Social Protection module is offering deployable module to manage social protection-related functionalities 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 Social Protection module is built using Rollup, a JavaScript module bundler.

• For building and deploying, refer to the openimis-fe_js repository and follow the instructions for development or server modes.

2. License

• The Social Protection 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 "Benefit Plans" option (benefitPlan.menu.benefitPlans key).

• This option is displayed if the user has the right 160001.

4. Other Contributions

• The Social Protection module interacts with the core.Router in the OpenIMIS client-side router by registering benefitPlans and benefitPlan routes.

• It provides contribution points for tab panel labels and panels displayed under Benefit Plan and Benefit Package detail views.

5. Available Contribution Points

a. Dispatched Redux Actions:

• BENEFIT_PLAN_BENEFIT_PLANS_{REQ|RESP|ERR}: Triggered when fetching BenefitPlans through the searcher.

• BENEFIT_PLAN_BENEFIT_PLAN_{REQ|RESP|ERR}: Triggered when fetching a chosen BenefitPlan.

• BENEFIT_PLAN_MUTATION_{REQ|ERR}: Sent when applying a mutation for a BenefitPlan.

• BENEFIT_PLAN_DELETE_BENEFIT_PLAN_RESP: Received as a result of the delete BenefitPlan mutation.

• BENEFIT_PLAN_UPDATE_BENEFIT_PLAN_RESP: Received as a result of the update BenefitPlan mutation.

• GROUP_BENEFICIARY_UPDATE_GROUP_BENEFICIARY_RESP: Received as a result of the update GroupBeneficiary mutation.

• BENEFICIARY_UPDATE_BENEFICIARY_RESP: Received as a result of the update Beneficiary mutation.

• BENEFIT_PLAN_CODE_FIELDS_VALIDATION_{REQ|RESP|ERR}: Received as a result of BenefitPlan code validation.

• BENEFIT_PLAN_NAME_FIELDS_VALIDATION_{REQ|RESP|ERR}: Received as a result of BenefitPlan name validation.

• BENEFIT_PLAN_SCHEMA_FIELDS_VALIDATION_{REQ|RESP|ERR}: Received as a result of BenefitPlan schema validation.

• BENEFIT_PLAN_CODE_SET_VALID: Sets the validity of BenefitPlan code in Redux state.

• BENEFIT_PLAN_NAME_SET_VALID: Sets the validity of BenefitPlan name in Redux state.

• BENEFIT_PLAN_SCHEMA_SET_VALID: Sets the validity of BenefitPlan schema in Redux state.

• BENEFICIARY_BENEFICIARIES_{REQ|RESP|ERR}: Triggered when fetching Beneficiaries through the searcher.

• GROUP_BENEFICIARY_GROUP_BENEFICIARIES_{REQ|RESP|ERR}: Triggered when fetching GroupBeneficiaries through the searcher.

• BENEFICIARY_BENEFICIARY_{REQ|RESP|ERR}: Triggered when fetching a chosen Beneficiary.

• GROUP_BENEFICIARY_GET_GROUP_{REQ|RESP|ERR}: Triggered when fetching a chosen GroupBeneficiary.

• BENEFICIARY_EXPORT_{REQ|RESP|ERR}: Triggered during the export of a list of Beneficiaries.

• GROUP_BENEFICIARY_EXPORT_{REQ|RESP|ERR}: Triggered during the export of a list of GroupBeneficiaries.

• GET_WORKFLOWS_{REQ|RESP|ERR}: Triggered when fetching a list of Workflows.

• GET_BENEFIT_PLAN_UPLOAD_HISTORY_{REQ|RESP|ERR}: Triggered when fetching a list of historical workflow actions related to BenefitPlan.

• SEARCH_BENEFIT_PLAN_TASKS_{REQ|RESP|ERR}: Triggered when fetching a list of tasks related to BenefitPlan.

b. Other Modules Listened Redux Actions:

• None: The Social Protection module does not listen to Redux actions from other modules.

6. Other Modules Redux State Bindings

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

• It also binds to state.policyHolder to retrieve Policy Holders for their respective pickers.

7. Configuration Options

• The Social Protection module does not provide specific configuration options.

Please note that the Social Protection module is designed to manage social protection-related functionalities 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.