Summary
Permanently deletes one or more sessions and all related records from a Reviewer workspace.
A Reviewer session is used to store and manage the results of your data analysis throughout the life cycle of an anomaly. It allows you to organize the results discovered from running batch jobs and visual inspections.
Usage
The Reviewer Workspace can be stored in enterprise, file, or personal geodatabases.
When deleting a session from an enterprise geodatabase, connect to the Reviewer Workspace using the same version used when the session was created.
Use the Create Reviewer Session tool to create sessions.
Syntax
arcpy.Reviewer.DeleteReviewerSession(reviewer_workspace, session)
Parameter | Explanation | Data Type |
reviewer_workspace | The workspace from which the Reviewer session will be deleted. | Workspace |
session [session,...] | The Reviewer session identifier and name. The session must exist in the Reviewer workspace, for example, Session 1 : data_qc. | String |
Derived Output
Name | Explanation | Data Type |
result | The result of the delete operation. | Boolean |
Code sample
DeleteReviewerSession example 1 (stand-alone script)
The following stand–alone script demonstrates how to use the DeleteReviewerSession tool.
# Name: DeleteReviewerSession.py
# Description: Deletes a Reviewer session from a Reviewer workspace
# Author: Esri
# Date: January 2013
# Import arcpy module
import arcpy
# check out a Data Reviewer extension license
arcpy.CheckOutExtension("datareviewer")
# path to a workspace and session
reviewer_gdb = "C:\\data\\Reviewer.sde"
session="Session 1 : qc01"
# execute the Delete Reviewer Session tool
arcpy.DeleteReviewerSession_Reviewer(reviewer_gdb,session)
# check in the Data Reviewer extension
arcpy.CheckInExtension("datareviewer")
DeleteReviewerSession example 2 (Python window)
The following Python window script demonstrates how to delete multiple sessions from a Reviewer workspace.
# variable for the Reviewer workspace
rev_workspace = "C:\\Data\\Reviewer.sde"
# create a list of sessions IDs
sessions = ['Session 4 : qc01','Session 5 : qc02','Session 6 : qc03']
# execute the Delete Reviewer Session tool
arcpy.DeleteReviewerSession_Reviewer(rev_workspace,sessions)
Environments
Licensing information
- Basic: Requires Data Reviewer
- Standard: Requires Data Reviewer
- Advanced: Requires Data Reviewer