Overview

The Individual service is an enhanced version of the User service that houses data about individuals. The Individual service is being re-used from the Health mission.

Click here to access details on the Individual Service.

Principles

The Works platform design approach is based on the principles of interoperability, open, standards-based, real-time, inclusivity, a single source of truth, security and privacy. The principles define the framework for a scalable and reliable platform that adapts to evolving needs. Read more about the platform design principles here.

Works aim to expedite payments for public works projects undertaken by different departments. The platform registries and APIs ensure units have instant access to trusted information that improves coordination between the various departments. The seamless flow of information ensures payments are fast-tracked, projects are managed better, and departments can execute more work.

Approach

The platform design provides the capability to integrate smart payments with iFIX. The integration enables departments to track project milestones and simplify vendor payments. The multi-layer architecture design ensures transparency, visibility and fast decisions all of which translate to an accelerated pace of development. The registries and APIs ensure information flows seamlessly across channels removing the challenges of siloed data structures and facilitating interoperability.

Click on the page link below to learn more about our platform architecture.

The platform architecture illustration below provides a visual representation of the key components and layers that facilitate a seamless flow of information across multiple departments.

The high-level design (refer image above) of the Works System can be divided into three parts:

1. Master(Reference) Data

2. Works Registries(Services)

3. Reused/Enhanced DIGIT Core Services

Master (Reference) Data

Below are classifications of some of the master data used in the Works platform. For a comprehensive list, please refer to the service documentation

1. Simple Masters:

   • Organisation Class

   • Organisation Functional Area

   • Organisation Type

   • Department

   • Nature of Work

   • Wage Seeker Skills

   • Labour Charges

   • Overheads

   • Headcodes

   • Applicable Charges

   • Mode of Entrustment

   • Beneficiary Type

   • Designations

2. Hierarchical Masters

   • Type of work

   • Sub-type of work

3. Location - Same as DIGIT

Works Registries

1. Individual - stores details of individual citizens. Individuals may or may not be users of the DIGIT system. If they need login access, they will be created in the User registry.

2. Organisation - This registry holds details of all types of organisations, their functional areas and class.

3. Bank Accounts - This registry stores bank account details to be used for online payments in a safe and secure manner.

Works Services

The following domain services have been developed/are being planned as part of the Works platform:

1. Project

2. Estimate

3. Contracts

4. Attendance

5. Muster roll

6. Expense/Billing

7. JIT Adapter (Roadmap)

8. Milestones (roadmap)

9. Payment Calendar (roadmap)

10. Measurement Book (roadmap)

Reused/Enhanced DIGIT Services

The following list consists of major core services from DIGIT that will be reused in Works Project. A few of the common core services might have been missed from the list.

• As-is Reused DIGIT Services

  1. Master Data Management Service(MDMS)

  2. Location Service

  3. User Service

  4. Access Control Service

  5. Zuul API Gateway

  6. PDF Service

  7. File Store Service

  8. IdGen Service

  9. Persister

  10. Indexer

  11. Inbox Service

  12. Report Service

API Specifications

Base path: /bankaccount-service/bankaccounts/

API Contract Link

API specification is available . To view in Swagger editor, click below.

Data Model

DB Schema Diagram

Web Sequence Diagrams

TBD

Persister

Indexer

No indexer has been configured for this service.

The Works platform hosts the below registries:

• - contains a detailed description of a citizen/individual who may/may not interact directly with the DIGIT platform but is a beneficiary.

• - contains the organisation details.

• - contains tenant/organisation bank account details.

API Specification

Base Path: /org-services/organisation

Raw API spec resides here. To view in the Swagger editor, click below:

DB Schema

Sequence Diagrams

To be added.

API Specifications

Base Path:

/attendance/

API Contract Link

Data Model

DB Schema Diagram

Web Sequence Diagram

Attendance Register

Staff

Attendee

Attendance Log

Click to learn more about this service.

Overview

The muster roll service aggregates attendance logs from the attendance service based on some rules and presents an attendance aggregate for a time period (week or month) per individual. This can then be used to compute payments or other semantics.

Dependencies

DIGIT backbone services

Idgen

Persister

Indexer

Workflow

User

Attendance

Code

API Specifications

Path:

/muster-roll

API Contract Link

Data Model

DB Schema Diagram

Web Sequence Diagrams

Master Data

Overview

Estimate Service will allow users to create estimates and forward them for approval to higher authorities across departments for technical, financial, and admin sanctions. For more technical information on this service, please refer to the and the folder.

Dependencies

• Project

• MDMS

• Workflow

• Notification

• Access Control

• User

• IDGen

API Specifications

Base Path: /estimates/

API Contract Link

DB Schema Diagram

Estimate Flow Diagram

The diagram below shows the interaction between the estimate service and the persister, indexer. This does not follow the default pattern. Instead, enrichment of the payload for the indexer happens via a separate consumer and then the enriched payload is pushed to a topic. The indexer listens to this topic and sends it to ElasticSearch.

Web Sequence Diagrams

Estimate Inbox

Estimate PDF

The proposed sequence diagram is below.

Postman Collections

TBD

Overview

API Specifications

Base path:

/contracts

API Contract Link

API spec YAML is . Click below to view it in Swagger Editor.

Data Model

DB Schema Diagram

Web Sequence Diagrams

API Specifications

Base path: /expense/bill/

API Contract Link

API specification is available . To view it in the Swagger editor, click below.

Data Model

DB Schema Diagram

Web Sequence Diagrams

TBD

Persister

Indexer

Index Name: expense-bill-index