Measurement Book Registry

Overview

The registry provides functionality to add measures data.

Pre-requisites

A running DIGIT platform is needed to deploy the measurement registry. Specifically, the following dependencies are needed:

• DIGIT backbone services

• Persister

• Indexer

• IDGen

• MDMS

• FileStore

Functionality

This service provides APIs to create, update and search for measurement registries. Refer to the functional specifications here.

Deployment

The below variables should be configured for the measurement registry in the Helm environment file before deployment. The Helm environment file will be located under:

https://github.com/{{ORG}}/DIGIT-DevOps/deploy-as-code/helm/environments/{{EnvironmentFile}}.yaml

Refer to the sample here.

• Add db-host,db-name,db-url,domain and all the digit core platform services configurations (Idgen, workflow,user etc.) in the YAML file.

• Add the ‘egov-mdms-service’ related configuration to the respective environment YAML file. Change the gitsync.branch name.

• Check the measurement-registry persister file is added to the egov-persister.perister-yml-path variable. If not, add the way it's done here.

• Make sure to add the DB (Postgres and flyway) username & password in the respective environment secret yaml file. Follow the steps here.

• Make sure to add the DIGIT core services-related secrets configured in the respective environment secret file. Follow the steps here.

Restart egov-mdms-service and egov-persister after the above changes are performed.

Configuration

Configure ID Generation

Ensure the id format is configured in the ‘IdFormat.json’ file of the ‘common-masters’ module. The sample is available here.

IDGen Format
{ "format": "MB/[fy:yyyy-yy]/[SEQ_MEASUREMENT_NUM]", "idname": "mb.reference.number" }

Configure Persister

Make sure that the file measurement-registry-persister.yml is present in the configs repository in the below location.

https://github.com/<YOUR ORGANISATION>/configs/tree/UNIFIED-DEV/works/egov-persister

In case it is not available, make sure to add the persister YML file.

It is important to restart MDMS and the persister service after adding the file to the above location.