Flows/Preview a template: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 17:25, 14 August 2026

flowplatformCARE 3.0+

Overview

This flow describes how to preview a report template in the template builder. Care renders a sample document, so you can check the layout before you make the template active.

Pre-requisites

You create a new report template, or you edit an existing report template, and the template builder is open.
You entered the template body. You selected a Context and a Default Format.
You have the permissions listed below.

Permissions

Permission	Access
Can Preview Template	Lets a Facility Admin or an Admin preview a report template.

Steps

1. Open the template in the builder

Create a new report template, or edit an existing report template. The builder shows the template body, the Context, and the Default Format.

2. Preview the template

Select Preview in the builder. Care renders the template body with sample data for the selected Context and Default Format.

3. Check the rendered sample

Care shows the sample document in the builder as a PDF or an HTML preview. Read the sample, and check the layout and the wording.

📝 Note

Care uses sample placeholder data for the preview. Care does not generate a report for a patient in this flow.

4. Correct any errors

If the template body has a syntax problem, Care shows a validation error. Read the error, correct the template body, and select Preview again.

Expected Outcome

Care shows the message “Template preview generated”.
Care shows the sample document in the builder.
You confirm the layout and the wording before you set the Status to Active.

Concept: Concepts/Report Template
Reference: References/Report & Templates

@@ Line 3: / Line 3: @@
 |domain=platform
 |title=Preview a template
+|summary=This flow describes how to preview a report template in the template builder. Care renders a sample document, so you can check the layout before you make the template active.
-|summary=Render sample output before saving a report template.
 |order=2
 |introduced=3.0
@@ Line 9: / Line 9: @@
 |reference=References/Report & Templates
 }}
+== Overview ==
+This flow describes how to preview a [[Concepts/Report Template|report template]] in the template builder. Care renders a sample document, so you can check the layout before you make the template active.
+== Pre-requisites ==
+* You create a new report template, or you edit an existing report template, and the template builder is open.
+* You entered the template body. You selected a Context and a Default Format.
+* You have the permissions listed below.
+== Permissions ==
+{| class="wikitable"
+|-
+! Permission
+! Access
+|-
+| Can Preview Template
+| Lets a Facility Admin or an Admin preview a report template.
+|}
 == Steps ==
-# Open a report template in the builder.
+=== 1. Open the template in the builder ===
-# Ensure its type, context, format, and body are complete.
-# Select '''Preview'''.
+Create a new report template, or edit an existing report template. The builder shows the template body, the Context, and the Default Format.
-# Review the rendered sample and return to the builder to fix any problems.
+=== 2. Preview the template ===
+Select '''Preview''' in the builder. Care renders the template body with sample data for the selected Context and Default Format.
+=== 3. Check the rendered sample ===
+Care shows the sample document in the builder as a PDF or an HTML preview. Read the sample, and check the layout and the wording.
+{{Note|1=Care uses sample placeholder data for the preview. Care does not generate a report for a patient in this flow.}}
+=== 4. Correct any errors ===
+If the template body has a syntax problem, Care shows a validation error. Read the error, correct the template body, and select '''Preview''' again.
 == Expected Outcome ==
-Care renders sample output without creating a patient report.
+* Care shows the message “Template preview generated”.
+* Care shows the sample document in the builder.
+* You confirm the layout and the wording before you set the Status to Active.
 {{Navbox platform}}