Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Illustrative guide to using the citizen portal
Citizens represent individuals or communities who are the system end-users. The birth & death module provides the citizens with the scope to download certificates of birth & death registrations. The citizen can -
Login to the portal using a registered mobile number and the OTP.
Click on the Birth or Death card on the home page as required.
Click on the Download Certificates card.
Enter the mandatory fields like Date of Birth, Gender, and City. To find any specific application, use the filters in the advanced search option screen. Click Search Registry after entering the required filters.
The search results are populated based on the fields that you entered. Click on the Pay and Download button in the Action column of the search result.
Accept the declaration by ticking the check box. Click on PROCEED.
Review the Payment Information on the next screen. Click on MAKE PAYMENT.
Proceed to make the payment through the payment gateway. After the payment is completed, a success message is displayed on the screen. Click on the Download button on the top right corner and then click on Download Certificate. Click on the Print button to print the certificate.
Clicking on the Download button redirects to the Search Receipts screen. Select Birth Certificate from the drop-down in the Service Category field and click on SEARCH. The list of payment receipts linked to the selected service category is displayed.
Click on the Birth or Death card on the home screen. Click on the My Requests card.
All applications are listed on the screen. Click on the DOWNLOAD CERTIFICATE option to download the certificate. Click on the GET RECEIPT option to download the receipts.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Illustrative guide to the employee portal
The Registrars/concerned employees receive the birth or death records from the hospitals, morgues, or other concerning bodies, and they create registrations through the system.
The employees can -
View reports
Log in as an employee for the Birth or Death Module viewer role.
Click on the Birth Certificate card on the home screen.
Enter the mandatory fields in the Search Registry like the Date range and the City.
Use the advanced search options to find specific applications.
Click on the link titled View for the desired application from the search result.
The Registration Details with all the information related to the concerned registrations are displayed on the screen.
Click on the printer icon in the search results page in the top right corner.
A list of all the registrations for the applied date filter is displayed and is available to download and print.
Log in as an employee for the Birth or Death Module Creator role.
Click on the Birth Certificate option in the side panel.
Click on Birth Registration when the side panel expands.
Fill in the required fields on the registration details page. All fields marked with (*) are mandatory.
Enter the Father’s and Mother’s Information for birth certificate registration.
Enter the Address of Parents at the Time of Birth and the Permanent Address of Parents. Enter Informant’s Information if applicable.
Click on the Submit button once all details are filled in and reviewed.
Click on Proceed to submit and Cancel to go back to edit the registration.
The registration is completed successfully.
Log in as an employee for the Birth or Death Module Editor role.
Enter the date range and City on the search page. Click on Search Registry. The relevant applications are listed on the screen. Click on the View option next to the desired application to make edits.
The corresponding registration details are displayed. Click on the Edit button on the top right corner of the page.
Tick the check box saying This is a Legacy Record. Proceed to make the edits in the registration form as required and click on Update. The previous record is now updated.
The Birth & Death module allows citizens to download birth & death certificates and pay for the service as well.
The module supports the following key functions -
Download and print QR code-enabled birth & death certificates, and payment receipts
Make payments for downloading certificates online
View previous applications history
Create birth & death registrations based on the records received from hospitals
Make edits to the legacy records of birth & death registrations
Filter and view applications of birth & death registrations
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.
User Role | Scope of Action | Role Description |
---|
This section of the user manual guides you through the user login process. Citizens can sign up to use the birth & death module through the online web portal or the mobile application login interface.
This section guides you through the details of using the birth & death module for each role. Click on the relevant role below to learn more about how to use the birth & death system.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by is licensed under a .
Citizen | Download birth & death certificates Make payments online for downloading certificates View details for previous applications | Individuals and society groups/communities |
Employee | Create birth & death registrations Edit birth & death registrations Filter and view registrations View Reports | Registrars or other officials at government offices |
Technical Doc
There are two dimensions to DSS. The first refers to the process where the data is pooled into ElasticSearch and the second relates to the way the data is fetched, aggregated, computed, transformed and sent across.
The DSS processes are easily configurable and this enables users to configure new analytics insights using a wide range of data sets.
This document defines the configuration steps for fetching analytical insights on the DSS for the Birth & Death module.
Analytics: Micro Service responsible for building, fetching, aggregating and computing the data on ElasticSearch to a consumable data response. This is used for visualizations and graphical representations.
Analytics Configurations: Analytics contains multiple configurations. Add the changes related to Birth& Death in the dashboard analytics configuration file. File location : configs/egov-dss-dashboards/dashboard-analytics at qa · egovernments/configs List of configurations that need to be changed to run FSM successfully.
Chart API Configuration
Master Dashboard Configuration
Role Dashboard Mappings Configuration
Chart API Configuration: Each visualization has its own properties. The visualization is derived from different data sources or a combination of data sources.
The Chart API Configuration Document is used to configure each visualization and its properties. The Visualization Code is the key and its properties are easily configurable.
Sample ChartApiConfiguration.json data for Birth and Death.
Click here to check the complete configuration
Master Dashboard Configuration: Master Dashboard Configuration is the main configuration that defines the key insights and visualizations to be painted on the screen. It includes all the visualizations, the groups, the charts embedded within them and even the dimensions in terms of height and width.
Click here for the complete configuration
Role Dashboard Mappings Configuration: Master Dashboard configuration explained earlier contains the list of available dashboards. Map the roles to specific dashboard views based on the user role requirements. The configuration allows each role to be mapped to authorized dashboard views.
Click here to check the configuration
MDMS configuration to be added: common-masters/uiCommonConstants.json
Click here to check the complete configuration
roleaction.json
Click here to check the complete configuration
Action test.json:
Click here to check the complete configuration
Birth and Death - State DSS contains multiple graphs which represent the data of Birth and Death. Each graph has its own configuration which will describe the chart and its type.
State DSS contains the following charts in the Birth & Death module:
Birth and Death Page
Birth:
Overview
Certificates Download Trend
Downloads by Channel
Births by Gender
Certificate Downloads by Boundary
Overview: The overview graph contains multiple data information as below in the selected time period.
Total Certificate Downloads: This represents the total number of birth certificates downloaded.
Total Collection: Total revenue collected for downloading birth certificates for the applied date filter.
Certificates Download Trend: This is a line graph that shows total birth certificates downloaded for a given month, total Birth Certificates downloaded for the applied date filter.
line - this graph/chart is data representation on date histograms or date groupings.
Downloads by Channel: This is a pie chart where total birth certificate downloads are bifurcated by channel (Mobile App, Web etc.)
Births by Gender: A pie chart illustrating the total births registered are bifurcated by gender
Certificate Downloads by Boundary: This tabular chart representation graph shows multiple Birth information like Total Downloads (Mobile App), Total Downloads (Web), Total Downloads, Delayed Registrations. And this table shows the data in DDR level and also has the drill down chart for each state to ulb and from ulb to ward level data for the same.
xtable type adds multiple computed fields with the aggregated dynamic fields.
To add multiple computed columns -
provide the actionName in the following format - actionNameComputedField<T> interface
provide the fields [] names as it exists in the query key
provide the newField as a name to reflect the computed details
Clicking on any DDR name offers a drill-down chart that represents the specific state data.
Clicking on the ULB navigates to show the data at the ward level.
Death:
Overview
Certificates Download Trend
Downloads by Channel
Deaths by Age Category
Certificate Downloads by Boundary
Overview: The overview graph contains multiple data information as below in the selected time period.
Total Certificate Downloads: This represents the total number of death certificates downloaded.
Total Collection: Total revenue collected for downloading death certificates for the applied date filter.
Certificates Download Trend: A line graph that shows the total death certificates downloaded for a given month, and total death Certificates downloaded for the applied date filter.
line - this graph/chart is data representation on date histograms or date groupings.
Downloads by Channel: This is a pie chart where total death certificate downloads are bifurcated by channel (Mobile App, Web etc.)
Deaths by Gender: This will be a split bar graph where total deaths registered will be bifurcated by age category (< 2 years, 2-15, 15-29, 30-44, 45-59, 60-74, >= 75) and each bar will show gender wise split
Clicking on any Category name drills down to charts that provide specific age group data.
Certificate Downloads by Boundary: This tabular chart representation graph shows multiple Birth information like Total Downloads (Mobile App), Total Downloads (Web), Total Downloads, and Delayed Registrations. And this table shows the data at the DDR level and also has the drill-down chart for each state to ULB and from ULB to ward level data for the same.
xtable type allows to add multiple computed fields with the aggregated fields dynamically added.
To add multiple computed columns, computedFields [] where actionName (IComputedField<T> interface), fields [] names as in exist in query key, newField as name to appear for computation must be defined.
Clicking on any DDR name provides the drill-down charts that represent state-specific data.
Clicking on the ULB navigates to wards under that specific ULB and each ward shows the specific data regarding that ward.
isRoundOff: This property is introduced to round off the decimal values. Ex: if the value is 25.43 by using the isRoundOff property in the configuration we will get it as 25. if the value is 22.56 round of value will be 23. This can be used for insights configuration as well for overview graphs.
Key(eg: fsmTotalrequest): This is the Visualization Code. This key will be referred to in further visualization configurations.
This is the key which will be used by the client application to indicate which visualization is needed for display.
chartName: The name of the Chart which has to be used as a label on the Dashboard. The name of the Chart will be a detailed name.
In this configuration, the Name of the Chart will be the code of Localization which will be used by the Client Side.
queries: Some visualizations are derived from a specific data source. While some others are derived from different data sources and are combined together to get a meaningful representation.
The queries of aggregation which are to be used to fetch out the right data in the right aggregated format are configured here.
queries.module: The module/domain level, on which the query should be applied on. Birth and Death is birth-death.
queries.indexName: The name of the index upon which the query has to be executed is configured here.
queries.aggrQuery: The aggregation query in itself is added here. Based on the Module and the Index name specified, this query is attached to the filter part of the complete search request and then executed against that index
queries.requestQueryMap: Client Request would carry certain fields which are to be filtered. The parameters specified in the Client Request are different from the parameters in each of these indexed documents.
In order to map the parameters of the request to the parameters of the ElasticSearch Document, this mapping is maintained.
queries.dateRefField: Each of these modules have separate indexes. And all of them have their own date fields.
When there is a date filter applied against these visualizations, each of them has to apply it against their own date reference fields.
In order to maintain what is the date field in which index, we have this configured in this configuration parameter.
chartType: As there are different types of visualizations, this field defines what is the type of chart/visualization that this data should be used to represent.
metric - this represents the aggregated amount/value for records filtered by the aggregate es query
pie - this represents the aggregated data on grouping. This is can be used to represent any line graph, bar graph, pie chart or donuts
line - this graph/chart is data representation on date histograms or date groupings
perform - this chart represents groping data performance-wise.
table - represents a form of plots and values with headers as grouped on and a list of its key, values pairs.
xtable - represents an advanced feature of the table, it has the addition capabilities for adding dynamic header values.
valueType: In any case of data, the values which are sent to the plot, might be a percentage, sometimes an amount and sometimes it is just a count.
In order to represent them and differentiate the numbers from the amount from the percentage, this field is used to indicate the type of value that this Visualization will be sending.
action: Some of the visualizations are not just aggregations of data sources. There might be some cases where we have to do a post-aggregation computation.
For Example, in the case of the Top 3 Performing ULBs, the Target and Total Collection are obtained and then the percentage is calculated. In these kinds of cases, the action that has to be performed on the data obtained is defined in this parameter.
documentType: The type of document upon which the query has to be executed is defined here.
drillChart: If there is a drill down on the visualization, then the code of the Drill Down Visualization is added here. This will be used by Client Service to manage drill-downs.
aggregationPaths: All the queries will be having Aggregation names in them. In order to fetch the value out of each Aggregation Responses, the name of the aggregation in the query will be an easy bet. These aggregation paths will have the names of Aggregation in them.
insights: It is to show the data with the comparison of last year with arrow symbols, it will show the data in how much % is increased or decreased.
_comment: In order to display information on the “i” symbol of each visualization, Visualization Information is maintained in this field.
The index that contains data for State-Birth and Death are - birth-cert-v1, death-cert-v1
The mapping for this index is:
Birth
Death
https://www.getpostman.com/collections/a6622af87bd5346d11fc
Objective:
Register the Birth and death information of the citizen into the system.
To Correct any wrong information which is captured earlier.
To enable citizens to search and download their respective certificates.
Both Birth and Death forms are quite similar.
MDMS details for hospitals:
Hospitals are configured at the city level.
Birth registration file link: frontend/mono-ui/web/rainmaker/dev-packages/egov-bnd-dev/src/ui-config/screens/specs/birth-employee/newRegistration.js
Death registration file link: frontend/mono-ui/web/rainmaker/dev-packages/egov-bnd-dev/src/ui-config/screens/specs/death-employee/newRegistration.js
Filename: newRegistrationFooter.js
It contains the logic related to the validation of the form, submission, and API call details.
APIs used -
Birth - Create and Update API
birth-death-services/common/saveBirthImport
birth-death-services/common/updateBirthImport
Death - Create and Update API
birth-death-services/common/saveDeathImport
birth-death-services/common/updateDeathImport
Search Certificate
Search certificate is the same for both employee and citizen.
The employee has view option. Whereas citizens can download for free for the first time. Second time downloads the citizen have to Pay & Download.
BIRTH_APPLICATION_CREATOR
& DEATH_APPLICATION_CREATOR
- the Birth Registration button is enabled on the search screen for this role.
Citizen View
API Details
birth-death-services/death/_search
birth-death-services/birth/_search
File Details -
Clicking on the Pay and download button - Generates demand for making a payment and after completing the payment it downloads the certificate automatically.
Auto download configuration file
postPaymentSuccess
method enables the auto-download.
Clicking on the Download button - searches for the filestore id and downloads the file.
birth-death-services/birth/_getfilestoreid?tenantId={{tenantid}}&consumerCode={{consumercode}}
birth-death-services/death/_getfilestoreid?tenantId={{tenantid}}&consumerCode={{consumercode}}
My Applications
Citizen
Citizens can download certificates and receipts from the My Applications screen.
How It Works Section
The How It works section shows the configured pdf to help citizens download certificates. Similarly in other environments, the same file is added to the Asset folder.
Also in Global config file
https://qa.digit.org/egov-qa-assets/globalConfigs.js
var assetS3Bucket = 'egov-qa-assets';
Refer to the Citizen User Manual for details.
Localization Module - rainmaker-bnd
This is the egov application, which helps and provides a digital interface, allowing employees/citizens for downloading Birth & Death Certificates. Employees can register both birth and death applications, and update and search where the citizen has an access to download the certificates. There are two processes while downloading the certificates citizen can download the certificate free for the first time and it will be charged for the next downloads so the citizen has to pay the amount and download the certificates.
The setup of the Application is as follows
Knowledge of Java/J2EE(preferably Java 8 version)
Knowledge of Spring Boot and spring-boot microservices.
Knowledge of Git or any version control system.
Knowledge of RESTful Web services.
Knowledge of the Lombok library will helpful.
knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-sms, eGov-email,eGov-user, eGov-localization, eGov-workflow-service will be helpful.
The BnD Module facilitates the citizen to search and download the certificate.
The BnD Module enables the counter employee to enter the details of Birth and Death using the Registration form.
The BnD Module provides a facility to the counter employee to search the details of registration and view the details of the registration.
The BnD Module provides a facility to anyone who has downloaded the certificate, to check the correctness of the certificate by scanning the QR Code.
The Application is present among the municipal services group of applications available in the eGov-services git repository with the folder name birth-death-services. The spring boot application needs the Lombok* extension added to your IDE to load it. Once the application is up and running API requests can be posted to the URL and ids can be generated.
in the case of IntelliJ, the plugin can be installed directly, for eclipse the Lombok jar location has to be added in the eclipse.ini file in this format javaagent:lombok.jar
Application.properties File Information:
kafka topics persister configs for eGov persister
persister.save.birth.topic=save-birth-topic
persister.update.birth.topic=update-birth-topic
URLs for the external API references:
eGvo mdms :-> egov.mdms.host = https://dev.digit.org/
eGov -idGen :-> egov.idgen.host = https://dev.digit.org/
localization service :-> egov.localization.host = https://dev.digit.org/
idGen Id formats :-> egov.idgen.birthapplnum.name=birth_cert.receipt.id egov.idgen.birthapplnum.format=BR/CB/01/2022-0/063768 egov.idgen.deathapplnum.name=death_cert.receipt.id egov.idgen.deathapplnum.format=DT/CB/01/2022-0/063767
Mdms configuration:
Action Test : URL Actions adding
Access to the Roles for the above Actions
Birth and Death Roles
Download receipt MDMS configuration to fetch the Birth and death in business service dropdown file link: RAIN-6838 :: BND Download receipt config updated typt to adhoc · egovernments/egov-mdms-data@bc9efec
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Please refer to Swagger API for YAML file details. Link -DIGIT-OSS/birth-death.yml at master · egovernments/DIGIT-OSS
API
ROLES
ACTION ID
egov-mdms-service/v1/_search
954
birth-death-services/death/_search
BND_CEMP
, CITIZEN
,DEATH_APPLICATION_VIEWER
,DEATH_APPLICATION_EDITOR
birth-death-services/birth/_search
BND_CEMP
, CITIZEN
,BIRTH_APPLICATION_VIEWER
,BIRTH_APPLICATION_EDITOR
birth-death-services/birth/_getfilestoreid
BND_CEMP
, CITIZEN
birth-death-services/death/_getfilestoreid
BND_CEMP
, CITIZEN
birth-death-services/common/saveDeathImport
BND_CEMP
,DEATH_APPLICATION_CREATOR
birth-death-services/common/updateDeathImport
BND_CEMP
,DEATH_APPLICATION_EDITOR
birth-death-services/common/saveBirthImport
BND_CEMP
,BIRTH_APPLICATION_CREATOR
birth-death-services/common/updateBirthImport
BND_CEMP
,BIRTH_APPLICATION_EDITOR