All pages
Powered by GitBook
5 of 5

Low Level Design

Here are the articles in this section:

Services

Services

Here are the articles in this section:

PQM Service

PQM Anomaly Finder

PQM Scheduler

PQM Service

Overview

The Process Quality Management (PQM) service will help users to create, update, and search for process quality monitoring tests. The service will evaluate the uploaded test values against benchmarks and produce result (FAIL/PASS) status. Test results will be further processed for anomaly analysis. The service can perform two types of test: Manual Test (Lab), and Automatic Test (IoT-based).

Plant User Mapping

The service enables mapping plant codes to operators and ULB admins, ensuring that each is only authorised to manage plants linked to their account, enhancing control and accountability. In the mapping process need to check below mention things

  • PlantCode : Unique plant code which is configured in the mdms

  • PlantUserType : User type will be either plant-operation or the ulb-admin

  • PlantUserUuid : Unique user id of the employee which have the type of ulb-admin or the plant-operator.

Service Dependencies:

List of services that PQM service depends on:

  • MDMS

  • Workflow

  • Notification

  • Localisation

  • Access Control

  • User

  • IDGen

Master Data

The following masters need to be created as part of this module:

  • Plant

  • PlantType

  • PlantConfig

  • Process

  • ProcessType

  • ProcessSubType

  • Stage

  • Material

  • Parameter

  • Unit

  • BenchmarkRule

  • TestingStandard

  • QualityCriteria

  • Device

  • DeviceDetails

  • DeviceConfig

Kafka Topic Details

Description
Topic Name

Save Test on creation

save-test-application

Update Test

update-test-application

Update Test Workflow

update-workflow-test-application

Save test topic for Inbox

save-test-event-application

Update test topic for Inbox

update-test-event-application

Anomaly topic for when a test fails

create-pqm-anomaly-finder

Anomaly topic for when a test result has not been submitted

testResultNotSubmitted-anomaly-topic

Creation of plant-user mapping

save-plant-user-mapping

Updation of plant-user mapping

update-plant-user-mapping

Postman-Collection

PQM- Api collection

Plant User Mapping- Api collection

API Specification

PQM Swagger Link

Data Model

Sequence Diagrams

Create New

Update - new

Search

Reference Docs

Doc Links

Title

Link

Workflow Technical Document

Workflow Service

User Technical Document

User Service

MDMS Technical Document

Mdms service

IDGen Technical Document

Idgen service

Localisation Technical Document

Localization service

Persister Technical Document

Persister service

API List

Title

Link

pqm-service/v1/_create

Postman Collection

pqm-service/v1/_update

Postman Collection

/pqm-service/v1/_search

Postman Collection

/pqm-service/v1/_create Adhoc

Postman Collection

/pqm-anomaly-finder/v1/_plainsearch

Postman Collection

/pqm-service/plant/user/v1/_create

Postman Collection

/pqm-service/plant/user/v1/_update

Postman Collection

/pqm-service/plant/user/v1/_search

Postman Collection

/inbox/v2/_search

Postman Collection

PQM Anomaly Finder

Overview

The Process Quality Management (PQM) anomaly finder service helps in monitoring anomalies in process quality and notifies the concerned user groups.

Master Data Types

The following masters need to be created as part of this module:

  • Plant

  • PlantConfig

Dependencies

List of services that PQM service depends on:

User-Event Service

User-event service api will get the notification for the anomaly .

Deploy the latest build if the service is not there in the environment “egov-user-event-db:v1.2.0-32caf0d992-25” .

Add the changes which are required . For this kindly refer the below pr.

Path: deploy-as-code/helm/charts/core-services/egov-user-event/Chart.yaml

File: Refer the pr for the changes

Notification

Note: For the test not submitted notification, the notification will only be sent when the frequency of a test standard is greater than the manualTestPendingEscalationDays from Plant Config Master

Localisation

Alert notification format needs to add in localisation.

[
  {
    "code": "NOTIF_TEST_RESULT_NOT_SUBMITTED",
    "message": "Lab results for plant {Plant Name} for {Output} of {Stage} stage scheduled on {Test Scheduled Date} has not yet been submitted.",
    "module": "rainmaker-tqm",
    "locale": "en_IN"
  },
  {
    "code": "NOTIF_TEST_RESULT_NOT_AS_PER_BENCHMARK",
    "message": "Lab results submitted for plant {Plant Name} for {Output} of {Stage} stage submitted on {Test Submitted Date} is not as per benchmark values.",
    "module": "rainmaker-tqm",
    "locale": "en_IN"
  }
]

Postman Collection

Link to collection

API Specification

PQM Anomaly Swagger Link

Kafka Topic Details

Event (In-App) Notification

persist-user-events-async

Anomaly topic for when a test fails

save-pqm-test-anomaly-details

Anomaly topic for when test result not submitted

testResultNotSubmitted-anomaly-topic

Save anomaly topic

create-pqm-anomaly-finder

ER Diagram

Sequence Diagram

Find Anomaly

Reference Docs

Doc Links

Title

Link

User Technical Document

User Service

MDMS Technical Document

Mdms service

Localisation Technical Document

Localization service

Persister Technical Document

Persister service

API Contract

API Contract

Postman Collection

Postman Collection

API List

Title

Link

pqm-anomaly-finder/v1/_search

Postman Collection

pqm-anomaly-finder/v1/_plainsearch

Postman Collection

PQM Scheduler

Overview

This pqm scheduler is a cronjob scheduler for scheduling tests. It runs based on environment configuration. It triggers multiple the schedule API from PQM-Service to generate the Tests on the basis of Test Standards present in MDMS.

Dependency

  • MDMS

  • User

  • PQM-Service

Key Functionalities

  • It creates tests based on MDMS Test Standards using pqm-service /v1/_scheduler API.

Sequence Diagram

Create Lab Test (CronJob)