Health
PlatformDomainAcademyDesign SystemFeedback
v1.0
v1.0
  • Introducing DIGIT Health Platform
    • Roadmap
  • Platform
    • Release Notes
      • Release Checklist
    • Platform Features
    • 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
        • Services
          • Project
          • Stock
    • Technical Skillset & Pre-requisites
    • Installation
      • Setup Requirements
      • Supported Clouds
    • Configuration
      • Localisation Keys
    • Development Guide
    • Source Code
    • DHIS2 to DIGIT Integration
      • DHIS2-DIGIT Field Mapping
  • Products
    • Health Campaign Management
      • Frontline Worker's App
        • User Personas
        • Features
        • 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
        • Test Cases
        • Functional Specifications
        • Field App Architecture
        • Installation
          • APK Installation
        • Configuration
          • HCM Configuration
            • Individual Registry
            • Household Registry
            • Product Registry
            • Facility Registry
            • Stock & Inventory
            • Project Services
            • Complaints
              • QA Sign-Off
                • Test Cases
            • User Management
              • QA Sign-Off
          • HCM Master Promotion Guide
        • Release Notes
          • Success Metrics
        • Product Sign-off
        • Architect Sign-off
          • Health UAT API Execution Report
          • Performance Report
        • QA Sign-off
        • Products Requirement Documents (PRDs)
          • User Management
          • Complaints Management
          • Supervision Flow
          • Role Action Mapping
          • Beneficiary Registration
          • Service Delivery
          • Inventory 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
    • Standard Operating Procedures (SOPs) and Plans
      • SOP for Helpdesk 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
    • Implementation Checklist
    • DIGIT Pre-Training Tutorials
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. Products
  2. Health Campaign Management
  3. Frontline Worker's App
  4. Configuration
  5. HCM Configuration

Facility Registry

PreviousProduct RegistryNextStock & Inventory

Last updated 2 years ago

Was this helpful?

Overview

The facility service helps and provides APIs to create facilities for the HCM. This document provides the configuration details for setting up the facility.

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, delete, and search facilities.

  2. Provides APIs to bulk create, bulk update, and bulk delete facilities.

Setup details

The source code for 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 Facility

facility.consumer.bulk.delete.topic=delete-facility-bulk-topic
facility.consumer.bulk.create.topic=create-facility-bulk-topic
facility.consumer.bulk.update.topic=update-facility-bulk-topic

facility.kafka.create.topic=save-facility-topic
facility.kafka.update.topic=update-facility-topic
facility.kafka.delete.topic=delete-facility-topic

URLs for the external API references:

Configuration details

Access MDMS configurations

Action test: URL actions adding

{
 "id": 1615,
 "name": "Facility Create",
 "url": "/facility/v1/_create",
 "displayName": "Facility Create",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "facility",
 "code": "null",
 "path": ""
},
{
 "id": 1616,
 "name": "Facility Bulk Create",
 "url": "/facility/v1/bulk/_create",
 "displayName": "Facility Bulk Create",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "facility",
 "code": "null",
 "path": ""
},
{
 "id": 1617,
 "name": "Facility Update",
 "url": "/facility/v1/_update",
 "displayName": "Facility Update",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "facility",
 "code": "null",
 "path": ""
},
{
 "id": 1618,
 "name": "Facility Bulk Update",
 "url": "/facility/v1/bulk/_update",
 "displayName": "Facility Bulk Update",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "facility",
 "code": "null",
 "path": ""
},
{
 "id": 1619,
 "name": "Facility Delete",
 "url": "/facility/v1/_delete",
 "displayName": "Facility Delete",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "facility",
 "code": "null",
 "path": ""
},
{
 "id": 1620,
 "name": "Facility Bulk Delete",
 "url": "/facility/v1/bulk/_delete",
 "displayName": "Facility Bulk Delete",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "facility",
 "code": "null",
 "path": ""
},
{
 "id": 1621,
 "name": "Facility Search",
 "url": "/facility/v1/_search",
 "displayName": "Facility Search",
 "orderNumber": 0,
 "parentModule": "",
 "enabled": false,
 "serviceCode": "facility",
 "code": "null",
 "path": ""
}

Access to role-based actions

{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1615,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1616,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1617,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1618,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1619,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1620,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "SYSTEM_ADMINISTRATOR",
 "actionid": 1621,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "WAREHOUSE_MANAGER",
 "actionid": 1614,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "WAREHOUSE_MANAGER",
 "actionid": 1615,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "WAREHOUSE_MANAGER",
 "actionid": 1616,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "WAREHOUSE_MANAGER",
 "actionid": 1617,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "WAREHOUSE_MANAGER",
 "actionid": 1618,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "WAREHOUSE_MANAGER",
 "actionid": 1619,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "WAREHOUSE_MANAGER",
 "actionid": 1620,
 "actioncode": "",
 "tenantId": "default"
},
{
 "rolecode": "WAREHOUSE_MANAGER",
 "actionid": 1621,
 "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 =

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