Helps you generate reports about the work being managed in your Workflow Manager system.
You can do the following using methods in the class:
- generate a report as HTML for viewing the overall job information based on a criteria defined in the report
- get information about all the reports configured in the Workflow Manager system
- get the url for the report content for a specific report
- get the raw set report data by executing a report
- get the XSLT stylesheet for a specific report
Constructors
new ReportTask(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
| Name | Type | Summary | |
|---|---|---|---|
| String | The name of the class. more details | more details | |
| Object | The options to be used for data requests. more details | more details | |
| String | URL to the ArcGIS Workflow Manager REST service. more details | more details | |
Property Details
declaredClassStringreadonly
The name of the class. The declared class name is formatted as
esri.folder.className.requestOptionsObject
The options to be used for data requests. These options can also be controlled through the
requestOptionsmethod parameter.urlString
URL to the ArcGIS Workflow Manager REST service.
Method Overview
| Name | Return Type | Summary | |
|---|---|---|---|
| Promise | Generates a report and returns the output as formatted HTML. more details | more details | |
| Promise | Gets all the reports that are configured in the Workflow Manager system. more details | more details | |
| String | Returns the URL string for the report content. more details | more details | |
| Promise | Executes a report and returns the raw report data. more details | more details | |
| Promise | Gets the XSLT stylesheet for the specified report. more details | more details | |
Method Details
generateReport(params, requestOptions){Promise}
Generates a report and returns the output as formatted HTML.
Parameters:params ObjectSee the object specifications in table below for the structure of the
paramsobject.Specification:reportId NumberThe id of the report.
user StringThe user name requesting the report.
optionalrequestOptions ObjectAdditional options to be used for the data request (will override requestOptions defined during construction).
Returns:Type Description Promise When resolved, returns the formatted HTML report. getAllReports(requestOptions){Promise}
Gets all the reports that are configured in the Workflow Manager system.
Parameter:optionalrequestOptions ObjectAdditional options to be used for the data request (will override requestOptions defined during construction).
Returns:Type Description Promise When resolved, returns an array of reports. getReportContentUrl(params){String}
Returns the URL string for the report content.
Parameters:params ObjectSee the object specifications in table below for the structure of the
paramsobject.Specification:reportId NumberThe id of the report.
user NumberThe username of the user requesting the report content.
Returns:Type Description String Returns the URL string for the report content. getReportData(params, requestOptions){Promise}
Executes a report and returns the raw report data.
Parameters:params ObjectSee the object specifications in table below for the structure of the
paramsobject.Specification:reportId NumberThe id of the report.
user StringThe username of the user requesting the report data.
optionalrequestOptions ObjectAdditional options to be used for the data request (will override requestOptions defined during construction).
Returns:Type Description Promise When resolved, returns a ReportData object. getReportStylesheet(reportId, requestOptions){Promise}
Gets the XSLT stylesheet for the specified report.
Parameters:reportId NumberThe id of the report.
optionalrequestOptions ObjectAdditional options to be used for the data request (will override requestOptions defined during construction).
Returns:Type Description Promise 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.
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 StringA description of the report.
groups ReportDataGroup[]The aggregation of the report data into subcategories.
title StringThe title of the report.
ReportDataGroupObject
ReportDataGroup aggregates the report results into user defined categories.
Properties:aggregateLabel StringThe label of the aggregate category as defined in the report, eg. Total Jobs.
aggregateValue StringThe 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 StringThe data value based on which the section is created.