Page Comparison

...

https://github.com/egovernments/Train-InfraOps/blob/master/helm/environments/qa.yaml
https://github.com/egovernments/Train-InfraOps/blob/master/helm/environments/uatdev.yaml

Database configuration

Add or update the db url in the environment specific file using the below property.

...

Update the db username and password, which are configured in the environment named secrets yaml file.

For example, for the qa dev environment, update the qadev-secrets.yaml.

secrets:
        db:
            username: <username value> 
            password:  <password value>

...

• Here citya.egovernments.org, cityb.egovernments.org are the domains and citya, cityb are the schemas/tenants.

Example environment specific configuration file for your reference.

• Update the domainurl in the eg_city table.

• Domain URL value should be the same as configured tenant domain_name
  Ex:

  Code Block
  language java
  For citya, domain url should be citya.egovernments.org For cityb, domain url should be cityb.egovernments.org

...

Systemintegration: |
 si.microservice.user=${si-microservice-user}
 si.microservice.password=${si-microservice-password}
 si.microservice.usertype=SYSTEM
 si.microservice.scope=read
 si.microservice.granttype=password
 
 env: |
  - name: si-microservice-password
    valueFrom:
      secretKeyRef:  
        name: egov-si-microservice
        key: si-microservice-password
  - name: si-microservice-user
    valueFrom:
      secretKeyRef:  
        name: egov-si-microservice
        key: si-microservice-user

Elastic Dashboard Configuration

To enable or disable an event to push the bills and vouchers to the elastic search indexer the below need to be configured either in the finance service values yaml file or the environment specific yaml file.

finance: true

File store Configuration

Configure the following property either in the finance service values yaml file or the environment specific yaml file.

filestore: /tmp/egovfilestore

Quartz Scheduler Configuration

Configure the following property either in the finance service values yaml file or the environment specific yaml file.

scheduler: true

DIGIT integration configuration

Finance service reads data from multiple other DIGIT services. The following are the different services finance system reads data from. Update the domain URL of the respective service based on the service where it is running.

microservice: |
  egov.default.services.endpoint=https://egov-micro-dev.egovernments.org/
  egov.hrms.service.endpoint=http://egov-hrms.egov:8080/
  egov.accesscontrol.service.endpoint=http://egov-accesscontrol.egov:8080/
  egov.hr.masters.service.endpoint=http://hr-masters.egov:8080/
  egov.user.service.endpoint=http://egov-user.egov:8080/
  egov.common.masters.endpoint=http://egov-common-masters.egov:8080/
  egov.billing.service.endpoint=http://billing-service.egov:8080/
  egov.collection.service.endpoint=http://collection-services.egov:8080/
  egov.egf.master.service.endpoint=http://egf-master.egov:8080/
  egov.egf.instrument.service.endpoint=http://egf-instrument.egov:8080/
  egov.mdms.service.endpoint=http://egov-mdms-service.egov:8080/
  egov.indexer.service.endpoint=http://egov-indexer.egov:8080/
  egov.services.billing.service.bill.generate=billing-service/bill/v2/_fetchbill
  egov.filestore.service.endpoint=http://egov-filestore.egov:8080/

MDMS Configuration

• The following master data is present in the MDMS repository.

  • Department

  • Designation

  • BusinessServiceMapping

  • TaxHeadMasterGlCodeMapping

  • InstrumentGLcodeMapping

  • AccountCodeTemplate

  • FinanceInstrumentStatusMapping

  • tenants

  • OnlineGLCodeMapping

• Define all the departments in the Departments json

• Define all the designations in the Designations json

• Configure finance tenants in the Citymodule json to enable finance module in the ULB

{
      "module": "Finance",
      "code": "Finance",
      "tenants": [
        {
          "code": "pb.jalandhar"
        },
        {
          "code": "pb.nawanshahr"
        }
      ]
    },

• Define business services mapping in the Business Service Mapping json to integrate different business services like Property Tax, Trade License and FireNOC etc with Finance and to post vouchers like demand and receipt vouchers. Enabling and disabling voucher posting for any service can be configured here.

• Define the Tax head and instrument glcode mappings in the Account Head Mapping json. This file contains each tax head wise glcode mapping and each instrument wise glcode mappings.

• Different instrument statuses can be defined in the Instrument Status Mapping json file.

• Different types of contractor bill templates are defined in the AccountCode Template file. These templates will be used in the contractor bill creation screen to auto-populate the account codes.

• Service-wise glcode mapping for the online instrument type for the particular city is defined in the Online Instrument Type json.

• Define the business service wise bank account mappings in the BankAccount Service Mapping json file. These details to be configured city wise as the bank details are specific to a city.

...

• Add one user in the system for system integration - SIFINANCE mapped with role SYS_INTEGRATOR_FINANCE by using the user service createnovalidate API.

• Find the createnovalidate API details below

{
	"info": {
		"_postman_id": "81469f7c-793c-43b2-8e05-9ce6c8174cd4",
		"name": "SIUSER_Creation",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "createnovalidate",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n \"RequestInfo\": {\n   \"api_id\": \"1\",\n   \"ver\": \"1\",\n   \"ts\": null,\n   \"action\": \"create\",\n   \"did\": \"\",\n   \"key\": \"\",\n   \"msg_id\": \"\",\n   \"requester_id\": \"\",\n   \"auth_token\": \"12e8753e-099f-42cb-b2ec-402b10215610\"\n },\n \"User\": {\n  \"userName\": \"SIFINANCE\",\n  \"name\": \"SYS INTG FINANCE\",\n  \"gender\": \"Male\",\n  \"mobileNumber\": \"\",\n  \"active\": true,\n  \"type\": \"SYSTEM\",\n  \"password\": \"sifinance123@\",\n  \"tenantId\":\"pg.citya\",\n  \"roles\": [\n       {\n                   \"tenantId\": \"pg.citya\",\n                   \"code\": \"SYS_INTEGRATOR_FINANCE\",\n                   \"name\": \"System Integrator Finance\"\n               }\n   ]\n }\n}\n"
				},
				"url": {
					"raw": "https://egov-micro-qa.egovernments.org/user/users/_createnovalidate",
					"protocol": "https",
					"host": [
						"egov-micro-qa",
						"egovernments",
						"org"
					],
					"path": [
						"user",
						"users",
						"_createnovalidate"
					]
				},
				"description": "user create with no OTP validation"
			},
			"response": []
		}
	]
}

Elastic Dashboard Configuration

To enable or disable an event to push the bills and vouchers to the elastic search indexer the below need to be configured either in the finance service values yaml file or the environment specific yaml file.

finance: true

File store Configuration

Configure the following property either in the finance service values yaml file or the environment specific yaml file.

filestore: /tmp/egovfilestore

Quartz Scheduler Configuration

Configure the following property either in the finance service values yaml file or the environment specific yaml file.

scheduler: true

DIGIT integration configuration

Finance service reads data from multiple other DIGIT services. The following are the different services finance system reads data from. Update the domain URL of the respective service based on the service where it is running.

microservice: |
  egov.default.services.endpoint=https://egov-micro-dev.egovernments.org/
  egov.hrms.service.endpoint=http://egov-hrms.egov:8080/
  egov.accesscontrol.service.endpoint=http://egov-accesscontrol.egov:8080/
  egov.hr.masters.service.endpoint=http://hr-masters.egov:8080/
  egov.user.service.endpoint=http://egov-user.egov:8080/
  egov.common.masters.endpoint=http://egov-common-masters.egov:8080/
  egov.billing.service.endpoint=http://billing-service.egov:8080/
  egov.collection.service.endpoint=http://collection-services.egov:8080/
  egov.egf.master.service.endpoint=http://egf-master.egov:8080/
  egov.egf.instrument.service.endpoint=http://egf-instrument.egov:8080/
  egov.mdms.service.endpoint=http://egov-mdms-service.egov:8080/
  egov.indexer.service.endpoint=http://egov-indexer.egov:8080/
  egov.services.billing.service.bill.generate=billing-service/bill/v2/_fetchbill
  egov.filestore.service.endpoint=http://egov-filestore.egov:8080/

MDMS Configuration

• The following master data is present in the MDMS repository.

  • Department

  • Designation

  • BusinessServiceMapping

  • TaxHeadMasterGlCodeMapping

  • InstrumentGLcodeMapping

  • AccountCodeTemplate

  • FinanceInstrumentStatusMapping

  • tenants

  • OnlineGLCodeMapping

• Define all the departments in the Departments json

• Define all the designations in the Designations json

• Configure finance tenants in the Citymodule json to enable finance module in the ULB

{
      "module": "Finance",
      "code": "Finance",
      "tenants": [
        {
          "code": "pb.jalandhar"
        },
        {
          "code": "pb.nawanshahr"
        }
      ]
    },

• Define business services mapping in the Business Service Mapping json to integrate different business services like Property Tax, Trade License and FireNOC etc with Finance and to post vouchers like demand and receipt vouchers. Enabling and disabling voucher posting for any service can be configured here.

• Define the Tax head and instrument glcode mappings in the Account Head Mapping json. This file contains each tax head wise glcode mapping and each instrument wise glcode mappings.

• Different instrument statuses can be defined in the Instrument Status Mapping json file.

• Different types of contractor bill templates are defined in the AccountCode Template file. These templates will be used in the contractor bill creation screen to auto-populate the account codes.

• Service-wise glcode mapping for the online instrument type for the particular city is defined in the Online Instrument Type json.

• Define the business service wise bank account mappings in the BankAccount Service Mapping json file. These details to be configured city wise as the bank details are specific to a city.

MDMS serach url is configured in the Application Configuration file.

Sub domain formation logic in front end employee app

Finance coexistence follows schema per ulb structure and each city requires one sub domain. Sub domain formation for the different environments is happening dynamically by reading the environment value from the FIN_ENV environment variable in the js file.

The following code snippet shows the sub domain formation logic

locale = localStorage.getItem("locale"),
    menuUrl = this.props.location.pathname,
    loc = window.location,
    subdomainurl,
    domainurl,
    finEnv,
    hostname = loc.hostname,
    winheight = window.innerHeight - 100,
    erp_url,
    tenantId = getTenantId();
    domainurl = hostname.substring(hostname.indexOf(".") + 1);
    finEnv = this.globalConfigExists() ? window.globalConfigs.getConfig("FIN_ENV") : process.env.REACT_APP_FIN_ENV;
    subdomainurl = !!(finEnv) ? "-" + finEnv + "." + domainurl : "." + domainurl;
    erp_url = loc.protocol + "//" + getTenantId().split(".")[1] + subdomainurl + menuUrl;
    console.log("ERP URL : " + erp_url);

The FIN_ENV variable is configurable and configured in the globalConfigs.js which is present (to be created if not present) in the S3 Bucket. The following code snippet shows the same.

var globalConfigs = (function() {
  var stateTenantId = 'pb'
  var finEnv = 'dev'
  var getConfig = function(key) {
      if(key === 'STATE_LEVEL_TENANT_ID'){
          return stateTenantId;
      } else if(key === 'FIN_ENV'){
        return finEnv;
      }
  };
  return {
      getConfig
  };
}());

The following are some examples

EX 1:
Domain url : citya.digit.org
Sub domain url: citya-uat.digit.org

Then configure the FIN_ENV variable as 'uat' like below
FIN_ENV='uat'

EX 2:
Domain url : staging.digit.org  
Sub domain url: citya.digit.org

Then configure the FIN_ENV variable as 'uat' like below
FIN_ENV=''

EX 3:
Domain url : dev.digit.org 
Sub domain url: amritsar-dev.digit.org

Then configure the FIN_ENV variable as 'uat' like below
FIN_ENV='dev'

The globalConfigs.js file is custom injected in the environment specific yaml files. The following code snippet shows the same.

employee:
  custom-js-injection: |
    sub_filter.conf: "
      sub_filter  '<head>' '<head>
      <script src=https://s3.ap-south-1.amazonaws.com/egov-telemetry-data/egov-telemetry-1557467338.js type=text/javascript></script>
      <script src=https://s3.ap-south-1.amazonaws.com/egov-dev-assets/globalConfigs.js type=text/javascript></script>
      <link rel=stylesheet href=https://egov-dev-assets.s3.ap-south-1.amazonaws.com/dashboard-iframe-fix.css>
      ';"

The sample environment yaml files for your reference

https://github.com/egovernments/Train-InfraOps/blob/master/helm/environments/dev.yaml

Changes required to setup workspace in local machine

...