Setting Up Finance Service
Last updated
Was this helpful?
Last updated
Was this helpful?
This document describes the steps to be followed to set up a new instance of Finance. When a new state or city is to be set up, there are some activities to be executed in a defined order. Setting up an instance of an application server and configuration changes etc are a few of the key activities.
Prior Knowledge of Java/J2EE.
Prior Knowledge of Spring and Hibernate
Prior knowledge of Maven
Prior knowledge of Git.
Maven v3.2.x
PostgreSQL v9.6
Git 2.8.3
JDK 8 update 112 or higher
Create subdomains under the main domain for each of the cities that are to be set up
Create a schema per city in the database
Any configurations and data specific to the client should be added in the client repository.
Any specific configuration change is required for any specific environment then update the environment named yaml file.
Sample environment named yaml files for your reference1 2 https://github.com/egovernments/Train-InfraOps/blob/master/helm/environments/qa.yaml https://github.com/egovernments/Train-InfraOps/blob/master/helm/environments/uat.yaml
Update the db username and password, which are configured in the environment named secrets yaml file.
For example, for the qa environment, update the qa-secrets.yaml.1 2 3 4 secrets: db: username: <username value> password: <password value>
Finance co-existence service uses schema-based multi-tenancy, this means there will be one schema present for a city. The following are the configuration changes to set up this kind of database.
Enable multi-tenancy by enabling the following property
1 multitenancy: true
Each ULB is enabled by adding a schema name and domain name. Schema names should follow a naming standard, It should be the same as that of the city name.
Each ULB can be configured by adding an entry like tenant.<domain_name>=schema_name (city_name)
1 2 3 tenants: | tenant.citya.egovernments.org=citya tenant.cityb.egovernments.org=cityb
To override and have separate tenants for a specific environment then update the environment-specific file like below.
1 2 3 FinanceTenants: | tenant.citya.egovernments.org=citya tenant.cityb.egovernments.org=cityb
Here citya.egovernments.org, cityb.egovernments.org are the domains and citya, cityb are the schemas/tenants.
Update the domainurl in the eg_city table.
Domain URL value should be the same as configured tenant domain_name Ex:1 2 For citya, domain url should be citya.egovernments.org For cityb, domain url should be cityb.egovernments.org
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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 { "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": [] } ] }
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.1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 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/
Department
Designation
BusinessServiceMapping
TaxHeadMasterGlCodeMapping
InstrumentGLcodeMapping
AccountCodeTemplate
FinanceInstrumentStatusMapping
tenants
OnlineGLCodeMapping
1 2 3 4 5 6 7 8 9 10 11 12 { "module": "Finance", "code": "Finance", "tenants": [ { "code": "pb.jalandhar" }, { "code": "pb.nawanshahr" } ] },
After set up is done, make the changes to the host file in the local machine, by mapping the domain URLs with a local IP address and save the changes. Restart your local machine to make the host mapping effective.
1 2 3 $ vim /etc/hosts 127.0.0.1 egov-micro-dev.egovernments.org
References
Title
Link
API Contracts
Co-existence finance code available
Sample client implementation repository
Configuring MDMS
Adding new service and CI/CD
The is the base repository for the finance product and the client-specific data needs to be defined in the
Fork and create a client implementation repository from to keep client-specific data and configurations.
The default application configurations of the finance service are present in the file. To enable or disable any feature, either update the values in the file or the file.
The is the template and the values for the template are present either in the yaml file or in the environment named yaml file. The yaml is the common file to override the default values and the changes made to this file are applicable for all environments (dev, qa, uat, prod etc).
Add or update the db url in the file using the below property.1 erp-db-url: "jdbc:postgresql://egov-dev-db.ctm6jbmr5mnj.ap-south-1.rds.amazonaws.com:5432/finance_qa_db"
The default tenants are configured in the file using the below configuration.
Example file for your reference.
The default database migration configurations are present in the file.1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 #Enable/Disable flyway migration db.migration.enabled=true #Enable/Disable flyway migration validation db.flyway.validateon.migrate=false #Enable/Disable repairing of flyway migration checksum db.flyway.migration.repair=false #Various flyway migration sql script file paths db.flyway.main.migration.file.path=classpath:/db/migration/main/ db.flyway.sample.migration.file.path=classpath:/db/migration/sample/ db.flyway.tenant.migration.file.path=classpath:/db/migration/%s/ db.flyway.statewide.migration.file.path=classpath:/db/migration/statewide/ #Enable/Disable to run migration sql's inside "statewide" migration folder (resources/db/migration/statewide) statewide.migration.required=false #Schema name where statewide migration to be executed, value must be your default schema name (see default.schema.name) statewide.schema.name=generic #Enable/Disable dev mode, this must be set to false in all non dev environments dev.mode=false
Override the default values by updating the properties either in the yaml file or the environment specific yaml file. The following are different properties.1 2 3 4 5 6 7 8 # Enable/Disable to execute the sample sql scripts. dev_mode: false # Enable/Disable flyway migration validation db_flyway: true #Enable/Disable to run migration sql's inside "statewide" migration folder (resources/db/migration/statewide) statewide_migration: true #Enable or Disable Multitenancy multitenancy: true
Configure the following property either in the yaml file or the environment-specific yaml file.1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 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
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 yaml file or the environment-specific yaml file.1 finance: true
Configure the following property either in the yaml file or the environment-specific yaml file.1 filestore: /tmp/egovfilestore
Configure the following property either in the yaml file or the environment-specific yaml file.1 scheduler: true
The following master data is present in the .
Define all the departments in the json
Define all the designations in the json
Configure finance tenants in the json to enable finance module in the ULB
Define business services mapping in the 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 json. This file contains each tax head wise glcode mapping and each instrument wise glcode mappings.
Different instrument statuses can be defined in the json file.
Different types of contractor bill templates are defined in the 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 json.
Define the business service wise bank account mappings in the 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 file.
Setup Finance service workspace by following the instructions provided in .