---
title: "Report Generator"
canonical: "https://help.cartinuum.com/space/WC/4559110173/Report%20Generator"
format: markdown
---
[The Report Generator widget](https://extensions.cartinuum.com/product/report-generator/) creates downloadable Word documents from selected map features using configured DOCX templates.

Use this widget when users need to turn selected features into structured reports, letters, summaries, inspection documents, or operational briefings.

## What this widget does

Report Generator connects selected features to one or more document templates. App authors configure which templates apply to which data sources. Users select a template, and the widget generates a populated report from the selected feature or features.

All processing is handled in the browser - no print services are required.

## When to use it

Use Report Generator when users need to:

- Generate reports from selected features.
- Use organisation-approved Word templates.
- Create single-feature or multi-feature reports.
- Include feature attributes in a document.
- Include maps for selected features.
- Summarise values across a selection.

## Key features

- DOCX template upload.
- Data source to template relationships.
- Single-feature templates.
- Multiple-feature templates.
- Attribute tag replacement.
- Selection loops.
- Date and number formatting.
- Aggregation functions such as count, sum, average, min, and max.
- Feature map and summary map tags.
- English, French, and Spanish translations.

## Requirements

- [ArcGIS Experience Builder 1.14 or later.](https://developers.arcgis.com/experience-builder/guide/release-versions/)
- A Map widget in the Experience Builder app.
- Data sources with selectable features.
- DOCX templates prepared with supported tags.
- A valid Cartinuum widget license.

## Before you begin

Before configuring Report Generator:

1. Add the map and selection workflow required by your app.
2. Identify the data sources users will report from.
3. Prepare one or more DOCX templates.
4. Decide whether each template supports a single selected feature or multiple selected features.
5. Install or enable the widget using the standard widget installation process.

For installation and licensing steps, see [Widget Installation](https://help.cartinuum.com/space/WC/4255481886/Widget+Installation).

## Add Report Generator to an app

1. Open your app in ArcGIS Experience Builder.
2. Add the Report Generator widget to the page.
3. Open the widget settings.
4. Add the widget license.
5. Select the Map widget.
6. Add a data source and template relationship.
7. Upload the DOCX template.
8. Set the template name, description, and type.
9. Save and publish the Experience Builder app.

## Configure the widget

### Report templates

For each template relationship, configure:

| Setting | What it controls |
| --- | --- |
| Data Source | The data source the template applies to. |
| Template Name | The name users see in the widget. |
| Template Description | Optional text describing the template. |
| Document Template | The DOCX template file. |
| Template Type | Single Feature or Multiple Features. |

## Template tags

Report Generator supports tags in DOCX templates.

### Attribute replacement

Use feature field names in braces to insert attribute values.

```
${asset_id}
${owner_name}
${inspection_date}
```

### Selection loops

Use selection loop tags to repeat content for multiple selected features.

```
${#selection}
Name: ${name}
Status: ${status}
${/selection}
```

### Formatting

Use pipe modifiers to format dates and numbers.

```
${created_date|yyyy-MM-dd}
${population|thousands}
${cost|currency}
```

### Aggregation

Use aggregation operations across selected features.

```
${population|sum}
${score|average}
${selection_count}
```

### Maps

Use map tags to include maps in the generated report.

```
${feature-map | size: 4x3in}
${summary-map | size: 6x4in}
```

Use `feature-map` when the template should include a map for each selected feature. This is typically used inside a selection loop.

Use `summary-map` when the template should include one map showing all selected features.

Map tag options are separated with pipe characters.

```
${feature-map | size: 4x3in | highlight-color: rgba(255, 0, 0, 0.7) | highlight-width: 3}
${summary-map | size: 6x4in | extent-buffer: 0.2}
```

Supported map tag options:

| Option | Applies to | What it controls |
| --- | --- | --- |
| `size` | `feature-map`, `summary-map` | Output map image size. Use `widthxheight` with `in`, `cm`, or `px`. The default is `4x3in`. |
| `extent-buffer` | `feature-map`, `summary-map` | Expands the map extent around the selected feature or features. For example, `0.5` adds 50 percent padding. The default is `0.5`. |
| `min-scale` | `feature-map`, `summary-map` | Temporarily sets the map view minimum scale constraint while the map image is captured. |
| `max-scale` | `feature-map`, `summary-map` | Temporarily sets the map view maximum scale constraint while the map image is captured. |
| `highlight-color` | `feature-map` | Highlight colour used for the selected feature in feature maps. Use a CSS colour such as `red`, `#ff0000`, or `rgba(255, 0, 0, 0.7)`. |
| `highlight-width` | `feature-map` | Highlight line or outline width in pixels. The default is `4`. |

Examples:

```
${feature-map | size: 10x8cm}
${feature-map | highlight-color: rgba(0, 0, 255, 0.5) | highlight-width: 5}
${summary-map | min-scale: 10000 | max-scale: 5000}
```

Feature maps only add highlight graphics when the widget is capturing a map for a single feature. Summary maps fit the extent around all selected features and do not add the per-feature highlight.

## Use the widget

1. Open the Experience Builder app.
2. Select one or more features using the app's selection workflow.
3. Open Report Generator.
4. Select the report template.
5. Generate the report.
6. Download the generated document.

## Troubleshooting

### No templates are shown

Check that:

- A template relationship has been configured.
- The current selection belongs to a configured data source.
- The selected feature count matches the template type.

### Values do not appear in the report

Check that the template field tags match the data source field names.

### A map does not appear in the report

Check that the map tag syntax is valid and that the selected feature geometry can be mapped.