DIGIT Works
Public FinanceSanitationUrbanHealth
Works v0.1
Works v0.1
  • Introducing DIGIT Works Platform
  • Platform
    • Release Notes
      • Service Build Updates
      • MDMS & Configuration Updates
      • Test cases
    • Platform Capabilities
    • Architecture
      • High Level Design
      • Low Level Design
        • Registries
          • Individual
          • Bank Account
          • Organisation
        • Services
          • Project
          • Estimates
          • Contracts
          • Attendance
          • Muster Roll
          • Expense
    • Functional Specifications
      • Project
      • Estimates
      • Organisation
      • Attendance Management
      • Muster Roll
      • Expenditure / Billing
      • Contracts
    • Platform Services
      • Project
      • Estimates
      • Contracts
      • Attendance
      • Muster Roll
      • Expense
      • Bank Account
      • Organisation
    • Source Code
    • Roadmap
    • Installation
    • Configuration
      • Service Configuration
        • Project
        • Estimate
        • Contract
        • Attendance
        • Muster Roll
        • Expense
        • Bank accounts
        • Organisation
        • Individual
  • Products
    • Works App
      • UX Design
      • Technical Design
      • Field App User Manual
      • Configuration Manual
      • Technical Manual
  • Programmes
    • MuktaSoft (v1.0)
      • Specifications
        • User Persona
        • Functional Requirements
          • Product Requirements Document
          • User Stories
            • User Creation & Role Mapping
            • Employee Login
            • Employee Home Page
            • Project User Stories
              • Create Project
              • Search Project
              • View Project Details
              • Modify Project Details
            • Estimate User Stories
              • Create Estimate
              • Estimate Workflow (Role Action Mapping)
              • Estimate Inbox
              • Estimate Create/Submit Workflow
              • Estimate Edit/Submit Workflow
              • Estimate Verify & Forward Workflow
              • Estimate Reject Workflow
              • Estimate Send Back Workflow
              • Estimate Send Back To Originator Workflow
              • Estimate Technical Sanction
              • Estimate Approve Workflow
              • Search Estimate
              • View Estimate
            • Contracts User Stories
              • Create Work Order
              • Work Order Workflow
              • Work Order Inbox Page
              • Create/ Submit Work Order
              • Edit/Submit Work Order
              • Verify & Forward
              • Send Back
              • Send Back To Originator
              • Reject Work Order
              • Approve
              • Work Order PDF
              • Search Work Order
              • View Work Order
            • Muster Roll User Stories
              • Inbox Page
              • Muster Roll Workflow
              • Muster Rolls - Verify & Forward
              • Muster Roll - Send Back
              • Muster Rolls - Send Back To CBO
              • Muster Roll - Edit/Submit
              • Muster Roll - Approve
              • Search Muster Roll
              • View Muster Roll
            • Bill User Stories
              • Create Purchase Bill
              • Create Wage Bill
              • Create Supervision Bill
              • Bill Workflow
              • Bill Inbox
              • Edit Purchase Bills
              • Verify & Forward
        • Roadmap
      • Deployment
        • Release Notes
          • Service Build Updates
          • MDMS & Configuration Updates
          • Gate 2 Release Checklist
          • Test Cases
        • MuktaSoft Services
          • IFMS Adapter
          • Expense Calculator
          • Works PDF
          • Works UI
            • UI Tech Flow Diagrams
          • Bill Scheduler
        • Deployment Guide
        • Configuration
          • Master Data Templates
            • Project Type
            • Target Demography
            • Unit Of Measurement (Units)
            • Overheads
            • Skill Category & Skills
            • Community-Based Organisation Roles
            • Scheme
            • Expense Heads
            • Standard Deductions
            • Organisation Type
            • Organisation Sub Type
            • Organisation Functional Category
            • Organisation Class/Rank
            • HRMS Sections/Departments
            • HRMS Designation
            • HRMS Employment Type
            • User Role
            • Organization
            • Wage Seeker
            • Tenants
            • Ward Boundary
            • Locality Boundary
            • Payment Advice Format
            • Users Data
          • Notifications & SMS Templates
          • Localisation
          • Service Configuration
          • UI Configuration
            • Common Configurations
              • Role Configuration
              • MDMS Configuration
              • APK Generation
            • Modules
              • Project
              • Estimate
              • Workorder
              • Muster Roll
              • Bill
              • Organization
              • WageSeeker
              • WageSeeker (CBO Application)
              • Attendance (CBO Application)
              • MusterRoll (CBO Application)
            • Drafts
              • Contracts
                • Create Contract
                • Contract Workflow
                • Modify Contract
              • Estimate
                • Create Estimate
                • Estimate Worflow
                • Modify Estimate
              • Attendance Management
                • Inbox
                • View Attendance
                • Modify Attendance
        • Customisation
          • UI Screens Customisation
            • Document Upload Container
            • CSS Customisation
            • Inbox/Search Screen
      • Implementation
        • Programme Details
          • Pilot Roll Out Plan
          • Pilot Go Live Definition
          • Pilot Sucess Metrics
          • Adoption Metrics
          • Implementation Plan
          • Implementation Checklist
          • Issue Management - Standard Operating Procedures
          • UAT Test Planning
            • Test Case Scenarios
            • UAT Test Case Scenarios
            • Issue Reporting Template
        • Training Resources
          • User Manual
            • Getting Started
            • CBO User Manual
              • CBO - Getting Started
              • My Works
              • Track Attendance
              • Muster Rolls
              • My Bills
            • Employee User Manual
              • Project
              • Estimate
                • Technical Sanctioner
              • Work Order
              • Workflow
              • Billing
              • Payment
              • Registries
              • Organizations
  • COMMUNITY
    • Discussion Board
    • Issues
Powered by GitBook

​​  ​All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page
  • Overview
  • Configuration Details
  • MDMS Configuration
  • roleactions.json
  • Persister Configuration
  • Indexer Configuration
  • Other Master Data Configuration
  • Deployment Details
  • Integration Details

Was this helpful?

Export as PDF
  1. Platform
  2. Configuration
  3. Service Configuration

Project

Steps to configure the project service

PreviousService ConfigurationNextEstimate

Last updated 2 years ago

Was this helpful?

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. This service is shared across multiple eGov missions. The source code for this service resides . For a deeper understanding, please refer to the following:

Configuration Details

MDMS Configuration

roles.json

 {
      "code": "PROJECT_CREATOR",
      "name": "PROJECT CREATOR",
      "description": "Project Creator"
    },
    {
      "code": "PROJECT_VIEWER",
      "name": "PROJECT VIEWER",
      "description": "Project Viewer"
    },

Define (if not present already) and assign the EMPLOYEE_COMMON role to all project actors.

actions.json

Below are the actions or APIs exposed by the Project service used by the Works platform. Note that the "id" in the attributes needs to be unique and may be different in the implementation environment. It need not be exactly the same as what is shown below.

{
      "id": 51,
      "name": "Create Project",
      "url": "/pms/project/v1/_create",
      "parentModule": "project-management-system",
      "displayName": "Create Project",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "project-management-system",
      "code": "null",
      "path": ""
    },
    {
      "id": 52,
      "name": "Search Project",
      "url": "/pms/project/v1/_search",
      "parentModule": "project-management-system",
      "displayName": "Search Project",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "project-management-system",
      "code": "null",
      "path": ""
    },
    {
      "id": 53,
      "name": "Update Project",
      "url": "/pms/project/v1/_update",
      "parentModule": "project-management-system",
      "displayName": "Update Project",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "project-management-system",
      "code": "null",
      "path": ""
    },

roleactions.json

The following table shows the mapping between the APIs and the roles:

Role Code
Description
API

PROJECT_CREATOR

Project Creator

/project/v1/_create

/project/v1/_update

/project/v1/_search

PROJECT_VIEWER

Project Viewer

/project/v1/_search

EMPLOYEE_COMMON

Employee Common

/inbox/v2/_search

The following role-action mappings derived from the above table are configured for the Project service in the roleactions.json in MDMS. A sample is provided below. Make sure the action ID is correct and corresponds to actions.json.

{
      "id": 51,
      "name": "Create Project",
      "url": "/project/v1/_create",
      "parentModule": "project-management-system",
      "displayName": "Create Project",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "project-management-system",
      "code": "null",
      "path": ""
    },
    {
      "id": 52,
      "name": "Search Project",
      "url": "/project/v1/_search",
      "parentModule": "project-management-system",
      "displayName": "Search Project",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "project-management-system",
      "code": "null",
      "path": ""
    },
    {
      "id": 53,
      "name": "Update Project",
      "url": "/project/v1/_update",
      "parentModule": "project-management-system",
      "displayName": "Update Project",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "project-management-system",
      "code": "null",
      "path": ""
    },

IdGen Format

{
    "format": "PJ/[fy:yyyy-yy]/[cy:MM]/[SEQ_PROJECT_NUM]",
    "idname": "project.number"
}

Persister Configuration

Indexer Configuration

Other Master Data Configuration

Deployment Details

The image name of the service is available in the release charts in the DevOps repository. The service can be deployed using Helm commands.

Environment variables to be configured in the Helm chart for the service are:

  • Add the ‘db-host’,’db-name’,’db-url’,’domain’ and all the digit core platform services configurations (Idgen, workflow, user etc.) in respective environments yaml file.

NOTE: Restart egov-mdms-service, egov-accesscontrol, egov-persister, audit-service, egov-indexer and zuul after the above changes are performed.

Integration Details

Add Id Format as configured in the ‘IdFormat.json’ file of the ‘common-masters’ module . This format is used to generate the unique ID of the project.

Add persister file as defined .

Add indexer file as defined .

1.

2.

3.

4.

Add project-management-system related environment variables values. A sample from a’ environment yaml file is provided below:

Add the ‘’ related configuration to the respective environment yaml file. Make sure you change the git-sync branch name to one that is appropriate for the environment.

Check the project management system persister file is added in the egov-persister.persister-yml-path variable. If not, please add the way it's done .

Check the project management system indexer file is added in the egov-indexer.egov-indexer-yaml-repo-path variable. If not, please add the way it's done .

Check the project management system persister file is added in the audit-service.persist-yml-path variable. If not, please add the way it's done .

Make sure to add the DB(Postgres and flyway) username & password in the respective environment secrets yaml file the way it's done.

Make sure to add the DIGIT core service-related secrets that are configured in the respective environment secret file the way it's done.

Refer to the for a description of the APIs. The associated are provided here for reference. Use these to understand the request payloads.

here
Low-level design
Functional specifications
here
project-management-system-persister.yml
here
projectmanagementsystem-indexer.yml
here
ProjectType
Department
Boundary Data
Nature of Work
‘dev
https://github.com/egovernments/DIGIT-DevOps/blob/digit-works/deploy-as-code/helm/environments/works-dev.yaml#L80
https://github.com/egovernments/DIGIT-DevOps/blob/digit-works/deploy-as-code/helm/environments/works-dev.yaml#L223-L230
https://github.com/egovernments/DIGIT-DevOps/tree/digit-works/deploy-as-code/helm/charts/digit-works/backend/project-management-system
egov-mdms-service
here
here
here
here
here
API spec
Postman scripts