PDF Generation Service

Overview

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

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.

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.

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

PDFMake: (https://github.com/bpampuch/pdfmake - Connect to preview ):- 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

Create data config and format config for a PDF according to product requirement.
Add data config and format config files in PDF configuration
Add the file path of data and format config in the environment yml file
Deploy the latest version of pdf-service in a particular environment.

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

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.

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.

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)