ArcGIS Desktop

  • ArcGIS Pro
  • ArcMap

  • My Profile
  • Help
  • Sign Out
ArcGIS Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS Desktop

A complete professional GIS

ArcGIS Enterprise

GIS in your enterprise

ArcGIS Developers

Tools to build location-aware apps

ArcGIS Solutions

Free template maps and apps for your industry

ArcGIS Marketplace

Get apps and data for your organization

  • Documentation
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

ArcMap

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • Extensions

Product library custom steps and tokens

Available with Production Mapping license.

  • Product library custom steps
  • The product library tokens

The product library custom steps and tokens can be used to leverage the file management capabilities of the product library as part of a workflow. These steps and tokens allow you to identify and associate a product library product with a job, synchronize the job files with the product files, check out the product, work with the product in ArcMap to perform data edits or cartographic updates, synchronize the product files with the job, and check the product back in.

The Product Library custom steps

Product library custom steps

The product library custom steps are included in the Production Mapping steps library. The steps, a basic description, and return codes are outlined in the table below.

See Creating step types for general information on configuring step types.

Step nameProg IDDescriptionReturn codes

Identify Product

ProductionMappingSteps.IdentifyProduct

Associates a product library product with a job.

The Check Out and Check In steps perform operations based on this association.

  • 0—Success
  • 1—Failure

Check Out

ProductionMappingSteps.CheckOutProduct

Checks out the product associated with the job.

  • 0—Success
  • 1—Failure

Launch ArcMap and Edit Product

JTXDesktopSteps.LaunchArcMap

Opens the map that has been checked out by the product library and saves the map in the checkout location.

Check In

ProductionMappingSteps.CheckInProduct

Checks in the product associated with the job.

  • 0—Success
  • 1—Failure

Sync Product Files

ProductionMappingSteps.SyncProductFiles

Copies files from job attachments to the product or vice versa.

  • 0—Success
  • 1—Failure

The product library tokens

Two additional tokens are available when working with the product library custom steps.

See the Tokens topic for general information on working with tokens.

ParserTokenDescriptionExample inputExample output

Product Library

[PL:TOKEN_MXD_NAME]

Name of the map document associated with the job

[PL:TOKEN_MXD_NAME]

My Map

Product Library

[PL:TOKEN_MXD_LOCATION]

The checkout location for the product associated with the job

[PL:TOKEN_MXD_LOCATION]

C:\Data

ArcGIS Desktop

  • Home
  • Documentation
  • Support

ArcGIS

  • ArcGIS Online
  • ArcGIS Desktop
  • ArcGIS Enterprise
  • ArcGIS
  • ArcGIS Developer
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Esri Blog
  • User Conference
  • Developer Summit
Esri
Tell us what you think.
Copyright © 2021 Esri. | Privacy | Legal