Set Task Group Dependencies (Topographic Production)

Summary

Creates dependencies between a job and other existing Task Group jobs based on the criteria defined in the extended properties.

Tip:

It is recommended that current Workflow Manager (Classic) users begin new projects using the services-driven version of ArcGIS Workflow Manager for ArcGIS Pro.

Usage

  • This tool is intended for use with the Topographic production management workflows and will not support an improperly configured Workflow Manager (Classic) repository.

  • The TASK_GROUP_RELATIONSHIPS table is used to determine which types of task group jobs this job is dependent on and the spatial relationship between the job AOIs.

  • If the Job ID parameter value is a Task job rather than a Task Group job, the dependencies created by this tool will be determined by the properties of the parent Task Group job.

Parameters

LabelExplanationData Type
Job ID

The job ID of the Workflow Manager (Classic) job that will have dependencies set.

Long
Input Database Path
(Optional)

The Workflow Manager (Classic) database connection file that contains the job information. If no connection file is specified, the current default Workflow Manager (Classic) database will be used.

File

Derived Output

LabelExplanationData Type
Output Job IDs

A list of the job IDs that this job is dependent on.

Long

arcpy.topographic.SetTaskGroupDependencies(job_id, {database_path})
NameExplanationData Type
job_id

The job ID of the Workflow Manager (Classic) job that will have dependencies set.

Long
database_path
(Optional)

The Workflow Manager (Classic) database connection file that contains the job information. If no connection file is specified, the current default Workflow Manager (Classic) database will be used.

File

Derived Output

NameExplanationData Type
out_job_ids

A list of the job IDs that this job is dependent on.

Long

Code sample

SetTaskGroupDependencies example (stand-alone script)

The following code sample demonstrates how to use the SetTaskGroupDependencies function in Python.

# Name: SetTaskGroupDependencies_sample.py
# Description: This script sets dependencies on the chosen job based on the
# task group extended properties.

# 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 = 12
input_database_connection = r'C:\Data\Workflows\Testing.jtc'

# Setting dependencies to ensure job run in the correct order
dependencies = arcpy.topographic.SetTaskGroupDependencies(job_id, input_database_connection)


# Check In Extensions
arcpy.CheckInExtension('Foundation')
arcpy.CheckInExtension('JTX')

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Requires Production Mapping and Workflow Manager
  • Advanced: Requires Production Mapping and Workflow Manager

Related topics