...

1. openimis-be-individual_pyThe

   Insert excerpt
   openimis-be-individual_py

   module is dedicated to handling individual references within the OpenIMIS system. It provides services and functionalities for managing individual records, including creating, updating, and deleting individual data.

   openimis-be-individual_py name summary nopanel true

2. openimis-be-social_protection_py

   The openimis-be-social_protection_py module focuses on managing social protection-related information within the OpenIMIS system. It handles various aspects of social protection data, ensuring proper data management and processing.

3. openimis-be-tasks_management_py

   The openimis-be-tasks_management_py module is responsible for managing tasks and activities within the OpenIMIS system. It helps streamline workflow by handling task assignment, tracking, and completion.

4. openimis-be-opensearch_reports_py

   The openimis-be-opensearch_reports_py module provides functionalities for generating and accessing reports in the OpenIMIS system. It allows users to search and retrieve relevant reports based on specific criteria.

5. openimis-be-workflow_py

   The openimis-be-workflow_py module is dedicated to managing data upload.

6. openimis-be-payment_cycle_py

   The openimis-be-payment_cycle_py module is responsible for managing payment cycles within the OpenIMIS system. It handles payment-related processes, including scheduling, calculations, and disbursements.

7. openimis-be-calcrule_social_protection_py

   The openimis-be-calcrule_social_protection_py module is specialized in managing calculation rules for social protection data within the OpenIMIS system. It ensures accurate and consistent calculation of benefits and entitlements.

...

OpenIMIS Backend Individual Reference Module Documentation

Introduction

The OpenIMIS Backend Individual Reference Module is a crucial component of the OpenIMIS system. This module is dedicated to handling individual references within the system. It provides services, functionalities, and GraphQL queries related to individual and group management. The Individual Reference Module is designed to be deployed as a module of openimis-be_py, the OpenIMIS backend application.

This documentation aims to provide a comprehensive guide on how to utilize, configure, and interact with the Individual Reference Module effectively.

ORM Mapping

The module uses Object-Relational Mapping (ORM) to map data from the database to Python objects. The following ORM mappings are used:

• individual_individual, individual_historicalindividual -> Individual: Represents an individual entity.

• individual_individualdataSource, individual_historicalindividualdataSource -> IndividualDataSource: Represents the data source associated with an individual.

• individual_individualdatasourceupload, individual_historicalindividualdatasourceupload -> IndividualDataSourceUpload: Represents data uploads associated with an individual data source.

• individual_group, individual_historicalgroup -> Group: Represents a group entity.

• individual_groupindividual, individual_historicalgroupindividual -> GroupIndividual: Represents the association between a group and an individual.

Developers can access and manipulate individual and group-related data using these mapped objects, which abstract away the underlying database complexities.

GraphQL Queries

The module provides several GraphQL queries to retrieve individual and group-related information:

• individual: Retrieves individual data based on specified criteria.

• individualDataSource: Retrieves individual data source information based on specified criteria.

• individualDataSourceUpload: Retrieves individual data source upload information based on specified criteria.

• group: Retrieves group data based on specified criteria.

• groupIndividual: Retrieves group-individual association data based on specified criteria.

These GraphQL queries provide a flexible and efficient way to retrieve relevant individual and group data.

GraphQL Mutations

The Individual Reference Module offers GraphQL mutations to manage individual and group data. Each mutation emits default signals and returns standard error lists following the conventions of openimis-be-core_py.

List of available mutations:

• createIndividual: Creates a new individual record.

• updateIndividual: Updates an existing individual record.

• deleteIndividual: Deletes an individual record.

• createGroup: Creates a new group record.

• updateGroup: Updates an existing group record.

• deleteGroup: Deletes a group record.

• addIndividualToGroup: Adds an individual to a group.

• editIndividualInGroup: Edits an individual in a group.

• removeIndividualFromGroup: Removes an individual from a group.

• createGroupIndividuals: Creates multiple group-individual associations.

These mutations enable seamless management of individual and group data within the OpenIMIS system.

Services

The module provides the following services:

• IndividualService: Offers methods to create, update, and delete individual records.

• IndividualDataSourceService: Provides methods to create, update, and delete individual data sources.

• IndividualDataSourceUploadService: Offers methods to create, update, and delete individual data source uploads.

• GroupService: Provides methods to create, update, and delete group records.

• GroupIndividualService: Offers methods to create, update, and delete group-individual associations.

Developers can interact with these services to perform various operations related to individual and group management.

Configuration Options

The behavior of the Individual Reference Module can be customized through configuration options, which can be modified via core.ModuleConfiguration. The available configuration options are:

• gql_individual_search_perms: Specifies the required rights to call the individual GraphQL query. (Default: ["159001"])

• gql_individual_create_perms: Specifies the required rights to call the createIndividual GraphQL mutation. (Default: ["159002"])

• gql_individual_update_perms: Specifies the required rights to call the updateIndividual GraphQL mutation. (Default: ["159003"])

• gql_individual_delete_perms: Specifies the required rights to call the deleteIndividual GraphQL mutation. (Default: ["159004"])

• gql_group_search_perms: Specifies the required rights to call the group GraphQL query. (Default: ["180001"])

• gql_group_create_perms: Specifies the required rights to call the createGroup, addIndividualToGroup, and createGroupIndividuals GraphQL mutations. (Default: ["180002"])

• gql_group_update_perms: Specifies the required rights to call the updateGroup and editIndividualInGroup GraphQL mutations. (Default: ["180003"])

• gql_group_delete_perms: Specifies the required rights to call the deleteGroup and removeIndividualFromGroup GraphQL mutations. (Default: ["180004"])

Developers can adjust these options to control access and permissions related to individual and group management operations.

OpenIMIS Modules Dependencies

The Individual Reference Module relies on the following module:

• core: Provides core functionality and utilities for the OpenIMIS system.

...

OpenIMIS Backend Social Protection Reference Module Documentation

Introduction

The OpenIMIS Backend Social Protection Reference Module is an integral part of the OpenIMIS system. This module is dedicated to handling social protection-related information, including benefit plans, beneficiaries, and group beneficiaries. It is designed to be deployed as a module of openimis-be_py, the OpenIMIS backend application.

This documentation aims to provide a comprehensive guide on how to utilize, configure, and interact with the Social Protection Reference Module effectively.

ORM Mapping

The module uses Object-Relational Mapping (ORM) to map data from the database to Python objects. The following ORM mappings are used:

...

Developers can access and manipulate social protection data using these mapped objects, which abstract away the underlying database complexities.

GraphQL Queries

The module provides several GraphQL queries to retrieve social protection-related information:

...

These GraphQL queries provide a flexible and efficient way to retrieve relevant social protection data.

GraphQL Mutations

The Social Protection Reference Module offers GraphQL mutations to manage social protection data. Each mutation emits default signals and returns standard error lists following the conventions of openimis-be-core_py.

...

These mutations enable seamless management of social protection data within the OpenIMIS system.

Services

The module provides the following services:

...

Developers can interact with these services to perform CRUD (Create, Read, Update, Delete) operations and handle beneficiary imports.

Configuration Options

The behavior of the Social Protection Reference Module can be customized through configuration options, which can be modified via core.ModuleConfiguration. The available configuration options are:

...

Developers can adjust these options to control access, permissions, and behavior related to social protection data.

OpenIMIS Modules Dependencies

The Social Protection Reference Module relies on the following modules:

...

OpenIMIS Backend Task Management Reference Module Documentation

Introduction

The OpenIMIS Backend Task Management Reference Module is a crucial component of the OpenIMIS system. This module is dedicated to managing tasks and activities within the system. It provides services, functionalities, and GraphQL queries related to task handling. The Task Management Reference Module is designed to be deployed as a module of openimis-be_py, the OpenIMIS backend application.

This documentation aims to provide a comprehensive guide on how to utilize, configure, and interact with the Task Management Reference Module effectively.

ORM Mapping

The module uses Object-Relational Mapping (ORM) to map data from the database to Python objects. The following ORM mappings are used:

...

Developers can access and manipulate task-related data using these mapped objects, which abstract away the underlying database complexities.

GraphQL Queries

The module provides several GraphQL queries to retrieve task-related information:

...

These GraphQL queries provide a flexible and efficient way to retrieve relevant task data.

Services

The module provides the following services:

...

Developers can interact with these services to perform various operations related to task management.

Configuration Options

The behavior of the Task Management Reference Module can be customized through configuration options, which can be modified via core.ModuleConfiguration. The available configuration options are:

...

Developers can adjust these options to control access and permissions related to task management operations.

OpenIMIS Modules Dependencies

The Task Management Reference Module relies on the following modules:

...

OpenIMIS Backend Workflow Reference Module Documentation

Introduction

The OpenIMIS Backend Workflow Reference Module is a crucial component of the OpenIMIS system. This module is dedicated to managing workflows and integrating with various workflow systems. It provides services and functionalities to register workflow systems, query available workflows, and execute workflows. The Workflow Reference Module is designed to be deployed as a module of openimis-be_py, the OpenIMIS backend application.

This documentation aims to provide a comprehensive guide on how to utilize and interact with the Workflow Reference Module effectively.

Services

The Workflow Reference Module provides the following service:

...

OpenIMIS Backend Payment Cycle Reference Module Documentation

Introduction

The OpenIMIS Backend Payment Cycle Reference Module is a crucial component of the OpenIMIS system. This module is designed to handle payment cycles and facilitate periodical payments for various business objects connected to payment plans. It offers services and functionalities to perform payment cycle calculations, including a specific service customized for Benefit Plan payment cycle calculation.

ORM Mapping

The Payment Cycle Reference Module utilizes ORM mapping to interact with the underlying database. The following mappings are used:

...

Developers can use this mapping to access payment cycle data efficiently.

GraphQL Queries

The module provides a GraphQL query to retrieve payment cycle information:

...

GraphQL queries offer a flexible and efficient way to fetch relevant payment cycle information.

GraphQL Mutations

The module offers a GraphQL mutation to trigger the calculation of payment cycles:

...

GraphQL mutations allow seamless execution of payment cycle calculations within the OpenIMIS system.

Services

The Payment Cycle Reference Module provides the following services:

...

Developers can utilize these services to perform payment cycle calculations and retrieve the results efficiently.

Configuration Options

The behavior of the Payment Cycle Reference Module can be customized through configuration options, which can be modified via core.ModuleConfiguration. The available configuration options are:

...

OpenIMIS Backend Calcrule_Social_Protection Reference Module Documentation

Introduction

The OpenIMIS Backend Calcrule_Social_Protection Reference Module is a critical component of the OpenIMIS system. This module is responsible for performing calculations to determine the amount of payment for beneficiaries based on specific criteria specified in custom filters of payment plans. It allows for flexible and customized payment calculations tailored to the needs of social protection programs.

...