Versions Compared

Old Version 5

changes.mady.by.user Uwe Wahser

Saved on

compared with

New Version Current

changes.mady.by.user Jan DoĊ‚kowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Custom filters play a pivotal role in the calculation process. They are user-defined criteria that determine how the payment amount is calculated for each beneficiary. The custom filters are configured within the payment plan and are tailored to the requirements of the social protection program.

...

Frontend Modules

This documentation provides a brief overview of the JavaScript modules/packages found in the OpenIMIS Frontend (openimis-fe) project. These modules are integral components of the user interface and handle various functionalities related to managing social health insurance and social protection schemes.

  1. openimis-fe-individual_js

    • Short Description: This module is responsible for managing individual member data in the OpenIMIS system. It facilitates tasks such as adding, editing, and deleting beneficiary information, ensuring accurate and up-to-date records.

  2. openimis-fe-social_protection_js

    • Short Description: Focused on social protection features, this module handles functionalities related to social protection programs in the OpenIMIS frontend. It enables administrators to manage programs, assess eligibility, and associate beneficiaries with relevant social protection initiatives.

  3. openimis-fe-tasks_management_js

    • Short Description: The tasks management module allows users to manage tasks within the OpenIMIS system. It provides functionality for task assignment, tracking, and completion, streamlining administrative processes.

  4. openimis-fe-opensearch_reports_js

    • Short Description: This module enables the generation and display of comprehensive reports based on the data stored in the OpenIMIS system. Reports may cover aspects such as the health insurance scheme's performance, financial status, and member statistics, aiding decision-making processes.

  5. openimis-fe-payment_cycle_js

    • Short Description: Responsible for managing payment cycles, this module handles payment calculations, processing payments to healthcare providers, beneficiaries, and maintaining a payment history. It ensures smooth financial transactions within the OpenIMIS ecosystem.

  6. openimis-fe-coremis_language_pack_js

    • Short Description: The language pack module provides essential translations and localization support for the coreMIS naming in OpenIMIS frontend.

...

OpenIMIS Frontend Individual Module - Documentation

This documentation provides a comprehensive overview of the OpenIMIS Frontend Individual module. The Individual module is deployable module for managing individuals in the OpenIMIS system. Below, you will find information on building, deploying, contributions, Redux actions, state bindings, and configuration options.

1. Building and Deploying

  • The Individual 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 Individual 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 following options:

    • "Beneficiaries and Households" (individual.mainMenu translation key)

    • "Individuals" (individual.menu.individuals key): Displayed if the user has the right 159001

    • "Groups" (individual.menu.groups key): Displayed if the user has the right 159001

4. Other Contributions

  • The Individual module interacts with the core.Router in the OpenIMIS client-side router by registering individuals and individual routes.

  • It provides contribution points for tab panel labels and panels displaying Individuals.

5. Available Contribution Points
a. Dispatched Redux Actions:

  • INDIVIDUAL_MUTATION_{REQ|ERR}: Sent when applying a mutation for an Individual.

  • INDIVIDUAL_DELETE_INDIVIDUAL_RESP: Received as a result of the delete Individual mutation.

  • INDIVIDUAL_UPDATE_INDIVIDUAL_RESP: Received as a result of the update Individual mutation.

  • GROUP_DELETE_GROUP_RESP: Received as a result of the delete Group mutation.

  • GROUP_UPDATE_GROUP_RESP: Received as a result of the update Group mutation.

  • GROUP_INDIVIDUAL_DELETE_GROUP_INDIVIDUAL_RESP: Received as a result of the delete GroupIndividual mutation.

  • GROUP_INDIVIDUAL_UPDATE_GROUP_INDIVIDUAL_RESP: Received as a result of the update GroupIndividual mutation.

  • INDIVIDUAL_INDIVIDUALS_{REQ|RESP|ERR}: Triggered when fetching Individuals through the searcher.

  • INDIVIDUAL_INDIVIDUAL_{REQ|RESP|ERR}: Triggered when fetching a chosen Individual.

  • GROUP_GROUPS_{REQ|RESP|ERR}: Triggered when fetching Groups through the searcher.

  • GROUP_GROUP_{REQ|RESP|ERR}: Triggered when fetching a chosen Group.

  • GROUP_INDIVIDUAL_GROUP_INDIVIDUALS_{REQ|RESP|ERR}: Triggered when fetching GroupIndividuals through the searcher.

  • INDIVIDUAL_EXPORT_{REQ|RESP|ERR}: Triggered during the export of Individuals.

  • GROUP_EXPORT_{REQ|RESP|ERR}: Triggered during the export of Groups.

  • GROUP_INDIVIDUAL_EXPORT_{REQ|RESP|ERR}: Triggered during the export of GroupIndividuals.

b. Other Modules Listened Redux Actions:

  • None: The Individual 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.

7. Configuration Options

  • The Individual module does not offer specific configuration options.

Please note that the Individual module is intended to manage individual beneficiaries 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.

...

OpenIMIS Frontend Social Protection Module - Documentation

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.

...

OpenIMIS Frontend Tasks Management Module - Documentation

This documentation provides a comprehensive guide to the OpenIMIS Frontend Tasks Management module. The Tasks Management is a deployable module for managing tasks 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 Tasks Management 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 Tasks Management 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 following options:

    • "Tasks" (tasksManagement.menu.tasksMainMenu key): Displayed to all users.

    • "Task Executioner Groups" (tasksManagement.menu.taskExecutionerGroups): Displayed if the user has the right 191001. Visible under Admin menu.

4. Other Contributions

  • The Tasks Management module interacts with the core.Router in the OpenIMIS client-side router by registering tasks, task, taskGroups, and taskGroup routes.

  • It provides a contribution point called tasksManagement.taskPreview, allowing the addition of tables suitable for displaying task entity subjects.

5. Available Contribution Points
a. Dispatched Redux Actions:

  • MUTATION: Sent when applying a mutation for task management.

b. Fetching Task Groups:

  • SEARCH_TASK_GROUPS: Triggered when searching for task groups.

c. Fetching Individual Task Group:

  • GET_TASK_GROUP: Triggered when fetching a specific task group.

d. Creating Task Group:

  • CREATE_TASK_GROUP: Triggered when creating a task group.

e. Updating Task Group:

  • UPDATE_TASK_GROUP: Received as a response when updating a task group.

f. Deleting Task Group:

  • DELETE_TASK_GROUP: Received as a response when deleting a task group.

g. Fetching Individual Task:

  • GET_TASK: Triggered when fetching a specific task.

h. Updating Task:

  • UPDATE_TASK: Received as a response when updating a task.

i. Resolving Task:

  • RESOLVE_TASK: Received as a response when resolving a task.

6. Other Modules Listened Redux Actions

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

7. Other Modules Redux State Bindings

  • The Tasks Management module does not provide specific configuration options.

Please note that the Tasks Management module is designed to manage tasks 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.

...

OpenIMIS Frontend OpenSearch Reports Module - Documentation

This documentation provides a comprehensive guide to the OpenIMIS Frontend OpenSearch Reports module. The OpenSearch Reports is a deployable module for generating and managing reports using OpenSearch Dashboards. Below, you will find information on building, deploying, OpenSearch Dashboards setup, contributions, Redux actions, state bindings, and configuration options.

1. Building and Deploying

  • The OpenSearch Reports 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 OpenSearch Reports 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. OpenSearch Dashboards Setup

  • To run the module on a dockerized instance, follow these steps:

    • Add the OPENSEARCH_BASIC_TOKEN environment variable to the environment file in openimis-dist_dkr. This variable should be based on admin and password credentials to OpenSearch.

    • Use the OPENSEARCH_PROXY_ROOT environment variable in the .env file in openimis-fe_js, set to "opensearch."

    • Run the backend and frontend services with opensearch and opensearch-dashboards services.

4. Main Menu Contributions

  • The module contributes to the OpenIMIS main menu with the "Open Search Reports" option (openSearchReports.openSearch key).

5. Other Contributions

  • The OpenSearch Reports module interacts with the core.Router in the OpenIMIS client-side router by registering openSearchReports routes.

6. Available Contribution Points

  • The module does not specify any specific contribution points.

7. Dispatched Redux Actions

  • The module does not specify any specific dispatched Redux actions.

8. Other Modules Listened Redux Actions

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

9. Other Modules Redux State Bindings

  • The module does not specify any specific Redux state bindings.

10. Configuration Options

  • The OpenSearch Reports module does not provide specific configuration options.

Please note that the OpenSearch Reports module is designed to integrate with OpenSearch Dashboards for generating and managing reports. 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.

...

OpenIMIS Frontend Coremis Language Pack Module - Documentation

This documentation provides a comprehensive guide to the OpenIMIS Frontend Coremis Language Pack module. The Coremis Language Pack is a deployable module with the purpose of changing default translations to ones suitable for CoreMIS. Below, you will find information on building, deploying, contributions, Redux actions, state bindings, and configuration options.

1. Building and Deploying

  • The Coremis Language Pack 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 Coremis Language Pack 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 does not specify any specific main menu contributions.

4. Other Contributions

  • The Coremis Language Pack module provides translations suitable for CoreMIS, altering the default translations used in OpenIMIS Frontend.

5. Available Contribution Points

  • The module does not specify any specific contribution points.

6. Dispatched Redux Actions

  • The module does not specify any specific dispatched Redux actions.

7. Other Modules Listened Redux Actions

  • The module does not specify any specific listened Redux actions from other modules.

8. Other Modules Redux State Bindings

  • The module does not specify any specific Redux state bindings from other modules.

9. Configuration Options

  • The Coremis Language Pack module does not provide specific configuration options.

Please note that the Coremis Language Pack module is designed to change default translations to ones suitable for CoreMIS. 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.

...

OpenIMIS Frontend Payment Cycle Module - Documentation

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.