Overview

The expense calculator is an implementation specific services that works in tandem with the expense service. This service holds all the specific business logic in computing expenses and calls the billing service with the correct payload to create a bill.

There are three types of bills in Mukta:

• Wage bill - auto-generated from an approved muster roll and to be paid to wage seekers on completion of work

• Purchase bill - submitted by a JE or ME on behalf of the vendor

• Supervision bill - computed on top of wage and purchase bills to be paid to the CBO (community based organisation).

The calculator performs the calculation for all three types of bills and creates a bill.

Dependency

• DIGIT backbone services

• Persister

• MDMS

• IDgen

• Expense

Key Functionalities

• Listens for muster roll approval on a Kafka topic and creates a wage bill based on the muster roll.

• Calculates supervision bill (if required) on any bills that have not been included so far and submits it to expense service

• Allows update of purchase bill.

• Search of meta information related to bills

Code

Expense calculator

Deployment

Helm charts

Master Data

HeadCodes

ApplicableCharges

LabourCharges

BusinessService

PayerList

Integration

API spec

Postman collection

Overview

This release note covers the functionality of the first version of MuktaSoft known as V1.0. MUKTA is a flagship scheme of the Odisha government designed to provide employment opportunities to the urban poor. It has basically 2 types of users, ULB employees and community-based organizations.

Release Highlights

New Features/Enhancements

It is a fresh development and getting released for the first time.

Bug Fixes

It is a fresh development and getting released for the first time.

Known Issues

1. Issues reported during the Bug Bash.

2. Observations recorded during product showcase.

Critical issues to be fixed before Go Live.

https://digit-discuss.atlassian.net/browse/PFM-3234 https://digit-discuss.atlassian.net/browse/PFM-3118 https://digit-discuss.atlassian.net/browse/PFM-3113 https://digit-discuss.atlassian.net/browse/PFM-3115 https://digit-discuss.atlassian.net/browse/PFM-3108 https://digit-discuss.atlassian.net/browse/PFM-3335 https://digit-discuss.atlassian.net/browse/PFM-3336 https://digit-discuss.atlassian.net/browse/PFM-3337

Upcoming Release Features

Closure Request

Revised Work Order (Time Extension)

JIT-FS Integration

Aadhar Integration

Dashboard

Fund Allocation Register

Related Docs & Links

Overview

Works-PDF is a service that can work between pdf-service and client requests. In works-pdf, there have multiple APIs to generate multiple PDFs. The service fetches data from multiple services, combines them, and sends the request to the PDF service to generate PDF.

It also has the functionality to generate an Excel file when payment is initiated. It listens to expense-payment-create topic and payment data.

Dependency

• MDMS

• PDF

• Project

• Estimates

• Muster Roll

• Contract

• Organization

• Localization

• Expense

• Expense calculator

• Bankaccount

• Filestore

Key Functionality

• It fetches data from multiple Create multiple PDFs like estimate, muster, project, etc.

• When a payment is created it generates excel files based on the payment bills, because listening to payment create topic.

• User can regenerate the payment excel using the same payment id.

Code

Deployment

• • Add all pdf configurations under pdf-service data config and format config

  • Add file type 'application/zip' under xlsx format in egov-filestore allowed-file-formats-map.

PDF Configs

Roll Action

Account creation for deductions

Create accounts for purchase and wage bills, for head codes where category is deduction.

E.g. this is the head code object

And tenantId is pg.citya

The format of referenceId is Deduction_{tanentId}_{headcode}

Then create a bank account with the field referenceId value Deduction_pg.citya_LC

Objective

This section is designed with the objective of helping implementation parties and end-users collect the required master data through minimal interaction and iterations and ensure the quality, consistency and shape of data needed to configure the system.

Audience

This page is intended to help stakeholders as given below on data gathering activities.

1. State Team

2. eGov Onsite Team/ Implementation Team

3. ULB Team (Nodal and DEO)

4. Implementation Partners

Output Artefacts

The artefacts of this document are the data template of a configurable entity, a page with content defining the entity template and helping on how to fill the template with required data.

Data Entry

1. Download the data template attached to this page.

2. Find the meaning of the different headers in the Data Definition section on this page

3. Make sure all the headers, data type, field size and definition/ description are clear. In case of any doubt, please reach out to the person who has shared this document with you to discuss the same and clear out the doubts.

4. Identify the different types of user roles on the basis of ULB functions.

5. Start filling the data starting from serial no. and complete a record at once. Repeat this exercise until the entire data is filled into a template.

6. Verify the data once again by going through the checklist and taking care of each and every point mentioned in the checklist.

Checklist

The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

This checklist covers the activities which are specific to the entity.

On this page:

• Test plan

• UI test cases

• Download test cases

Test Plan

UI Test Cases

Download Test Cases

Click here to download our test cases.

Overview

Integration with Odisha IFMS is via the Just-in-Time (JIT) APIs provided by the Odisha treasury.

Components

Sequence Diagram

Success Flow

API specifications

Overview

This document provides details about the module, flow, and different APIs that are used on individual screens.

WORKS UI Design (MUKTA)

Mukta Release Notes

Service Builds

Please refer to this used.

Deployment Helm Charts

Helm charts for all Mukta services are . To override the environment variables, please create a Helm environment chart for your DIGIT environment and customize the values.

Configure MDMS Configs Steps

1. Create Common Masters

a. Create IdFormat.json which will be used by service.

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

1. Create tenants by .

2. Create sample . Refer for to this for more details

3. Create configs for

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.

Deploy Digit Core Services

Deploy DIGIT Works Services

Deploy MuktaSoft services

Steps to configure Mukta configs

Note: Any changes to indexer and persister configs, requires restart of indexer and persister.

User Creation

Localisation upsert

Mukta MDMS Configuration:

MDMS configuration is listed for each service.

Overview

MUKTA UI is a customization of the basic Works module screens. The way the UI flows work is specific to the program/solution and this can vary. The below diagram shows how MUKTA UI relates back to the Works platform.

The Miro board below offers an understanding of the UI call flows in MUKTA.

Overview

This bill scheduler is a cronjob scheduler for calculating the supervision bill. It runs based on environment configuration. It triggers multiple APIs to generate the supervision bill.

Dependency

• MDMS

• User

• Contract

• Expense Calculator

Key Functionalities

• It creates supervision bills based on ACTIVE contracts using expense-calculate service /v1/_calculate API.

Code

Configuration

• Create a role in ACCESSCONTROL-ROLES/roles.json MDMS like .

• Create a SYSTEM user with BILL_CREATOR and SYSTEM roles. Find the curl below.

• The same username will be used to generate bills BILL_GEN_CRONJOB, it’s defined in the environment config.

• Cron job duration will be configured using environment variables from .

Deployment

Update schedular

You can update the configuration of scheduler in two ways

1. Add the config in the DevOps environment file, and restart the service it will trigger the scheduler based on the updated environment configuration, and restart the expense-cronjob service.

1. Using commands Change schedule - kubectl patch cronjobs expense-cronjob -p '{"spec" : {"schedule": "*/10 * * * *" }}'

   Pause cron job -

   kubectl patch cronjobs expense-cronjob -p '{"spec" : {"suspend" : true }}' Resume cron job -

   kubectl patch cronjobs expense-cronjob -p '{"spec" : {"suspend" : false}}' Create new cronjob scheduler - kubectl create job --from=cronjob/expense-cronjob expense-cronjob

Introduction

Target demography are the areas which are on prime focus of Government for the employment and improvement.

Data Table

Data Definition

Attachments

MDMS Changes

Config Changes

Infra Changes

Introduction

Overheads are the items other than SOR and Non-SOR which are included in the estimate to complete the estimation and arrive the final value of work.

Data Table

Data Definition

Attachments

Introduction

MUKTA is known as a scheme and it is configured in the system along with its HOAs.

Data Table

Data Definition

Attachments

Introduction

Project types are the category of works which are included and executed under the scheme MUKTA.

Data Table

Data Definition

Attachments

Introduction

In MUKA community-based organizations have different roles to play based on the work value. The role defined is Implementation Agengency and Implementation Partner.

Data Table

Data Definition

Attachments

Introduction

The Community Based Organization are further categories and refered as sub type.

Data Table

Data Definition

Attachments

Introduction

These are deductions which are made from the purchase bills and then remitted to respective departments.

Data Table

Data Definition

Attachments

Introduction

Unit of measurements is the units used to capture the measurement and create the estimate for work in MUKTA.

Data Table

Data Definition

Attachments

Introduction

These are name of sections/ departments within the ULBs which set the functional scope of employees belong to these sections.

Data Table

Data Definition

Attachments

Introduction

The Community Based Organization and Vendors are created as 2 different type of organization.

Data Table

Data Definition

Attachments

Overview

This page provides details about the MuktaSoft UI configuration required to enable it in any environment.

DevOps Configuration

In the DevOps repository of your organization, locate the following "deploy-as-code/helm/environments/works-dev.yaml". Inside the environment YAML file used to deploy the Works platform, please add the following block of code:

works-ui:
  custom-js-injection: |
    sub_filter.conf: "
      sub_filter  '<head>' '<head>
      <script src={{INSERT_YOUR_AWS_BUCKET_NAME}}/globalConfigsWorks.js type=text/javascript></script>';"

A dev environment sample file is linked here. Note that you will have to modify this for your deployment.

GlobalConfig

This section contains a config that is applicable globally to all UI modules. These need to be configured prior to service specific UI configurations.

Steps to create a globalconfig.js file:

1. Create a config file(globalconfigs.js) with below mentioned config (see code below).

2. Configure all the images/logo required in the S3 and add links as footerBWLogoURL , footerLogoURL

3. Mention the state tenant ID as stateTenantId

4. If any User roles have to be made invalid add as invalidEmployeeRoles

5. Then push this global config file into your S3 bucket as globalconfigs.js

6. Mention the globalconfig file URL into your Environment config

var globalConfigs = (function () {
  var stateTenantId = 'pg' // statetenantId
   var gmaps_api_key = '<<INSERT_GMAP_GENERATED_TOKEN>>';
   var contextPath = 'works-ui'; 
   var configModuleName = 'commonMuktaUiConfig'; 
   var centralInstanceEnabled = false;
   var footerBWLogoURL = '{{INSERT_YOUR_AWS_BUCKET_NAME}}/digit-footer-bw.png';
   var footerLogoURL = '{{INSERT_YOUR_AWS_BUCKET_NAME}}/digit-footer.png';
   var digitHomeURL = 'https://www.digit.org/';
   var xstateWebchatServices = 'wss://dev.digit.org/xstate-webchat/';
   var assetS3Bucket = '{{INSERT_YOUR_AWS_BUCKET_NAME}}';
   var invalidEmployeeRoles = ["CBO_ADMIN","STADMIN","ORG_ADMIN","ORG_STAFF","SYSTEM"] 

 
   var getConfig = function (key) {
     if (key === 'STATE_LEVEL_TENANT_ID') {
       return stateTenantId;
     }
     else if (key === 'GMAPS_API_KEY') {
       return gmaps_api_key;
     }
     else if (key === 'ENABLE_SINGLEINSTANCE') {
       return centralInstanceEnabled;
     } else if (key === 'DIGIT_FOOTER_BW') {
       return footerBWLogoURL;
     } else if (key === 'DIGIT_FOOTER') {
       return footerLogoURL;
     } else if (key === 'DIGIT_HOME_URL') {
       return digitHomeURL;
     } else if (key === 'xstate-webchat-services') {
       return xstateWebchatServices;
     } else if (key === 'S3BUCKET') {
       return assetS3Bucket;
     } else if (key === 'CONTEXT_PATH'){
	return contextPath;
     } else if (key === 'UICONFIG_MODULENAME'){
	return configModuleName;
     } else if (key === 'INVALIDROLES'){
	return invalidEmployeeRoles;
     }
   };
 
 
   return {
     getConfig
   };
 }());

MDMS configs

All the UI Screen configurations required for MUKTA are present in this folder commonMuktaUiConfig. For other MDMS configurations, please check here.

Roles Configuration

Please refer to the table in this document for screen-specific role configuration. Note that some of this will overlap with configurations done for the backend service modules. If already present in MDMS, please ignore it.

Localization Configs

All strings localized per module are provided in this sheet linked here. To translate the UI into other languages, please follow this sheet and provide appropriate translations in your language.

Reference Links

1. Figma screens for the UI are here. Please refer to them to understand the MUKTA UI.