Report Text Tool

The Report Text tool creates a text element to output in a report via the Render tool. The Text tool can use incoming data as values for the text, and provides a variety of options for styling the text.

Configure the tool

  • Create new field for this text: Creates a new column for the text report element. Specify the Field Name for the element to make it easy to choose it in other reporting tools.
  • Attach text to existing field: Attaches the text element above, below, to the left, or to the right of another incoming report element so that the two elements become one.
  • Expert Mode: Treat text as Raw PCXML: Paste or write custom PCXML code. When this options is selected, text style options are not available.
    • Validate PCXML: Displays an error message if there are any syntax errors in the custom PCXML code.
  • Expert Mode: Treat text as Raw PCXML: Paste or write custom PCXML code. When this options is selected, text style options are not available.

    HTML Passthrough

    If your custom PCXML code includes HTML code that you plan to output verbatim via the Render tool, wrap the code in the <htmlpassthrough> tag. This tag should be used in cases when the body of the tag must not be parsed, and must be copied as is to HTML output only. This is typically used to render iframes, map embeds, interactive charts, etc. These objects can't be exported to Excel, Word, and other non-HTML file formats. As a result, the <htmlpassthrough> tag is not compatible with non-HTML outputs from the Render tool.

  • Text Data: Use the text editor buttons to style the text.
  • Available Fields: Displays the data (except spatial) from the previous connected tool that can be used as text.
  • Special Tags: Provides a list of formatting and style options for the text.
    • Horizontal Line: Adds a horizontal line below the text.
    • Current Page: Adds the current page number of the report. Use this when creating a Header or Footer.
    • Total Pages: Adds the total number of pages in the report. Use this when creating a Header or Footer.
    • Page Break: Adds a new page for subsequent reporting elements.
    • Limitations

      The page break is ignored when the Text tool is connected to:

      • A Layout Tool with an orientation other than Vertical with Section Breaks.
      • A Table Tool.
      • Another Text tool and the Attach text to existing field option is selected with a left or a right position.
    • Superscript Selection: Makes the selected text appear above the regular text.
    • Subscript Selection: Makes the selected text appear below the regular text.