HCM Master Promotion Guide

Overview

This document is a step-by-step promotion guide to set up/promote Health Campaign Manegement (HCM) to higher environments. The guide can be used by implementation teams or other external teams to set up the product.

Table of Contents

1. Release Notes for HCM

• Release features

• List of Core DIGIT services used

• Services built for HCM

• Environment variables for HCM services

- Individual

- Household

- Product

- Facility

- Project

- Stock

- Service request

- Complaints Management

- User Management

2. Promotion Guide

• DIGIT environment production setup & deployment

• HCM promotion

• Steps to create a tenant for HCM

• Steps to add localisation using Rest API

• Deploy Digit Core services

• Deploy HCM services

• UI/APK promotion guide

1. Release Notes: HCM

Version	Date	Description
Version 1.1	11/05/2023	This version covers the HCM promotion guide.

Release Features: List of Core DIGIT Services Used

Service	Image
Access control	egovio/egov-accesscontrol:v1.1.3-72f8a8f87b-24
Encryption Service	egovio/egov-enc-service:v1.1.2-72f8a8f87b-9
File Store	egovio/egov-filestore:v1.2.4-72f8a8f87b-10
Localisation	egovio/egov-localization:v1.1.3-72f8a8f87b-6
ID Gen	egovio/egov-idgen:v1.2.3-72f8a8f87b-7
Indexer	egovio/egov-indexer:v1.1.7-f52184e6ba-25
Location	egovio/egov-location:v1.1.5-f9271c8-7
MDMS	egovio/egov-mdms-service:v1.3.2-72f8a8f87b-12
Notification Mail	egovio/egov-notification-mail:health-digit-master-6865af2823-2
Notification SMS	egovio/egov-notification-sms:v1.1.3-48a03ad7bb-10
OTP	egovio/egov-otp:v1.2.2-72f8a8f87b-12
Persister	egovio/egov-persister:v1.1.4-72f8a8f87b-6
Searcher	egovio/egov-searcher:v1.1.5-72f8a8f87b-16
URL Shortening	egovio/egov-url-shortening:v1.1.2-1715164454-3
User	egovio/egov-user:health-digit-master-e27b970-31
User OTP	egovio/user-otp:health-digit-master-6865af2823-3
Workflow	egovio/egov-workflow-v2:v1.2.1-df98ec3c35-2
Report	egovio/report:v1.3.4-96b24b0d72-16
Document Uploader	egovio/egov-document-uploader:v1.1.0-75d461a4d2-4
Playground	egovio/playground:1.0

Services Built for HCM

Service	Tag	Description
Individual	egovio/individual:v1.1.0-73167482a2-82	Individual service built in to the DIGIT platform, all the CRUD operations are allowed using API.
Household	egovio/household:v1.1.0-73167482a2-50	Household service provided to create household and add members to a household.
Facility	egovio/facility:v1.1.0-73167482a2-28	Facility services provide the APIs to create, update, delete and read facilities.
Product	egovio/product:v1.1.0-73167482a2-12	Product services provide the APIs for CRUD operations for products and product variants.
Project	egovio/project:v1.1.0-73167482a2-80	Project services provide the apis for CRUD operations for project, project task, project staff, project resource, and project beneficiary.
Stock	egovio/stock:v1.1.0-73167482a2-36	Stock services provide the APIs for creating, updating, deleting of stock receipts and stock reconciliations.
Service Request	egovio/service-request:v1.0.0-a51bee1435-7	Service requests provide the create and submission APIs for checklists.
Transformer	egovio/transformer:v1.1.0-73167482a2-38	Library that transforms the data according to the analytics dashboard requirements.
Complaints	egovio/pgr-services:v1.1.7-f58e5abb0d-8	Complaints services provide features like add complaints, resolve complaints, etc.
User Management	egovio/egov-hrms:health-digit-master-5bc2341e92-14	Create and manage users and team assignments for their respective boundaries.

Environment Variables for HCM Services

Individual: Click here to know more.

Environment Variable	Value	Comments
SPRING_KAFKA_CONSUMER_GROUP_ID	health-individual
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
TRACER_ERRORS_PROVIDEEXCEPTIONINDETAILS
EGOV_IDGEN_HOST		Value of IDGEN host server
EGOV_IDGEN_PATH	egov-idgen/id/_generate
EGOV_IDGEN_INTEGRATION_ENABLED	true/false
IDGEN.INDIVIDUAL.ID.FORMAT	individual.id
SPRING_REDIS_HOST	redis.backbone
SPRING_REDIS_PORT
SPRING_CACHE_TYPE	redis
SPRING_CACHE_REDIS_TIME-TO-LIVE
SPRING_CACHE_AUTOEXPIRY	true
JAVA_OPTS
JAVA_ARGS
JAVA_ENABLE_DEBUG
SERVER_PORT
SECURITY_BASIC_ENABLED	false
MANAGEMENT_SECURITY_ENABLED	false
TRACER_OPENTRACING_ENABLED	true/false
INDIVIDUAL.CONSUMER.SAVE.TOPIC	save-individual-topic	Topic to save individual
INDIVIDUAL.CONSUMER.UPDATE.TOPIC	update-individual-topic	Topic to update individual
INDIVIDUAL.CONSUMER.DELETE.TOPIC	delete-individual-topic	Topic to delete individual
INDIVIDUAL.CONSUMER.BULK.CREATE.TOPIC	individual-consumer-bulk-create-topic	Topic to create individuals in bulk
INDIVIDUAL.CONSUMER.BULK.UPDATE.TOPIC	individual-consumer-bulk-update-topic	Topic to update individuals in bulk
INDIVIDUAL.CONSUMER.BULK.DELETE.TOPIC	individual-consumer-bulk-delete-topic	Topic to delete individuals in bulk
STATE_LEVEL_TENANT_ID	default
EGOV_ENC_HOST
EGOV_ENC_ENCRYPT_ENDPOINT	/egov-enc-service/crypto/v1/_encrypt
EGOV_ENC_DECRYPT_ENDPOINT	/egov-enc-service/crypto/v1/_decrypt
AADHAAR_PATTERN	\d{12}
MOBILE_PATTERN	\d+
EGOV_USER_HOST
EGOV_CREATE_USER_URL	/user/users/_createnovalidate
EGOV_SEARCH_USER_URL	/user/_search
EGOV_UPDATE_USER_URL	/user/users/_updatenovalidate
EGOV_USER_INTEGRATION_ENABLED	true
USER_SYNC_ENABLED	true
USER_SERVICE_ACCOUNT_LOCKED	false
INDIVIDUAL_PRODUCER_UPDATE_USER_ID_TOPIC	update-user-id-topic
NOTIFICATION_SMS_ENABLED	false

Household: Click here to know more.

Environment Variable	Value	Comments
SPRING_KAFKA_CONSUMER_GROUP_ID	health-household
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
TRACER_ERRORS_PROVIDEEXCEPTIONINDETAILS
EGOV_IDGEN_HOST		Value of IDGEN host server
EGOV_IDGEN_PATH	egov-idgen/id/_generate
EGOV_IDGEN_INTEGRATION_ENABLED	true/false
HOUSEHOLD.IDGEN.ID.FORMAT	household.id
SPRING_REDIS_HOST	redis.backbone
SPRING_REDIS_PORT	6379
SPRING_CACHE_TYPE	redis
SPRING_CACHE_REDIS_TIME-TO-LIVE
SPRING_CACHE_AUTOEXPIRY	true
JAVA_OPTS
JAVA_ARGS
JAVA_ENABLE_DEBUG
SERVER_PORT	8080
SECURITY_BASIC_ENABLED	false
MANAGEMENT_SECURITY_ENABLED	false
TRACER_OPENTRACING_ENABLED	true/false
HOUSEHOLD.KAFKA.CREATE.TOPIC	save-household-topic	Topic to save household
HOUSEHOLD.KAFKA.UPDATE.TOPIC	update-household-topic	Topic to update household
HOUSEHOLD.KAFKA.DELETE.TOPIC	delete-household-topic	Topic to delete household
HOUSEHOLD.CONSUMER.BULK.CREATE.TOPIC	create-household-bulk-topic	Topic to create households in bulk
HOUSEHOLD.CONSUMER.BULK.UPDATE.TOPIC	update-household-bulk-topic	Topic to update households in bulk
HOUSEHOLD.CONSUMER.BULK.DELETE.TOPIC	delete-household-bulk-topic	Topic to delete households in bulk
HOUSEHOLD_MEMBER_KAFKA_CREATE_TOPIC	save-household-member-topic	Topic to create household member
HOUSEHOLD_MEMBER_KAFKA_UPDATE_TOPIC	update-household-member-topic	Topic to update household member
HOUSEHOLD_MEMBER_KAFKA_DELETE_TOPIC	delete-household-member-topic	Topic to delete household member
HOUSEHOLD.MEMBER.CONSUMER.BULK.CREATE.TOPIC	household-member-consumer-bulk-create-topic	Topic to create bulk household members
HOUSEHOLD.MEMBER.CONSUMER.BULK.UPDATE.TOPIC	household-member-consumer-bulk-update-topic	Topic to update bulk household members
HOUSEHOLD.MEMBER.CONSUMER.BULK.DELETE.TOPIC	household-member-consumer-bulk-delete-topic	Topic to delete bulk household members

Product: Click here to know more.

Environment Variable	Value	Comments
SPRING_KAFKA_CONSUMER_GROUP_ID	health-product
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
TRACER_ERRORS_PROVIDEEXCEPTIONINDETAILS
EGOV_IDGEN_HOST		Value of IDGEN host server
EGOV_IDGEN_PATH	egov-idgen/id/_generate
EGOV_IDGEN_INTEGRATION_ENABLED	true/false
SPRING_REDIS_HOST	redis.backbone
SPRING_REDIS_PORT	6379
SPRING_CACHE_TYPE	redis
SPRING_CACHE_REDIS_TIME-TO-LIVE
SPRING_CACHE_AUTOEXPIRY	true
JAVA_OPTS
JAVA_ARGS
JAVA_ENABLE_DEBUG
SERVER_PORT	8080
SECURITY_BASIC_ENABLED	false
MANAGEMENT_SECURITY_ENABLED	false
TRACER_OPENTRACING_ENABLED	true/false
PRODUCT_KAFKA_CREATE_TOPIC	save-product-topic	Topic to save product
PRODUCT_KAFKA_UPDATE_TOPIC	update-product-topic	Topic to update product
PRODUCT_VARIANT_KAFKA_CREATE_TOPIC	save-product-variant-topic	Topic to create product variant
PRODUCT_VARIANT_KAFKA_UPDATE_TOPIC	update-product-variant-topic	Topic to update product variant

Facility: Click here to know more.

Environment Variable	Value	Comments
SPRING_KAFKA_CONSUMER_GROUP_ID	health-project
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
TRACER_ERRORS_PROVIDEEXCEPTIONINDETAILS
EGOV_IDGEN_HOST		Value of IDGEN host server
EGOV_IDGEN_PATH	egov-idgen/id/_generate
EGOV_IDGEN_INTEGRATION_ENABLED	true/false
FACILITY.IDGEN.ID.FORMAT	facility.id
SPRING_REDIS_HOST	redis.backbone
SPRING_REDIS_PORT	6379
SPRING_CACHE_TYPE	redis
SPRING_CACHE_REDIS_TIME-TO-LIVE
SPRING_CACHE_AUTOEXPIRY	true
JAVA_OPTS
JAVA_ARGS
JAVA_ENABLE_DEBUG
SERVER_PORT
SECURITY_BASIC_ENABLED	false
MANAGEMENT_SECURITY_ENABLED	false
TRACER_OPENTRACING_ENABLED	true/false
FACILITY.KAFKA.CREATE.TOPIC	save-facility-topic
FACILITY.KAFKA.UPDATE.TOPIC	update-facility-topic
FACILITY.KAFKA.DELETE.TOPIC	delete-facility-topic
FACILITY.CONSUMER.BULK.CREATE.TOPIC	create-facility-bulk-topic
FACILITY.CONSUMER.BULK.UPDATE.TOPIC	update-facility-bulk-topic
FACILITY.CONSUMER.BULK.DELETE.TOPIC	delete-facility-bulk-topic

Project: Click here to know more.

Environment Variable	Value	Comments
SPRING_KAFKA_CONSUMER_GROUP_ID	health-project
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
TRACER_ERRORS_PROVIDEEXCEPTIONINDETAILS
EGOV_IDGEN_HOST		Value of IDGEN host server
EGOV_IDGEN_PATH	egov-idgen/id/_generate
EGOV_IDGEN_INTEGRATION_ENABLED	true/false
PROJECT.STAFF.IDGEN.ID.FORMAT	project.staff.id	Project staff id generated format
PROJECT.FACILITY.IDGEN.ID.FORMAT	project.facility.id	Project facility id generated format
PROJECT.TASK.IDGEN.ID.FORMAT	project.task.id	Project task id generated format
IDGEN.PROJECT.BENEFICIARY.ID.FORMAT	project.beneficiary.id	Project beneficiary id generated format
EGOV_USER_CONTEXT_PATH	/user/users	User service context path
EGOV_SEARCH_USER_URL	/user/_search	User service search url
EGOV_USER_INTEGRATION_ENABLED	true/false	User service integration enabled if it is true
SPRING_REDIS_HOST	redis.backbone
SPRING_REDIS_PORT	6379
SPRING_CACHE_TYPE	redis
SPRING_CACHE_REDIS_TIME-TO-LIVE
SPRING_CACHE_AUTOEXPIRY	true
JAVA_OPTS
JAVA_ARGS
JAVA_ENABLE_DEBUG
SERVER_PORT	8080
SECURITY_BASIC_ENABLED	false
MANAGEMENT_SECURITY_ENABLED	false
TRACER_OPENTRACING_ENABLED	true/false
EGOV_LOCATION_CONTEXT_PATH	/egov-location/location/v11
EGOV_LOCATION_ENDPOINT	/boundarys/_search	Egov Location end point
EGOV_MDMS_INTEGRATION_ENABLED	true/false
EGOV_MDMS_MASTER_NAME	project_master	Creating a mdms service bean
EGOV_MDMS_MODULE_NAME	project	Nor required.
EGOV_HOUSEHOLD_HOST		Host of the household service
EGOV_INDIVIDUAL_HOST		Host of individual service
EGOV_SEARCH_INDIVIDUAL_URL	/individual/v1/_search	Search url of the individual
EGOV_PRODUCT_HOST		Host of product service
EGOV_SEARCH_PRODUCT_VARIANT_URL	/product/variant/v1/_search	URL of the product variant search
PROJECT.TASK.KAFKA.CREATE.TOPIC	save-project-task-topic	Topic to save project task
PROJECT.TASK.CONSUMER.BULK.CREATE.TOPIC	save-project-task-bulk-topic	Topic to save bulk project tasks
PROJECT.TASK.KAFKA.UPDATE.TOPIC	update-project-task-topic	Topic to update project task
PROJECT.TASK.CONSUMER.BULK.UPDATE.TOPIC	update-project-task-bulk-topic	Topic to update bulk project tasks
PROJECT.TASK.KAFKA.DELETE.TOPIC	delete-project-task-topic	Topic to delete project task
PROJECT.TASK.CONSUMER.BULK.DELETE.TOPIC	delete-project-task-bulk-topic	Topic to delete bulk project tasks
PROJECT.BENEFICIARY.KAFKA.CREATE.TOPIC	save-project-beneficiary-topic	Topic to create project beneficiary
PROJECT.BENEFICIARY.KAFKA.UPDATE.TOPIC	update-project-beneficiary-topic	Topic to update project beneficiary
PROJECT.BENEFICIARY.KAFKA.DELETE.TOPIC	delete-project-beneficiary-topic	Topic to delete project beneficiary
PROJECT.BENEFICIARY.CONSUMER.BULK.CREATE.TOPIC	project-beneficiary-consumer-bulk-create-topic	Topic to create bulk project beneficiaries
PROJECT.BENEFICIARY.CONSUMER.BULK.UPDATE.TOPIC	project-beneficiary-consumer-bulk-update-topic	Topic to update bulk project beneficiaries
PROJECT.BENEFICIARY.CONSUMER.BULK.DELETE.TOPIC	project-beneficiary-consumer-bulk-delete-topic	Topic to delete bulk project beneficiaries
PROJECT.STAFF.KAFKA.DELETE.TOPIC	delete-project-staff-topic	Topic to delete project staff
PROJECT.STAFF.KAFKA.CREATE.TOPIC	save-project-staff-topic	Topic to create project staff
PROJECT.STAFF.KAFKA.UPDATE.TOPIC	update-project-staff-topic	Topic to update project staff
PROJECT.STAFF.CONSUMER.BULK.DELETE.TOPIC	delete-project-staff-bulk-topic	Topic to delete bulk project staff
PROJECT.STAFF.CONSUMER.BULK.CREATE.TOPIC	create-project-staff-bulk-topic	Topic to create bulk project staff
PROJECT.STAFF.CONSUMER.BULK.UPDATE.TOPIC	update-project-staff-bulk-topic	Topic to update bulk project staff
SEARCH_API_LIMIT	1000	Search api limit
PROJECT.DOCUMENT.ID.VERIFICATION.REQUIRED	false	Project ID verification is done if value is true
PROJECT.MANAGEMENT.SYSTEM.KAFKA.CREATE.TOPIC	save-project	Topic to save project
PROJECT.MANAGEMENT.SYSTEM.KAFKA.UPDATE.TOPIC	update-project	Topic to update project
PROJECT.DEFAULT.OFFSET	0
PROJECT.DEFAULT.LIMIT	100
PROJECT.SEARCH.MAX.LIMIT	200
EGOV.IDGEN.PROJECT.NUMBER.NAME	project.number
PROJECT.RESOURCE.IDGEN.ID.FORMAT	project.resource.id
PROJECT.RESOURCE.KAFKA.CREATE.TOPIC	save-project-resource-topic	Topic to save project resource
PROJECT.RESOURCE.KAFKA.UPDATE.TOPIC	update-project-resource-topic	Topic to update project resource
PROJECT.RESOURCE.KAFKA.DELETE.TOPIC	delete-project-resource-topic	Topic to delete project resource
PROJECT.RESOURCE.CONSUMER.BULK.CREATE.TOPIC	save-project-resource-bulk-topic	Topic to create bulk project resources
PROJECT.RESOURCE.CONSUMER.BULK.UPDATE.TOPIC	update-project-resource-bulk-topic	Topic to update bulk project resources
PROJECT.RESOURCE.CONSUMER.BULK.DELETE.TOPIC	delete-project-resource-bulk-topic	Topic to delete bulk project resources
PROJECT.FACILITY.KAFKA.CREATE.TOPIC	save-project-facility-topic	Topic to save project facility
PROJECT.FACILITY.KAFKA.UPDATE.TOPIC	update-project-facility-topic	Topic to update project facility
PROJECT.FACILITY.KAFKA.DELETE.TOPIC	delete-project-facility-topic	Topic to delete project facility
PROJECT.FACILITY.CONSUMER.BULK.CREATE.TOPIC	create-project-facility-bulk-topic	Topic to create bulk project facilities
PROJECT.FACILITY.CONSUMER.BULK.UPDATE.TOPIC	update-project-facility-bulk-topic	Topic to update bulk project facilities
PROJECT.FACILITY.CONSUMER.BULK.DELETE.TOPIC	delete-project-facility-bulk-topic	Topic to delete bulk project facilities
EGOV_FACILITY_HOST		Host of the facility service
EGOV_SEARCH_FACILITY_URL	/facility/v1/_search	Url of the search facility
PROJECT_MDMS_MODULE	HCM-PROJECT-TYPES
EGOV_LOCATION_HIERARCHY_TYPE	Admin	Hierarchy value used to get boundary values
EGOV_LOCATION_CODES_QUERY_PARAM	code	Query param used in egov location boundary api

Stock: Click here to know more.

Environment Variable	Value	Comments
SPRING_KAFKA_CONSUMER_GROUP_ID	health-project
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
TRACER_ERRORS_PROVIDEEXCEPTIONINDETAILS
EGOV_IDGEN_HOST		Value of IDGEN host server
EGOV_IDGEN_PATH	egov-idgen/id/_generate
EGOV_IDGEN_INTEGRATION_ENABLED	true/false
STOCK.IDGEN.ID.FORMAT	stock.id	stock id generated format
STOCK.RECONCILIATION.IDGEN.ID.FORMAT	stock.reconciliation.id	Stock reconciliation id generated format
PROJECT.TASK.IDGEN.ID.FORMAT	project.task.id	Project task id generated format
SPRING_REDIS_HOST	redis.backbone
SPRING_REDIS_PORT	6379
SPRING_CACHE_TYPE	redis
SPRING_CACHE_REDIS_TIME-TO-LIVE
SPRING_CACHE_AUTOEXPIRY	true
JAVA_OPTS
JAVA_ARGS
JAVA_ENABLE_DEBUG
SERVER_PORT	8080
SECURITY_BASIC_ENABLED	false
MANAGEMENT_SECURITY_ENABLED	false
TRACER_OPENTRACING_ENABLED	true/false
EGOV_SEARCH_PRODUCT_VARIANT_URL	/product/variant/v1/_search	Product variant search url to validate product variant id
STOCK.KAFKA.CREATE.TOPIC	save-stock-topic	Topic to save stock receipts
STOCK.KAFKA.UPDATE.TOPIC	update-stock-topic	Topic to update stock receipts
STOCK.KAFKA.DELETE.TOPIC	delete-stock-topic	Topic to delete stock receipts
STOCK.CONSUMER.BULK.CREATE.TOPIC	create-stock-bulk-topic	Topic to create bulk stock receipts
STOCK.CONSUMER.BULK.UPDATE.TOPIC	update-stock-bulk-topic	Topic to update bulk stock receipts
STOCK.CONSUMER.BULK.DELETE.TOPIC	delete-stock-bulk-topic	Topic to delete bulk stock receipts
STOCK.RECONCILIATION.KAFKA.CREATE.TOPIC	save-stock-reconciliation-topic	Topic to create stock reconciliation audits
STOCK.RECONCILIATION.KAFKA.UPDATE.TOPIC	update-stock-reconciliation-topic	Topic to update stock reconciliation audits
STOCK.RECONCILIATION.KAFKA.DELETE.TOPIC	delete-stock-reconciliation-topic	Topic to delete stock reconciliation audits
STOCK.RECONCILIATION.CONSUMER.BULK.CREATE.TOPIC	create-stock-reconciliation-bulk-topic	Topic to create bulk stock reconciliation
STOCK.RECONCILIATION.CONSUMER.BULK.UPDATE.TOPIC	update-stock-reconciliation-bulk-topic	Topic to update bulk stock reconciliation
STOCK.RECONCILIATION.CONSUMER.BULK.DELETE.TOPIC	delete-stock-reconciliation-bulk-topic	Topic to delete bulk stock reconciliation
SEARCH_API_LIMIT	1000	Search api limit
EGOV_FACILITY_HOST		Host of the facility services
EGOV_SEARCH_FACILITY_URL	/facility/v1/_search	Search url of the facility
EGOV_PROJECT_FACILITY_HOST		Host of the project facility service
EGOV_SEARCH_PROJECT_FACILITY_URL	/project/facility/v1/_search	Search url of the project facility

Service Request: Click here to know more.

Environment Variable	Value	Comments
SPRING_KAFKA_CONSUMER_GROUP_ID	service-request
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
SPRING_KAFKA_PRODUCER_VALUE_SERIALIZER	org.springframework.kafka.support.serializer.JsonSerializer
EGOV_SERVICE_DEFINITION_CREATE_TOPIC	save-service-definition	Checkist definition
EGOV_SERVICE_CREATE_TOPIC	save-service	Checklist answers payload
EGOV_SERVICE_REQUEST_DEFAULT_OFFSET	0
EGOV_SERVICE_REQUEST_DEFAULT_LIMIT	10
EGOV_SERVICE_REQUEST_MAX_LIMIT	100
EGOV_MAX_STRING_INPUT_SIZE	8192
JAVA_OPTS
JAVA_ARGS
MANAGEMENT_SECURITY_ENABLED	false
SERVER_PORT	8080
SECURITY_BASIC_ENABLED	false

Complaints - PGR: Click here to know more.

Environment Variables	Value	Comments
SPRING_KAFKA_CONSUMER_GROUP_ID	egov-pgr-services
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
SPRING_KAFKA_PRODUCER_VALUE_SERIALIZER	org.egov.tracer.kafka.serializer.ISTTimeZoneJsonSerializer
PGR_KAFKA_CREATE_TOPIC	save-pgr-request
EGOV_SERVICE_CREATE_TOPIC	PGR_KAFKA_UPDATE_TOPIC
KAFKA_TOPICS_NOTIFICATION_SMS	egov.core.notification.sms
PERSISTER_SAVE_TRANSITION_WF_TOPIC	save-wf-transitions
PGR_KAFKA_MIGRATION_TOPIC	pgr-migration
PGR_KAFKA_MIGRATION_PERSISTOR_TOPIC	save-pgr-request-batch
PERSISTER_SAVE_TRANSITION_WF_MIGRATION_TOPIC	save-wf-transitions-batch
NOTIFICATION_SMS_ENABLED
REASSIGN_COMPLAINT_ENABLED
NEW_COMPLAINT_ENABLED
NOTIFICATION_EMAIL_ENABLED
EGOV_IDGEN_HOST		Value of IDGEN host server
EGOV_URL_SHORTNER_HOST
EGOV_WORKFLOW_HOST
EGOV_LOCALIZATION_HOST
EGOV_INFRA_SEARCHER_HOST
EGOV_COMMON_MASTERS_HOST
EGOV_FILESTORE_HOST
EGOV_UI_APP_HOST
EGOV_USER_HOST
EGOV_MDMS_SEARCH_ENDPOINT
REOPEN_COMPLAINT_ENABLED
COMMENT_BY_EMPLOYEE_NOTIF_ENABLED
EGOV_PGR_APP_PLAYSTORE_LINK
EGOV_HRMS_HOST
TRACER_ERRORS_PROVIDEEXCEPTIONINDETAILS
JAVA_OPTS
JAVA_ARGS
MANAGEMENT_SECURITY_ENABLED	false
SERVER_PORT	8080
SECURITY_BASIC_ENABLED	false
EGOV_LOCATION_HOST
EGOV_USR_EVENTS_NOTIFICATION_ENABLED	false
EGOV_USR_EVENTS_CREATE_TOPIC	persist-user-events-async
EGOV_USR_EVENTS_RATE_LINK	/citizen/otpLogin?mobileNo=$mobile&redirectTo=feedback/$servicerequestid
EGOV_USR_EVENTS_REOPEN_LINK	/citizen/otpLogin?mobileNo=$mobile&redirectTo=reopen-complaint/$servicerequestid
EGOV_USR_EVENTS_RATE_CODE	RATE
EGOV_USR_EVENTS_REOPEN_CODE	REOPEN
ENABLE_STATE_LEVEL_SEARCH	true
PGR_STATELEVEL_TENANTID	default
TRACER_OPENTRACING_ENABLED	true
PGR_COMPLAIN_IDLE_TIME

User Management - HRMS: Click here to learn more.

Environment Variables	Value	Comments
EGOV_SERVICES_DATA_SYNC_EMPLOYEE_REQUIRED	false
EGOV_MDMS_HOST	http://egov-mdms-service:8080/
EGOV_MDMS_SEARCH_ENDPOINT	/egov-mdms-service/v1/_search
EGOV_FILESTORE_HOST	http://egov-filestore:8080/
STATE_LEVEL_TENANT_ID	default
EGOV_FILESTORE_URL_ENDPOINT	/filestore/v1/files/url
EGOV_LOCALIZATION_HOST	http://egov-localization:8080/
EGOV_LOCALIZATION_SEARCH_ENDPOINT	/localization/messages/v1/_search
EGOV_IDGEN_HOST	http://egov-idgen:8080/
EGOV_SERVICES_EGOV_IDGEN_CREATEPATH	/egov-idgen/id/_generate
EGOV_SERVICES_EGOV_IDGEN_EMP_CODE_NAME	employee.code
EGOV_SERVICES_EGOV_IDGEN_EMP_CODE_FORMAT	EMP_[SEQ_EMPLOYEE_CODE]
EGOV_USER_HOST	http://egov-user:8080/
EGOV_OTP_HOST	http://egov-otp:8080/
EGOV_ENVIRONMENT_DOMAIN	https://health-qa.digit.org/
EGOV_USER_SEARCH_ENDPOINT	/user/v1/_search
EGOV_USER_CREATE_ENDPOINT	/user/users/_createnovalidate
EGOV_USER_UPDATE_ENDPOINT	/user/users/_updatenovalidate
EGOV_HRMS_EMPLOYEE_APP_LINK
SPRING_KAFKA_CONSUMER_GROUP_ID	employee-group1
SPRING_KAFKA_PRODUCER_KEY_SERIALIZER	org.apache.kafka.common.serialization.StringSerializer
SPRING_KAFKA_PRODUCER_VALUE_SERIALIZER	org.springframework.kafka.support.serializer.JsonSerializer
KAFKA_TOPICS_SAVE_SERVICE	save-hrms-employee
KAFKA_TOPICS_UPDATE_SERVICE	update-hrms-employee
KAFKA_TOPICS_NOTIFICATION_SMS	egov.core.notification.sms
JAVA_OPTS
SERVER_PORT	8080
JAVA_ARGS
SECURITY_BASIC_ENABLED	false
MANAGEMENT_SECURITY_ENABLED	false
EGOV_HRMS_AUTO_GENERATE_PASSWORD	false

Promotion Guide

This section will detail the promotion guide steps for the HCM product.

Digit Environment Production Setup & Deployment

For the DIGIT environment setup, refer to the documentation here.

HCM Promotion

Steps to Create a Tenant for HCM

Refer to this document for creating a tenant in DIGIT.

Steps to Add Localisation Using Rest API

Refer to this document for more details

curl --location --request POST 'https://health-dev.digit.org/localization/messages/v1/_upsert' \
--header 'Content-Type: application/json' \
--data-raw '{
   "RequestInfo": {
       "apiId": "Rainmaker",
       "ver": ".01",
       "ts": "",
       "action": "_create",
       "did": "1",
       "key": "",
       "msgId": "20170310130900|en_IN",
       "authToken": "052c8e95-35c1-4f97-b366-c5f23e23ce05"
   },
   "tenantId": "default",
   "messages":[
 {
   "code": "ABG_COMMON_TABLE_COL_ACTION",
   "message": "Action",
   "locale": "en_IN",
   "module": "rainmaker-common"
 },{
   "code": "ABG_COMMON_TABLE_COL_ACTION",
   "message": "Action",
   "locale": "en_IN",
   "module": "rainmaker-common"
 }
]
}'

Steps to Configure the MDMS configs

1. Create Common Masters

a. Create IdFormat.json which will be used by egov-id-gen service.

b. Create StateInfo.json which will configure eligible languages for tenant

2. Create sample boundary data. Refer to this document for more details

3. Create field-app-configuration.json which will be used for drop-down values or select options to be presented in the HCM app

4. Create project-task-configuration.json

5. Create project-types.json which will be used as a health campaign configuration

6. Create service-registry.json which has a list of APIs that the HCM app will call.

7. Create PGR/Complaints configs

   • UIConstants.json

   • ServiceDefs.json

   • RejectionReasons.json

   • ComplainClosingTime.json

8. Create UserManagemet/HRMS configs

   • CampaignAssignmentFieldsConfig.json

   • CommonFieldsConfig.json

   • DeactivationReason.json

   • Degree.json

   • EmployeeDepartment.json

   • EmployeeStatus.json

   • EmployeeType.json

9. Create configs for Access Control Sevices

• actions-test.json

• roleactions.json

8. Configure map-config for the tenant

Restart the MDMS server and restart the Zuul API gateway.

Note: Any modifications in the above configuration, need to restart the MDMS server. Any modifications to action-test.json and roleactions.json require a restart of the Zuul API gateway.

Steps to Configure Health Campaign Configurations

Step 1: Create a persister config for each backend service that will be picked by the persister service.

Step 2: Create an indexer config for each backend service which will be picked by the indexer service.

Note: Any changes to the indexer and persister configurartions require the restart of the indexer and the persister.

Deploy DIGIT Core Services

Refer to this section for a list of core services to be deployed.

Deploy HCM Services

Refer to this section for a list of HCM services to be deployed.

UI/APK Promotion Guide

https://health.digit.org/product/setup/apk-installation