Skip to content
Bogdan Marc edited this page Sep 9, 2024 · 7 revisions

Price Paid Standard Reports UI

This project provides a straighforward user experience for users who want to define and download a Price Paid Standard Report. Standard Reports aggregate various slices of Price Paid (PPD) data, according to property type, region and date. The basic workflow is fairly simple: users step through a wizard interface making selections for the various report criteria, then at the end they click to download the selected report which will kick off a background batch job, using our report generator API. This batch job will either return with the report download link, if a report with those options has already been generated and cached, or a queue position as the job moves up the batch queue.

Please see the other repositories in the HM Land Registry Open Data project for more details.

Operator Notes

Runtime Configuration environment variables

We use a number of environment variables to determine the runtime behaviour of the application:

name description default value
API_SERVICE_URL The base URL from which data is accessed, including the HTTP scheme eg. None
http://localhost:8081 if running a standard-reports-manager service locally
http://standard-reports-manager:8080 if running a standard-reports-manager docker image locally
SECRET_KEY_BASE See description.
For development mode a acceptable value is already configured, in production mode this should be set to the output of rails secret.
This is handled automatically when starting a docker container, or the server make target
SENTRY_API_KEY The DSN for sending reports to the PPD Sentry account None

Developer Notes

Clone this wiki locally