openimis-fe-individual_js

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.