Details coming soon...

• Always define the Yaml for your APIs as the first thing using Open API 3 Standard (https://swagger.io/specification/)

• APIs path should be standardised as follows:

  • /{service}/{entity}/{version}/_create: This endpoint should be used to create the entity

  • /{service}/{entity}/{version}/_update: This endpoint should be used to edit an entity which is already existing

  • /{service}/{entity}/{version}/_search: This endpoint should be used to provide search on the entity based on certain criteria

  • /{service}/{entity}/{version}/_count: This endpoint should be provided to give a count of entities that match a given search criteria

• Always use POST for each of the endpoints

• Take most search parameters in the POST body only

• If query params for search need to be supported then make sure to have the same parameters in POST body also and POST body should take priority over query params

• Provide additional Details objects for _create and _update APIs so that the custom requirements can use these fields

• Each API should have a RequestInfo object in request body at the top level

• Each API should have a ResponseInfo object in response body at the top level

• Mandatory fields should be minimum for the APIs.

• minLength and maxLength should be defined for each attribute

• Read-only fields should be called out

• Use common models already available in the platform in your APIs. Ex -

  • Address

  • User(Citizen or Employee or Owner)

  • Role

  • AuditDetails

  • ErrorRes (Response sent in case of errors)

  • TODO: Add all the models here

• For receiving files in an API, don’t use binary file data. Instead, accept the file store ids

• If there is only one file to be uploaded and no persistence is needed, and no additional json data is to be posted, you can consider using direct file upload instead of using filestore id

APIs developed on digit follow certain conventions and principles. The aim of this document is to provide some do’s and don’ts while following those principles

Details coming soon...

Overview

Through report service, useful data get shown for a specific module based on some given criteria like date, locality, financial year, etc.

For example, PT dump report of property tax service you have to select from date to date, financial year etc and based on the criteria we can see all the data full filling the criteria. In the response we see all the details of a property which is paid between the given from date and to date, if we selected financial year then we can see the property which is paid for that specific financial year.

Pre-requisites

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

• User with permissions to edit the git repository where Reports are configured and knowledge on YAML.

• Prior Knowledge of YAML.

• Prior Knowledge of SQL queries.

• Prior Knowledge of the relation between the tables for which module you are going to write a report.

Key Functionalities

• User can write queries (like SQL queries) for fetching the real-time data to display in a UI application.

• User can apply filters like from date, to date, financial year, etc based on the report configuration.

• User can download the result in PDF and XLS format.

• User can select or deselect the columns user wants to see.

• User can choose the number of records he/she wants to see on a page.

Deployment Details

1. Once the changes have been done in the report configuration file we have to restart the report service so the report service will read the new configuration.

Configuration Details

• To add a new report first add the file path in the reportFileLocationsv1[https://raw.githubusercontent.com/egovernments/configs/DEV/reports/reportFileLocationsv1.txt] (In this file, the path of the report configuration files get stored).

  • <Module Name>=file:///work-dir/configs/reports/config/<report file name>.yml

  • ex: pgr=file:///work-dir/configs/reports/config/pgr-reports.yml

• Write the report configuration. Once it is done commit those changes.

• Add the role and actions for the new report.

• Restart the MDMS and report service.

Reference Docs

Doc Links

This section contains docs that walk you through the various steps required to configure DIGIT services.

• API Do's And Dont's

• Setting Up Service Locally

• Configuring Reports

• Customizing PDF Notices And Certificates

Overview

Configuring Report for a module requires adding the required report configuration as per the standard format and with the minimum development time.

UI can have different types of filters such as date, dropdown etc.. and even the sum of a column can also be easily displayed in UI. Pagination and downloading the report in pdf format, xls format is already present in the report UI.

Type of Reports which can be configured :

1. Count of applications

2. Statewide collections

3. Application status

4. Cancelled receipts

5. Migrated records / Data entry records

Limitation of this framework is for reports having requirements with complex queries with multiple joins as the report uses the query to fetch the data from the database, It is resource-intensive and response might be slow in those scenarios.

Pre-requisites

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

• User with permissions to edit the git repository to add the report configuration

• User with permissions to add action and role action in the mdms

Key Functionalities

• Showcase the data in the required and cleaner format.

• The UI is rendered with the help of configuration in the report and there is no extra effort in building UI for different reports.

• For Implementation specific report requirements, customization is easy and turn around time is less.

Deployment Details

1. After adding the new report/ editing existing report configuration in the respective module, the report service needs to be restarted.

Configuration Details

1. Create a reports.yml file and add report configuration as per standard format.

2. Add the action and role action in the mdms.

3. Add the github raw path of the report.yml file in the report.config file

Reference Docs

Doc Links