Skip to content

Latest commit

 

History

History

spp_program_id

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
data
data
 
 
i18n
i18n
 
 
models
models
 
 
readme
readme
 
 
static/description
static/description
 
 
views
views
 
 
README.rst
README.rst
 
 
__init__.py
__init__.py
 
 
__manifest__.py
__manifest__.py
 
 
pyproject.toml
pyproject.toml
 
 

README.rst

OpenSPP Program ID

Alpha License: LGPL-3 OpenSPP/openspp-modules

OpenSPP Program ID

This document describes the OpenSPP Program ID module, an extension to the OpenSPP platform. This module enhances the existing OpenG2P: Programs functionality by adding unique, system-generated IDs to each program for improved tracking and reference.

Purpose

The OpenSPP Program ID module aims to:

  • Provide Unique Program Identification: Generate and assign a distinct ID to each program, allowing for easy identification and reference.
  • Enhance Data Management: Improve the organization and management of program data by introducing a standardized identification system.
  • Facilitate Integration: Enable seamless integration with other systems or modules by providing a consistent program identifier.

Module Dependencies and Integration

  1. spp_programs:
    • Leverages the core program management features provided by the OpenSPP Programs module.
    • Extends program models and views to incorporate the program ID field.
  2. g2p_programs:
    • Builds upon the program structure and functionality provided by the G2P Programs module.
    • Integrates with program views to display the generated program ID.

Additional Functionality

  • Program ID Generation:
    • Automatically generates a unique program ID using a defined sequence (program.id.sequence) upon program creation.
    • Ensures that each program has a distinct identifier.
  • Program ID Field:
    • Introduces a new field, program_id, in the g2p.program model to store the generated unique ID.
    • Makes the program_id field read-only to prevent accidental modification.
  • View Integration:
    • Integrates the program_id field into relevant program views:
      • Search Filter: Adds program_id as a search filter option in the program list view.
      • List View: Displays the program_id alongside other program details in the program list view.
      • Form View: Shows the program_id prominently within the program form view.

Conclusion

The OpenSPP Program ID module enhances the OpenSPP platform by providing a simple yet powerful mechanism for uniquely identifying programs. This enhancement contributes to better data management, easier referencing, and smoother integration with other systems, ultimately improving the efficiency and usability of the OpenSPP platform.

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:

jeremi gonzalesedwin1123 nhatnm0612

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

You are welcome to contribute.