Skip To Content

Get Job AOI

Summary

Gets the job's location of interest (LOI) as a feature layer. The output layer has either the polygon representing the area of interest (AOI) of the job or point representing the point of interest (POI) of the job.

Usage

  • The Input Job ID must be for a job that currently exists in the repository and has location of interest features defined. If there are no location of interest features, an empty output will be generated.

  • The output layer has either the polygon representing the area of interest (AOI) of the job or point representing the point of interest (POI) of the job. For more information about the location of interest see: Location of interest.

  • 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})
ParameterExplanationData Type
Input_JobID

The ID of the job whose AOI is to be retrieved.

String
aoi_Layer

The layer name for the location of interest retrieved. The output layer has either the polygon representing the area of interest (AOI) of the job or point representing the point of interest (POI) of the job.

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 jobs location of interest (LOI) layer as a feature layer. The output layer has either the polygon representing the area of interest (AOI) of the job or point representing the point of interest (POI) of the job.

# Import arcpy module
import arcpy

# Check out any necessary licenses
arcpy.CheckOutExtension("JTX")

# Local variables:
Input_JobID = "1"
LOI_Layer = "LOILayer_Job1"
Input_DatabasePath = "C:\\Program Files\\WMX\\Database\\wmx.jtc"

# Process: Get Job AOI
arcpy.GetJobAOI_wmx(Input_JobID, LOI_Layer, Input_DatabasePath)

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • ArcGIS Desktop Basic: No
  • ArcGIS Desktop Standard: Requires Workflow Manager
  • ArcGIS Desktop Advanced: Requires Workflow Manager

Related topics