Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: DashboardTask
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/datareviewer/DashboardTask"], function(DashboardTask) { /* code goes here */ });
Description
(Added at v3.14)
Provides functionality to retrieve dashboard results from an ArcGIS Data Reviewer for Server Dashboard REST resource. Dashboard results summarize default and custom (user-defined) fields in a reviewer workspace's REVTABLEMAIN and REVBATCHRUNTABLE tables. Summary values show the number of occurrences of a unique value in a field in these tables.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new DashboardTask(url) | Creates a new DashboardTask object. |
Methods
| Name | Return type | Summary |
|---|---|---|
| createReviewerSession(sessionName, sessionOptions) | Deferred | Creates a new Reviewer session. |
| getCustomFieldNames() | Deferred | Returns an array of custom field names defined in a Reviewer workspace.
Access the array through either the deferred object, get-custom-field-names event, or onGetCustomFieldNamesComplete event.
The callback function in the deferred object will contain a response object that holds an array of custom field names defined in a Reviewer workspace. |
| getDashboardFieldNames() | Deferred | Requests Dashboard results field names. |
| getDashboardResults(fieldName, filters?) | Deferred | Requests dashboard results by fieldName. |
| getLifecycleStatusStrings() | Deferred | Retrieves a list of localized life cycle status strings from the Reviewer workspace. |
| getReviewerMapServerUrl() | String | Extracts the MapServer url from the full ArcGIS Data Reviewer for Server SOE url. |
| getReviewerSessions() | Deferred | Returns an array of sessions in a Reviewer workspace. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| create-reviewer-sessions | {
reviewerSession: < | Fires when the createReviewerSessions method is complete. |
| error | {
error: < | Fires when an error occurs during a DashboardTask method execution. |
| get-custom-field-names | {
customFieldNames: < | Fires when the getCustomFieldNames method is complete. |
| get-dashboard-field-names | {
fieldNames: < | Fires when the getDashboardFieldNames method is complete. |
| get-dashboard-results | {
dashboardResult: < | Fires when the getDashboardResults method is complete. |
| get-lifecycle-status-strings | {
lifecycleStatusStrings: < | Fires when the getLifecycleStatusStrings method is complete. |
| get-reviewer-sessions | {
reviewerSessions: < | Fires when the getReviewerSessions method is complete. |
Constructor Details
Creates a new DashboardTask object.
Parameters:
< |
Required | The DataReviewerServer Server Object Extension (SOE) URL. |
Sample:
require([
"esri/tasks/datareviewer/DashboardTask"
], function(DashboardTask) {
var dashboardTask = new DashboardTask("http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/");
Method Details
Creates a new Reviewer session. The Reviewer session stores results from check and batch job execution. The callback function in the deferred object will contain a response object that holds
ReviewerSession.Return type:
DeferredParameters:
< |
Required | Name of the session to be created. |
< |
Required | Session properties to be used to create the session. |
Returns an array of custom field names defined in a Reviewer workspace.
Access the array through either the deferred object,
get-custom-field-names event, or onGetCustomFieldNamesComplete event.
The callback function in the deferred object will contain a response object that holds an array of custom field names defined in a Reviewer workspace. The result of this method can be used to write matching custom field attributes to a Reviewer workspace using ReviewerResultsTask.writeFeatureAsResult method, or can also be used to fetch custom field values from ReviewerResultsTask.getResults method. (Added at v3.15)Return type:
DeferredRequests Dashboard results field names. The callback function in the deferred object will contain a response object that holds an array of dashboard field names.
Return type:
DeferredRequests dashboard results by fieldName. fieldName can be any of the following:
BATCHJOBCHECKGROUPCHECKTITLEFEATUREOBJECTCLASSLIFECYCLESTATUSSESSIONIDSEVERITYSUBTYPE
REVTABLEMAIN for fieldName.Return type:
DeferredParameters:
< |
Required | Field name for dashboard results. Use the getDashboardFieldNames function to get field names to use in this parameter. |
< |
Optional | Instance of ReviewerFilters containing one or more filters used to narrow down dashboard results. Similar to a where clause. See ReviewerFilters |
Sample:
var url="http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/"
var dashboardTask=new DashboardTask(url);
var deferred=dashboardTask.getDashboardResults("BATCHJOBCHECKGROUP");
//Deferred callback and errback function
deferred.then(function(response) {
array.forEach(response.dashboardResult.fieldValues, function (item,i) {
console.log("BATCHJOBCHECKGROUP Name: " + item);
console.log("Result count: " + response.dashboardResult.getCount(item));
});
}, function(error) {
console.log("Error occurred: " + error.message);
});
Retrieves a list of localized life cycle status strings from the Reviewer workspace. Each Reviewer result stored in the Reviewer workspace has a life cycle status code that matches one of the strings returned from this method execution. Use these strings to replace the numeric code values when displaying a list of Reviewer results to the user. The callback function in the deferred object will contain a response object that holds an array of lifecyclestatus strings.
Return type:
DeferredExtracts the MapServer url from the full ArcGIS Data Reviewer for Server SOE url.
Return type:
StringReturns an array of sessions in a Reviewer workspace. Access the array through either the deferred object or the onGetReviewerSessionsComplete event. The callback function in the deferred object will contain a response object that holds an array of
ReviewerSession.Return type:
DeferredSample:
var url="http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/";
var dashboardTask=new DashboardTask(url);
var deferred=DashboardTask.getReviewerSessions();
deferred.then(function(response) {
array.forEach(response.reviewerSessions, function(item,i) {
console.log("Session name: " + item.sessionName);
console.log("Session Id: " + item.sessionId);
console.log("User name: " + item.userName);
console.log("Version name: " + item.versionName);
});
},
function(error) {
console.log("Error occurred: " + error.message);
});
Event Details
[ On Style Events | Connect Style Event ]
Fires when the createReviewerSessions method is complete.
Event Object Properties:
< |
The ReviewerSession created from the createReviewerSession method. |
Sample:
require([
"esri/tasks/datareviewer/DashboardTask"
], function(DashboardTask) {
var dashboardTask = new DashboardTask(url);
dashboardTask.on("create-reviewer-sessions",function(event){
console.log("Event: ", event);
});
});Fires when an error occurs during a DashboardTask method execution.
Event Object Properties:
< |
A JavaScript error object containing the message and code properties that occurred during a BatchValidationTask method execution. |
Sample:
require([
"esri/tasks/datareviewer/DashboardTask"
], function(DashboardTask) {
var dashboardTask = new DashboardTask(url);
dashboardTask.on("error",function(event){
console.log("Event: ", event);
});
});Fires when the
getCustomFieldNames method is complete. (Added at v3.15)Event Object Properties:
< |
An array containing custom field names configured in a Reviewer workspace. |
Sample:
require([
"esri/tasks/datareviewer/DashboardTask"
], function(DashboardTask) {
var dashboardTask = new DashboardTask(url);
dashboardTask.on("get-custom-field-names",function(event){
console.log("Event: ", event);
});
});Fires when the getDashboardFieldNames method is complete.
Event Object Properties:
< |
An array property named fieldNames containing the dashboard results field names. |
Sample:
require([
"esri/tasks/datareviewer/DashboardTask"
], function(DashboardTask) {
var dashboardTask = new DashboardTask(url);
dashboardTask.on("get-dashboard-field-names",function(event){
console.log("Event: ", event);
});
});Fires when the getDashboardResults method is complete.
Event Object Properties:
< |
An instance of DashboardResult containing dashboard results based upon a specific field name and optional filters. |
Sample:
require([
"esri/tasks/datareviewer/DashboardTask"
], function(DashboardTask) {
var dashboardTask = new DashboardTask(url);
dashboardTask.on("get-dashboard-results",function(event){
console.log("Event: ", event);
});
});Fires when the getLifecycleStatusStrings method is complete.
Event Object Properties:
< |
An array of localized life cycle status strings from the Reviewer workspace. |
Sample:
require([
"esri/tasks/datareviewer/DashboardTask"
], function(DashboardTask) {
var dashboardTask = new DashboardTask(url);
dashboardTask.on("get-lifecycle-status-strings",function(event){
console.log("Event: ", event);
});
});Fires when the getReviewerSessions method is complete.
Event Object Properties:
< |
An array of sessions in a Reviewer workspace. |
Sample:
require([
"esri/tasks/datareviewer/DashboardTask"
], function(DashboardTask) {
var dashboardTask = new DashboardTask(url);
dashboardTask.on("get-reviewer-sessions",function(event){
console.log("Event: ", event);
});
});