Rhythm 2.0 Specifications

Appearance

WF-PFM-QRY-008Deliver a scheduled query or report to its recipients

Markdown

WF-PFM-QRY-008

Deliver a scheduled query or report to its recipients

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Implements
CAP-PFM-QRY-015, CAP-PFM-QRY-014, CAP-PFM-QRY-013

KindWorkflowProduct areaPlatformModuleQuestions, record exploration and data deliveryRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Deliver a scheduled query or report to its recipients ​

What It Does ​

A recurrence is due, or an authorized person requests an immediate schedule run. Manual execution uses the clicking person’s access.

The Flow ​

Claim due recurrences, insert unique occurrence runs, advance recurrence and publish delivery work. For manual execution, commit the run and its export request, then publish after commit. Start the occurrence using the owner for automatic work or manual runner for immediate work. Resolve the pinned query or current report. Generate query files in the receive, or dispatch a report render and poll its file for up to twelve minutes. Suppress delivery for an empty query when its empty-result option is enabled. Resolve each current recipient address, record skip reasons where needed and submit the template and personal signed link through Communications. Settle success, skip or failure through recurrence tracking, resetting or incrementing the streak and applying the five-failure pause.

When Something Fails ​

A later dispatcher pass handles missed due work. A due run may wait for successful dispatch. Observed publication rejection releases the offered run for dispatch. A crash between commit and publication can leave an offered queued run awaiting recovery. Source access loss fails the run; applicable automatic occurrences pause their schedule. Manual-run access failure does not by itself pause the owner’s recurrence. Permanent refusals settle; infrastructure or unfinished-render failures retry within three receives. A report file can complete after the delivery run has already failed. The skip outcome is recorded rather than retried as a delivery error. No communication is requested for the skipped occurrence. Submission failure retries the run while retaining completed recipient outcomes. Some recipients can already have messages while others await another attempt. A persistence error remains subject to the consumer’s failure handling. Delivered external messages remain delivered even if later settlement fails.

Idempotency and Concurrency ​

Occurrence uniqueness protects admission. Retries reuse the run’s file and recipient communication keys, which coordinate duplicate submission without recalling any message already sent. The dispatcher is single-concurrency. Three delivery consumers run separately from interactive export work, and a report run occupies its consumer while polling the renderer.

Controls

48 controls apply, from the corpus control catalogue.

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

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