# 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 proceeding with the documentation, ensure the following prerequisites are met:

1. [Install](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04) *NPM*
2. Ensure the Kafka server is operational
3. Confirm that the [persister](/platform/platform/core-services/persister-service.md) service is running and configured with a [PDF generation](https://github.com/egovernments/configs/blob/DEV/egov-persister/pdf-generator.yml) persister [path](https://github.com/egovernments/DIGIT-DevOps/blob/1e3c8ee05ad312ab6cfa3811d71ae9c777ca0957/deploy-as-code/helm/environments/unified-dev.yaml#L476)
4. Verify that the PostgreSQL (PSQL) server is running, and a database is created to store filestore IDs and job IDs of generated PDFs
   * Note : Refer to this [document](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04) to know how to install postgreSQL locally and then creating a DB

## 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 or QR code in a PDF
* Provide functionality to generate PDFs in bulk
* Provide functionality to specify the maximum number of records to be written in one PDF

| Environment 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 used : <a href="#external-libraries-used" id="external-libraries-used"></a>

* **PDFMake: (**[![](https://github.githubassets.com/favicon.ico)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>

<figure><img src="/files/NIJB7rcxnNjf1NL49sRe" alt=""><figcaption></figcaption></figure>

## 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 yaml 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, refer to [Customizing PDF Receipts & Certificates](https://urban.digit.org/platform/configure-digit/configuring-digit-services/configuring-common-services/customizing-pdf-notices-and-certificates/customizing-pdf-receipts-and-certificates).

## 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.

### Integration Steps <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 Integration with UI, please refer to the links in Reference Docs)

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

## Play around with the API's : [DIGIT-Playground](https://digit-api.apidog.io/doc-507201)

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

| Title                                                                                                                                                                                                                                                                 |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Customizing PDF Receipts & Certificates](https://urban.digit.org/platform/configure-digit/configuring-digit-services/configuring-common-services/customizing-pdf-notices-and-certificates/customizing-pdf-receipts-and-certificates)                                 |
| [Steps for Integration of PDF in UI for download and print PDF](https://urban.digit.org/platform/configure-digit/configuring-digit-services/configuring-common-services/customizing-pdf-notices-and-certificates/integration-of-pdf-in-ui-for-download-and-print-pdf) |
| [API Swagger Documentation](https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/pdf-service/pdf-swagger-contract.yml)                                                                                                                       |

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

| Title                                                                                           |
| ----------------------------------------------------------------------------------------------- |
| [*`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)       |

{% hint style="info" %}
**Note:** All the APIs are in the same Postman collection, therefore, the same link is added in each row.
{% endhint %}


---

# Agent Instructions: 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:

```
GET https://docs.digit.org/platform/platform/core-services/pdf-generation-service.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.