Set Data Workspace (Topographic Production)

Summary

Sets the data workspace for the chosen job to the appropriate database based on the production type of the job.

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

• For the Topographic Mapping production workflows, a production type defines the database and maps that will be used to perform a type of production work such as MGCP data extraction or TM50 cartography.

• The tool ensures that other Workflow Manager (Classic) steps, such as Open Map, use the appropriate data as defined by the production type.

• This tool should only be run after Set Production Properties. Extended properties defined by the Set Production Properties tool are required to exist on the job before this tool can run successfully.

• The parent version assigned to the selected job will be the default parent version for the assigned data workspace.

• Creates a version in the data workspace. The version name will be the same as the job name.

• Creates an .sde connection file to the job version. The file will be created in the Geodatabases folder in the path set in the TOPO_PRODUCTION_PROPERTIES.Current_Job_Path extended property.

Syntax

SetDataWorkspace(job_id, {database_path})

Parameter	Explanation	Data Type
job_id	The job ID of the Workflow Manager (Classic) job that will be updated.	Long
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_job_id	The job ID of the updated Workflow Manager (Classic) job.	Long

Code sample

SetDataWorkspace example (stand-alone script)

This script sets the data workspace for a job.

# Name: SetDataWorkspace_sample.py
# Description: Sets the data workspace for a job.

# 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 = 2079
database_path = r"C:\Data\Workflows\Testing.jtc"

# Calling the Set Data Workspace tool sets the data workspace for a job
arcpy.topographic.SetDataWorkspace(job_id, 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.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