Health
PlatformDomainAcademyDesign SystemFeedback
v1.2
v1.2
  • Introducing DIGIT Health Platform
    • Roadmap
  • Platform
    • Release Notes
      • Master Data Management Service (MDMS) & Configuration Updates
      • Test Cases
      • Data Migration
      • Service Build Updates
      • Gate 2 Release Checklist
    • Platform Capabilities
      • Technical Skillset & Pre-requisites
    • Architecture
      • Master Data Management Service (MDMS)
      • High Level Design
        • Health Campaign System High Level Design
        • Design Decision Log
      • Low Level Design
        • Registries
          • Individual
          • Household
          • Product
          • Facility
          • Referral
        • Services
          • Project
          • Stock
    • Source Code
    • Installation
      • Setup Requirements
      • Supported Clouds
    • Platform Services
      • Individual Registry
      • Household Registry
      • Product Registry
      • Facility Registry
      • Stock & Inventory
      • Project Services
      • Referral Registry
      • Complaints
        • QA Sign-Off
          • Test Cases
      • User Management
        • QA Sign-Off
    • Configuration
      • Localisation Keys
      • Developer Guide
  • Products
    • Health Campaign Management
      • Frontline Worker's App
        • Features
        • User Personas
        • User Interface Design
          • User Management
          • Complaints Management
          • Supervision Flow
          • Beneficiary Registration
          • Service Delivery
          • Inventory Management
          • User Login
        • HCM App User Manual
          • Language Selection
          • Login
          • Forgot Password
          • Project Selection
          • Beneficiary Registration
          • Delivery Intervention
          • Stock Management
          • Checklist
          • Multi-Round Campaigns
          • Tracking Side-Effects for Beneficiaries
          • Tracking Beneficiary Referrals
          • Voucher-Based Registration and Distribution
          • Proximity-Based Search
          • Downloading Beneficiary Data for Longitudinal Tracking
          • Test Cases
        • Functional Specifications
        • Field App Architecture
        • Installation
          • App Setup
        • Configuration
          • HCM Master Promotion Guide
            • Configuring Tenants
              • MDMS Configuration
        • Release Notes
          • Success Metrics
          • Product Sign-off
          • Architect Sign-off
            • Health UAT API Execution Report
            • Performance Report
          • QA Sign-off
          • SMC UX Audit
        • Products Requirement Documents (PRDs)
          • User Management
          • Complaints Management
          • Supervision Flow
          • Role Action Mapping
          • Beneficiary Registration
          • Referral Management
          • Service Delivery
          • Inventory Management: Last Mile Delivery
          • Proximity-Based Search
          • 2D Voucher Scanning
          • Adverse Events Workflow
          • Multi-Round Service Delivery
          • Inventory Management
          • Referral Management
          • User Login
      • Campaign Management Dashboard
        • Features
        • User Stories
        • User Interface Design
        • Dashboard User Manual
        • Test Cases
        • Installation
        • Configuration
          • Dashboard UI Enhancements
          • HCM Dashboard Master Promotion Guide
        • Release Notes
          • UX Audit
          • PM Audit
          • Product Sign-Off
          • Architect Sign-Off
          • QA Sign-Off
        • Product Requirement Document (PRD)
  • Programme
    • Specifications
    • Deployment
    • LLIN Implementation
      • Standard Operating Procedures (SOPs) and Plans
        • SOP for Help desk Support
        • User Management SOP
          • Master Data Collection Template
            • Boundary Hierarchy
            • Boundary Data Specs
            • System User Setup
            • Facility
            • Product
        • Master Data Management SOP
        • Training Plan
        • Field Test Plan
        • Programme Roll-Out Plan
        • Change Management Strategy
        • UAT Plan
          • UAT 1
            • UAT 1 Test Scenarios
            • UAT Test Cases
              • Registration & Distribution
              • Inventory Flow
              • Supervision
            • User Acceptance Test Report
              • Plan Dates
          • UAT 2
            • UAT 2 SOP
            • UAT 2 Test Scenarios
            • UAT Observations
              • Registration and Distribution
              • Inventory Flow
              • Supervision
              • General Feedback
            • UAT Feedback Form: SUS
            • UAT Feedform Form: Process
      • Monitoring and Evaluation (M&E) Tools
      • Master data template
      • Implementation Checklist
      • DIGIT Pre-Training Tutorials
    • SMC Implementation
      • Localisation Plan
      • SMC Programme and Implementation Plan (Checklist)
      • Helpdesk and Support Process
      • Master Training of Trainers (ToT) Plan
      • UAT Plan
        • Change Management Strategy
      • Master Data Template
Powered by GitBook

https://creativecommons.org/licenses/by/4.0/

On this page
  • Overview
  • Pre-requisites
  • Functionalities
  • Setup details
  • API details
  • Configuration details

Was this helpful?

Export as PDF
  1. Platform
  2. Platform Services

Product Registry

PreviousHousehold RegistryNextFacility Registry

Last updated 1 year ago

Was this helpful?

Overview

The product service provides APIs to create products and product variants to the HCM. This document provides the configuration details for setting up products and product variants.

Pre-requisites

  • Knowledge of Java/J2EE (preferably Java 8 version).

  • Knowledge of spring boot and spring-boot micro-services.

  • 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.

Functionalities

  1. Provides APIs to create, update, and search products.

  2. Provides APIs to create, update, and search product variants.

Setup details

The source code for a is present in the health-campaign-services Git repo. The spring boot application needs the Lombok* extension added to the IDE to load it. Once the application is up and running, the API requests can be posted to the URL and the IDs can be generated.

*In the case of IntelliJ, the plugin can be installed directly. For eclipse, the Lombok jar location has to be added in the eclipse.ini file in this format javaagent:lombok.jar.

API details

Application.properties file information:

Kafka topics persister configs for eGov persister

product.kafka.create.topic=save-product-topic
product.kafka.update.topic=update-product-topic
product.variant.kafka.create.topic=save-product-variant-topic
product.variant.kafka.update.topic=update-product-variant-topic

URLs for the external API references:

Configuration details

Access MDMS configurations

Action test: URL actions adding

{
 "id": 1536,
 "name": "Product Variant Create",
 "url": "/product/variant/v1/_create",
 "displayName": "Product Variant Create",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "product",
 "code": "null",
 "path": ""
},
{
 "id": 1537,
 "name": "Product Create",
 "url": "/product/v1/_create",
 "displayName": "Product Create",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "product",
 "code": "null",
 "path": ""
},
{
 "id": 1541,
 "name": "Product Update",
 "url": "/product/v1/_update",
 "displayName": "Product Update",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "product",
 "code": "null",
 "path": ""
},
{
 "id": 1542,
 "name": "Product Search",
 "url": "/product/v1/_search",
 "displayName": "Product Search",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "product",
 "code": "null",
 "path": ""
},
{
 "id": 1543,
 "name": "Product Variant Update",
 "url": "/product/variant/v1/_update",
 "displayName": "Product Variant Update",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "product",
 "code": "null",
 "path": ""
},
{
 "id": 1544,
 "name": "Product Variant Search",
 "url": "/product/variant/v1/_search",
 "displayName": "Product Variant Search",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "product",
 "code": "null",
 "path": ""
},

Access to role-based actions

{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1536,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1537,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1541,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1542,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1543,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1544,
 "actioncode": "",
 "tenantId": "default"
}

Persister configuration

Indexer configuration

Database schema

Postman collection

Refer to the Swagger API for YAML file details:

eGvo mdms :-> egov.mdms.host =/

eGov -idGen :-> egov.idgen.host =

eGov-User Service -> egov.user.host =

Product
Product.yaml
https://health-dev.digit.org
https://health-dev.digit.org/
https://health-dev.digit.org/
Action-test.json
Roleaction.json
Product Persister Yaml
Product Indexer Yaml
https://www.postman.com/lunar-resonance-126497/workspace/hcm/environment/24751924-61d3084a-c7bf-4591-8b7d-2ec5828d96b1