Get Job Data Workspace (Workflow Manager)

Available with Workflow Manager license.

Summary

Gets the job data workspace as an enterprise geodatabase connection file. This tool is typically used in ModelBuilder to retrieve the connection file for use as an input to other tools such as Reconcile Versions in the model.

Usage

  • The Input Job ID must be for a job that currently exists in the repository.

  • This tool is typically used in a model to retrieve the job's data workspace as an enterprise geodatabase connection file. For example, a model can be created to reconcile and post edits made in a specific job version to the parent version. The Get Job Data Workspace tool would be utilized to retrieve the data workspace connection, whereas the job's version would be retrieved using the Get Job Version tool, and the parent version would be retrieved using the Get Job Parent Version tool.

  • When the job has the Feature Service data workspace, the tool retrieves the job's data workspace as a feature service URL.

Parameters

LabelExplanationData Type
Input Job ID

The ID for the job whose data workspace connection is to be retrieved.

String
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 in the project is used.

File
Save a copy of the Job Data Workspace in
(Optional)

The job's data workspace connection file will be written to the specified folder.

Folder

Derived Output

LabelExplanationData Type
Output Job Data Workspace

For the enterprise geodatabase, the output is a geodatabase connection file. For the feature service, the output is the feature service URL.

Workspace

arcpy.wmx.GetJobDataWorkspace(Input_JobID, {Input_DatabasePath}, {Input_SDEFileLocation})
NameExplanationData Type
Input_JobID

The ID for the job whose data workspace connection is to be retrieved.

String
Input_DatabasePath
(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 in the project is used.

File
Input_SDEFileLocation
(Optional)

The job's data workspace connection file will be written to the specified folder.

Folder

Derived Output

NameExplanationData Type
Output_JobDataWorkspace

For the enterprise geodatabase, the output is a geodatabase connection file. For the feature service, the output is the feature service URL.

Workspace

Code sample

GetJobDataWorkspace example (stand-alone script)

Get the data workspace for the specified job.

# Import arcpy module
import arcpy

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

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

# Process: Get Job Data Workspace
arcpy.wmx.GetJobDataWorkspace(Input_JobID, Input_DatabasePath, Input_SDEFileLocation)

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics