> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/local-governance/v2.7/platform/configure-digit/services-overview/core-services/pdf-generation-services.md).

# PDF Generation Service

## Overview <a href="#overview" id="overview"></a>

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

## Pre-requisites <a href="#pre-requisites" id="pre-requisites"></a>

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 to it.
* PSQL server is running and the database is created to store the filestore id and job id of generated pdf.

## Key Functionalities <a href="#key-functionalities" id="key-functionalities"></a>

* Provide a common framework to generate PDFs.
* 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 the maximum number of records to be written in one PDF.

| Environmental Variables       | Description                                                                        |
| ----------------------------- | ---------------------------------------------------------------------------------- |
| MAX\_NUMBER\_PAGES            | Maximum number of records to be written in one PDF                                 |
| DATE\_TIMEZONE                | Date timezone which will be used to convert epoch timestamp into date (DD/MM/YYYY) |
| DEFAULT\_LOCALISATION\_LOCALE | Default value of localisation locale                                               |
| DEFAULT\_LOCALISATION\_TENANT | Default value of localisation tenant                                               |
| DATA\_CONFIG\_URLS            | File path/URL'S of data config                                                     |
| FORMAT\_CONFIG\_URLS          | File path/URL'S of format config                                                   |

#### External Libraries: <a href="#external-libraries-used" id="external-libraries-used"></a>

* **PDFMake: (**[<img src="https://github.githubassets.com/favicon.ico" alt="" data-size="line">https://github.com/bpampuch/pdfmake - Connect to preview](https://github.com/bpampuch/pdfmake) **):-** for generating PDFs
* **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 <a href="#interaction-diagram" id="interaction-diagram"></a>

![](/files/-MMu616__NjQnmqEap-J)

## Deployment Details <a href="#deployment-details" id="deployment-details"></a>

1. Create data config and format config for a PDF according to product requirements.
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 <a href="#configuration-details" id="configuration-details"></a>

For Configuration details please refer to [**Customizing PDF Receipts & Certificates.**](/local-governance/v2.7/platform/configure-digit/configuring-digit-services/customizing-pdf-notices-and-certificates/customizing-pdf-receipts-and-certificates.md)

## Integration Details <a href="#integration" id="integration"></a>

### Integration Scope <a href="#integration-scope" id="integration-scope"></a>

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

### Integration Benefits <a href="#integration-benefits" id="integration-benefits"></a>

* 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 <a href="#steps-to-integration" id="steps-to-integration"></a>

* To download and print the required PDF \_create API has to be called with the required key (For *i*ntegration with UI, please refer to the links in Reference Docs)

## Reference Docs <a href="#reference-docs" id="reference-docs"></a>

### Doc Links <a href="#doc-links" id="doc-links"></a>

| Description                                                   | Link                                                                                                                                                                                                                              |
| ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Customizing PDF Receipts & Certificates                       | [Customizing PDF Receipts & Certificates](/local-governance/v2.7/platform/configure-digit/configuring-digit-services/customizing-pdf-notices-and-certificates/customizing-pdf-receipts-and-certificates.md)                       |
| Steps for Integration of PDF in UI for download and print PDF | [Integration of PDF in UI for download and print PDF](/local-governance/v2.7/platform/configure-digit/configuring-digit-services/customizing-pdf-notices-and-certificates/integration-of-pdf-in-ui-for-download-and-print-pdf.md) |
| API Swagger Documentation                                     | [Swagger Documentation](https://app.swaggerhub.com/apis/eGovernment/pdf-service_ap_is/1.1.0)                                                                                                                                      |

### API List <a href="#api-list" id="api-list"></a>

| Description                     | Link                                                          |
| ------------------------------- | ------------------------------------------------------------- |
| *pdf-service/v1/\_create*       | <https://www.getpostman.com/collections/5a9bfd6fd03f9f2a6fad> |
| *pdf-service/v1/\_createnosave* | <https://www.getpostman.com/collections/5a9bfd6fd03f9f2a6fad> |
| *pdf-service/v1/\_search*       | <https://www.getpostman.com/collections/5a9bfd6fd03f9f2a6fad> |

*(Note: All the APIs are in the same postman collection, therefore, the same link is added in each row)*

[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/)All content on this page by [eGov Foundation ](https://egov.org.in/)is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digit.org/local-governance/v2.7/platform/configure-digit/services-overview/core-services/pdf-generation-services.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.