Workflow configuration using the Data Reviewer custom steps

Available with Data Reviewer license.

The sections below illustrate how the steps can be configured and provide additional guidance and best practices.

Create Reviewer Session step

The Create Reviewer Session step creates a Reviewer session and an association between the new Reviewer session and the job. The Launch ArcMap step, when configured with the Start Reviewer Session command, can use this association to perform its operation. Multiple Reviewer sessions per job are supported.

During step configuration, you must specify a set of arguments that determines how the Reviewer session is created. The Create Reviewer Session dialog box guides you in setting up these arguments.

The table below describes each argument for the step and its associated behavior.

Name	Description	Argument example	Behavior
Results Workspace (Required)	Specifies the Results workspace where the new session will be created. The argument may be set in three ways: Same as the job's data workspace WMX Data Workspace Connection Personal or File Geodatabase Note: An existing Reviewer workspace must be selected. This step will not create a Reviewer workspace.	/StoreInJobDW	The Reviewer workspace is identified as being the same as the job's data workspace. On step execution, the new Reviewer session is created in the job's data workspace. Tokens are accepted in this argument.
		/RevWSVersion:[JOB:VERSION]	On step execution, the new Reviewer session is associated with the specified geodatabase version. The default is the [JOB:VERSION] token.
		/WMXDW:Reviewer	The Reviewer workspace is identified as being a Workflow Manager (Classic) data workspace. On step execution, the Reviewer session is created in this workspace.
		/RevWSVersion:DEFAULT	On step execution, the new Reviewer session is associated with the specified geodatabase version.
		/ReviewWS:"C:\Data\Reviewer.gdb"	The Reviewer workspace is identified as being a file or personal geodatabase. On step execution, the Reviewer session is created in this workspace. Tokens are accepted in this argument.
Session Properties (Only Session Name property is required)	Specifies properties for the session. These include the name of the session, who created it, how duplicate checking is performed, and whether a result's geometry should be stored or not. These properties must be set: Session Name Session User Name Check for Duplicate Results Do Not Store Result Geometry	/SessionName:Job[JOB:ID]	On step execution, the new Reviewer session is named according to this argument. In the argument example, the Reviewer session is named based on the job ID, for example, Job123. The default is the [JOB:ID] token.
		/SessionUserName:[JOB_ASSIGNED_TO]	The name of the person creating this Reviewer session. The default is [JOB_ASSIGNED_TO] —who the job is assigned to. Note: If this field is left blank, the [JOB_ASSIGNED_TO] token will be honored. Tokens are accepted in this argument.
		/CheckDuplicateResults:SESSION	Determines how duplicate validation results are handled in the session. NONE—Does not search for duplicate validation results. SESSION—Searches within the session for duplicate validation results. This is the default. DATABASE—Searches the entire database for duplicate validation results.
		/DoNotStoreResultsGeometry	Determines if a result includes an associated geometry. Store Result Geometry(Unchecked)—Results will include both geometry and attribute information. This is the default. Do Not Store Result Geometry(Checked)—Results will include only attribute information.

Note:

If the custom step Support Platform type is set to Server or Both, all execution dialog boxes are suppressed and do not display.

When this step is executed in ArcGIS Pro all dialog boxes are suppressed and do not display.

Learn more about creating step types

Run Reviewer Batch Job step

The Run Reviewer Batch Job step executes a batch job in a workflow.

Arguments may be used to specify the following:

• The batch job that is going to be executed
• The spatial data the batch job is going to validate
• The Reviewer workspace and session where the results are written

The Run Reviewer Batch Job dialog box guides you in configuring these arguments:

The table below describes each argument for the step and its associated behavior.

Name	Description	Argument example	Behavior
Reviewer Batch Job File (Required)	Specifies the path to the Reviewer batch job.	/BatchJobPath:"C:\Data\sample.rbj"	On execution, the specified batch job is run. Tokens are accepted in this argument.
Data Workspace (Optional) Note: Required if the Override Batch Job Data Workspace check box is checked.	Identifies the data workspace that the batch job is going to be run against. The argument may be set in three ways: Same as the job's data workspace WMX Data Workspace Connection Personal or File Geodatabase	If you check the Override Batch Job Data Workspace check box, use an argument such as /OverrideBatchDataWS.	On step execution, the batch job will run against the data workspace specified in the step type. The alternate workspace and version must be specified using the Reviewer Batch Job Data Workspace and Reviewer Batch Job Data Version arguments.
		/SameAsJobDW	On step execution, the batch job validates data within the job's data workspace.
		/BatchJobDataVersion:[JOB:VERSION]	On step execution, the batch job validates data within the specified version. The default is the [JOB:VERSION] token.
		/BatchJobInWMXDW:Reviewer	On step execution, the batch job validates data within the specified Workflow Manager (Classic) data workspace.
		/BatchJobInWMXDW:DEFAULT	On step execution, the batch job validates data within the specified version.
		/BatchJobDataInPersonalFile:"C:\Data\MyData.gdb"	On step execution, the batch job validates data within the specified file or personal geodatabase. Tokens are accepted in this argument.
Results Workspace (Required)	Specifies the Reviewer workspace where results will be written. This argument maybe set in three ways: Same as the job's data workspace WMX Data Workspace Connection Personal or File Geodatabase Note: An existing Reviewer workspace must be selected. This step will not create a Reviewer workspace.	/RevIsSameAsJobDW	The Reviewer workspace is identified as being the same as the job's data workspace. On step execution, Reviewer results are written to the job's data workspace.
		/RevWSVersion:[JOB:VERSION]	On step execution, Reviewer results are written to the specified version. The default is [JOB:VERSION] token.
		/RevInWMXDW:Reviewer	The Reviewer workspace is identified as being a Workflow Manager (Classic) data workspace. On step execution, Reviewer results are written to this data workspace.
		/RevWSVersion:DEFAULT	On step execution, Reviewer results are written to the specified version.
		/RevInPersonalFile:"C:\Data\Reviewer.gdb"	The Reviewer workspace is identified as being a file or personal geodatabase. On step execution, Reviewer records are written to this data workspace. Tokens are accepted in this argument.
Reviewer Session Name (Required)	Specifies the Reviewer session where results are going to be written. Note: The Reviewer session must exist before executing the step. This step will not create a Reviewer session.	/RevSessionName:JOB[JOB:ID]	On step execution, Reviewer records are written to the specified session. If there is more than one Reviewer session with the same name, you are prompted to choose which Reviewer session you want records to be written to. Tokens are accepted in this argument.
Analysis Area (Required)	Specifies the spatial extent on which the batch job is run.	/AreaValidation:FullDB	On step execution, the batch job is run against the entire geodatabase.
		/AreaValidation:AOI	On step execution, the batch job is run against the job's area of interest.
		/AreaValidation:ChangedOnly	On step execution, the batch job is run against changed features only. Note: This option is only valid when working with a versioned dataset.
Result Created By	Specifies the name of the person who created the Reviewer results.	/SessionUserName:[JOB_ASSIGNED_TO]	The name of the person creating the Reviewer results. The default is [JOB_ASSIGNED_TO]. Note: If this field is left blank, the [JOB_ASSIGNED_TO] token will be honored.

Note:

If the custom step Support Platform type is set to Server or Both, all execution dialog boxes are suppressed and do not display. When a job is associated with multiple Reviewer sessions, results are written to the session with the highest (most recent) session ID.

When this step is executed in ArcGIS Pro all dialog boxes are suppressed and results are written to the highest (most recent) session ID.

Learn more about creating step types

Start Reviewer Session command

When using the Data Reviewer custom steps as part of a workflow, it is possible to configure the Launch ArcMap step to start a Reviewer session associated with the job.

The table below outlines each step type argument and associated behavior.

Name	Description	Argument example	Behavior
Run ArcMap Command		/guid:WMXReviewer.StartSession	On step execution, Workflow Manager starts ArcMap and the Reviewer session associated with the job. If there is more than one Reviewer session associated with the job, you will be prompted to choose which Reviewer session will be started.

Note:

If the custom step Support Platform type is set to Server or Both, all execution dialog boxes are suppressed and do not display. When a job is associated with multiple sessions, the system will choose the session with the highest (most recent) session ID.

Learn more about creating step types

See Workflow Manager custom steps for general information about configuring the Launch ArcMap custom step.

Delete Reviewer Session step

The Delete Reviewer Session step deletes one or more Reviewer sessions that were created using the Create Reviewer Session step during a job’s execution.

During step configuration, you must specify the argument that determines the Reviewer sessions to be deleted.

Name	Description	Argument example	Behavior
Session(s) to Delete (Required)	Specifies which Reviewer sessions to be deleted.	/sessionsToDelete:all	On step execution, the specified Reviewer sessions are deleted. all—All Reviewer sessions associated with the job are deleted. selected—You are prompted to select one or more sessions for deletion.

Note:

If the custom step Support Platform type is set to Server or Both, all execution dialog boxes are suppressed and do not display. When a job is associated with multiple sessions, the session with the highest (most recent) session ID is deleted when the selected argument is specified.

When this step is executed in ArcGIS Pro all dialog boxes are suppressed and the highest (most recent) session ID is deleted when the selected argument is specified.

Learn more about creating step types