Subject area

Render reports

How you request a document: the render request, the payload check, output types and formats, the three modes, pictures and SVG, the limits of a render, and language and time zone.

Rendering means: CRMS takes an approved template, inserts the data of your application and returns a finished document, for example a PDF. This chapter shows the way from the call to the bytes.

The render request: what a request contains, embedded and over REST.
The payload and its check: at most two levels, field rules, violations.
Output types and formats: which template delivers which format, PDF profiles.
Preview, final, transient: what is stored and how a document says what it is.
Pictures and SVG: attachments, attachment:<name> and crms.svg.
Execution and limits: pool, timeout, size limits, sandbox.
Language and time zone: where language and time zone come from and how numbers and dates look.

Topics in this subject area

1.The render request
What a render request contains: template key, format, mode, reference, language, time zone, PDF profile, payload and attachments. Embedded as a Java call, standalone through POST /crms/render, plus checking without rendering.
2.The payload and its check
What the payload may hold: at most two levels, only plain values. How CRMS checks the fields a template declares, and how violations come back with field path and rule key.
3.Output types and formats
A template's output type (DOCUMENT, TABLE, WORD) decides which formats it delivers: HTML and PDF, XLSX, CSV and ODS, DOCX. Which formats an installation offers and which PDF profiles exist.
4.Preview, final, transient
The three modes PREVIEW, FINAL and TRANSIENT: what is stored and sealed, how each format says what it is (watermark and marker), and when TRANSIENT is allowed.
5.Pictures and SVG
Three ways to a picture in the document: assets of the template (asset:<name>), attachments of the request (attachment:<name>, PNG or JPEG) and SVG from the payload through crms.svg with an allow-list. What is refused.
6.Execution and limits
Where a render runs: the caller's thread and a bounded pool. Timeout, size limits for payload, attachments and output, a full queue, the template's sandbox and which resources are refused.
7.Language and time zone
Where a document's language comes from (request, CIAS, the installation's default) and where its time zone comes from (request, TZ, UTC). How numbers, dates and points in time are formatted in the template.