openimis-fe-tasks_management_js

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.