Generate Word Reports with YARG in Spring Boot 3.2.5 – A Step-by-Step Guide

1. Introduction

Yet Another Report Generator (YARG) is an open‑source Java reporting library that can create documents in formats such as .docx, .xls, .html, .csv, etc., by filling templates with data loaded from SQL, Groovy or JSON. This article shows how to use a Spring Boot 3.2.5 @RestController to generate a .docx file from JSON data.

2. Practical Example

2.1 Add Maven Dependency

<dependency>
  <groupId>com.haulmont.yarg</groupId>
  <artifactId>yarg</artifactId>
  <version>2.2.14</version>
</dependency>
<repositories>
  <repository>
    <snapshots>
      <enabled>false</enabled>
    </snapshots>
    <id>repo-cuba-platform-work</id>
    <name>repo</name>
    <url>https://repo.cuba-platform.com/content/groups/work</url>
  </repository>
</repositories>

2.2 Design Word Template

2.3 Load Template

ReportBuilder reportBuilder = new ReportBuilder();
ReportTemplateBuilder reportTemplateBuilder = new ReportTemplateBuilder()
    .documentPath(new ClassPathResource("templates/day.docx").getURI().getPath())
    .documentName("day.docx")
    .outputType(ReportOutputType.docx)
    .readFileFromPath();
reportBuilder.template(reportTemplateBuilder.build());

2.4 Prepare Data

Map<String, Object> data = Map.of(
  "date", "2018-12-20", "p1", 234, "p2", 123,
  "p3", 489, "p4", 789, "p5", 127, "p6", 489);
String jsonStr = new ObjectMapper().writeValueAsString(data);

2.5 Define Data Band

BandBuilder bandBuilder = new BandBuilder();
ReportBand r = bandBuilder.name("R")
    .query("R", "parameter=p$", "json")
    .build();
reportBuilder.band(r);

2.6 Generate Report

Report report = reportBuilder.build();
Reporting reporting = new Reporting();
reporting.setFormatterFactory(new DefaultFormatterFactory());
reporting.setLoaderFactory(new DefaultLoaderFactory().setJsonDataLoader(new JsonDataLoader()));
response.setContentType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
reporting.runReport(new RunParams(report).param("p", jsonStr), response.getOutputStream());

The above steps produce a downloadable Word file containing the filled data, as shown in the following screenshots.