Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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.

urlString

URL to the ArcGIS Workflow Manager REST service.

Method Overview

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:

Type	Description
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:

Type	Description
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:

Type	Description
String	Returns 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:

Type	Description
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:

Type	Description
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.

id Number 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.

groups ReportDataGroup[] 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.

row String[] The rows containing the data returned in the report.

value String The data value based on which the section is created.