Examples

Use this widget to support app design requirements such as the following:

• You want to generate a report about assets you inspected in the field.
• You want to generate an inspection report for all assets you inspected within a certain time period.

Usage notes

This widget requires connection to a data source. The data source must be a feature layer that is associated with an ArcGIS Survey123 survey.

Survey123 surveys can have associated report templates. If you are the survey item owner or an organization administrator, you can upload a new report template with the Feature Report widget and attach it to the survey. The item owner and organization administrators can also delete and update report templates. Organization members with shared ownership of a survey can update the report template by, for example, changing the name, summary, or template file. Users who are not item owners or organization administrators can only use a report template that is already attached to the survey layer.

Using this widget is an ArcGIS Online Premium Service and consumes credits. To use the widget at run time, the user must be signed in with an ArcGIS account with a user type that has privileges to print feature reports. Learn more about configuring organization member roles.

• Generating a report with the Feature Report widget consumes a minimum of 0.5 credits.
• Generating a report from multiple records consumes 0.5 credits per record.
• Any related records for a record can be included in a report at no extra cost.
• Summary sections do not incur credit charges beyond the cost of other reports printed at the same time.

To test your report without consuming credits, you can click Preview sample report. This generates a watermarked .pdf file for up to 20 features at a time at no credit cost. Printing reports in ArcGIS Enterprise does not consume credits but does have limitations.

Settings

The Feature Report widget includes the following settings:

• Select data—Select a feature layer to use to generate reports. The feature layer must be associated with a survey.
• Report template—Select report templates to use to generate reports. You can add a new template or start with any of the three provided sample templates:
  • Individual record is a template designed for one input record. Adding multiple input records generates multiple reports.
  • Summary is a template that summarizes information across multiple records. Adding multiple input records generates a single report.
  • Combined is a template that generates individual reports for each input record and a summary report for all input records.

  Tip:

  Click Help to open the Report Template Help window, which has links to relevant Survey123 documentation. You can also download .docx files of the three sample templates.

  Click + New template to open the Manage template panel.

  • Select existing template—Use an existing template that is already associated with the survey. If there are any, they appear in the drop-down menu.
  • Upload new template—Upload a new template by browsing for a file in local storage. If you upload a template, it is attached to the survey. The template's share settings are the same as those configured for the survey under Who can view the results of this survey? on the Share results tab of Survey123 settings. This setting is only available for survey item owners and organization administrators.
  • You must enter a name for the new template. Optionally, you can enter a summary description. Click Save to add the template.

• Configuration—Configure settings for the components that appear in the widget panel. For each component, you can change the run time label. For most components, you can click the visibility button to make the component appear or not appear in the widget panel at run time. If you make a component visible, the user can interact with it at run time and make choices such as what to name their report file. If you make a component invisible, the settings you configure are unchangeable by the user. The widget can have the following user interface components:
  • Input features—Displays the total number of records included in the report and lists the first 10 records according to the specified template. You can use the attribute selector to also list certain attributes for the records.
  • Select template— This drop-down menu allows the user to select a report template. This is useful if you connect multiple report templates.
  • Output settings—Options related to the output report, such as the file name and where to save the report. Click the gear button to open the Output settings panel.
    • File options—Determines how records are printed and how the widget handles multiple records. Split generates one report for each record or summary. When the user prints multiple reports at once, Merge (next page) separates the reports using page breaks and Merge (continuous) formats them in a continuous list.
    • Report name—The name of the output report file. You can use the attribute selector to include dynamic text in the file name.
    • Save to my ArcGIS account—Allows the user to choose where to save the report. By default, the save location is the user's root folder.
    • Format—Allows the user to choose whether to save the report as a Microsoft Word document (.docx) or PDF (.pdf).
  • Show credits—Calculates the number of credits needed to generate the report.
  • Generate—The button that the user clicks to generate a report. This component cannot be hidden.
  • Recent reports—Lists the 10 most recently generated reports. This component cannot be hidden.