Rhythm 2.0 Specifications

Appearance

CAP-PFM-QRY-013Render a report for download

Markdown

CAP-PFM-QRY-013

Render a report for download

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-PFM-QRY-04
Exercised by
FAS-PFM-QRY-04-01, FAS-PFM-QRY-04-03, FAS-PFM-QRY-04-04, FAS-PFM-QRY-05-04, FAS-PFM-QRY-05-05
Key concepts
CON-PFM-QRY-003, CON-PFM-QRY-004
Actors
ACT-PFM-013, ACT-PFM-012
Journeys
JNY-PFM-QRY-004
Depends on
CAP-PFM-QRY-011
Related
CAP-PFM-QRY-011, CAP-PFM-QRY-012, CAP-PFM-QRY-014, CAP-PFM-QRY-015
Open questions
OQ-PFM-QRY-002
Proved by
ATS-PFM-QRY-013

Implementation

Executable suites
TST-PFM-QRY-027, TST-PFM-QRY-110, TST-PFM-QRY-111, TST-PFM-QRY-112, TST-PFM-QRY-113, TST-PFM-QRY-231, TST-PFM-QRY-232, TST-PFM-QRY-333, TST-PFM-QRY-334, TST-PFM-QRY-409

KindCapabilityProduct areaPlatformModuleQuestions, record exploration and data deliveryRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Render a report for download ​

Purpose ​

Produce a report file through a controlled rendering session evaluated as the requester.

How It Works ​

A person requests a report file in a supported format. Platform creates an export record for the renderer to process. Before opening the print page, it checks that the requester still has access. The renderer uses a fresh browser and supplies permitted page parameters. Its API requests are answered internally under the requester’s current access. Requests outside the permitted surface are stopped. Readiness, time and file-size checks decide whether the rendered file can be stored. A successful export becomes downloadable for its retention period, while a failure explains the reason without exposing internal details.

Relationships ​

Rendering uses report presentations and the shared export records; scheduled report delivery requests that output.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Staff receive report files suitable for circulation.Rendering checks the requester’s current access.Failed or excessive rendering does not publish a partial file.
Surfaces
consoleapijob

Controls

34 controls apply, from the corpus control catalogue.

TC-AVL-004 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-004 TC-DAT-005 TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-IAM-006 TC-LOG-001 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-SEC-001 TC-SEC-002 TC-SEC-003 TC-SEC-004 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
platform.reports.useapitenant
platform.queries.read (to follow and download, CAP-014)apitenant

Business Rules

11 rules, 11 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
Report export requires report use and a visible report, returns not found for an inaccessible report and writes nothing for rejected requests.
proved by ATS-PFM-QRY-013-01, ATS-PFM-QRY-013-14, ATS-PFM-QRY-014-12, TST-PFM-QRY-231, TST-PFM-QRY-232, TST-PFM-QRY-334
permissionapi, servicetest
services-platform:modules/queries/tests/integration/services/rendering/report-exports.integration.spec.js#answers a colleague who may not see the private report 404, writing nothing
02must prove
Proposed
All report kinds support PDF, only coded and table reports support Excel, and report CSV is rejected.
proved by ATS-PFM-QRY-013-02, TST-PFM-QRY-334
validationservicetest
services-platform:modules/queries/tests/integration/services/rendering/report-exports.integration.spec.js#refuses an Excel export of a dashboard, writing nothing
03must prove
Proposed
Print parameters preserve submitted values and accept at most fifty names, text up to five hundred characters and lists up to one hundred entries, rejecting unsupported values and the renderer’s reserved name.
proved by ATS-PFM-QRY-013-03, TST-PFM-QRY-334
validationservicetest
services-platform:modules/queries/tests/integration/services/rendering/report-exports.integration.spec.js#refuses the renderer’s own parameter name at parameters, writing nothing
04must prove
Proposed
Before opening a browser, rendering rechecks the report and requester, failing deleted or newly inaccessible reports and lost report-use access as access lost.
proved by ATS-PFM-QRY-013-04, ATS-PFM-QRY-013-15, ATS-PFM-QRY-015-19, TST-PFM-QRY-333
policyservicetest
services-platform:modules/queries/tests/integration/services/rendering/render-report.integration.spec.js#fails a requester who may not use reports access_lost, saying so plainly
05must prove
Proposed
Print-page API calls run internally as the requester through an allowed route set in the export workspace, with other origins, operations and routes refused and logged without query strings.
proved by ATS-PFM-QRY-013-05, TST-PFM-QRY-409
invariantservicetest
services-platform:modules/queries/tests/unit/services/rendering/api-interception.spec.ts#aborts a route of Platform off the allowlist, a write among them
06must prove
Proposed
Each page request renews its access check, and revoked access fails the export rather than producing a file of refusal messages.
proved by ATS-PFM-QRY-012-12, ATS-PFM-QRY-013-06, ATS-PFM-QRY-013-13, TST-PFM-QRY-111, TST-PFM-QRY-333
policyservicetest
services-platform:modules/queries/tests/integration/services/rendering/render-report.integration.spec.js#fails the export access_lost rather than printing a page of refusals
07must prove
Proposed
Rendering rejects work beyond five minutes, PDFs above two hundred pages, and invalid or oversized Excel files above one hundred megabytes, without storing a rejected file.
proved by ATS-PFM-QRY-013-07, TST-PFM-QRY-113, TST-PFM-QRY-333
validationservicetest
services-platform:modules/queries/tests/integration/services/rendering/render-report.integration.spec.js#fails a PDF past its page limit too_many_pages
08must prove
Proposed
Completed files use the report name and workspace date and remain available for thirty days.
proved by ATS-PFM-QRY-013-08, TST-PFM-QRY-333, TST-PFM-QRY-334
lifecycleservicetest
services-platform:modules/queries/tests/integration/services/rendering/render-report.integration.spec.js#keeps the file thirty days from its completion, as the bucket’s rule removes it
09must prove
Proposed
Report deletion leaves completed files downloadable but causes queued rendering to fail for lost access.
proved by ATS-PFM-QRY-011-16, ATS-PFM-QRY-013-09, ATS-PFM-QRY-013-12, TST-PFM-QRY-110
lifecycleservice, databasedocumented
services-platform:docs/queries/report-rendering.md#2. The export row
10must prove
Proposed
Rendering uses a fresh browser without a login session or stored credentials, disables service workers and downloads, and rejects page-opened connections.
proved by ATS-PFM-QRY-013-10, TST-PFM-QRY-027, TST-PFM-QRY-112, TST-PFM-QRY-409
invariantservicetest
services-platform:modules/queries/tests/unit/services/rendering/api-interception.spec.ts#records a WebSocket the page opened as refused
11must prove
Proposed
Internal rendering failures retry through the queue and become a generic final failure on the last attempt.
proved by ATS-PFM-QRY-013-11, TST-PFM-QRY-333
policyservicetest
services-platform:modules/queries/tests/integration/services/rendering/render-report.integration.spec.js#records internal on the last receive, with the sentence that never says what went wrong

Scenarios

IdGivenWhenThenProvenance
01A report render begins while its requester has access.A required grant is revoked during page requests.The export ends as access lost rather than storing refusal content.test
services-platform:modules/queries/tests/integration/services/rendering/render-report.integration.spec.js#fails the export access_lost rather than printing a page of refusals

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software