Download Job Files (Topographic Production)

Summary

Downloads and extracts the latest version of the job files from a topographic production server for manual operations.

Caution:

This tool is intended for use with Topographic Production workflows and is designed to be run as a step in an ArcGIS Workflow Manager workflow. Workflow Manager must be properly configured to use this tool.

Usage

  • The active portal in ArcGIS Pro must be the portal that hosts the ArcGIS Workflow Manager service and Topographic Production service items. You must sign in to ArcGIS Pro with the account that has access to both services.

  • Accounts with administrator access can download files for any job item, and accounts without administrator access can only download the files for their own job items.

    Note:

    The account assigned to the ArcGIS Workflow Manager Server job must be the account that created the job running on the Topographic Production service.

  • The topographic mapping job item must be paused on the server for this tool to run.

  • Job files are uploaded to the location specified in the local_job_folder extended property of the Workflow Manager job. Accounts with administrator access can update this property's value.

Parameters

LabelExplanationData Type
Service Item

The unique name or identifier of the Workflow Manager service item on the portal with topographic production capabilities. Available Workflow Manager item options depend on the active portal in ArcGIS Pro.

String
Job Identifier

The unique name or identifier of the currently active topographic product job. Available job item options depend on the Service Item parameter value.

String

Derived Output

LabelExplanationData Type
Output Job Location

The output location where the job files will be downloaded and extracted on the local machine.

Folder

arcpy.topographic.DownloadJobFiles(service_item, job_id)
NameExplanationData Type
service_item

The unique name or identifier of the Workflow Manager service item on the portal with topographic production capabilities. Available Workflow Manager item options depend on the active portal in ArcGIS Pro.

String
job_id

The unique name or identifier of the currently active topographic product job. Available job item options depend on the service_item parameter value.

String

Derived Output

NameExplanationData Type
out_job_location

The output location where the job files will be downloaded and extracted on the local machine.

Folder

Code sample

DownloadJobFiles example (stand-alone script)

The following Python window script demonstrates how to use the DownloadJobFiles function to download job files from a topographic production server.

# Name: Download_Job_Standalone.py
# Description: Downloads Workflow Job Data

# Import System Modules
import arcpy

# Sign In To My Portal
arcpy.SignInToPortal("https://ps025320.esri.com/portal", 
                     'admin', 'esri.agp')

# Run Download Job Files Tool
arcpy.topographic.DownloadJobFiles("9203905e001047c3b2cc2d267973ef28", "2GkCwo5qRoqCbQCybls2tQ")

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Requires Topographic Mapping
  • Advanced: Requires Topographic Mapping

Related topics