HTMLReportGenerator

This transformer supports Group By and outputs a single feature per group (or simply a single feature if Group By is not used) containing a single HTML page in the html_content attribute. All input attributes (other than the Group By attributes) and geometries will be lost on the output feature.

This section allows users to add, order, and remove page elements from the list. The output page will display the elements in the order that they are specified in this list.

The configuration for each element will be set up in the corresponding Content Settings box to the right.

Preview in Browser

This button at the bottom of the transformer allows the user to view a preview of the page they are creating in their default browser. Clicking this button will show a preview of the rough layout of the page. Preview generation may not work while some parameters are in the invalid state. The final page will in many cases look different as the preview is unaware of the actual values that will be sent in at run-time.

Content Settings

Chart (Bar)	This element creates a basic responsive bar chart using the chart.js library. This page element expects multiple input features and combines the data from these features into a single chart. Each input feature will create a new bar along the x axis of the chart. Content Settings X Axis Label This optional text field allows you to place an x axis label on the chart. X Tick Label Attribute This mandatory attribute field controls the values that will appear under each bar along the x-axis. Y Axis Label This optional text field allows you to place an y axis label on the chart. Data Series This table allows the user to specify multiple different data series for their bar chart. In the Data Attribute column the user should select a numeric attribute that will be plotted as the count data (or the bar height) for a given feature. The Color field allows the user to specify a unique color for each data series.
Chart (Line)	This element creates a basic responsive line chart using the chart.js library. This page element expects multiple input features and combines the data from these features into a single chart. Each input feature will create a new point along the x axis of the chart. Content Settings X Axis Label This optional text field allows you to place an x axis label on the chart. X Tick Label Attribute This mandatory attribute field controls the values that will appear under each bar along the x-axis. Note that datapoints will always be evenly spaced along the x axis. If you require the flexibility to have non-uniformly spaced x axis values, consider using the ChartGenerator transformer to generate a static chart image that can be added to the page as an “Image” element. Y Axis Label This optional text field allows you to place an y axis label on the chart. Data Series This table allows the user to specify multiple different data series for their line chart. In the Data Attribute column the user should select a numeric attribute that will be plotted as the y axis data (or the point height) for a given feature. The Color field allows the user to specify a unique color for each data series.
Chart (Pie)	This element creates a basic responsive pie chart using the chart.js library. This page element expects multiple input features and combines the data from these features into a single chart. Each input feature will create a slice in the pie chart. Content Settings Label Attribute This mandatory attribute field controls the labels for each slice of the pie chart, that will be used in both the tooltip and chart legend. Data Attribute This value of this numeric attribute will determine the size of a given slice. Slices will be weighted according to the value of this attribute. Color Scheme Here a color scheme can be specified for the pie chart. Options include Red to White, Blue to White, Red to Green, Rainbow, Pastel and Dark.
Header	Allows the user to enter text either as a header or paragraph form. Content Settings Text Required parameter that allows the user to enter text to appear in the page. Header Level This allows the user to set the header level of the text. If set to None, the text will be added at regular paragraph (<p> tag) size. Identifier Optional parameter that allows the user to specify the id attribute for this header or paragraph element. If left blank, no id attribute will be set. Text Alignment Allows the user to specify the alignment of the text on the page. Options include Left, Right, Center and Justified. Color Allows the user to specify a color for the text. Specifying Colors Colors may be entered directly or chosen from the color picker via the ellipsis button. Syntax Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1). If the value type is unclear, as in (1,1,1), the 24-bit interpretation is used. Hex codes are accepted with or without a hash sign (#).   24-bit RGB Decimal RGB Hex code 0,0,0 0,0,0 #000000 255,0,0 1,0,0 #FF0000 202,173,232 0.79,0.68,0.91 #CAADE8 255,255,255 Not Available #FFFFFF
Image	This element allows the user to either link to or embed an image in their page. Content Settings Attachment Method This setting allows the user to choose whether they want to link to an image using a URL or a relative path or to embed the actual content of the image within their page. Note that the latter option may bloat the size of the HTML page considerably for larger images. Image URL This option is only enabled when the Attachment Method is set to Link. It allows the user to specify an image via a relative path or external URL. Image File This option is only enabled when the Attachment Method is set to Embed. It allows the user to specify an image on the disk to embed within the page. This parameter expects a valid path to a png or jpeg file. If setting this path from an attribute, the user must ensure that the image exists on disk at the time the features hit this transfomer. In the event you wish to use an image dynamically created as part of a workflow, consider using the FeatureWriter transformer before this transformer to write this image to disk and use it within the report within a single workspace. Alternate Text This optional parameter allows one to specify text that will be displayed in the event the image fails to load.
List	Allows the user to create a list of text from an attribute. Content Settings List Item Content The attribute that will be used to populate the list values one entry per feature. List Item Markers This option specifies whether the list will be marked with bullets, letters, numbers, roman numerals or nothing. Text Color Allows the user to set a color for the list text. Specifying Colors Colors may be entered directly or chosen from the color picker via the ellipsis button. Syntax Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1). If the value type is unclear, as in (1,1,1), the 24-bit interpretation is used. Hex codes are accepted with or without a hash sign (#).   24-bit RGB Decimal RGB Hex code 0,0,0 0,0,0 #000000 255,0,0 1,0,0 #FF0000 202,173,232 0.79,0.68,0.91 #CAADE8 255,255,255 Not Available #FFFFFF Badge Content This attribute can only be set if List Item Markers is set to None. In the event this is set, bootstrap style badges will be set on the right-hand side of the list.
Map (Esri Leaflet)	This element allows the user to create a simple webmap featuring the geometries of input features as a layer. Note  The tiles used to generate embedded maps may be subject to usage limitations and other restrictions. Please review the terms of use. Content Settings Label Attribute This optional parameter allows the user to specify an attribute value used to label each feature on the map within a tooltip. Escape HTML This parameter controls whether Label Attribute values will be HTML-escaped. If Yes (default): Attribute input values such as <b>input</b> will be rendered as-is. If No: Input will be parsed as though it contains HTML tags, causing inputs like <b>input</b> to appear as b. Layer Color This option allows the user to specify a color for the layer. Specifying Colors Colors may be entered directly or chosen from the color picker via the ellipsis button. Syntax Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1). If the value type is unclear, as in (1,1,1), the 24-bit interpretation is used. Hex codes are accepted with or without a hash sign (#).   24-bit RGB Decimal RGB Hex code 0,0,0 0,0,0 #000000 255,0,0 1,0,0 #FF0000 202,173,232 0.79,0.68,0.91 #CAADE8 255,255,255 Not Available #FFFFFF Basemap This option allows the user to select from the list of available Esri Basemaps. Options include: Street, Terrain, Satellite, Gray, Dark Gray, Shaded Relief, Topographic, and National Geographic. Feature Layer URL(s) This parameter allows the user to specify a list of comma delimited ArcGIS Online feature layer URLs, that will be displayed as additional layers on the map.
Map (Google)	This element allows the user to create a simple webmap featuring the geometries of input features as a layer. Note that this transformer only supports a single Google map per page. To create a web page with multiple Google maps, you must create multiple pages (using Group By or multiple HTMLReportGenerator transformers) and then reassemble these into a single page using the HTMLLayouter transformer. Note  The tiles used to generate embedded maps may be subject to usage limitations and other restrictions. Please review the terms of use. Content Settings Label Attribute This optional parameter allows the user to specify an attribute value used to label each feature on the map within a tooltip. Escape HTML This parameter controls whether Label Attribute values will be HTML-escaped. If Yes (default): Attribute input values such as <b>input</b> will be rendered as-is. If No: Input will be parsed as though it contains HTML tags, causing inputs like <b>input</b> to appear as b. Layer Color This option allows the user to specify a color for the layer. Specifying Colors Colors may be entered directly or chosen from the color picker via the ellipsis button. Syntax Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1). If the value type is unclear, as in (1,1,1), the 24-bit interpretation is used. Hex codes are accepted with or without a hash sign (#).   24-bit RGB Decimal RGB Hex code 0,0,0 0,0,0 #000000 255,0,0 1,0,0 #FF0000 202,173,232 0.79,0.68,0.91 #CAADE8 255,255,255 Not Available #FFFFFF Access Token This optional field allows the user to specify their Google Maps API Access token. Note that this is not required to create a simple Google Maps webmap.
Map (Mapbox Leaflet)	This element allows the user to create a simple webmap featuring the geometries of input features as a layer. Note this page element requires the user to create or possess a Mapbox account to obtain a Mapbox access token. Visit www.mapbox.com to create a free account. Note  The tiles used to generate embedded maps may be subject to usage limitations and other restrictions. Please review the terms of use. Content Settings Label Attribute This optional parameter allows the user to specify an attribute value used to label each feature on the map within a tooltip. Escape HTML This parameter controls whether Label Attribute values will be HTML-escaped. If Yes (default): Attribute input values such as <b>input</b> will be rendered as-is. If No: Input will be parsed as though it contains HTML tags, causing inputs like <b>input</b> to appear as b. Layer Color This option allows the user to specify a color for the layer. Specifying Colors Colors may be entered directly or chosen from the color picker via the ellipsis button. Syntax Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1). If the value type is unclear, as in (1,1,1), the 24-bit interpretation is used. Hex codes are accepted with or without a hash sign (#).   24-bit RGB Decimal RGB Hex code 0,0,0 0,0,0 #000000 255,0,0 1,0,0 #FF0000 202,173,232 0.79,0.68,0.91 #CAADE8 255,255,255 Not Available #FFFFFF Access Token This mandatory field allows the user to specify their Mapbox API Access token. This token is required for the basemap to render correctly. Map Id This allows the user to input the style id of a map created with their Mapbox account. The default is set to mapbox/streets-v11 as this map should be present on all accounts.
Map (Mapbox GL JS)	This element allows the user to create a simple webmap featuring the geometries of input features as layers. External data sources can also be specified as additional layers. Note this page element requires the user to create or possess a Mapbox account to obtain a Mapbox access token. Visit www.mapbox.com to create a free account. Content Settings Access Token This mandatory field allows the user to specify their Mapbox API Access token. This token is required for the basemap to render correctly. Label Attribute This optional parameter allows the user to specify an attribute value used to label each feature on the map within a clickable tooltip. Escape HTML This parameter controls whether Label Attribute values will be HTML-escaped. If Yes (default): Attribute input values such as <b>input</b> will be rendered as-is. If No: Input will be parsed as though it contains HTML tags, causing inputs like <b>input</b> to appear as b. Layer Color This option allows the user to specify a color for the geometry layers and any added vector layers Specifying Colors Colors may be entered directly or chosen from the color picker via the ellipsis button. Syntax Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1). If the value type is unclear, as in (1,1,1), the 24-bit interpretation is used. Hex codes are accepted with or without a hash sign (#).   24-bit RGB Decimal RGB Hex code 0,0,0 0,0,0 #000000 255,0,0 1,0,0 #FF0000 202,173,232 0.79,0.68,0.91 #CAADE8 255,255,255 Not Available #FFFFFF Basemap This allows the user to input the stylemap id of a map created with their Mapbox account. The default is set to mapbox/streets-v11 as this map should be present on all accounts. WMS URL(s) This optional field allows the user to input a list of comma delimited URLs to WMS sources to be added as additional layers on the output map. By default, the tile size will be 512. Vector Layers This table allows the user to input an optional list of pairs consisting of vector layer source URLS and layers in those sources. These layers will be rendered as line layers. Feature Layer URL The link to a vector layer source. This must be provided with the `{z}/{y}/{x}` suffix. Note that using a non-MapBox vector tile service may cause CORS issues when loading the layer in certain browsers. Source Layer The name of the source layer in the corresponding tile service
Separator	Allows the user to set a separator element or <hr> tag. Content Settings Separator Thickness (pixels) This integer parameter controls the width of the separator.
Table	This element creates a basic HTML table featuring data from attributes. Content Settings Table Style Allows the user to choose between several bootstrap table styles including: Basic, Bordered, Condensed, Combined, Hover, and Striped. The Default style is Bordered. The Combined style will produce a table with bordered, condensed, hover, and striped styling. Column Settings This table allows the user to configure the columns of the output HTML table. The ‘Column Contents’ column must be set to an attribute value. These values will appear as the rows of the column. The ‘Column Name’ field allows the user to specify a name for each column.
Custom HTML	Allows the user to enter custom HTML. Content Settings Custom HTML Raw HTML-formatted text that will be inserted into the output page. The user should ensure that the text is valid HTML.

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

Content Types

String Functions	These functions manipulate and format strings.
Special Characters	A set of control characters is available in the Text Editor.
Math Functions	Math functions are available in both editors.
Date/Time Functions	Date and time functions are available in the Text Editor.
Math Operators	These operators are available in the Arithmetic Editor.
FME Feature Functions	These return primarily feature-specific values.
FME Parameters	FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters	Create your own editable parameters.

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Note: Not all tools are available in all transformers.