spp_import_dci_api

OpenSPP Import: DCI API

OpenSPP Import: DCI API

Overview

The spp_import_dci_api module is an OpenSPP extension that enables the integration of external registries, particularly those adhering to the DCI (Digital Convergence Initiative) standard, into the OpenSPP ecosystem.

Purpose

This module streamlines the process of importing and synchronizing registrant data from DCI-compliant registries into the OpenSPP registry. This facilitates efficient data sharing and interoperability between different systems. For more information, visit Digital Convergence Initiative.

Key Features

• API Endpoints:
  • Exposes RESTful API routes specifically designed for interacting with DCI-compliant systems.
  • Handles authentication and authorization for secure data exchange.
• Data Mapping:
  • Maps incoming DCI data fields to the corresponding fields within the OpenSPP registry.
  • Handles data transformations to ensure compatibility between the two systems.
• Import Processes:
  • Provides automated workflows for importing new registrants and updating existing records.
  • Includes data validation steps to maintain data integrity within the OpenSPP registry.

Dependencies and Integration

1. G2P Programs (g2p_programs)

• Integration: Utilizes program definitions and eligibility criteria from g2p_programs to potentially assign imported registrants to relevant programs based on their DCI attributes.

2. SPP Programs (spp_programs)

• Integration: Similar to g2p_programs, this module might utilize in-kind entitlement logic from spp_programs if the imported DCI data includes information relevant to in-kind benefits.

3. G2P Registry: Base (g2p_registry_base)

• Integration: Relies heavily on g2p_registry_base for core registry functionality:
  • Registrant Creation: Creates new registrant records using the base model provided by g2p_registry_base.
  • ID Management: Leverages g2p.reg.id from g2p_registry_base to store and manage DCI-provided identifiers.
  • Relationships: Potentially utilizes the g2p.reg.rel model to establish relationships between imported registrants based on DCI data.

4. SPP Registry Data Source (spp_registry_data_source)

• Integration: Depends on spp_registry_data_source for:
  • Data Source Configuration: Retrieves connection details and API specifications of the external DCI registry from data source configurations defined in this module.

5. G2P Registry: Individual (g2p_registry_individual)

• Integration: Extends the individual registrant model (res.partner) from g2p_registry_individual:
  • Data Population: Populates individual-specific fields within the OpenSPP registry using mapped DCI data (e.g., name, birthdate, gender).

Additional Functionality

CRVS Integration

The module includes specialized components for interacting with CRVS (Civil Registration and Vital Statistics) systems, which are often DCI-compliant. These components include:

• Location Management:
  • Models CRVS-specific location hierarchies (spp.crvs.location.type, spp.crvs.location).
  • Imports and synchronizes location data from the CRVS system.
• Beneficiary Fetching:
  • Provides tools (spp.fetch.crvs.beneficiary) to search and retrieve beneficiary data from CRVS systems based on specific criteria.
  • Supports complex search queries using logical operators and field filters.
• Data Import and Processing:
  • Processes retrieved CRVS data, creating or updating registrant records in OpenSPP (spp.crvs.imported.individuals).
  • Handles the creation of family groups and relationships based on CRVS data.

Conclusion

The spp_import_dci_api module enhances the OpenSPP platform by enabling seamless data exchange with external DCI-compliant registries, including specialized integration with CRVS systems. This promotes interoperability, streamlines data management, and expands the potential reach of OpenSPP implementations. For more information, visit Digital Convergence Initiative.

Important

This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. More details on development status

Table of contents

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• OpenSPP.org

Maintainers

Current maintainers:

This module is part of the OpenSPP/openspp-modules project on GitHub.

You are welcome to contribute.