Skip to main content

Jasper Print Service Implementation

1. Overview

Jasper Print Service is used to generate bills, vouchers, and other system documents using predefined Jasper report formats.

There are two approaches to implementing Jasper Print Service, depending on the document type:

  1. Local Jasper Service – Used for Billing.

  2. Cloud Jasper API – Used for other system vouchers.

Each approach has different installation, configuration, and connectivity requirements.


2. Billing – Local Jasper Service

For billing, Jasper Print Service must be installed on the local PC where the billing operation is performed.

2.1 Installation and Configuration

  1. Install the Jasper Print Service on the local PC.

  2. The service will run on a designated local port.

  3. Open the service URL in a web browser using the configured port.

  4. The Jasper configuration interface will be displayed.

  5. From this interface, users can:

    • Upload Jasper report formats.

    • Configure report-related settings.

    • Manage the available Jasper templates.

2.2 Workflow

  1. The user initiates the billing operation.

  2. The system communicates with the locally installed Jasper service.

  3. Jasper processes the configured report format.

  4. The generated bill is returned for printing.

Requirement: The local Jasper service must be installed and running on the billing PC.


3. Other System Vouchers – Cloud Jasper API

For other system vouchers, Jasper Print Service is accessed through a cloud-based API.

Unlike billing, this approach requires an active internet connection because the system communicates with the cloud Jasper API.

3.1 Prerequisites

Before implementation, obtain the following information from the Senior Team:

  • Cloud Jasper API URL.

  • Pre-generated UUID.

{"url":"here_url","token":"here_uuid"}

These credentials are required to configure the Jasper Print Service in the application.

3.2 Jasper API Configuration

Follow these steps to configure the cloud Jasper service:

  1. Open the application.

  2. Navigate to Application → Key Manager.

  3. Select the following type:

    Type: Jasper Print Service

  4. Enter the Cloud Jasper API URL provided by the Senior Team.

  5. Enter the pre-generated UUID.

  6. Save the configuration.

Once saved, the application can use the configured cloud Jasper API.

3.3 Voucher Template Configuration

Each module provides its own Jasper configuration under the Setup section.

To configure a Jasper voucher:

  1. Navigate to the required module.

  2. Open its Setup section.

  3. Locate the Jasper configuration option.

  4. Paste the required Jasper report code/template.

  5. Save the configuration.

Repeat this process for each module and voucher that requires Jasper printing.

3.4 Workflow

The communication flow for cloud-based voucher printing is:

Client PC → System API → Cloud Jasper API → System API → Client PC

Step-by-step process:

  1. The user initiates voucher printing from the client PC.

  2. The client PC sends a request to the System API.

  3. The System API retrieves the configured Jasper API URL and UUID.

  4. The System API sends the printing request to the Cloud Jasper API.

  5. The Cloud Jasper API processes the supplied Jasper report template and data.

  6. The generated report is returned to the System API.

  7. The System API returns the generated report to the client PC.

  8. The client PC displays or prints the voucher.

Requirement: An active internet connection and valid Cloud Jasper API configuration are necessary.


4. Implementation Comparison

ParticularsBillingOther Vouchers
Jasper serviceLocal serviceCloud API
InstallationRequired on local PCNot required on client PC
InternetNot necessarily requiredRequired
ConfigurationLocal browser interfaceApplication Key Manager
API credentialsLocal service configurationURL and UUID
Template managementLocal Jasper interfaceModule Setup section
CommunicationClient PC → Local JasperClient PC → System API → Cloud Jasper API

5. Important Notes

  • The local Jasper service must be running before generating bills.

  • The local service port must be correctly configured.

  • The Cloud Jasper API URL and UUID must be obtained from the Senior Team.

  • Do not use an unverified URL or UUID.

  • Each module's Jasper template must be configured separately where applicable.

  • Internet connectivity is necessary for cloud-based voucher printing.

  • Ensure the configured Jasper template matches the corresponding voucher structure and data requirements.


6. Support and Troubleshooting

IssueThings to Check
Billing report is not generatingCheck whether the local Jasper service is running.
Local Jasper interface is inaccessibleVerify the configured port and service status.
Cloud voucher is not generatingCheck internet connectivity and Cloud Jasper API URL.
API authentication failsVerify the UUID provided by the Senior Team.
Voucher format is incorrectVerify the Jasper template configured under the module's Setup section.
A particular module cannot printConfirm that its Jasper template has been configured and saved.

Document Purpose: This knowledge base serves as an implementation and configuration reference for Jasper Print Service across Billing and other system voucher modules.

Documented By : Sundar Mishra