Orange polygon with horizontal white lines stacked on top of each other and decreasing in size from top tp bottom.

Report Text Tool

Version:
Current
Last modified: October 21, 2019

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.

Tool configuration

  • 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.
  • Text Data: Use the text editor buttons to style the text.
    • Text editor options

      • Bold icon: Makes the text bold.
      • Italic icon: Makes the text italicized.
      • Underline icon: Makes the text underlined.
      • Insert Image icon: Inserts a .png, .jpeg, or .gif image file.
      • Link icon: Inserts a hyperlink.
        • Text To Display: Type the text to display as the link, or select data from Insert Field.
        • Address: Type the location of the content to link to, or select data from Insert Field. Web addresses must include the Hypertext Transfer Protocol (http)

          Example: http://www.alteryx.com/ instead of www.alteryx.com
           
      • Pick Font icon: Provides fonts, font styles, and sizes.
      • Color Picker icon: Provides color options for the text.
      • Background Color Picker icon: Provides color options for the background of the text.
      • Left Align icon: Aligns the text on the left.
      • Center Align icon: Centers the text.
      • Right Align icon: Aligns the text on the right.
  • 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.
       

       

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

      • Layout Tool with an orientation other than Vertical with Section Breaks.
      • 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.
Was This Helpful?

Need something else? Visit the Alteryx Community or contact support.