What PDF Reports Do You Need to Request in a Web Application?
By Adrian Butnaru · Independent developer · Blanes (Girona), working remotely across Spain.
Adrian's GitHub · Adrian's LinkedIn.
Published: · Last technical review:
To define the PDF reports for a web application, it is advisable to specify what records or incidents each document includes, which site or timeframe it filters by, what roles have permission to export it, and who will review it. We agree in writing on the structure of each PDF deliverable before starting development.
I start with the decision you want to make with the document
If you ask me for «export to PDF», I would ask what you expect to read in the file and what you will do with it. It can serve to consult records or to share a selection of information. I would not choose a template until understanding that purpose and who needs to use the document.
My web application and PWA offering includes PDF export. That allows discussing the published capability, but it does not mean that every conceivable report is included. The content, selection of records, and layout of your document must be defined in your project scope.
The summary sheet you can prepare
| Decision | Information I need |
|---|---|
| Purpose | What you want to generate the report for |
| Content | What fields and records must appear |
| Scope | Which site or group it includes |
| Selection | What criteria you want to apply |
| Recipient | Who needs to consult it |
| Layout | What example we can review in writing |
| Exclusions | What information must be left out |
You do not need to design the file before writing to me. If you have an existing document, you can explain which parts you need to keep and which are redundant. If none exists, a description of its intended use can serve as the starting point. I do not presuppose a template migration or an exact reproduction without reviewing it.
I distinguish available data from the requested document
It is advisable to review where each piece of content would come from. If a field is not part of what you collect, I would not present it as information that will appear automatically in the PDF. First, we would need to decide whether you need to record it and what incorporating it into the application involves.
I also want to separate raw data from an interpretation. If you request conclusions, indicators, or validation, we must specify what they mean and what evidence you require. A file of raw records and a document that interprets information are not the same deliverable. I need to distinguish them to agree with you on what the application should produce.
An editorial example to describe the request
Instead of «I want all the reports», I suggest formulating a requirement like this: I want to review a selection of records from a site and share it with an authorised person. Afterwards, we would specify what selection, what fields, and what layout. This is a conversational template, not a model attributed to my product.
If you need different documents for different tasks, I prefer that we identify them separately. That way we can discuss what they share and what changes, without leaving an undefined set of reports hidden behind a single quote line item.
How to review a document proposal
I propose preparing a description of the report without using screenshots of another application as a substitute for its requirements. State the recipient's task, the information they need, and what should be left out. If you are starting from a previous template, distinguish its content from elements that only serve a visual purpose.
As an editorial exercise, imagine a document that gathers a selection of records for review. The question is not solely whether it can be downloaded: you need to explain what selection it represents, how it is identified, and who is authorised to receive it. This example does not describe an already implemented report, nor does it add an included template to my offering.
It is also advisable to decide what should happen when there are no records matching the requested criteria. I suggest setting out that scenario in writing rather than treating an empty file as an obvious answer. The final presentation requires review and cannot be deduced simply from an export button.
This guide does not incorporate a report template: its fields, filters, and exclusions are defined for each project.
When you should NOT request a PDF
I would not recommend generating documents if what you need is to modify information within the application. I suggest distinguishing an on-screen query from a file intended for sharing. If your task depends on continuous changes, I want to clarify what you expect the document to represent at the moment it is generated.
As a comparison, I would contrast an on-screen consultation against an export. The screen responds to a workflow within the tool; the file also requires agreeing on its content and recipient. I do not claim that one is always better, nor that a PDF replaces every inquiry need.
Nor would I ask for all available fields by default. It is advisable to review what the reader of the report actually needs. If you cannot identify the purpose of a data point within the document, I prefer to leave its inclusion as an open question before bloating the scope with content that lacks a clear purpose.
How I prepare the deliverable with you
To assess your reports, I need a purpose, a selection of records, and a recipient. I review that request in writing and agree with you on each document as a deliverable, differentiating its content from the export method. Afterwards, you can compare functional progress against the template and its exclusions, rather than just against a download button.
It is advisable to review an end-to-end workflow: what information you enter, how you select what you want to consult, and what you expect to find in the file. I would add a case where a record should not appear or where no information exists to display. These are scenarios to agree upon, not behaviours that I take as already implemented.
I would also ask you to decide who will be able to generate and consult each document. If there are multiple sites, the scope needs to appear in the definition. If you request a consolidated report, I want it specified in writing as such rather than deduced from multi-site capability.
What you can prepare with the self-assessment
In the checklist self-assessment, you can specify what technical records you manage, whether you operate across multiple sites, and what PDF reports you need to generate. I suggest using those questions to separate the application's content from the document you expect to obtain.
You can come to the consultation with a list of fields, a description of recipients, and any open questions. I do not need the example to be perfect. I prefer reviewing a specific request and its exclusions with you rather than promising a library of templates that we have not yet defined or verified.
The document must answer a specific reading need
I suggest reviewing the content from the perspective of the task facing whoever receives the file. A list of fields alone does not explain what reading that person requires. You can point out what information helps review the document and what data should not be included, without copying a report from another tool or attributing it to an existing project.
For your application, describe whether the report should gather logs, incidents, or a selection of information per site. Also point out what data the recipient does not need. A document may require a review distinct from the working screen, and a consolidated query must not lose track of the site each record belongs to. Before designing the PDF, I want to agree on that reading and its exclusions with you.
Frequently asked questions
What data should the report contain?
A web application PDF report should contain the records necessary for its purpose, with defined fields, site, and selection criteria. I review with you what information is left out and who will read the document. PDF export forms part of my offering, but each template requires its own written scope.
Who needs to consult it?
The recipients of a PDF report must be defined by their task and access scope. I review with you which profile needs each document and for which site. I do not take for granted that viewing a record grants permission to download any report; that permission is agreed alongside the other access rights of the application.