DIGIT Urban is India’s largest open-source platform for Urban Governance. It is built on OpenAPI (OAS 2.0) and provides API based access to a variety of urban/municipal services enabling state governments and city administrators to provide citizen services with relevant new services and also integrating the existing system into the platform and run seamlessly on any commercial/on-prem cloud infrastructure with scale and speed.

Key Architecture Highlights

• DIGIT Urban is a microservices-based platform which is built to scale. Microservices are small, autonomous and developer-friendly services that work together.

• A big software or system can be broken down into multiple small components or services. These components can be designed, developed & deployed independently without compromising the integrity of the application.

• Parallelism in development: Microservices architectures are mainly business-centric.

• MicroServices have smart endpoints that process info and apply logic. They receive requests, process them, and generate a response accordingly.

• Decentralized control between teams, so that its developers strive to produce useful tools that can then be used by others to solve the same problems.

• MicroServices architecture allows its neighbouring services to function while it bows out of service. This architecture also scales to cater to its clients’ sudden spike in demand.

• MicroService is ideal for evolutionary systems where it is difficult to anticipate the types of devices that may be accessing our application.

DIGIT users can sign up to use various modules through the online web portal or the mobile application login interface.

User Registration

The first step to logging in to use the DIGIT modules is to register as a user.

Enter the ULB url in your browser. For instance, people of Punjab will use the link https://mseva.lgpunjab.gov.in/citizen/user/register to register for Punjab mSeva services.

Enter your Mobile Number, Name, City to register as a user. Click on the Continue button.

The system sends an OTP to the given mobile number. Enter the OTP.

Click on the Resend button on the screen in case you have not received your OTP. Click on the Get Started button after entering the OTP. You are now registered as a user in the DIGIT app.

User Login

Enter the URL https://egov-micro-qa.egovernments.org/citizen/ to log in to the system. Click on the Login button.

Enter your Mobile Number. Mobile app users can scan the QR code on the screen to file/track complaints. Click on the Continue button.

Enter the OTP sent to the registered mobile number. Click on the Continue button. You are logged in to the app.

Edit User Profile

Click on the drop-down icon next to your profile logo on the top right corner of the window to change your account details. Click on Edit Profile.

Enter your new user Name if you want to change the existing profile name. Select the applicable City from the drop-down list if you want to change your city settings. Enter your Email Id if you want to reset your email address.

Click on the Save button. The profile changes are saved and applied.

Change Language Settings

Users can change the language of the app from English to Hindi or the local language for ease and convenience. To change language click on the button labelled English adjacent to the profile icon.

Select the preferred language from the list of available languages. The system menu and prompts will now be displayed in the selected language.

Logging Out

To log out from the app click on the drop-down icon next to your profile logo on the top right corner of the window. Click on Logout.

You are logged out of the system.

• Open Source - DIGIT is Open Source and has been built using the best in class Open Source technology stacks powering the most advanced companies in the world. DIGIT is able to provide the lowest total cost of ownership and helps ensure that governments retain strategic control of their systems and data.

• Mobile-Enabled - DIGIT has adopted a mobile-first approach, with robust mobile applications enabling citizens to easily access government services through their phones. Government officials and field workers are also empowered with mobile applications that enable them to deliver 24×7 governance with ease.

• Real-time Dashboards - DIGIT’s real-time dashboards provide governments with actionable insights on demand. Administrators and department heads are empowered with verified data that enables them to manage their work and budgets better. Field level employee reports enable effective performance management and ensure efficient usage of government resources.

• Access governments easily using your mobile phones

• Your requests automatically reach the appropriate person

• Stay up-to-date with inbuilt notifications

DIGIT modules follow structured workflows to allow easy tracking of applications and processes. This section walks you through the various workflows and features supported by each module.

The citizen pays the fees for miscellaneous services through the CEs or FEs. Once the payment transaction is complete the citizen can access the payment receipts online.

Citizens can

• Search receipts

• Download receipts

• Print receipts

Search Download And Print Receipts

Citizens can search for payment receipts and download or print these online. To search for payment receipts navigate to the Collections option in the sidebar main menu.

Enter the relevant search parameter. The system enables you to search using payment Receipt No. or Service Category, or payee Mobile No. Click on the Search button.

The system will display the relevant search results in the panel below. Click on the relevant record to view the payment receipt.

The system will generate a pdf format of the payment receipt. Click on the download icon on the pdf page to download the receipt.

Click on the Print icon on the pdf page to print the receipt.

Click on the Reset button to renew your search with different parameters.

Citizens and CE

Citizens represent individuals, communities, or business entities who are the system end-users. The TL module allows business owners to apply for a trade license online or even apply for renewal of an existing license.

The citizen can also approach the Counter Employee (CE) to submit new TL applications or raise renewal requests for existing licenses.

The Citizen or CE role can -

• Apply for new TL

• Renew trade license

• Search application

• Pay license fee

• Download payment receipts, license certificates, or applications

Apply For New TL

Citizens or CE can apply for a new trade license through the DIGIT web portal or the DIGIT mobile app. To apply for new TL click on the Trade License card available in the Citizen Services section of the DIGIT home page.

Click on the New Application button on the screen. This will open the TL application form page.

The system displays the Required Documents - Trade License list. Click on the Print button to get a hard copy of the documents list for reference.

Click on the Apply button to proceed with the trade license application. The form sections are available on the top of the page.

The New Application form page contains various sub-sections -

1. Trade Details

2. Owner Details

3. Documents

4. Summary

The system displays the Trade Details page. The page contains 4 panels - Trade Details, Trade Unit, Accessories, and Trade Location Details.

In the Trade Details panel, enter the following details.

Select the applicable Financial Year. Select the relevant License Type from the drop-down list. Enter the Name of Trade. Select the appropriate Structure Type and Structure Sub Type. Enter the Trade Commencement Date. Enter the Trade GST No. if applicable. Enter the Operational Area (Sq Ft). and the Number of Employees for the listed trade.

In the Trade Unit panel, provide the following details -

In the Accessories panel, enter the following details -

Enter the following details in the Trade Location Details panel -

Select the City. The system displays the registered city by default. Enter the Property ID/UID, Door/House No., Building/Colony Name, Street Name, Mohalla, and Pincode for the listed premises. Click on the map icon to provide the GIS coordinates for the location. Enter the Electricity Connection No. for the listed premise.

Click on the Next Step button to move to the Owner Details section.

Select the Type of Ownership and the Type of Sub-Ownership. Provide the following information in the Owner Information section.

Enter the owner Mobile No., Name, Father/Husband’s Name. Check Father or Husband to indicate the Relationship of the given name with the owner. Check the applicable Gender of the owner. Enter the Date of Birth of the owner. Enter the owner’s Email ID, PAN No., Correspondence Address. Select the applicable Special Owner Category from the drop-down list.

Click on the Next Step button to move to the Documents section.

Click on the Upload File button to browse and upload the required documents for processing the TL. Click on the Next Step button once all the documents are uploaded.

The Application Summary page provides all the information filled in by the applicant. The Application Summary panel on top of the page provides the Trade License Tax and Total Amount details. This amount has to be paid by the applicant.

Click on the View Breakup button to fetch the fee details.

The Trade License Application No. is displayed along with this message. Click on the Download button to download a copy of the application. Click on the Print button to print the application.

Renew Trade License

Citizens can renew their existing trade applications on the DIGIT portal. CE can also apply for TL renewal on behalf of the citizens. To renew TL navigate to the home page and then click on the Trade License option. Click on My Applications. Click on the Renew Now button on the specific license.

The system will display the license details. Click on the Take Action button. Click on the Edit button to make any changes to the existing license details. Click on the Submit for Renewal button to apply for renewal.

The Trade License is submitted for renewal.

Search Application

To search for a submitted application or track the status of submitted applications navigate to the Trade License home page.

Enter at least one of the listed search parameters in the Search panel. The listed search parameters include

• Application No.

• Trade License No.

• Owner Mobile No.

• Application Type

• From Date

• To Date

• Application Status

Click on the Search button. The system displays the records matching the listed parameter.

Click on the Application No. link. The screen displays the application details. Scroll down the page to view the details.

Click on the Take Action button and click on Edit option to edit the form details. The Task Status panel on the top of the Application displays the current status of the application.

Click on the View History button on the top right corner of the Task Status panel to view the actions taken on the application to date.

Pay Trade License Fee

Applicants have to pay the license fee once the TL application is approved. The application status changes to Pending for Payment. To make payment for the trade license fee click on your Application No. to open the application. Click on the Take Action button.

Click on Pay. Enter the payment details. The system allows you to pay by cash, cheque, or credit/debit card. Click on the Cash, Cheque, Credit/Debit Card tab depending on the preferred payment method.

Enter payment details as requested on the screen. Click on the Generate Receipt button to confirm the payment. The screen displays the success acknowledgement message along with the Payment Receipt No.

Once the payment is complete the Trade License Certificate is issued. Click on the Download or Print button to download or print the Payment Receipt and Trade License Certificate.

CE And FE

The counter employees or field employees collect and process the miscellaneous payments on behalf of the citizens.

The CE or FE role can -

• Collect payment

• Search payment receipts

• Print receipts

• Download payment receipts

Collect Payment

CE can process and collect payments for miscellaneous services through the DIGIT web portal or the DIGIT mobile app. To process a new payment navigate to the Universal Collections option in the sidebar main menu.

Click on the New Collection button on the screen. This will open a new collection form page.

Enter the Mobile No. and Consumer Name of the payee.

Select the applicable Service Category.

Enter the From Date and To Date to identify the applicable payment period. **Enter any additional information in the Comments** field.

Click on the Next button to move to the payment section. The Payment Collection Details page displays the fee details and capture payment form. The Fee Details panel displays the fee breakup and Total Amount details.

The Capture Payment panel displays the available payment methods. Click on the preferred payment tab. The available payment tabs are Cash, Cheque, Credit/Debit Card.

Enter the Paid By and the Payee Name details.

Enter the Payer Mobile No.

Enter the Cheque No., Cheque Date, IFSC, Bank Name, and Bank Branch details in case of payment by cheque. Enter your credit card or debit card Last 4 digits, Transaction No., and Re-enter Transaction No. details if you have selected the Credit/Debit Card payment option.

Enter the Gen/G8 Receipt No. issued at the payment counter in case payments are made offline. Enter Gen/G8 Receipt Issue Date mentioned on the receipt.

Click on the Generate Receipt button once the payment is collected or processed. The system will display the payment success acknowledgement message.

Click on the Download button to download/view the receipt. Click on the Print button to print the receipt.

Search Receipts

To search for payment receipts navigate to the Universal Collections page in the sidebar main menu.

Enter the relevant search parameter. The system enables you to search using payment Receipt No. or Service Category, or payee Mobile No. Click on the Search button.

The system will display the relevant search results in the panel below. Click on the relevant record to view the payment receipt. The system will generate a pdf format of the payment receipt.

Click on the download icon on the pdf page to download the receipt. Click on the print icon on the pdf page to print the receipt.

Click on the Reset button to renew your search with different parameters.

Property Tax

DIGIT-Property Tax (PT) is a self-serve web and mobile-based, easy-to-use and configurable product that addresses the objectives of municipal corporations and local government to automate all property tax operations, thus providing property tax assessment and payment services to citizens in real-time.

Public Grievance Redressal

DIGIT-Public Grievance Redressal (PGR) is a self-serve web and mobile-based, easy-to-use and configurable product for submission of grievances by the citizens from anywhere, anytime. For the speedy and efficient resolution of civic related complaints, DIGIT-PGR facilitates the municipal employees with easy For the speedy and efficient resolution of civic related complaints, DIGIT-PGR enables the citizens to report the issues, real-time and enables municipal employees with easy identification of the issues and helps them to initiate corrective actions, without any delay.

Trade License

DIGIT-Trade License (TL) enables local government to regulate the trade and protect the interest of the public at large against the health hazard and inconvenience which a business may cause. With DIGIT-TL traders can obtain the trade certificate in a simplified manner and ensure compliance with rules and safety guidelines issued by the government.

Online Building Permission System

DIGIT-Online Building Permission System (OBPS) enables local government to bring in transparency, accountability and time-bound service for the public. With DIGIT-OBPS, professionals like architects, engineers, supervisors can seek permission for construction of a building from any Urban Local Bodies/District Town and Country Planning/Centre for Municipal Administration with a speedy, hassle-free and user-friendly procedure, online.

DIGIT offers several modules. Each module is designed to automate the manual workflows for various governance units.

Key Benefits

DIGIT enables ULBs to be more effective and accountable—and to make better, data-driven decisions. The platform ensures both interoperability among ULBs and rapid development of new modules by a wide array of software partners.

The Public Grievance Redressal or the PGR is a standardized solution offering on DIGIT platform to register and redress citizen grievances. It provides a transparent and trackable mechanism to solve public grievances by inducing responsive administration. PGR enables the citizens to file the complaints using various channels and helps the municipal employees to resolve them timely.

Key Features

• Citizens can lodge complaints, track, reopen and rate complaints through the web portal or the mobile application.

• ULB employees too can use the web or mobile interface to comment, forward, assign, verify, share, and resolve citizen complaints.

User Roles

Refer to the table below to understand the different user roles and the scope of action linked to each role. The manual provides a detailed description of how to use the system for each role.

Using PGR

This section guides you through the details of using the PGR module for each role. Click on the relevant role below to learn more about how to use the PGR system.

The mCollect module is designed to facilitate the ULBs process miscellaneous types of payments. Miscellaneous payments may include parking fees, advertising fees, rent, challans, etc. The module objective is to process and record payment collections on account of miscellaneous heads within the ULBs. This makes it easy to track payment receipts and generate reports for administrative purposes.

Key Features

The MCS module enables ULB employees to -

• Capture payment details

• Generate and print payment collection receipts

• Access dashboard analytics

• Generate reports for administration

User roles

Refer to the table below to understand the different user roles and the scope of action linked to each role. The applicable user roles and action items can vary from one State to another. DIGIT customizes the workflows to suit the requirements defined at the State level.

Using MCS

This section guides you through the details of using the MCS module for the defined roles. Click on the relevant role below to learn more about how to use the MCS system.

Overview

Workflows are a series of steps that moves a process from one state to another state by actions performed by different kind of Actors - Humans, Machines, Time based events etc. to achieve a goal like onboarding an employee, or approve an application or grant a resource etc. The egov-workflow-v2 is a workflow engine which helps in performing these operations seamlessly using a predefined configuration.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

• Java 8

• Kafka server is up and running

• egov-persister service is running and has workflow persister config path added in it

• PSQL server is running and database is created to store workflow configuration and data

Key Functionalities

• Always allow anyone with a role in the workflow state machine to view the workflow instances and comment on it

• On the creation of workflow, it will appear in the inbox of all employees that have roles that can perform any state transitioning actions in this state.

• Once an instance is marked to an individual employee it will appear only in that employee's inbox although point 1 will still hold true and all others participating in the workflow can still search it and act if they have necessary action available to them

• If the instance is marked to a person who cannot perform any state transitioning action, they can still comment/upload and mark to anyone else.

• Overall SLA: SLA for the complete processing of the application/Entity

• State-level SLA: SLA for a particular state in the workflow

Interaction Diagram

Deployment Details

1. Deploy the latest version of egov-workflow-v2 service

2. Add businessService persister yaml path in persister configuration

3. Add Role-Action mapping for BusinessService API’s

4. Overwrite the egov.wf.statelevel flag ( true for state level and false for tenant level)

5. Create businessService (workflow configuration) according to product requirements

6. Add Role-Action mapping for /processInstance/_search API

7. Add workflow persister yaml path in persister configuration

Configuration Details

For Configuration details please refer to the links in Reference Docs

Integration Details

Integration Scope

The workflow configuration can be used by any module which performs a sequence of operations on an application/Entity. It can be used to simulate and track processes in organisations to make it more efficient too and increase accountability.

Integration Benefits

• Role-based workflow

• An easy way of writing rule

• File movement within workflow roles

Steps to Integration

1. To integrate, host of egov-workflow-v2 should be overwritten in helm chart

2. /process/_search should be added as the search endpoint for searching workflow process Instance object.

3. /process/_transition should be added to perform an action on an application. (It’s for internal use in modules and should not be added in Role-Action mapping)

4. The workflow configuration can be fetched by calling _search API to check if data can be updated or not in the current state

Reference Docs

Doc Links

API List

(Note: All the API’s are in the same postman collection, therefore, the same link is added in each row)

Document Verifier (DV)

DV is responsible for verifying the supporting documents uploaded by the applicants or the counter employee on behalf of the applicant.

The DV can

• Reject applications

• Verify and forward applications

• Edit applications

Reject Applications

Trade license applications are rejected if the supporting documents uploaded by the applicant fails to comply with the license requirements or the details provided in the form are incorrect.

To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on Reject.

Enter your Comments to state the reason for rejection. Click on the Upload Files button to upload any supporting documents to validate the rejection. Click on the Reject button.

The applicant will receive a rejection notification on his mobile number or email address.

Verify and Forward

The DV verifies and forwards the TL application to the Field Inspector if the DV finds all information and documents provided by the applicant correct.

To verify and forward the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Verify and Forward button. Select the relevant Assignee Name from the list of available employees for subsequent processing.

Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Upload Files to upload any supporting documents for the application. Click on the Verify and Forward button.

The TL application is assigned to the selected Assignee for subsequent processing.

Edit Application

To edit applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Edit button. Change any details in the form as required.

Field Inspector (FI)

FI is responsible for verifying the field details provided by the applicants.

The FI can

• Send applications back to citizens

• Send back

• Reject applications

• Verify and forward applications

• Edit applications

Send Back To Citizen

FI sends back the applications to the citizens if some vital information is missing in the application or there is a mistake in the information provided.

To send applications back to the citizen navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Send Back to Citizen button. Enter any Comments stating why the application is sent back.

Click on the Upload Files button to upload any files or images in context to the application. Click on the Send Back to Citizen button.

The system displays a success acknowledgement message stating that the application is sent back to the initiator.

Send Back

The FI can send back the TL application to the DV if there is any mistake or lapses in the document verification process.

To send back applications to the DV navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Send Back button.

Select the Assignee Name who will be responsible for verifying the application. Enter any Comments as additional information to the assignee stating why the application is sent back. Click on the Upload Files button to upload any files or images in context. Click on the Send Back button.

The application is assigned back to the selected assignee for verification of documents.

Reject Applications

Trade license applications are rejected if the supporting documents uploaded by the applicant fails to comply with the license requirements or the details provided in the form are incorrect.

To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on Reject.

Enter your Comments to state the reason for rejection. Click on the Upload Files button to upload any supporting documents to validate the rejection. Click on the Reject button.

The applicant will receive a rejection notification on his mobile number or email address.

Verify and Forward

The FI verifies and forwards the TL application to the Approver if the information and documents provided by the applicant are correct.

To verify and forward the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Verify and Forward button. Select the relevant Assignee Name from the list of available employees for subsequent processing.

Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Upload Files to upload any supporting documents for the application. Click on the Verify and Forward button.

The TL application is assigned to the selected Assignee for subsequent processing.

Edit Application

To make any changes in the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Edit button. Change any details in the form as required.

Approver

The Approver is responsible for the final approval of the TL application.

The Approver can

• Send applications back to field inspectors

• Reject applications

• Approve applications

Send Back

The Approver can send back the TL application to the FI or DV if there is any mistake or lapses in the document verification process.

To send back applications to the DV or FI navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Send Back button.

Select the Assignee Name who will be responsible for verifying the application. Enter any Comments stating why the application is sent back. Click on the Upload Files button to upload any files or images in context. Click on the Send Back button.

The application is assigned back to the selected assignee for verification of application.

Reject Applications

Trade license applications are rejected if the supporting documents uploaded by the applicant fails to comply with the license requirements or the details provided in the form are incorrect.

To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on Reject.

Enter your Comments to state the reason for rejection. Click on the Upload Files button to upload any supporting documents to validate the rejection. Click on the Reject button.

The applicant will receive a rejection notification on his mobile number or email address.

Approve Applications

The Approver signs off the TL application once the information and documents provided by the applicant are found correct. The TL Certificate is issued once the application is approved.

To approve the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Approve button.

Select the relevant Assignee Name from the list of available employees for subsequent processing. Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Upload Files to upload any supporting documents for the application. Click on the Approve button.

The TL application is approved and the TL Certificate is issued to the applicant. Click on the Download or Print button to download or print the TL Certificate.

Citizens represent individuals or communities who are the system end-users. The PGR module provides the citizens with the scope to file their complaints or grievances to initiate necessary action.

The Citizen role can -

• File complaints

• Track complaints

• Rate complaints

• Reopen complaints

File Complaints

The File Complaints option allows citizens to register their complaints.

To file complaints navigate to Complaints Home page. Click on the File Complaints tab on the screen. This will open the complaint form page. Select the relevant Complaint Type and the subtype from the drop-down list of options. Refer to the list of complaint types available in PGR.

The system will display the Complaint Registered Successfully message along with the Complaint No. Click on the Continue button. Your complaint details are available on the dashboard.

My Complaints

My Complaints tab enables citizens to track the status of their complaints.

To view or track complaints click on My Complaints tab. The system will display all complaints filed by you or from your account and the corresponding status. Click on the Open button corresponding to any complaint to view the complaint details.

The complaint summary view contains the Complaint Details, Complaint Timeline, and Comments text box. The complaint timeline indicates the action taken on the complaint and the current or pending action status of the complaint.

Enter any additional information about the complaint in the Comments section.

Rate Complaints

The PGR module enables the citizens to give their feedback on resolved complaints.

To rate resolved complaints navigate to the Complaints menu option in the sidebar. Click on the My Complaints tab. Scroll down to the complaint you want to rate. You can rate only complaints marked as Closed. Scroll down to the Complaint Timeline section.

Click on the Rate button on the timeline.

Click on the number of stars on the screen to rate the work on the complaint on five. Click on the most appropriate feedback statement to rate the work. Add any additional information in the Comments section. Click on the Submit button.

The system displays an acknowledgement for your ratings. Click on the Go To Home button to navigate back to the home page.

Reopen Complaints

To reopen the complaint navigate to Complaints > My Complaints menu option in the sidebar. Click on the closed complaint that you want to reopen. Scroll down to the Complaint Timeline section. Click on the Re-Open button on the timeline.

Select the appropriate reason for reopening the complaint. Click on the camera icon to upload any photos related to the complaint. Enter any additional information in the Comments section. Click on the Continue button once done. The system displays an acknowledgement message stating the complaint is reopened. Click on the Go To Home button to navigate back to the home page.

The Trade License (TL) module offers the citizens and governance bodies a convenient and transparent means of processing trade licenses. Trade license is the permission issued by the local governing bodies to carry on specified business or trading activity within the authorized area. It is a mandatory document required to run a business or commercial activity of any type.

Key Features

The TL module enables citizens to apply for trade licenses or renew existing licenses online. It facilitates the governing bodies to validate and approve the license applications.

User Roles

Using TL

This section guides you through the details of using the TL module for each role. Click on the relevant role below to learn more about how to use the TL system.

1. Citizens

2. Counter Employee (CE)

3. Document Verifier (DV)

4. Field Inspector (FI)

5. Approver

CSR

Complaints can also be registered by ULB counter employees on behalf of the citizen.

The CSR or counter employees can perform the following actions on PGR -

File Complaints

To file complaints on behalf of the citizen navigate to the Home page and click on the Complaints card. Else, click on the Complaints menu option in the sidebar. Click on the File Complaint tab on the screen. This will open the complaint form page.

Enter the Citizen Name. and the Citizen Mobile No. Select the relevant Complaint Type and the subtype from the drop-down list of options. Refer to the list of complaint types available in PGR. Enter any additional information in the Complaint Additional Details field. The City field will display the city specified in your profile by default. You can change the city if required. Choose the applicable Locality/Mohalla from the drop-down list. Enter the House No. and Street Name. Enter any Landmark to identify the exact location for the listed complaint.

Click on File Complaint button once you have finished filling in all the details. The system will display the Complaint Registered Successfully message along with the Complaint No.

Click on the Continue button. Your complaint details are available on the dashboard. Click on the complaint to view the complaint details.

Search Complaints

Employees can search for specific complaints using the registered mobile number of citizens or by entering the last few digits of the complaint number.

To search complaints navigate to Complaints Home page. Enter Citizen Mobile No. Or, enter the last 6 digits of the Complaint No.

Click on the Search button. The system will retrieve and display the matching records. Click on the Clear Search button to initiate a fresh search.

Reopen Complaints

To reopen the complaints navigate to Complaints > My Complaints menu option in the sidebar. Click on the closed complaint that you want to reopen. Scroll down to the Complaint Timeline section. Click on the Re-Open button on the timeline.

Select the appropriate reason for reopening the complaint. Click on the camera icon to upload any photos related to the complaint. Enter any additional information in the Comments section. Click on the Continue button once done.

The system displays an acknowledgement message stating the complaint is reopened. Click on the Go To Home button to navigate back to the home page.

GRO

The Grievance Routing Officer or GRO manages the complaints queue. The role ensures the complaints are routed to the appropriate employees for prompt action.

GROs can

5. Call citizens

6. Comment on complaints

Assign Complaints

Grievances filed by citizens are assigned to specific employees who are responsible for acting on and resolving the complaints.

To assign complaints, navigate to the Home page and click on the Complaints card. Or, navigate to Complaints > Open Complaints. The GRO Complaint page contains two tabs - Unassigned and Assigned complaints.

Click on the Unassigned tab. The list of unassigned complaints is available on the screen. Click on the Complaint you want to assign. This will open the Complaint Summary page.

Click on the Assign button available in the bottom right corner of the screen. This will display the list of employees. Select an employee.

Click on the Assign button.

The complaint is assigned to the selected employee.

Re-Assign Complaints

Assigned complaints can be re-assigned by the GRO depending on the situation and requirements.

To re-assign complaints navigate to the Home page and click on the Complaints card. Click on the Assigned tab. Click on the complaint you want to re-assign. Click on the Re-Assign button available on the bottom right corner of the screen. Select the employee to whom the complaint should be assigned. Click on the Assign button.

The Complaint is re-assigned to the selected employee.

Share Complaints

GROs can share complaints with other department users based on the requirements.

To share complaints click on the complaint you want to share.

Click on the share icon in blue on the top right corner of the screen.

Select the appropriate channel. The system will redirect you to the selected channel interface. Select the person or list of people for sharing. Click on the Send button.

The complaint is shared with the selected recipients.

Reject Complaints

In certain cases, the GRO might reject registered complaints. This usually happens when the complaint is beyond the operational scope of the department or the complaint is invalid.

To reject complaints navigate to the Home page and click on the Complaints card. Click on the relevant Complaint. This will open the Complaint Summary page. Click on the Reject button available in the bottom right corner of the screen. Select the appropriate Reason to Reject.

Add any additional information in the Comments space. Click on the Submit button. The complaint is rejected.

FME

First Mile Employees or FMEs are responsible for acting on citizen complaints.

FMEs can -

3. Call citizens

4. Comment on complaints

Request Re-Assign

FMEs work on the assigned complaints. In some cases, the FMEs may request complaints to be reassigned to some other employee.

To request reassign navigate to the Complaints menu option in the sidebar. Click on Open Complaints. Search for a specific complaint using the Citizen Mobile No. or inputting the last 6 digits of the Complaint No.

Else, click on the relevant complaint from the list of open complaints. Click on the Request Re-Assign button available in the bottom right corner of the screen.

Select a specific reason for requesting a re-assign.

Enter any additional information in the Comments section. Click on the Request Re-Assign button.

Resolve Complaints

Once the complaints are actioned on the FME marks the issue resolved. The complaint is closed subsequently.

To mark the complaint resolved, navigate to the Complaints menu option in the sidebar. Click on Open Complaints. Search for a specific complaint using the Citizen Mobile No. or inputting the last 6 digits of the Complaint No.

Else, click on the relevant complaint from the list of open complaints. **Click on the Mark Resolved** button available in the bottom right corner of the screen.

Click on the camera icon to upload photos as evidence that the issue has been resolved.

Enter any additional information related to the issue resolution in the Comments section. Click on the Mark Resolved button.

The system will display an acknowledgement message. Click on the Go To Home button to navigate back to the home page.

Document Verifier (DV)

DV is responsible for verifying the supporting documents uploaded by the property applicants or the counter employee on behalf of the applicants.

The DV can

Reject Applications

Property applications are rejected if the supporting documents uploaded by the applicant fails to comply with the property regulatory requirements or the details provided in the form are incorrect.

To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on Reject.

Enter your Comments to state the reason for rejection. Click on the Upload Files button to upload any supporting documents to validate the rejection. Click on the Reject button.

The applicant will receive a rejection notification on his mobile number or email address.

Verify and Forward

The DV verifies and forwards the property applications to the Field Inspector if the DV finds all information and documents provided by the applicant correct.

To verify and forward the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Verify and Forward button. Select the relevant Assignee Name from the list of available employees for subsequent processing.

Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Upload Files to upload any supporting documents for the application. Click on the Verify and Forward button.

The property application is assigned to the selected assignee for subsequent processing.

Edit Application

To edit applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Edit button. Change any details in the form as required.

Field Inspector (FI)

FI is responsible for inspecting and verifying the field details of the property in the application.

The FI can

Send Back To Citizen

FI sends back the applications to the citizens if some vital information is missing in the application or there is a mistake in the information provided.

To send applications back to the citizen navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Send Back to Citizen button. Enter any Comments stating why the application is sent back.

Click on the Upload Files button to upload any files or images in context to the application. Click on the Send Back to Citizen button.

The system displays a success acknowledgement message stating that the application is sent back to the initiator.

Send Back

The FI can send back the PT application to the DV if there is any mistake or lapses in the document verification process.

To send back applications to the DV navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Send Back button.

Select the Assignee Name who will be responsible for verifying the application. Enter any Comments stating why the application is sent back. Click on the Upload Files button to upload any files or images in context. Click on the Send Back button.

The application is assigned back to the selected assignee for verification of documents.

Reject Applications

Property tax applications are rejected if the supporting documents uploaded by the applicant fails to comply with the license requirements or the details provided in the form are incorrect.

To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on Reject.

Enter your Comments to state the reason for rejection. Click on the Upload Files button to upload any supporting documents to validate the rejection. Click on the Reject button.

The applicant will receive a rejection notification on his mobile number or email address.

Verify and Forward

The FI verifies and forwards the property applications to the Approver if the information and documents provided by the applicant are correct.

To verify and forward the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Verify and Forward button. Select the relevant Assignee Name from the list of available employees for subsequent processing.

Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Upload Files to upload any supporting documents for the application. Click on the Verify and Forward button.

The property application is assigned to the selected assignee for subsequent processing.

Approver

The Approver is responsible for the final approval of the PT application.

The Approver can

Send Back

The Approver can send back the property applications to the FI or DV if there is any mistake or lapses in the document verification process.

To send back applications to the DV or FI navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Send Back button.

Select the Assignee Name who will be responsible for verifying the application. Enter any Comments stating why the application is sent back. Click on the Upload Files button to upload any files or images in context. Click on the Send Back button.

The application is assigned back to the selected assignee for verification of application.

Reject Applications

Property applications are rejected if the supporting documents uploaded by the applicant fails to comply with the regulatory requirements or the details provided in the form are incorrect.

To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on Reject.

Enter your Comments to state the reason for rejection. Click on the Upload Files button to upload any supporting documents to validate the rejection. Click on the Reject button.

The applicant will receive a rejection notification on his mobile number or email address.

Approve Applications

The Approver signs off the PT application once the information and documents provided by the applicant are found correct.

To approve the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on the Application No. to open the application. Scroll down the form to review the filled in details.

Click on the Take Action button available at the bottom of the page. Click on the Approve button.

Select the relevant Assignee Name from the list of available employees for subsequent processing. Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Upload Files to upload any supporting documents for the application. Click on the Approve button.

The property application is approved.

This section contains all technical documents related to DIGIT stack.

The key services include -

Introduction to PT

The Property Tax (PT) module offers the citizens and governance bodies a convenient and transparent means of processing property taxes. Local governing bodies identify the applicable tax slabs for different types of properties. The PT module assesses properties, calculates tax amount, processes tax payment and generates tax collection reports.

Key Features

The PT module enables citizens to pay property taxes online. It facilitates the governing bodies process property tax payments.

User roles

Refer to the table below to understand the different user roles and the scope of action linked to each role. The applicable user roles and action items can vary from one State to another. DIGIT customizes the workflows to suit the requirements defined at the State level.

Using PT

This section guides you through the details of using the PT module for each role. Click on the relevant role below to learn more about how to use the PT system.

Core Services is one of the key DIGIT components. Browse through this section to learn more about key configuration and integration details of these core services.

Overview

A core application which provides location details of the tenant for which the services are being provided.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

• Java 8

• PSQL server is running and database is created

• Knowledge of egov-mdms service

• egov-mdms service is running and all the required mdms master are loaded in it

Key Functionalities

• The location information is also known as boundary data of ULB

• Boundary data can be of different hierarchies ADMIN, ELECTION hierarchy which is defined by the Administrators, Revenue hierarchy defined by the Revenue department.

• The election hierarchy has the locations divided into several types like zone, election ward, block, street and locality. The Revenue hierarchy has the locations divided into a zone, ward, block and locality.

• The model which defines the localities like zone, ward and etc is boundary object which contains information like name, lat, long, parent or children boundary if any. The boundaries come under each other in a hierarchy like a zone contains wards, ward contains blocks, a block contains locality. The order in which the boundaries are contained in each other will differ based on the tenants.

Deployment Details

1. Add/Update the mdms master file which contain boundary data of ULB’s.

2. Add Role-Action mapping for egov-location API’s.

3. Deploy/Redeploy the latest version of egov-mdms service.

4. Fill the above environment variables in egov-location with proper values.

5. Deploy the latest version of egov-location service.

Configuration Details

The boundary data has been moved to mdms from the master tables in DB. The location service fetches the JSON from mdms and parses it to the structure of boundary object as mentioned above. A sample master would look like below.

Integration

Integration Scope

The egov-location API’s can be used by any module which needs to store the location details of the tenant.

Integration Benefits

• Get the boundary details based on boundary type and hierarchy type within the tenant boundary structure.

• Get the geographical boundaries by providing appropriate GeoJson.

• Get the tenant list in the given latitude and longitude.

Steps to Integration

1. To integrate, host of egov-location should be overwritten in helm chart.

2. /boundarys/_search should be added as the search endpoint for searching boundary details based on tenant Id, Boundary Type, Hierarchy Type etc.

3. /geography/_search should be added as the search endpoint .This method handles all requests related to geographical boundaries by providing appropriate GeoJson and other associated data based on tenantId or lat/long etc.

4. /tenant/_search should be added as the search endpoint. This method tries to resolve a given lat, long to a corresponding tenant, provided there exists a mapping between the reverse geocoded city to tenant.

5. The MDMS Tenant boundary master file should be loaded in MDMS service.

Reference Docs

Doc Links

API List

DIGIT offers key municipal services such as Public Grievance & Redressal, Trade License, Water & Sewerage, Property Tax, Fire NOC, and Building Plan Approval.

• PGR Services

• Trade License Services

This section provides technical details about business service setup, configuration, deployment, and API integration.

Details coming soon...

Details will be updated soon...

Details will be updated soon...

eGov Payment Gateway acts as a liaison between eGov apps and external payment gateways facilitating payments, reconciliation of payments and lookup of transactions' status'.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

• Java 8

• Kafka server is up and running

• egov-persister service is running and has pg service persister config path added in it

• PSQL server is running and the database is created to store transaction data.

Key Functionalities

• Create or initiate a transaction, to make a payment against a bill.

• Make payment for multiple bill details [multi module] for a single consumer code at once.

• Transaction to be initiated with a call to the transaction/_create API, various validations are carried out to ensure the sanctity of the request.

• The response includes a generated transaction id and a redirect URL to the payment gateway itself.

• Various validations are carried out to verify the authenticity of the request and the status is updated accordingly. If the transaction is successful, a receipt is generated for the same.

Payment Flow

Reconciliation

• Reconciliation is carried out by two jobs scheduled via a Quartz clustered scheduler.

• Early Reconciliation job is set to run every 15 minutes [configurable via app properties], and is aimed at reconciling transactions which were created 15 - 30 minutes ago and are in PENDING state.

• Daily Reconciliation job is set to run once per day and is aimed at reconciling all transactions that are in PENDING state, except for ones which were created 30 minutes ago.

Extensions

• Axis, Phonepe and Paytm payment gateways are implemented.

• Additional gateways can be added by implementing the Gateway interface. No changes required to the core packages.

Configuration Details

Following properties in the application.properties file in egov-pg-service has to be added and set to default value after integrating with the new payment gateway. In the below table properties for AXIS bank, payment gateway is shown the same relevant property needs to be added for other payment gateways.

Deployment Details

1. Deploy the latest version of egov-pg-service

2. Add pg service persister yaml path in persister configuration

Integration Details

Integration Scope

The egov-pg-service acts as communication/contact between eGov apps and external payment gateways.

Integration Benefits

• Record of every transaction against a bill.

• Record of payment for multiple bill details for a single consumer code at once.

Steps to Integration

1. To integrate, host of egov-pg-service should be overwritten in helm chart

2. /pg-service/transaction/v1/_create should be added in the module to initiates a new payment transaction, on successful validation

3. /pg-service/transaction/v1/_update should be added as the update endpoint to updates an existing payment transaction. This endpoint is issued only by payment gateways to update the status of payments. It verifies the authenticity of the request with the payment gateway and forward all query params received from a payment gateway

4. /pg-service/transaction/v1/_search should be added as the search endpoint for retrieving the current status of a payment in our system.

Reference Docs

Doc Links

API List

(Note: All the API’s are in the same postman collection, therefore, the same link is added in each row)

Overview

Public Grievances & Redressal (PGR) is a system that enables citizens to raise a complaint with there ULB’s. A citizen can track the complaint, upload image related to the complaint, re-open the complaint if he/she is not satisfied and rate the service. This document contains the details about how to setup PGR service and describes the functionalities it provides

Pre-requisites

Before you proceed with the configuration, make sure the following pre-requisites are met -

• Java 8

• Kafka server is up and running

• egov-persister service is running and has pgr-services persister config path added in it

• PSQL server is running and database is created to store complaint data

• (Optional) Indexer config for pgr-services is added in egov-indexer yaml paths to index the generated data. Index is required for data visualisation in Kibana or in DSS.

• (Optional) Report config for pgr-services is added in Report service config paths. Required if reports are to be provided to the user.

• Following services should be up and running:

  • egov-user

  • egov-workflow-v2

  • egov-perister

  • egov-localization

  • egov-notification-sms

  • egov-mdms

  • egov-idgen

  • egov-url-shortening

  • egov-hrms

Key Functionalities

• A citizen can file, track and rate the complaint

• A citizen can add image and comments related to the complaint

• A citizen can re-open the complaint in a certain given period of time after resolution

• ULB can setup the complaint workflow according to their requirements and staff capacity

• ULB can track the SLA for resolving each complaint and can use it as a metric to streamline the process for resolving complaints

• Department wise assignment of the complaint to the LME

Deployment Details

1. Deploy the latest version of pgr-services

2. Add pgr-service-persister.yml file in config folder in git and add that path in persister. (The file path is to be added in environment yaml file in param called persist-yml-path )

3. If any Report Config is created, the config should be added to the config folder in git and that path should be added in Report service. (The file path is to be added in a file called “reportFileLocationsv1.txt” in Config folder)

4. If index is to be created add the indexer config path in indexer service. (The file path is to be added in environment yaml file in param called egov-indexer-yaml-repo-path)

Configuration Details

1. Add master data in MDMS service with the module name as RAINMAKER-PGR. Following is some sample master data for the service:

{
  "tenantId": "pb",
  "moduleName": "RAINMAKER-PGR",
  "ServiceDefs": [
    {
      "serviceCode": "NoStreetlight",
      "keywords": "streetlight, light, repair, work, pole, electric, power, repair, damage, fix",
      "department": "Streetlights",
      "slaHours": 336,
      "menuPath": "StreetLights",
      "active": false,
      "order": 1
    },
    {
      "serviceCode": "StreetLightNotWorking",
      "keywords": "streetlight, light, repair, work, pole, electric, power, repair, fix",
      "department": "DEPT_1",
      "slaHours": 336,
      "menuPath": "StreetLights",
      "active": true,
      "order": 2
    },
    {
      "serviceCode": "GarbageNeedsTobeCleared",
      "keywords": "garbage, collect, litter, clean, door, waste, remove, sweeper, sanitation, dump, health, debris, throw",
      "department": "DEPT_25",
      "slaHours": 336,
      "menuPath": "Garbage",
      "active": true,
      "order": 3
    }
  ]
}

Create businessService (workflow configuration) using the __/businessservice/_create. Following is the product configuration for PGR:

{
      "tenantId": "pb",
      "businessService": "PGR",
      "business": "pgr-services",
      "businessServiceSla": 432000000,
      "states": [
        {
          "sla": null,
          "state": null,
          "applicationStatus": null,
          "docUploadRequired": false,
          "isStartState": true,
          "isTerminateState": false,
          "isStateUpdatable": true,
          "actions": [
            {
              "action": "APPLY",
              "nextState": "PENDINGFORASSIGNMENT",
              "roles": [
                "CITIZEN",
                "CSR"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "PENDINGFORASSIGNMENT",
          "applicationStatus": "PENDINGFORASSIGNMENT",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": false,
          "actions": [
            {
              "action": "ASSIGN",
              "nextState": "PENDINGATLME",
              "roles": [
                "GRO",
                "DGRO"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "GRO",
                "DGRO"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "PENDINGFORREASSIGNMENT",
          "applicationStatus": "PENDINGFORREASSIGNMENT",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": false,
          "actions": [
            {
              "action": "REASSIGN",
              "nextState": "PENDINGATLME",
              "roles": [
                "GRO",
                "DGRO"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "GRO",
                "DGRO"
              ]
            }
          ]
        },

        {
          "sla": 259200000,
          "state": "PENDINGATLME",
          "applicationStatus": "PENDINGATLME",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": false,
          "actions": [
            {
              "action": "RESOLVE",
              "nextState": "RESOLVED",
              "roles": [
                "PGR_LME"
              ]
            },
            {
              "action": "REASSIGN",
              "nextState": "PENDINGFORREASSIGNMENT",
              "roles": [
                "PGR_LME"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "REJECTED",
          "applicationStatus": "REJECTED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true,
          "actions": [
            {
              "action": "REOPEN",
              "nextState": "PENDINGFORASSIGNMENT",
              "roles": [
                "CFC",
                "CSR",
                "CITIZEN"
              ]
            },
            {
              "action": "RATE",
              "nextState": "CLOSEDAFTERREJECTION",
              "roles": [
                "CFC",
                "CITIZEN"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "RESOLVED",
          "applicationStatus": "RESOLVED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true,
          "actions": [
            {
              "action": "REOPEN",
              "nextState": "PENDINGFORASSIGNMENT",
              "roles": [
                "CFC",
                "CSR",
                "CITIZEN"
              ]
            },
            {
              "action": "RATE",
              "nextState": "CLOSEDAFTERRESOLUTION",
              "roles": [
                "CFC",
                "CITIZEN"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "CLOSEDAFTERREJECTION",
          "applicationStatus": "CLOSEDAFTERREJECTION",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        },
        {
          "sla": null,
          "state": "CLOSEDAFTERRESOLUTION",
          "applicationStatus": "CLOSEDAFTERRESOLUTION",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        }
      ]
    }

Using /localization/messages/v1/_upsert , add localisation (templates) for notification messages to be sent. Following are the product notification templates:

{
  "messages": [
       {
            "code": "PGR_APPLY_PENDINGFORASSIGNMENT_SMS_MESSAGE",
            "message": "Dear Citizen, Your complaint for <complaint_type> has been submitted with ID <id> on <date>. You can track your complaint status on the mSeva Punjab mobile App (download here - <download link>) or your local municipal web portal.",
            "module": "rainmaker-pgr",
            "locale": "en_IN"
        },
        {
            "code": "PGR_RESOLVE_RESOLVED_SMS_MESSAGE",
            "message": "Dear Citizen, Your complaint for <complaint_type> with ID <id> submitted on <date> has been resolved by <emp_name>. If you are not satisfied with service you can REOPEN complaint through mSeva Punjab mobile App (download here - <download_link>) or your local municipal web portal or by calling our CSR.",
            "module": "rainmaker-pgr",
            "locale": "en_IN"
        },
        {
            "code": "PGR_REOPEN_PENDINGFORASSIGNMENT_SMS_MESSAGE",
            "message": "Dear Citizen, Your complaint for <complaint_type> with ID <id> submitted on <date> has been RE-OPEN as per your request. You can track your complaint status and connect with our officials on the mSeva Punjab mobile App (download here - <download_link>) or your local municipal web portal.",
            "module": "rainmaker-pgr",
            "locale": "en_IN"
        },
        {
            "code": "PGR_REJECT_REJECTED_SMS_MESSAGE",
            "message": "Dear Citizen, Your complaint for <complaint_type> with ID <id> submitted on <date> has been rejected. Reason for Rejection: <reason>, Additional Comments: <additional_comments> If you wish to re-open the complaint, you can download the mSeva Punjab mobile app (download here - <download_link>) or visit your local municipal website.",
            "module": "rainmaker-pgr",
            "locale": "en_IN"
        },
        {
            "code": "PGR_REASSIGN_PENDINGATLME_SMS_MESSAGE",
            "message": "Dear Citizen, Your complaint for <complaint_type> with ID <id> submitted on <date> has been re-assigned to <reassign_emp_name>, <emp_designation>, <emp_department>. You can track your complaint status and connect with our officials on the mSeva Punjab mobile App (download here - <download_link>) or your local municipal web portal.",
            "module": "rainmaker-pgr",
            "locale": "en_IN"
        }      
    ]
}

Add Role-Action mapping for the APIs in MDMS. Following are the required entries. They should be mapped to both CITIZEN and appropriate employee roles.

{
  {
      "id": {{ID_PLACEHOLDER}},
      "name": "Create PGR Request",
      "url": "/pgr-services/v2/requests/_create",
      "parentModule": "",
      "displayName": "Create PGR Request",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "pgr-services",
      "code": "null",
      "path": ""
    },
    {
      "id": {{ID_PLACEHOLDER}},
      "name": "Update PGR Request",
      "url": "/pgr-services/v2/requests/_update",
      "parentModule": "",
      "displayName": "Update PGR Request",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "pgr-services",
      "code": "null",
      "path": ""
    },
    {
      "id": {{ID_PLACEHOLDER}},
      "name": "Search PGR Request",
      "url": "/pgr-services/v2/requests/_search",
      "parentModule": "",
      "displayName": "Search PGR Request",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "pgr-services",
      "code": "null",
      "path": ""
    },
    {
      "id": {{ID_PLACEHOLDER}},
      "name": "Search PGR Request",
      "url": "/pgr-services/v2/requests/_count",
      "parentModule": "",
      "displayName": "Count PGR Request",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "pgr-services",
      "code": "null",
      "path": ""
    }

Integration

Integration Scope

PGR service can be integrated with any organisation or system which wants to track customer queries or complaint. The organisations can customise the workflow depending on their product requirements.

Integration Benefits

• Easy tracking and resolution of complaints

• Configurable workflow according to client requirement

Steps to Integration

1. Customer can raise a complaint using the /requests/_create.

2. Organisation or System can search the complaint using /requests/_searchendpoint.

3. Once the complaint is raised the organisation or system can call /requests/_update endpoint to move the application further in workflow until it gets resolved.

Interaction Diagram

Reference Docs

Doc Links

API List

Overview

The objective of PDF generation service is to bulk generate pdf as per requirement.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

• Install npm.

• Kafka server is up and running.

• egov-persister service is running and has pdf generation persister config path added in it.

• PSQL server is running and the database is created to store filestore id and job id of generated pdf.

Key Functionalities

• Provide a common framework to generate PDF.

• Provide flexibility to customise the PDF as per the requirement.

• Provide functionality to add an image, Qr Code in PDF.

• Provide functionality to generate pdf in bulk.

• Provide functionality to specify a maximum number of records to be written in one PDF.

External Libraries used :

• Mustache.js: (https://github.com/janl/mustache.js/ ):- as templating engine to populate format as defined in format config, from request json based on mappings defined in data config

Interaction Diagram

Deployment Details

1. Create data config and format config for a PDF according to product requirement.

2. Add data config and format config files in PDF configuration

3. Add the file path of data and format config in the environment yml file

4. Deploy the latest version of pdf-service in a particular environment.

Configuration Details

For Configuration details please refer to the Customizing PDF Receipts & Certificates document in Reference Docs

Integration

Integration Scope

The PDF configuration can be used by any module which needs to show particular information in PDF format that can be print/downloaded by the user.

Integration Benefits

• Functionality to generate PDFs in bulk.

• Avoid regeneration.

• Support QR codes and Images.

• Functionality to specify the maximum number of records to be written in one PDF.

• Uploading generated PDF to filestore and return filestore id for easy access.

Steps to Integration

1. To download and print the required PDF _create API has to be called with the required key (For Integration with UI, please refer to the links in Reference Docs)

Reference Docs

Doc Links

API List

(Note: All the API’s are in the same postman collection therefore the same link is added in each row)

Overview

User service is responsible for user data management and providing functionality to login and logout into Digit system

Pre-requisites

Before you proceed with the configuration, make sure the following pre-requisites are met -

• Java 8

• Kafka server is up and running

• Encryption and MDMS services are running

• PSQL server is running and database

• Redis is running

Key Functionalities

• Store, update and search user data

• Provide authentication

• Provide login, logout functionality into DIGIT platform

• Store user data PIIs in encrypted form

Interaction Diagram

Deployment Details

1. Setup latest version of egov-enc-service and egov-mdms- service

2. Deploy the latest version of egov-user service

3. Add Role-Action mapping for API’s

Configuration Details

Following application properties file in user service are configurable.

Integration Details

Integration Scope

User data management and functionality to login and logout into Digit system using OTP and password.

Integration Benefits

Providing following functionality to citizen and employee type users

• Employee:

  • User registration

  • Search user

  • Update user details

  • Forgot password

  • Change password

  • User role mapping(Single ULB to multiple roles)

  • Enable employee to login into DIGIT system based on a password.

• Citizen:

  • Create user

  • Update user

  • Search user

  • User registration using OTP

  • OTP based login

Steps to Integration

• To integrate, host of egov-user should be overwritten in the helm chart.

• Use /citizen/_create and /users/_createnovalidate endpoints for creating users into the system

• Use /v1/_search and /_search endpoints to search users in the system depending on various search parameters

• Use /profile/_update for partial update and /users/_updatenovalidate for update

• Use /password/nologin/_update for otp based password reset and /password/_update for logged in user password reset

• Use /user/oauth/token for generating token, /_logoutfor logout and /_details for getting user information from his token

Reference Docs

Doc Links

API List

Overview

DIGIT is API based Platform here each API is denoting to a DIGIT resource. Access Control Service (ACS) primary job is to authorise end-user based on their roles and provide access to the DIGIT platform resources. Access control functionality basically works based on below points:

Actions: Actions are events which are performed by a user. This can be an API end-point or Frontend event. This is MDMS master

Roles: Role are assigned to the user, a user can hold multiple roles. Roles are defined in MDMS masters.

Role-Action: Role actions are mapping b/w Actions and Roles. Based on role, action mapping access control service identifies applicable action for the role.

Pre-requisites

Before you proceed with the configuration, make sure the following pre-requisites are met -

• Java 8

• MDMS service is up and running

Key Functionalities

• Serve the applicable actions for a user based on user role (To print menu three).

• On each action which is performed by a user, access control looks at the roles for the user and validate actions mapping with the role.

• Support tenant-level role-action. For instance, an employee from Amritsar can have a role of APPROVER for other ULB like Jalandhar and hence will be authorised to act as APPROVER in Jalandhar.

Deployment Details

1. Deploy the latest version of Access Control Service

2. Deploy MDMS service to fetch the Role Action Mappings

Configuration Details

Define the roles

{
      "code": "EMPLOYEE",
      "name": "Employee",
      "description": "Default role for all employees"
}

Add the Actions (URL)

{
      "id": {{ACTION_ID}},
      "name": "Create TradeLicense",
      "url": "/tl-services/v1/_create",
      "parentModule": "",
      "displayName": "Create TradeLicense",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "tl-services",
      "code": "null",
      "path": ""
}

Add the role action mapping

{
      "rolecode": "EMPLOYEE",
      "actionid": {{ACTION_ID}},
      "actioncode": "",
      "tenantId": "pb"
    }

(The details about the fields in the configuration can be found in the swagger contract)

Integration Details

Integration Scope

Any microservice which requires authorisation can leverage the functionalities provided by access control service.

Integration Benefits

Any new microservice that is to be added in the platform won’t have to worry about authorisation. It can just add it’s role action mapping in the master data and Access Control Service will perform authorisation whenever API for the microservice is called.

Steps to Integration

1. To integrate with Access Control Service the role action mapping has to be configured(added) in the MDMS service.

2. The service needs to call /actions/_authorize API of Access Control Service to check for authorisation of any request

Interaction Diagram

Reference Docs

Doc Links

API List

(*POSTMAN COLLECTION HAS TO BE UPDATED)

Overview

Version 2.0 of 'Water & Sewerage' product allows the user to Apply for a New Water/Sewerage connection online. A citizen can apply for a new Water/ Sewerage connection Individually or in an Integrated manner. Citizen will receive a text and in-app notification on each step of the workflow. The Applications can be tracked online, in the 'My Applications' section provided to the citizen. Online application payment, send back to the citizen are some other features available for the citizen. Employees can search and process the application filed by the citizen. Some other features are workflow approval process, application payment collection etc.

Release Highlights

1. W&S and Property integration, while applying for a New connection

2. Generation of artefacts at a desired stage of the application (For eg. Generation of 'estimation notice' after the 'field inspector' approves the application)

3. 'Send back' as a workflow step to facilitate employees to carry out, the desired correction in the application

4. Separate 'Search' for 'Connections' and 'Applications' on Employee side

5. Apply for an Integrated connection and track the applications individually (Configurable workflow and calculation logic)

6. The citizen can manage applications in the 'My Application' section also make payment for the application online.

7. Capture plumber information

8. Usage of Property ontology to cater to diverse use cases (For eg. Water/Sewerage connections for Institutional, Commercial properties etc.)

Release Features

The W&S Version 2.0 release is equipped to allow citizens and employee to create an application for new water and sewerage connection online. The application is designed to facilitate the following affordance:

• Apply for water/sewerage connections including metered and non metered connection

• Addition of rebate/penalty on the employee side to cater use cases pertaining to the presence of any schemes

• Linkage of Property and W&S connection for a user

• Configurations available

  • Workflow actions and steps for application processing

  • Calculation logic for water and sewerage estimated demand

  • Estimation notice and sanction letter format

Notifications format

Known Issues

• 'Property Type' localization value missing

• Owner details, in case of multiple owners, need to refresh for getting other names

• Not able to find Jalandhar property, Not working for Nawashahr as well (For both citizen and employee)

  • PB-PT-2020-04-04-004623 (Nawashahr)

  • PB-PT-2020-03-23-004500 (Jalandhar)

• Displaying random value in case of multiple owners

• Connection details missing from the Application summary page

• Incorrect names and random DOB value in Application summary page

• Application-based on the same property has different values for "Rainwater harvesting": Sewerage application: SW_AP/1013/2020-21/062956 Water application: WS_AP/1013/2020-21/062955

• Application forms PDFs for the applications mentioned above have incorrect values for mentioned fields

  • No. of floors (It is not captured as a part of the property in case of Flat/part of a building, so this value is random)

  • Property Sub Usage type

• After submission of the application by the counter employee,

  • Downloaded application PDF did not have meter installation date value, which was not also filled in the first place,

  • Task details page of Doc verifier is displaying a random date for the meter installation date

  • Downloaded application PDF by doc verifier still doesn't have the meter installation date

• No download/Print option to DV, FI, AP after submission (Artifacts are needed to be downloaded)

• Metered connection getting executed without initial meter reading

Upcoming Release Feature

Reference Doc Links

Overview

This service is used to issue a license to the user after verification. The service is designed in such a way that it can be used to serve different type of licenses. Currently used to issue trade licenses, perform stakeholder registration and issue lockdown pass. The service is integrated with workflow where we can define the steps for approval of the application. Once the application is approved the license is generated.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

• Java 8

• Kafka server is up and running

• egov-persister service is running and has tl-services persister config path added in it

• PSQL server is running and database is created

Key Functionalities

• Used for license generations in trade licenses, stakeholder registration and issue lockdown pass

• Define roles to applicants on successful application to access Building Plan Approval services at the time of stakeholder registration

• Generate application number and license number

• Support workflows

• Provide notification on various status changes for an application

Interaction Diagram

Deployment Details

1. Add MDMS configs required for Trade License and BPA stakeholder registration and restart MDMS service

2. Deploy the latest version of tl-services service

3. Add tl-service persister yaml path in persister configuration and restart persister service

4. Add Role-Action mapping for API’s

5. Create businessService (workflow configuration) according to trade license and stakeholder registration

6. Add tl-service indexer yaml path in indexer service configuration and restart indexer service

Configuration Details

Following application properties in the Trade License service are configurable.

Integration

Integration Scope

The trade-license service is currently used to issue trade licenses, perform stakeholder registration and issue lockdown pass.

Integration Benefits

• Provide backend support for the different license registration process.

• Mseva and SMS notifications on application status changes.

• The elastic search index for creating visualizations and Dashboards.

• Bpa Stakeholder registration provides new roles to the user to access the Building Plan Approval system.

• Supports workflow which is configurable

Steps to Integration

1. To integrate, host of tl-services service should be overwritten in the helm chart.

2. {servicename}/_create/ _create should be added as the create endpoint for creating any license in the system

3. {servicename}/_search/ _search should be added as the search endpoint. This method handles all requests to search existing records depending on different search criteria

4. {servicename}/_update/ _update should be added as the update endpoint. This method is used to update fields in existing records or to update the status of the application based on workflow.

Reference Docs

Doc Links

API List

In all below endpoints if the service name is BPAREG it is treated as a stakeholder registration application and if it is TL or if it is absent then the application is treated as trade license application.

Overview

One of the applications in the Digit core group of services aims to reduce the time spent by developers on writing codes to store and fetch master data ( primary data needed for module functionality ) which doesn’t have any business logic associated with them. Instead of writing APIs, creating tables in every different service to store and retrieve data that is seldom changed MDMS service keeps them at a single location for all modules and provides data on will with the help of no more than three lines of configuration.

Pre-requisites

1. Prior Knowledge of Java/J2EE.

2. Prior Knowledge of Spring Boot.

3. Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.

4. Prior knowledge of Git.

5. Advanced knowledge on how to operate JSON data would be an added advantage to understand the service.

Key Functionalities

• Adds master data for usage without the need to create master data APIs in every module.

• Reads data from GIT directly with no dependency on any database services.

Deployment Details

1. Deploy the latest version of Mdms-service

2. Add conf path for the file location

3. Add master config JSON path

Integration Details

Integration Scope

The MDMS service provides ease of access to master data for any service.

Integration Benefits

• No time spent writing repetitive codes with no business logic.

Steps to Integration

1. To integrate, host of egov-mdms-service should be overwritten in helm chart

2. egov-mdms-service/v1/_search should be added as the search endpoint for searching master data.

3. Mdms client from eGov snapshots should be added as mvn entity in pom.xml for ease of access since it provides mdms request pojos.

Reference Docs

API List

Citizens and CE

Citizens represent individuals, communities, or business entities who are the system end-users. The PT module allows property owners to register their property details online. These details are then used for various property-related transactions.

The citizen can also approach the Counter Employee (CE) to register new property, assess property or pay property tax.

The Citizen or CE role can -

• Add new property

• Edit property

• Search property

• Assess property

• Re-assess property

• Transfer property

• Pay property tax

• Download payment receipts

Add New Property

Citizens or CE can add new property details through the DIGIT web portal or the DIGIT mobile app.

To add a new property click on the Property Tax card available in the Citizen Services section of the Home page.

Click on the Add New Property button on the screen. This will open a new form page.

The system will display the Required Documents - Property Tax list. Note the list of documents valid for address, identity, registration, usage, special category, and occupancy proofs.

Click on the Print button to get a hard copy of the documents list for reference. Click on the Apply button to proceed with adding your property. The form sections are available on the top of the page.

Add Property Form Sections

The add property form page contains various sections that include

• Property Address

• Property Details

• Owner Details

• Document Info

• Summary

Enter the following information in the Property Address section.

The system will display the New Property form page.

The City field displays the registered city by default. Click on the drop-down list to select a different city. Enter the House/Shop No., Building/Colony Name, Street Name, Locality/Mohalla, and the Pincode. Enter the Existing Property ID in case there is a legacy property ID available for the listed property.

Click on the Next button to move to the next section.

Enter the following details in the Property Details section

Select the applicable Property Usage Type and the Property Type from the drop-down list available.

Check Yes or No to indicate Whether rainwater harvesting structure provided on the property? Enter Vasika No. and Vasika Date if applicable. Enter Allotment Letter No. and Allotment Date if applicable.

Enter Firm/Business Name if the property is listed as commercial or institutional. Enter any information in the Remarks field. Check the box Do you have any inflammable material stored on your property? if it is true. Check the box adjacent to Height of property more than 36 feet? if it is true. Fill in the Unit details if the selected property usage type is Commercial, Institutional, Other Non-Residential, or Residential.

The Unit Usage Type by default accepts the Property Usage Type value. Select the applicable Sub Usage Type for the listed property in case of Commercial or Institutional properties. Select the most applicable option for the type of Occupancy. Enter the Built-up-area (sq ft) value of the property. Select Floor to identify the relevant floor of the property. Click on +Add One More Unit button to add more units.

Click on the Next button to proceed to enter the Owner Details.

Enter the following information in the Owner Details section. Select the relevant Type of Ownership. Enter the Owner’s Name.

Check the applicable Gender of the owner. Enter the owner’s Mobile No. and Guardian’s Name. Select Relationship of the owner with the guardian. Enter the applicable Special Category. Enter the owner’s Email Id and the Correspondence Address. Check the Same as property address box if the correspondence address is the same as the address of the listed property. The Correspondence Address field is auto-populated in that case.

Click on the Next button to move to the Documents section.

Upload the required documents in the Documents section of the application form. In the Select Document field, select the type of document you are uploading for Address Proof, Identity Proof, Registration Proof, Usage Proof, and Construction Proof.

Click on the Upload File button to upload the documents.

Click on the Next button to proceed to the next section.

Click on the Add Property button once the details are reviewed and corrected. The system displays the New Property Successfully Added acknowledgement message.

The Property ID is available along with this message.

Click on the Download button on top of the message box to download the application. Click on the Print button to print the application.

Search Property

To search for a submitted application or track the status of submitted applications navigate to the Property Tax home page. There are two search options available. Users can search by property or application.

To Search by Property click on the Search Property tab. Enter the ULB. The system displays the registered City or ULB details by default. Enter any of the following search parameters or combinations to refine the search for property. Enter the Owner Mobile No. or the Unique Property ID allotted by the system. Enter the Existing Property ID if there is any legacy ID linked to the property.

Click on the Search button to view the results. Click on the Reset button to renew search with different parameters.

To Search by Application click on the Search Application tab.

Enter any of the following search parameters or combinations to refine the search for property. Enter the Application No. or the Owner Mobile No. or the Unique Property ID.

Click on the Search button to view the search results. Click on the Reset button to renew search with different parameters.

The search results show the filtered list of property entries along with the application Status.

An Active Status means the listed property is pending for further action. Inworkflow status means there is some action going on for the listed property and hence it is not accessible for any other action. Once the action is complete the status will change to Active.

Click on the Unique Property ID or Application No. hyperlink to access the property details.

Assess Property

Listed properties are assessed every financial year to calculate the property tax amount.