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

#	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. Document Config - Based on the document config, respective documents will be rendered on the Create Screen. Mention the validations, file type, and file size limits in this config.
2. 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.