Run Report Activity

Description

The Run Report activity runs a VertiGIS Studio report. You must supply the URL of a report item located in ArcGIS Online or Portal for ArcGIS.

Usage

You could allow the user to select features and areas on a map and pass them as inputs to the Run Report activity. The report must be configured to expect these inputs. You could then provide the user a link to download the report.

Inputs

Url

Required

Type: String

The URL of the report to run.

Feature Ids

Optional

Type: Object[]

The IDs of the features to generate the report for.

This corresponds to the FeatureIds input parameter of layer reports.

Parameters

Optional

Type: Lookup<any | any[]>

Additional report parameters.

Example: ={ title: "Report Title", parameter1: 1, parameter2: "two" }

Include Map

Optional

Type: Boolean

Indicates whether the activity should include a web map when running the report. If the report template contains a Map Picture Box control and Include Map is true, the control will show the currently selected map in the generated report.

When run in ArcGIS Web AppBuilder, this will not work unless the VertiGIS Studio Printing widget is installed. You will need to Prepare the Printing Widgets for Web AppBuilder.

Webmap Parameters

Optional

Type: Object | Object[]

The parameters for including a map or maps in a report.

Result File Name

Optional

Type: String

The name of the result file that is downloaded.

Data Sources

Optional

Type: Object | Object[]

Replace the data from one or more data sources at run time.

Each object in the array has a name and a value:

{
    "name": "{data-source-name}",
    "value": { replacement-data }
}

The name is the name of the data source whose data you want to replace. The name must match the name of the data source in the report.

The value is an object that defines the data to use in the report. The value is defined using the same schema as the data source in the report.

Format

Optional

Type: "docx" | "pdf" | "rtf" | "xlsx" | String

The output format of the report. The default is "pdf".

Requires Reporting 5.20 or later.

Language

Optional

Type: String

The language code for the language to use within the report. For example, "en-US" is English (United States).

If not specified, the language of the application running the workflow is used.

Outputs

href

Type: String

The URL to the report result.

Properties

For information about the ID, Display Name, and Description properties, see Properties Common to all Activities.

Connectivity Requirements

This activity does not work when the device has intermittent connectivity to the network.

Version Information

Supported from: VertiGIS Studio Workflow 2.9, ArcGIS Web AppBuilder 2.4.