The referral management registry provides APIs to register side effects and referrals for beneficiaries of a health campaign of the DIGIT platform. This document provides the configuration details for setting up the registry.
Pre-requisites
Knowledge of Java/J2EE (preferably Java 8 version).
Knowledge of Spring Boot and Spring Boot microservices.
Knowledge of Git or any version control system.
Knowledge of RESTful web services.
Knowledge of the Lombok library is helpful.
Knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-indexer, and eGov-user will be helpful.
Knowledge of the Project, Household, and Individual modules.
Functionalities
Provides APIs to create, update, and delete referrals and side effects.
Provides APIs to bulk create, update, and delete referrals and side effects.
Inactivates the status of referrals and side effects post-deletion.
Provides a search API for referral on unique ID, client reference unique ID, project beneficiary ID, side-effect ID, referrer ID and recipient ID.
Provides a search API for side effects on unique ID, client reference unique ID, and project task ID.
Setup
1
Clone or download the code from the GitHub repository
The source code for the Referral Management registry is located in the Git repository here. Clone or download the code from this repository before proceeding.
2
Add the Lombok extension/plugin
The Referral Management Registry is a Spring Boot application that uses Lombok, a Java library. Add the Lombok extension/plugin to open and build the project in your IDE (like IntelliJ or Eclipse).
3
Setup Lombok in IDEs
Install the Lombok plugin directly from the IntelliJ plugins marketplace.
Download the Lombok jar file.
Add the following line to your eclipse.ini file (replace lombok.jar with the correct path to your Lombok jar):
4
Run application
Once Lombok is set up and the application is running (using your IDE or command line), you can start making API requests to the Individual service’s endpoints.
5
Generate IDs
When you send API requests, the system generates the required IDs automatically as part of its normal operation.
Follow the details outlined below to configure and enable Referral Management API actions and access control using MDMS, role-action mapping, persister, and indexer configurations.
MDMS Configurations
Define Action URLs
Add new actions in the MDMS actions configuration (e.g., action-test.json). Each action represents an API endpoint you wish to secure and manage: actions-test.json
Assign Actions to Roles
Configure which user roles can access which API actions in roleaction.json. Map each action ID to the required roles: Roleaction.json. Refer example below:
