Orange polygon containing piece of paper with a pen writing lines.

Render Tool

Version:
Current
Last modified: December 02, 2019

The Render tool transforms report snippets into presentation-quality reports into a variety of formats. Output to Microsoft Office formats are only supported for Office 2007 and above.

Most reports require a Render tool to publish the report. The Allocate Report Tool can publish content without a Render tool.

Tool Configuration

Render Configuration

Output Mode: Select the output file format. Choose from the supported temporary file types or Choose a Specific Output File.

When the Output Mode is set to Temporary PNG Image or the Output File type is a .png, the PNG Options area displays.

Output File: If setting a specific output, enter the path to the file's location or browse to it. Supported output file types include:

  • HTML files (*.html)
  • Composer files (*.pcxml)
  • PDF document (*.pdf): PDF output is limited to 8,191 pages.
  • RTF document (*.rtf)
  • Word document (*.docx)
  • Excel document (*.xlsx)
  • MHTML files (*.mht)
  • PowerPoint presentation (*.pptx)
  • PNG image (*.png): PNG output is limited to a size of 10,000x10,000 pixels or 100M pixels.
  • Zip file (*.zip): The zip file contains an *.html file and a folder with all of the *.html file dependencies such as images.

Group Data Into Separate Reports: Allows the user to group data into separate report. This option is only available when using Output Mode: Choose a Specific Output File.

  • Field to Group On: Select a column to group data by, creating a separate report for each group.
  • Modify Filename By:
    • Appending Group to Filename: Appends the value of the selected filename to the end of the specified Group.
    • Prepending Group To Filename: Prepends the value of the selected filename to the beginning of the specified Group.
    • Replacing Filename With Group: Changes the filename to the value of the selected Group.
    • Replacing Entire Path With Group: Changes the entire path to the value of the selected Group.

Report Data

Data Field: Specify which reporting piece to render. If all pieces have been put into a layout there will only be one field to choose from.

Separator: Specify one of several separator options for how the report should be rendered.

  • No Spacing Between Records: Puts no space between records.
  • Insert Whitespace Between Records: Inserts a white space between records.
  • Insert Line Between Records: Inserts a horizontal or vertical line between records.
  • Insert Section Breaks Between Records: Section breaks can vary depending on the report format.
    • PDF, DOC, DOCX and RTF: Section break equals a new page.
    • XLS and XLSX: Section break equals a new sheet within a workbook.
    • HTML and PCXML: Section break does not provide a break at all.

Use static chart: Specify if the output should include a static or interactive chart. This option is only available when using Output Mode: Temporary HTML File or Temporary Composer File.

Header: Specify if one of the edited text tools should be used as a header on every page, with the exception of the first page of the report.

Footer: Specify if one of the edited text tools should be used as a footer on every page, with the exception of the first page of the report.

Header/Footer edge distance (points): Specify the distance from the edge of the paper (in points) to display the Header and Footer. This setting ensures the Header and Footer information will be placed inside the printable area of the document. This specification is dependent on the output format and printer settings unique to your configuration.

Show header and footer on first page: Specify if the header and footer is desired on the first page of the report by checking the box.

PNG Options

When the Output Mode is set to Temporary PNG Image or the Output File type is a .png, the PNG Options area displays.

Resolution: Specify the image resolution. Lower resolution creates a smaller file and is best for viewing on a monitor. Higher resolution creates a larger file with much better print quality.

If Content Too Large: Specify what Alteryx should allow in the event the content of the report exceeds the dimensions of the paper size.

  • Warn with the following behavior
  • Error if the content is too large
  • Allow with the following behavior
  • Behavior if Too Large: Based on the specification set above, specify what should be done with content when it exceeds the paper size.
  • Shrink Content to Fit Paper Height
  • Truncate Content to Fit Paper Height
  • Grow Paper Height to Fit Content
  • Background: Set the transparency of the background of the rendered image.
  • Transparent: When checked, anything that renders in the specified color will be set to transparent.

Report Style

Paper Size: Select a paper size from one of the pre-configured options or select Custom Size to set the Size (in.).

Size (in.): expected behavior

If Default Distance Units is set to kilometers, this field is calculated in centimeters. See Localization.

Orientation: Select Portrait or Landscape.

Margins (in.): Margins are set in inches. Select the size of the margin in the four boxes for left, top, right and bottom margins.

Margins (in.): expected behavior

If Default Distance Units is set to kilometers, this field is calculated in centimeters. See Localization.

Edit Default Styles: Click to open the Style Editor window. Set the Text Style for this entire report by customizing the available fields. See Render Styles.

When accessing this control from a Render tool, the style editor does not overwrite styles that have been specifically set by the user in a Report Text Tool.

  • Font: Specify a font from the drop down menu. ┬áThe drop down menu contains fonts that are local to the machine.
  • Size: Specify a size for the font.
  • Justification: Specify horizontal or vertical alignment for the text.
  • Text Color: Specify the color for the text
  • Background Color: Specify a background color for the text.
Was This Helpful?

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