Works PDF

Overview

Works-PDF is an intermediary service that bridges the gap between the pdf-service and client requests. Within works-pdf, there are several APIs available for producing various PDFs. This service gathers data from multiple sources, amalgamates it, and then forwards the request to the PDF service for PDF generation.

Further, Works PDF can produce an Excel file when a payment is initiated. It actively listens to the "expense-payment-create" topic, capturing relevant payment data to trigger this process.

Dependency

  • MDMS

  • PDF

  • Project

  • Estimates

  • Muster Roll

  • Contract

  • Organization

  • Localization

  • Expense

  • Expense calculator

  • Bank account

  • Filestore

Key Functionalities

  • The system retrieves data from various sources to create multiple PDFs such as estimates, muster reports, and project documents.

  • When a payment is generated, it produces Excel files corresponding to the payment bills. This is triggered by a payment creation event communicated through a topic.

  • Users also have the option to recreate the Excel files for a specific payment using the same payment ID. This functionality allows for the regeneration of payment-related Excel documents.

Code

Works-PDF

Deployment

  • Environment

    • Add all pdf configurations under pdf-service data config and format config

    • Add file type 'application/zip' under xlsx format in egov-filestore allowed-file-formats-map.

PDF Configuration

Role Action

API EndPointsRoles

/egov-pdf/download/estimate/estimates

ESTIMATE_CREATOR

ESTIMATE_VERIFIER

TECHNICAL_SANCTIONER

ESTIMATE_APPROVER

ESTIMATE_VIEWER

/egov-pdf/download/musterRoll/muster-roll

MUSTER_ROLL_APPROVER

ORG_ADMIN

MUSTER_ROLL_VERIFIER

/egov-pdf/download/project/project-details

PROJECT_VIEWER

/egov-pdf/download/workOrder/work-order

ORG_ADMIN

WORK_ORDER_VIEWER

WORK_ORDER_APPROVER

/egov-pdf/bill/_generate

BILL_ACCOUNTANT

/egov-pdf/bill/_search

BILL_ACCOUNTANT

Create Account For Deductions

Create accounts for purchase and wage bills, for head codes where the category is deduction.

Example: Below is the head code object:

{
      "id": "5",
      "code": "LC",
      "category": "deduction",
      "service": "works.purchase",
      "description": "Labour Cess",
      "active": true,
      "effectiveFrom": 1682164954037,
      "effectiveTo": null
}

Where tenantId is pg.citya

The format of referenceId is Deduction_{tanentId}_{headcode}

Then create a bank account with the field referenceId value Deduction_pg.citya_LC

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.