require(["esri/tasks/workflow/ReportTask"], function(ReportTask) { /* code goes here */ });
Class: esri/tasks/workflow/ReportTask
Inheritance: ReportTask Task Accessor
Since: ArcGIS API for JavaScript 4.3

Helps you generate reports about the work being managed in your Workflow Manager system.

You can do the following using methods in the class:

Constructors

new ReportTask(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Object

The options to be used for data requests.

more details
more detailsTask
String

URL to the ArcGIS Workflow Manager REST service.

more details
more detailsReportTask

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

requestOptionsObject inherited

The options to be used for data requests. These options can also be controlled through the requestOptions method parameter.

URL to the ArcGIS Workflow Manager REST service.

Method Overview

NameReturn TypeSummaryClass
Promise<String>

Generates a report and returns the output as formatted HTML.

more details
more detailsReportTask
Promise<Report>

Gets all the reports that are configured in the Workflow Manager system.

more details
more detailsReportTask
String

Returns the URL string for the report content.

more details
more detailsReportTask
Promise<ReportData>

Executes a report and returns the raw report data.

more details
more detailsReportTask
Promise<String>

Gets the XSLT stylesheet for the specified report.

more details
more detailsReportTask

Method Details

generateReport(params, requestOptions){Promise<String>}

Generates a report and returns the output as formatted HTML.

Parameters:
params Object

See the object specifications in table below for the structure of the params object.

Specification:
reportId Number

The id of the report.

user String

The user name requesting the report.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< String>When resolved, returns the formatted HTML report.

getAllReports(requestOptions){Promise<Report>}

Gets all the reports that are configured in the Workflow Manager system.

Parameter:
requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Report>When resolved, returns an array of reports.

getReportContentUrl(params){String}

Returns the URL string for the report content.

Parameters:
params Object

See the object specifications in table below for the structure of the params object.

Specification:
reportId Number

The id of the report.

user Number

The username of the user requesting the report content.

Returns:
TypeDescription
StringReturns the URL string for the report content.

getReportData(params, requestOptions){Promise<ReportData>}

Executes a report and returns the raw report data.

Parameters:
params Object

See the object specifications in table below for the structure of the params object.

Specification:
reportId Number

The id of the report.

user String

The username of the user requesting the report data.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< ReportData>When resolved, returns a ReportData object.

getReportStylesheet(reportId, requestOptions){Promise<String>}

Gets the XSLT stylesheet for the specified report.

Parameters:
reportId Number

The id of the report.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< String>When resolved, returns the XSLT stylesheet for the specified report as a string.

Type Definitions

ReportObject

Report represents a configured report in the Workflow Manager system.

Properties:
description String

A description of the report.

hierarchy String

The category to which the report belongs in the system.

A unique id for the report.

name String

The name of the report.

title String

The title of the report.

ReportDataObject

ReportData is the generated result of a report after it has been executed.

Properties:
columns String[]

The name of columns returned as part of the report.

description String

A description of the report.

The aggregation of the report data into subcategories.

title String

The title of the report.

ReportDataGroupObject

ReportDataGroup aggregates the report results into user defined categories.

Properties:
aggregateLabel String

The label of the aggregate category as defined in the report, eg. Total Jobs.

aggregateValue String

The value of the aggregate category based on the calculation defined in the report section options.

The rows containing the data returned in the report.

value String

The data value based on which the section is created.

API Reference search results

NameTypeModule

There were no match results from your search criteria.