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
  • MDMS Configurations
  • Module Enablement Configuration
  • PDF Configuration
  • Role-action Mapping
  • Sidebar Configuration
  • Sample Configuration
  • Screen Configuration
  • Localisation Configuration & Modules
  • Workflow Configuration
  • Customisation

Was this helpful?

Export as PDF
  1. Programmes
  2. MuktaSoft (v1.0)
  3. Deployment
  4. Configuration
  5. UI Configuration
  6. Modules

Project

Project module frontend tech documentation

Overview

The Project module enables the Junior Engineer to capture the details of the project, search, view and modify the existing projects. This module is the initial step in starting the work.

The module has 4 associated screens :

  1. Create

  2. Search

  3. Modify

  4. View

MDMS Configurations

S.No.
Data
MDMS Link

1

Project Type

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/works/ProjectType.json

2

Target Demography

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/works/TargetDemography.json

3

ULB, City, Locality

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/citya/egov-location/boundary-data.json

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/cityb/egov-location/boundary-data.json

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/cityc/egov-location/boundary-data.json

4

Document Config

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/works/DocumentConfig.json

Module Enablement Configuration

Set module code as “Project” in Module.js of Project Module. Refer https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/tenant/citymodule.json.

 {
            "module": "Project",
            "code": "Project",
            "active": true,
            "order": 8,
            "tenants": [
                {
                    "code": "pg.cityb"
                },
                {
                    "code": "pg.cityc"
                },
                {
                    "code": "pg.citya"
                }
            ]
},

Enable module in App.js. Update the object ‘enabledModules’. Use the code “Project”. This code should match the code of cityModule.json, mentioned above.

PDF Configuration

The project created can be downloaded in PDF format from the View Project screen in the project module. The PDF contains the respective project descriptions, work details, and location details.

PDF URL : https://works-dev.digit.org/egov-pdf/download/project/project-details?projectId=<project-Id>&tenantId=<tenant-Id>

Role-action Mapping

S.No.
API
Action ID
Roles

1

/pms/project/v1/_create

51

PROJECT_CREATOR

2

/pms/project/v1/_search

52

PROJECT_VIEWER

3

/pms/project/v1/_update

52

PROJECT_CREATOR

Sidebar Configuration

S.No.
Screen
Navigation URL
Left-icon Updates
Roles

1

Create Project

/works-ui/employee/project/create-project

dynamic:ProjectIcon

PROJECT_CREATOR

2

Search Project

/works-ui/employee/project/search-project

dynamic:ProjectIcon

PROJECT_VIEWER

Sample Configuration

 {
     "id": 15,
     "name": "PROJECT",
     "url": "url",
     "displayName": "Create Project",
     "orderNumber": 1,
     "parentModule": "",
     "enabled": true,
     "serviceCode": "PROJECT",
     "code": "null",
     "navigationURL": "/works-ui/employee/project/create-project",
     "path": "1PROJECT.Create",
     "leftIcon": "dynamic:ProjectIcon"
  }

Screen Configuration

S.No.
Screen
Configuration

1

Create / Update

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/commonMuktaUiConfig/CreateProjectConfig.json

2

Search

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/commonMuktaUiConfig/SearchProjectConfig.json

Localisation Configuration & Modules

TenantID
Module

pg

rainmaker-project

pg

rainmaker-common-masters

pg

rainmaker-common

pg.citya

rainmaker-pg.citya

Workflow Configuration

NA

Customisation

Create Screen:

  1. Use the common Utility “PreProcessMDMSConfig”.

  2. Pass the associated dependencies for the config.

  3. The utility returns a config that will run through the FormComposer.

  4. Refer to docs for pre-process config in component comments.

Search Screen:

  1. Use the common utility “preProcessMDMSConfigInboxSearch”.

  2. Pass the associated dependencies for the config.

  3. The utility returns a config that will run through the RenderFormFields.

  4. Refer to docs for pre-process config in component comments.

Custom Components Used in Projects:

  1. Form Validations: Check if all form validations are added to the screen configurations. Add the populators for respective validations and mention the JSON path for the pre-process to work.

PreviousModulesNextEstimate

Last updated 1 year ago

Was this helpful?

Document Config - Based on the , respective documents will be rendered on the Create Screen. Mention the validations, file type, and file size limits in this config.

document config