Summary
Extracts features from a source geodatabase into a target geodatabase based on the Filter Feature Layer parameter (or job AOI).
The Target Database parameter value can be a database that includes the input schema, or it can be an empty database in which the tool will create a schema that matches the Source Database parameter value.
Caution:
This tool is designed to be run as a step in a Workflow Manager (Classic) workflow. Running this tool outside of Workflow Manager (Classic) does not honor all Workflow Manager (Classic) constraints such as job assignment, dependencies, or holds and may cause a job to enter an unusable state.
Caution:
This tool is intended for use with the Topographic Mapping production workflows and will not support an improperly configured Workflow Manager (Classic) repository. Sample workflows and instructions for configuring Topographic Mapping production workflows are available as part of the product file installer.
Usage
This tool will extract all points, polylines, polygons, and annotation features from the Source Database parameter. If the input features include a topology, features are extracted from all the layers that participate in that topology.
For tables, only the schema for the table will be copied to the Target Database parameter value.
The Target Database parameter value must exist before this tool can run.
If the Target Database value includes feature classes with the same name as features classes in the source, the tool will reuse the schema in the Target Database parameter and only get features for these feature classes.
If no Filter Feature Layer value is specified, the tool will use the job AOI as the extent for extraction.
If the Replicate Data option is chosen for the Extract Operation parameter, all features that intersect the Filter Feature Layer value, or job AOI, will be extracted. If the Extract Data option is chosen for the Extract Operation parameter, you can choose the feature extents using the Filter Spatial Relation parameter.
The Filter Feature Layer parameter requires that only one feature is selected.
The selected feature in the Filter Feature Layer parameter must be a polygon. If it is not, the tool will return an error.
Syntax
arcpy.topographic.GetFeaturesByJobAOI(job_id, source_database, target_database, extract_operation, {filter_feature}, {filter_type}, {replica_type}, {database_path})| Parameter | Explanation | Data Type |
job_id | The job ID of the Workflow Manager (Classic) job that will be updated. The default area over which features will be extracted or replicated is also determined. | Long |
source_database | The path to the source database containing features to extract. | Workspace |
target_database | The database from which features will be extracted. | Workspace |
extract_operation | Specifies whether the data will be copied to the target database or replicated to the target database.
| String |
filter_feature (Optional) | A feature layer with one selected feature used to limit the extent of the data that will be extracted. If no filter feature is specified, the job AOI will be used. | Feature Layer |
filter_type (Optional) | Specifies the spatial relationship between Source Database and Filter Feature Layer. This parameter is only used if the extract_operation parameter is set to EXTRACT_DATA.
| String |
replica_type (Optional) | Specifies the type of replica that will be created. This parameter is only used if the extract_operation parameter is set to REPLICATE_DATA.
| String |
database_path (Optional) | The Workflow Manager (Classic) database connection file (.jtc) that contains the job information. If no connection file is specified, the current default Workflow Manager (Classic) database will be used. | File |
Derived Output
| Name | Explanation | Data Type |
| updated_database | Returns the Target Database with the extracted features added to the databases. | Workspace |
Code sample
The following stand-alone script demonstrates how to use the GetFeaturesByJobAOI function to extract features from a source geodatabase into a target geodatabase based on the filter_feature parameter (or job AOI).
# Name: GetFeaturesByJobAOI_sample.py
# Description: Sample script extracts features from a source geodatabase into a target
# geodatabase based on the Filter Feature Layer (or job AOI).
# Import System Modules
import arcpy
# Check Out Extensions
arcpy.CheckOutExtension('Foundation')
arcpy.CheckOutExtension('JTX')
# Setting the environment
arcpy.env.overwriteOutput = True
# Setting Local Variables
job_id = 11883
source_database = r'\\server1\data\TopoMapping\TestData\ProJobArtifacts\TDS_JOB_11882'
target_database = r'C:\data\Geodatabases\TDS_JOB_11882.gdb'
extract_operation = 'REPLICATE_DATA'
filter_feature = ''
filter_type = 'CONTAINS'
replica_type = 'CHECK_OUT'
database_path = ''
# Calling the Copy Job Files tool to copy files from a shared server machine to a location on a local machine
arcpy.topographic.(job_id, source_database, target_database, extract_operation, filter_feature, filter_type, replica_type, database_path)
# Getting all messages, warnings, and errors from the tool run and printing the results back to the user
messages = arcpy.GetMessages(0)
warnings = arcpy.GetMessages(1)
errors = arcpy.GetMessages(2)
arcpy.AddMessage('Tool Messages: {}\nTool Warnings: {}\nTool Errors{}\n'.format(messages, warnings, errors))
# Check In Extensions
arcpy.CheckInExtension('Foundation')
arcpy.CheckOutExtension('JTX')Environments
Licensing information
- Basic: No
- Standard: Requires Production Mapping and Workflow Manager
- Advanced: Requires Production Mapping and Workflow Manager