Overview

The contract service captures work orders or purchase orders. It validates the work order against the estimate(s). Line items from one estimate can be put in a contract. Line items from multiple estimates can be aggregated into one work order as well. The contract service validates the line items from each estimate as part of create and update.

Dependencies

• Estimate service

• IDGen

• MDMS

• Workflow

• User

• HRMS

• Organisation

Key Functionalities

• Models a real world work order/contract

• All line items of a single estimate can be put in a contract.

• Line items from multiple estimates can also be grouped into a contract.

• The service validates the estimate line items and ensures no duplication happens in including estimate line items in a contract.

• Terms and conditions, milestones and payment calendar are WIP

Code:

Contracts

Deployment:

Contract Helm charts

Master Data Types

Contract Type - defines different contract types

OIC Roles - defines Officer-in-charge roles

CBO Roles - defines the capacities in which an organisation can accept the contract.

Integration

Base path:

/contracts

API specification

Contracts postman collection

Overview

The expense module implements the functionality of bills and payments. A bill or a group of bills can be aggregated together as payments. Payments advice can be submitted through integration with IFMS (Integrated Financial Management Systems) or any other third party payments provider. The expense module always works in combination with a calculator service. The calculator service is implementation specific and provides business logic to compute bills. The calculator calls into the expense service to create bills. In general, the expense create/update APIs are not called by any other module other than the calculator. For more information on the sample calculator provided with the Works platform, please navigate here.

Dependencies

• DIGIT backbone services

• Persister

• Indexer

• IDGen

• MDMS

• Workflow

• Notification

Key Functionality

• Create/update/search functionality for bills

• Ability to create different bill types according to configuration.

• Workflow is integrated and needs to be configured for usage.

• Works with an expense calculator that contains the business logic to compute bills.

Code

Expense Module

Deployment

Helm Chart

Master Data

HeadCodes

Integration

API spec

Postman TBD

Overview

Estimate Service allows users to create estimates and forward them for Workflow approval to higher authorities across departments for technical, financial, and admin sanctions. A prepared estimate can then be tendered out for contracting.

Dependencies

• Project

• MDMS

• Workflow

• Notification

• Access Control

• User

• IDGen

Key Functionality

• Create/update/search for Work estimates for a project.

• Allows upload of offline documents related to estimate creation as part of create.

• Workflow and inbox integration

Code

Deployment

Master Data

Integration

Base Path: /estimates/

Overview

The bank accounts registry houses financial account details of individual and organisational entities. The registry stores the account name, type, bank branch identifier (IFSC code) and other optional information. The bank branch identifier can be configured as master data. This makes it easy to extend this registry for use in countries outside India. The registry encrypts all PII and stores it in a secure fashion.

Dependencies

• DIGIT backbone services

• Persister

• Encryption

Key Functionality

• Stores bank account details of entities in a secure fashion.

• All PII data is encrypted securely.

Code

Deployment

for deployment

Master Data

BankBranchIdentifier

Integration

Base path: /bankaccount-service/bankaccount

Overview

This is being designed as a cross-functional registry that will house vendors, suppliers, contractors, non-profits, SHGs etc.. Can be used across domains.

Dependencies

• DIGIT backbone services

• Persister

• Indexer

• IDGen

• Individual

Key Functionality

• Provides create/update/search operations for organisation entities.

• Captures organisation details, contact details and classifications.

• Links organisations to functional areas they are operational in.

Code

Deployment

Master Data

OrgType - Defines types of organisations

OrgFunctionCategory - The functional area where an organisation works

OrgFunctionClass - The class (rating) of an organisation in a specific functional area.

OrgTaxIdentifier - The list of tax identifiers that can be entered.

OrgTransferCode - The bank account transfer code (IFSC etc..). This is usually only one defined in the master data. Can be customised for other countries.

Integration

Overview

The attendance module allows creation of an attendance register, enrolment of staff and attendees and capture of attendance records with entry/exit times. To compute attendance based on the logs, a calculator service should be built with specific business logic.

Dependencies

• DIGIT backbone services

• IDGen

• Persister

Key Functionalities

• Allows creation/updation/search of an attendance register

• Allows mapping of staff and attendees to a register and enforces permissions.

• Logs entry and exit timestamps in epoch time for a referenced entity

Code

Module code

Deployment

Helm Charts

Integration

Base Path:

/attendance/

API spec

Attendance Postman collection

Overview

The project service provides APIs to create, update and manage a generic project. A project can have one or more of the following constructs: staff, tasks, beneficiaries and facilities. Currently, this service is shared across the Health and Works platforms. All Works projects start with a project construct. The Works platform uses only 3 primary APIs: project create, update and search. For low-level design and other information on this service, click .

Key Functionalities

• Creating, updating, and searching for a project

• Adding staff, tasks, resources and facilities to a project

Code

Module code

Deployment in Works

Integration

API Spec

Base path: /project/

Documentation for this service is available here.

Postman Collection

Click here to access the Postman collection used to test APIs. Import the link into Postman and follow the instructions to run the collection.

Master Data Types

The following primary masters are defined by this module and used for validations. Other common masters such as department, tenant etc..are also used by this module.

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

Integration

Base path: /muster-roll

Steps to run the postman collection:

3. MusterRoll requires the below services from Attendance Service API to be run prior to creating muster. So run the below services before running the musterRoll postman collection.

4. Update the current value of the variable ‘registerId’ in the ‘Muster Environment’ with the id returned by the response of the create attendance register ( in step 3 a)

5. Run the ‘Muster Roll Service’ postman collection as ‘Run Collection’ . It will run the /_estimate, /_create, /_update and /_search APIs success and validation error scenarios.

6. Muster will be created for the attendees enrolled in the attendance register (in step 3 b) using the attendance logs created (in step 3 c).

The current value of environment variables ‘musterRollId’ and ‘musterRollNumber’ will be set from the response of the /_create muster roll which will be used by /_update and /_search APIs.