openimis-fe-opensearch_reports_js

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.