ArcMap

Create Reviewer Session

Available with Data Reviewer license.

Summary

Creates a new Reviewer session in the specified workspace.

Usage

  • The input workspace must be a Reviewer workspace. Use the Enable Data Reviewer or the Reviewer Session Manager tool to create a Reviewer workspace.

  • The input workspace must contain a current version of the Reviewer schema. If not, use the Enable Data Reviewer or the Reviewer Session Manager tool to upgrade the workspace.

  • The Session Template parameter allows you to copy settings from an existing Reviewer session into the new session created by this tool. Settings include the following:

    • Continue batch processing if check fails
    • Do not store geometry for faster processing
    • Reviewer Table Writer Options (Check for duplicates)
    • Reviewer Table Properties

    If you use a Session Template, these parameters will be disabled:

    • Check For Duplicates
    • Do Not Store Geometry
    • Session Name
    • Session Version

Syntax

CreateReviewerSession(reviewer_workspace, session_name, {session_template}, {duplicate_checking}, {store_geometry}, {username}, {version})
ParameterExplanationData Type
reviewer_workspace

The workspace in which a new Reviewer session is going to be created.

Workspace
session_name

The name of the session that is going to be created in the Reviewer workspace.

String
session_template
(Optional)

An existing Reviewer session whose properties will be copied to the new session.

String
duplicate_checking
(Optional)

Determines how duplicate validation results are handled in the session.

  • NONE —Does not search for duplicate validation results. This will improve performance when writing validation results to the database. This is the default.
  • SESSION —Searches within the session for duplicate validation results.
  • DATABASE —Searches the entire database for duplicate validation results.
String
store_geometry
(Optional)

Determines if a result includes an associated geometry.

  • STORE_GEOMETRY —Results will include both geometry and attribute information. This is the default.
  • DO_NOT_STORE_GEOMETRY —Results will include only attribute information. This can improve performance when writing validation results to the geodatabase.
Boolean
username
(Optional)

The user name of the person creating this Reviewer session. This defaults to the currently logged in Windows user.

String
version
(Optional)

The enterprise geodatabase version to which the session will be associated and is only enabled when you choose a Reviewer workspace stored in an enterprise geodatabase.

String

Derived Output

NameExplanationData Type
session

The name of the Reviewer session created after tool execution.

String

Code sample

CreateReviewerSession example (stand-alone script)

This stand-alone Python script creates a new session in the Reviewer workspace stored in an enterprise geodatabase. The session is called QC Pass 1.

# Name: CreateReviewerSession.py
# Description: Creates a reviewer session in a geodatabase
# Author: Esri
# Date: December 2011

# Import arcpy module
import arcpy

# check out a data reviewer extension license
arcpy.CheckOutExtension("datareviewer")

# path to a workspace
reviewer_gdb = "C:/SampleData/Reviewer.sde"

# Execute the Create Reviewer Session tool
arcpy.CreateReviewerSession_Reviewer(reviewer_gdb, "QC Pass 1")

# check in the data reviewer extension
arcpy.CheckInExtension("datareviewer")
CreateReviewerSession example 2 (stand-alone script)

This stand-alone Python script creates a new session in the Reviewer workspace stored in an enterprise geodatabase. The duplicate checking and store geometry parameters are set.

# Name: CreateReviewerSession.py
# Description: Creates a reviewer session in a geodatabase
# Author: Esri
# Date: May 2015

# Import arcpy module
import arcpy

# check out a data reviewer extension license
arcpy.CheckOutExtension("datareviewer")

# path to a workspace
reviewer_gdb = "C:/SampleData/Reviewer.sde"

# Execute the Create Reviewer Session tool. Do not specify a template session and set the duplicate checking and store geometry parameters.
# Session User Name parameter is not supplied so it will be set to the logged in user name.
# Session Version parameter is not supplied so it will be set to the Default version.

arcpy.CreateReviewerSession_Reviewer(reviewer_gdb, 'Test Session', '', 'DATABASE', 'DO_NOT_STORE_GEOMETRY')

# check in the data reviewer extension
arcpy.CheckInExtension("datareviewer")

Environments

Licensing information

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

Related topics