License:
Organization members must be assigned the ArcGIS Advanced Editing user type extension to use this step.
The Evaluate Data Quality step allows you to evaluate the quality of the data used in a job using the Validation Service's Evaluate operation. When the step runs, it evaluates the rules associated with the data reference configured with the workflow diagram and identifies errors.
When the step is run, it can be cancelled by clicking Cancel.
Note:
If the step isn't optional, the step must be run before it can finish.
Configure the step
To configure the step, do the following:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Evaluate Data Quality from the Step Library panel to a connection arrow of a step on the workflow canvas.
The Step Details panel appears.
- Provide a name for the step in the Step Name text box.
- In the Evaluation Type section, check the check boxes for the type of evaluation you want to perform.
- Validation Rules—Check features in a dataset based on specific requirements or constraints.
- Calculation Rules—Automatically populate attribute configurations for features.
- Topology Rules—Compare feature geometry to all topology rules defined in the source geodatabase.
- In the Data Sources section, choose one of the following options:
- All—Evaluate all data references associated with the workflow diagram.
Note:
Only feature service data references hosted on the current ArcGIS Enterprise portal that have the validation capability will be evaluated.
Select Sources—Choose the feature service data references that you want to evaluate from the drop-down menu.
If you don't have a feature service data reference associated with the workflow diagram, click Add data reference from the drop-down menu and add a data reference by doing one of the following:
- Browse for item—Browse and choose from a list of items on the current portal.
Tip:
You can refine results by applying filters and tags to the search.
Enter item ID manually—Provide the item ID and reference name in the Item ID and Reference Name text boxes.
The item is automatically validated by Workflow Manager and the data reference type is set in the Type bar.
If the data reference cannot be validated, you must provide the item ID to a valid data reference that matches the set data reference type.
- Browse for item—Browse and choose from a list of items on the current portal.
Arcade Expression—Provide an ArcGIS Arcade expression that returns the data reference's item ID to dynamically determine the data reference that will be evaluated when the step is run.
The Arcade expression must return the data reference ID, not the data reference name.
Click This input supports Arcade Expressions
and choose an Arcade expression to add it to its associated text box.
- All—Evaluate all data references associated with the workflow diagram.
- In the Data to Evaluate section, choose one of the following options:
- Job Location—Only evaluate data in the defined job location.
- Entire Dataset—Evaluate all data in the dataset.
- In the Version section, choose one of the following options:
- Job Version—Evaluate the job-specific version of the data.
- Default—Evaluate the default version of the data.
- Optionally, uncheck the Run as asynchronous job check box to run the evaluations sequentially.
- Optionally, check the Run on changes in version only check box to only run the evaluation on changes that are made to the job-specific version of the data.
- Click the Options tab.
- Configure Step Options as necessary:
- Manual—Run the step manually.
- Optional—Allow the step to be finished without being run.
- Automatic—Run the step as soon as it becomes active.
Note:
If the workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token expires will not run automatically. The ArcGIS Workflow Manager Server Advanced role is required to run additional automated steps without manual intervention.
- Run on a Schedule—Run the step according to a set schedule.
- Manual—Run the step manually.
- Optionally, choose one of the following options to configure help in the step:
- None—Configure the step without step help.
- Text—Configure help text for the step in the Text text box.
You can use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, format the text as follows:
'For further assistance, please contact' + JobCreator($Job) + '.' - URL—Configure the step with a link to a help resource in the URL text box.
Note:
Steps that are run in the web app only support HTTP and HTTPS URL formats. Steps that are run in ArcGIS Pro support HTTP, HTTPS, and file formats.
You can also use Arcade expressions to provide a dynamic value. If the URL contains plain text and Arcade expressions, format the text as follows:
'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'Configure the Automatically Encode Arcade Result check box as follows:
- If an Arcade expression returns special characters that must be escaped when converted to a URL, such as a space or a forward slash, ensure that the Automatically Encode Arcade Result check box is checked.
- If an Arcade expression is used to form the base URL, uncheck the Automatically Encode Arcade Result check box.
- Optionally, click the Style tab to change the shape and color of the step.
- Optionally, click the About tab and provide a description for the step in the Step Description text box.
Tip:
The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output. Click Copy Step ID
to copy the step ID to the clipboard.
Return value
When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:
| Return value | Description |
|---|---|
| S000001 | The step completed successfully. |
F000001 | The step failed to complete successfully. |
Output value
When the step is completed, its output value is stored and can be used to determine the path the workflow follows or can be used as inputs for other steps throughout the workflow. The following table lists the step's output values:
| Output | Description |
|---|---|
errorsIdentified | Returns the number of identified errors. |
| moment | Returns the date and time of the response. |
success | Returns true if the step completed successfully or false if the step failed to complete successfully. |