Summary
Gets the job's area of interest (AOI) layer as a feature layer.
Usage
The Input Job ID must be for a job that currently exists in the repository and has an AOI defined. If an AOI doesn't exist, an empty output will be generated.
The output layer has the polygon representing the AOI of the job.
The output layer can be used as input to other tools and models. It may also be saved as a feature class using the Copy Features tool.
Syntax
GetJobAOI_wmx (Input_JobID, aoi_Layer, {Input_DatabasePath})| Parameter | Explanation | Data Type |
Input_JobID | The ID of the job whose AOI is to be retrieved. | String |
aoi_Layer | The layer name for the AOI retrieved. | Feature layer |
Input_DatabasePath (Optional) | The Workflow Manager database connection file for the input job. If no connection file is specified, the current default workflow manager database in the project is used. | File |
Code Sample
GetJobAOI example (stand-alone Python script)
Gets the job's area of interest (AOI) layer as a feature layer.
# Import arcpy module
import arcpy
# Check out any necessary licenses
arcpy.CheckOutExtension("JTX")
# Local variables:
Input_JobID = "1"
AOI_Layer = "AOILayer_Job1"
Input_DatabasePath = "C:\\Program Files\\WMX\\Database\\wmx.jtc"
# Process: Get Job AOI
arcpy.GetJobAOI_wmx(Input_JobID, AOI_Layer, Input_DatabasePath)
Environments
This tool does not use any geoprocessing environments
Licensing Information
- ArcGIS for Desktop Basic: No
- ArcGIS for Desktop Standard: Requires Workflow Manager
- ArcGIS for Desktop Advanced: Requires Workflow Manager