Back to Top

Write To Reviewer Table (Data Reviewer)

In this topic

  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information

Available with Data Reviewer license.

Summary

Writes a feature class, feature layer, table, or table view to the Reviewer workspace.

Usage

  • Use this tool to write any feature class, feature layer, table, or table view to the Reviewer workspace.

    Caution:

    This tool does not support features or Reviewer workspaces that contain 64-bit object IDs.

  • The tool writes geometries from feature classes and layers to the applicable Reviewer REVTABLEPOINT, REVTABLELINE, or REVTABLEPOLY feature class.

  • The Reviewer Results pane must be closed and reopened after running this tool to view the new records.

  • To enable feature navigation and selection capabilities of the Reviewer Results pane, the ID Field and Origin Table Name parameters must be configured as follows:

    • The ID Field parameter must be populated using the unique identifier field (typically the ObjectID field).
    • The Origin Table Name parameter must be populated using the feature or object class name.

Parameters

DialogPython

LabelExplanationData Type
Reviewer Workspace

The path to the Reviewer workspace where the features or table records will be written.

Workspace
Session

The Reviewer session ID where the features or table records will be written. Use the full session ID format: Session 1 : Session 1.

String
Input Features

The features or table records that will be written to the Reviewer workspace.

Feature Layer; Table View
ID Field

The field that contains identifiers for the features. The value from this field populates the ID field in the Reviewer Results pane. The field you provide must have a data type of Long.

Field
Origin Table Name (Value or Field)

The string or field value that will be used to populate the Source field in the Reviewer Results pane for each record that is written. This is typically the name of the feature class or table.

  • String—The name of the feature layer is defined as a text string.
  • Field—The value for the feature layer name is derived from a field in the feature layer or table.
String; Field
Review Status

A status string that will be associated with the group of records written to the Reviewer workspace. The default value is Write GP Results to Reviewer Table.

Note:

If the default value is deleted or left blank, the Write GP Results to Reviewer Table value will be used as the status string.

  • String—You can type the value in the String text box.
  • Field—You can choose the Review Status field from the feature layer.
String; Field
Subtype
(Optional)

The feature class subtype to which the features belong. This can be derived from a specified value or a field on the feature class. The value from this parameter populates the Subtype field in the Reviewer Results pane.

  • String—You can type the value in the String text box.
  • Field—You can choose the Subtype value from a field on the feature layer.
String; Field
Notes
(Optional)

The text that populates the Notes field in the Reviewer table. The notes are used to provide a more specific description of the feature or table record.

  • String—You can type the value in the String text box.
  • Field—You can choose the Notes value from a field on the feature layer.
String;Field
Severity
(Optional)

A numeric value that represents the significance of the features or table records that have been written to the Reviewer workspace. The values range from 5 (low priority) to 1 (high priority). This value populates the Severity field in the Reviewer Results pane.

  • String—You can type the value in the String text box.
  • Field—You can choose the Severity value from a field on the feature layer.
String;Field
Check Title
(Optional)

The text that populates the Check Title field in the Reviewer Results pane. The Check Title value is used to describe the error condition detected on the feature or table record.

  • String—You can type the value in the String text box.
  • Field—You can choose the Check Title value from a field on the feature layer.
String;Field

Derived Output

LabelExplanationData Type
REVTABLEMAIN

Table view of error results created after tool operation.

Table View

arcpy.Reviewer.WriteToReviewerTable(in_reviewer_workspace, in_session, in_features, in_field, in_origin_table_name, in_review_status, {in_subtype}, {in_notes}, {in_severity}, {in_check_title})
NameExplanationData Type
in_reviewer_workspace

The path to the Reviewer workspace where the features or table records will be written.

Workspace
in_session

The Reviewer session ID where the features or table records will be written. Use the full session ID format: Session 1 : Session 1.

String
in_features

The features or table records that will be written to the Reviewer workspace.

Feature Layer; Table View
in_field

The field that contains identifiers for the features. The value from this field populates the ID field in the Reviewer Results pane. The field you provide must have a data type of Long.

Field
in_origin_table_name

The string or field value that will be used to populate the Source field in the Reviewer Results pane for each record that is written. This is typically the name of the feature class or table.

  • String—The name of the feature layer is defined as a text string.
  • Field—The value for the feature layer name is derived from a field in the feature layer or table.
String; Field
in_review_status

A status string that will be associated with the group of records written to the Reviewer workspace. The default value is Write GP Results to Reviewer Table.

Note:

If the default value is deleted or left blank, the Write GP Results to Reviewer Table value will be used as the status string.

  • String—You can type the value in the String text box.
  • Field—You can choose the Review Status field from the feature layer.
String; Field
in_subtype
(Optional)

The feature class subtype to which the features belong. This can be derived from a specified value or a field on the feature class. The value from this parameter populates the Subtype field in the Reviewer Results pane.

  • String—You can type the value in the String text box.
  • Field—You can choose the Subtype value from a field on the feature layer.
String; Field
in_notes
(Optional)

The text that populates the Notes field in the Reviewer table. The notes are used to provide a more specific description of the feature or table record.

  • String—You can type the value in the String text box.
  • Field—You can choose the Notes value from a field on the feature layer.
String;Field
in_severity
(Optional)

A numeric value that represents the significance of the features or table records that have been written to the Reviewer workspace. The values range from 5 (low priority) to 1 (high priority). This value populates the Severity field in the Reviewer Results pane.

  • String—You can type the value in the String text box.
  • Field—You can choose the Severity value from a field on the feature layer.
String;Field
in_check_title
(Optional)

The text that populates the Check Title field in the Reviewer Results pane. The Check Title value is used to describe the error condition detected on the feature or table record.

  • String—You can type the value in the String text box.
  • Field—You can choose the Check Title value from a field on the feature layer.
String;Field

Derived Output

NameExplanationData Type
REVTABLEMAIN_View

Table view of error results created after tool operation.

Table View

Code sample

WriteToReviewerTable example (stand-alone script)

Before running the example script, use CreateReviewerSession to create a Reviewer session.

# Name: WriteToReviewerTable_Example.py
# Description: Imports features into the Reviewer workspace
# Requirements: ArcGIS Data Reviewer extension

# Import arcpy module
import arcpy
from arcpy import env

# Check out a Data Reviewer extension license
arcpy.CheckOutExtension("datareviewer")

# set the environment
env.workspace = "c:/arcgis/ArcTutor/Data Reviewer"

# Path to feature class and Reviewer workspace
Hospitals = "California.gdb/Landmarks/Hospitals"
reviewer_gdb = "Reviewer.gdb"

# Use the Create Reviewer Session tool to create a session before running this script.
Session = "Session 1 : Session 1"

# Execute the Write to Reviewer Table function with all required parameters
# Original Table name determined by the String value
arcpy.WriteToReviewerTable_Reviewer(reviewer_gdb, Session, Hospitals, "OBJECTID", "My table name", "My review status")

# Execute the Write to Reviewer Table function with all required parameters
# Original Table name determined by the value in the field specified
arcpy.WriteToReviewerTable_Reviewer(reviewer_gdb, Session, Hospitals, "OBJECTID", "NAME", "My review status")

# Execute the Write to Reviewer Table function with all required parameters and all optional parameters
# Original Table name/Subtype/Notes/Severity/Check Title determined by the String value
arcpy.WriteToReviewerTable_Reviewer(reviewer_gdb, Session, Hospitals, "OBJECTID", "My table name", "My review status", "My Subtype", "New Hospitals", "3", "My Check results")

# Execute the Write to Reviewer Table function with all required parameters and optional parameters
# Original Table name/Subtype/Notes/Check Title determined by the value in the field specified
arcpy.WriteToReviewerTable_Reviewer(reviewer_gdb, Session, Hospitals, "OBJECTID", "NAME", "CITY", "TYPE_CODE", "ADMIN_DESC", "3", "TYPE_DESC")

# Check in the Data Reviewer extension
arcpy.CheckInExtension("datareviewer")

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: Requires Data Reviewer
  • Standard: Requires Data Reviewer
  • Advanced: Requires Data Reviewer

Related topics

  • An overview of the Data Validation toolset
  • Find a geoprocessing tool

Feedback on this topic?

In this topic
  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information