> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/platform-documentation/form-node-parts/report-text.md).

# Report Text

## Description

Report-text is a form part in the Assessment Framework that allows you to "echo back" the selections or text entries users make on the left side of the screen to create a report on the right side of the screen. This part offers a text area that can be populated with text, html/URL links, and interpolated variables for use within longer text constructions.

**Node Type:** This is a form-part node.

**Used With:** This part is for use with the Assessment Framework.

## Editor Fields

| Field Name                        | Description/Use                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Type/Options | Optional/Mandatory                                                      |           |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------------------------------------------------------- | --------- |
| HTML enabled                      | Check this box to open an HTML editor for the text box, which allows you to format text in a variety of ways, including bold, italics, underline, bullet points and numbered lists, symbols, and access to the underlying HTML for review and direct edit.                                                                                                                                                                                                                  | On\|Off      | Mandatory                                                               |           |
| Text                              | Enter the report text here. Text can include variables referenced using the syntax $(my\_variable). See the Tips and Tricks section below for creative ways to use this feature. Note: The system HTML-encodes all text inserted using interpolation in the text field to prevent XSS.                                                                                                                                                                                      | Text         | Mandatory                                                               |           |
| Skip interpolation                | Check this box to leave any $(...) variable references unresolved.                                                                                                                                                                                                                                                                                                                                                                                                          | On\|Off      | Mandatory                                                               |           |
| <p>Escape $(..)-text<br>v7.4+</p> | <p>Check this box if your report text includes $(..) variables that should NOT be encoded. For example,<br><code>mytext = "\<b>Hello\</b></code><br><code>$(mytext) will appear as Hello (off) or \<b>Hello\</b> (on)</code><br>If the text box contains several interpolations only some of which need to be escaped, use the <strong>$(html(mytext))</strong> construction to turn off escaping for specific output.<br><code>$(html(mytext)) appears as Hello</code></p> | <p>On        | Off<br>On by default (existing nodes)<br>Off by default (new nodes)</p> | Mandatory |

### Tips and Tricks

#### Display Clickable URLs

To display a clickable link on the report panel, use this form part and the following HTML construction:

```markup
<a href="your-URL" target="_blank">Display Text</a>
```

#### Use Interpolation for Text Construction

When the report-item part cannot deliver exactly the text you want to appear on screen, use this form part to create a custom display. This part allows you to string multiple variables together for a verbose report. For example, if your application output is a sentence including multiple variables of different types, you can use the Format Variable part to first convert your outputs into the right (date, list) format, then include them in this node to present on screen generating an output like this:

As of **Monday July 1st, 3pm**, the sky is **blue** today, with **a few** clouds. Rain is expected on **Tuesday, Wednesday and Friday** **.**

You can create this string the following entry in the HTML node, preceded by two format variable nodes to define time of day and rain forecast variables:

As of ***$(time\_of\_day\_formatted)***, the sky is ***$(sky\_color)*** today, with ***$(cloud\_cover)*** clouds. Rain is expected on ***$(rain\_forecast\_days\_formatted\_as\_list)***

### Notes

You can use this node for simple text and for text that requires more finely tuned formatting/styling. Click the HTML-enabled checkbox to access the HTML editor for access to customization tools. See the image below for examples.

The URL and Wikipedia buttons will NOT correctly generate URL links in the report panel - see *Displaying Clickable URLs* above.

![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-6eaa019849b3f942d65a6f61be9e81219da39914%2Fd38c76a7-43af-45d8-89a9-bf9c9094e89f.jpg?alt=media)

## Example Project

Download the [How-To Guide and Q\&A Showcase](/release-9/example-gallery/how-to-guides/qa-showcase-and-example-project.md) example project to see various report item nodes configured to create the above output.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/platform-documentation/form-node-parts/report-text.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
