Upload Job Files (Topographic Production)

Summary

Uploads a packaged job file to a topographic production server for further processing.

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 upload files for any job item, and accounts without administrator access can only upload 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
Keep Local Copy
(Optional)

Specifies whether a copy of the files will remain on the local machine.

  • Checked—The local copies and a copy of the packaged file that is uploaded will remain after a successful upload.
  • Unchecked—The local files will be deleted after a successful upload. This is the default.
Boolean

Derived Output

LabelExplanationData Type
Updated Job Identifier

The job ID of the job with updated files.

String

arcpy.topographic.UploadJobFiles(service_item, job_id, {keep_local_copy})
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
keep_local_copy
(Optional)

Specifies whether a copy of the files will remain on the local machine.

  • KEEP_LOCAL_COPYThe local copies and a copy of the packaged file that is uploaded will remain after a successful upload.
  • DELETE_LOCAL_COPYThe local files will be deleted after a successful upload. This is the default.
Boolean

Derived Output

NameExplanationData Type
updated_job_id

The job ID of the job with updated files.

String

Code sample

UploadJobFiles example (stand-alone script)

The following Python window script demonstrates how to use the UploadJobFiles function to upload job files to a topographic production server.

# Name: Upload_Job_Standalone.py
# Description: Uploads Workflow Job Data

# Import System Modules
import arcpy

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

# Run Upload Job Files Tool
arcpy.topographic.UploadJobFiles("9203905e001047c3b2cc2d267973ef28", "2GkCwo5qRoqCbQCybls2tQ", "KEEP_LOCAL_COPY")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics