Skip to main content

Topographic Production Service

License:

To use this resource, an ArcGIS GIS Server Advanced license and an ArcGIS Topographic Mapping server extension license are required.

Topographic Production Service is a server object extension (SOE) to a map service. It allows you to perform topographic production capabilities on the map service, such as producing topographic maps based on industry-standard map product specifications.

Learn more about Topographic Production Service

Learn more about REST SOEs

Learn more about ArcGIS Server Services Directory

Publish the service

The Topographic Mapping extension in ArcGIS Pro allows you to publish Topographic Production Service.

Configure operations and properties

After you publish the service with the Topographic Production capability enabled, you can access the service operations and properties in the item settings in your organization or in ArcGIS Server Manager.

Access in the organization

Publishing the service creates a map image layer in your organization.

Important:

The Topographic Production operations and properties only appear for map image layers that you publish with the Topographic Production capability enabled and configured to use a dedicated instance. Map image layers that are published as shared instances do not expose these operations or properties in your organization.

Complete the following steps to access the service operations and properties in your organization:

  1. Sign in to the organization as an administrator or as the map image layer item owner.

  2. Open the item details page for the layer.

  3. Click Settings.

  4. In the Topographic production section, turn on the Configuration toggle button if necessary.

    The Operations and Properties subsections appear.

  5. Turn an operation's toggle button on to make the operation available.

  6. Review or update the service properties:

    1. In the Topographic production database text box, update the path to a spatial database engine (SDE) connection file.

    2. In the Product type text box, update the types of products that are available.

    3. In the Workflow item identifier text box, update the ID for the workflow item associated with the service.

      Caution:

      This is a required value if you are running topographic workflows that involve ArcGIS Workflow Manager. Workflow jobs fail to return workflow products if a value is not provided.

    4. In the Workflow local job folder text box, update the path to the local folder where workflow jobs are stored.

      Caution:

      This is a required value if you are running topographic workflows that involve ArcGIS Workflow Manager. Download jobs fail if a value is not provided.

    5. In the Extraction timeout text box, update how many seconds the data extraction can run before timing out.

      The default value is 900 seconds.

    6. Check or uncheck the Auto update products check box to specify whether the service automatically updates existing map product definitions.

  7. Click Save.

    The Save edits dialog box appears and asks whether you want to save and restart the service.

  8. Click Save and restart to confirm or Cancel to continue making changes.

If you click Save and restart, the Save edits dialog box closes and the service restarts with your saved changes. If you click Cancel, the Save edits dialog box closes.

Access in ArcGIS Server Manager

In Server Manager, you can access the settings for a service, including its capabilities and properties, and make changes.

ArcGIS Server Manager with the Topographic Production capability highlighted to show its operations and other properties that were set when the service was published from ArcGIS Pro

Complete the following steps in Server Manager to configure, review, or update a service's capabilities or properties:

  1. Sign in to Server Manager.

  2. If you don't see a list of services, click Services > Manage Services.

  3. Click the map service that you want to enable topographic production capabilities on.

  4. Click Capabilities.

  5. Click Topographic Production.

    The Topographic Production Configuration section appears.

  6. Check the check boxes for the operations that you want for the service.

  7. Review or update properties for the service.

    1. In the Product Type text box, update the types of products that are available.

    2. In the Topographic Production Database text box, update the path to a spatial database engine (SDE) connection file.

    3. In the Workflow Item Identifier text box, update the ID for the workflow item associated with the service.

      Caution:

      This is a required value if you are running topographic workflows that involve ArcGIS Workflow Manager. Workflow jobs fail to return workflow products if a value is not provided.

    4. In the Workflow Local Job Folder text box, update the path to the local folder where workflow jobs are stored.

      Caution:

      This is a required value if you are running topographic workflows that involve ArcGIS Workflow Manager. Download jobs fail if a value is not provided.

    5. In the Extraction timeout text box, update how many seconds the data extraction can run before timing out.

      The default value is 900.

    6. Check or uncheck the Auto Update Products check box to specify whether the service automatically updates existing map product definitions.

    7. Click Save and restart to confirm or Cancel to continue making changes.

Topographic Production Database

Topographic Production Service references a geodatabase through the tmserverDatabase property. This property is labeled Topographic Production Database in ArcGIS Server Manager.

Important:

This is a dedicated enterprise geodatabase that stores and manages operational information such as jobs, job history, products, workflow components, and other service-related data. It is not the production data geodatabase that contains the source feature data that Topographic Production Service publishes, edits, queries, and exposes through the REST API.

Provide one of the following to specify the geodatabase:

Note:

In Server Manager, this path can be specified in the Topographic Production Database text box. The ArcGIS Server account must have read access to the location of the .sde connection file. The path can also be specified when Topographic Production Service is published in ArcGIS Pro using the tmserverDatabase text box.

Learn more about publishing Topographic Production Service in ArcGIS Pro

  • Registered database (user-managed)—Specify one of the following:

    • The name of the registered database

    • The data item path value of the registered database, for example, /enterpriseDatabases/<registered_database_name>.

      Important:

      The data item path is case-sensitive. To copy an exact value, sign in to the ArcGIS Server Administrator Directory and browse to data > items > enterpriseDatabases and choose the registered database. The path property in the response is the value to copy and paste. Alternatively, use the Data Item REST API endpoint.

This geodatabase contains multiple tables and includes additional database objects for task and control workflows:

  • TPS_WORKTASK stores work task records. The run_context field stores task execution context information in JSON format.

  • TPS_CONTROL_STATE stores key/value control state information used by distributed topographic services.

  • TPS_WORKTASK_VIEW provides a consolidated view of related work and task records for query workflows.

Jobs table

Key job properties are stored in TPS_JOB table dedicated fields to improve query performance and simplify integration with reporting workflows.

  • jobName—stores the job name.

  • parentJobId—stores the parent job reference that is used by topographic production workflow jobs.

  • productName—stores the job's specified map product name.

  • productVersion stores the job's specified map product version.

Existing values are extracted from job parameters and written to these fields.

Properties table

The TPS_PROPERTY table contains the properties that are defined when the service is published from ArcGIS Pro and can be accessed from ArcGIS Server Manager after the service is published. This table also stores properties for each service that is published with the topographic production SOE enabled. It contains the following properties:

  • ObjectID

  • ServiceIdentifier

  • Name

  • Value

Note:

The ServiceIdentifier column contains the service's unique ID. If the value of the ID is -1, the property is a global property that applies to all services.

Each row in the TPS_PROPERTY table is a property. The following table describes each property:

Property

Description

AdditionalOutputPaths

  • Additional output file paths for the generateProduct operation. File paths must be separated by a semicolon.

    Caution:

    The operation to copy outputs to these locations fails if the ArcGIS Server account doesn't have read and write access to the specified file.

  • Data and output files at any of the specified locations are deleted during the cleanups defined by the CleanupInterval property.

AdminGroupId

A global property that allows a group of users to cancel or delete jobs in the web apps included with the ArcGIS Topographic Mapping server extension.

To provide a group with these privileges, update the AdminGroupId property to match the value of a group ID that corresponds to a group that you create for a web app.

In a stand-alone ArcGIS Server deployment, you can assign these privileges to a group by providing the role name value of a user with an ArcGIS Server administrator role type as the value for this property.

Learn more about roles in ArcGIS Server Manager

AllowedSDEAuthMode

The SDE authentication mode that is allowed.

The following are supported:

Caution:

Changing the mode by updating this value poses a security risk. Changing this setting is not recommended.

  • OSA—Operating System Authentication, authentication performed by the operating system or network domain. This is the default.

  • DBMS—Database Management System manages the username and password.

  • Basic—Simple username and password authentication; the ArcGIS Server or SDE configuration stores and manages the credentials.

AllowedServices

A list of services that are outside of the federated environment that an organization has deemed safe. This list should only contain public services and can be comma-separated values.

The service URL structure impacts which services are allowed. For example:

https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3—Allows only the layer service for states (3 is states).

https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer—Allows the layer services in that map server.

https://sampleserver6.arcgisonline.com/arcgis/—Allows all services on the sampleserver6.arcgisonline.com domain.

AllowWebAdaptorRouting

Specifies whether the service uses public or private urls.

True—The service will use public urls.

False—The service will use private urls.

AutoUpdateProducts

Specifies whether updates to the map product definitions—made in the .json file—are propagated to the map product definitions in the topographic server geodatabase when the server is restarted.

True—When the service is restarted, its existing map product definitions in the database are automatically updated with the map product definitions from the .json file installed with the ArcGIS Enterprise product data files. This is the default.

False—When the service is restarted, its existing map product definitions are not automatically updated with the map product definitions from the .json file installed with the ArcGIS Enterprise product data files.

CleanupInterval

The number of hours before temporary data used to produce a map product and the output map products are deleted from the server. The default is 24.

CustomProductFilesPath

Note:

This property applies to Linux only.

If the product files are not located at the default installation location, provide the path to their location.

DatabaseIdentifier

The unique database ID. This is stored internally and cannot be modified throughout the lifespan of the geodatabase.

The TopographicProductionServer properties REST resource also exposes the database identifier and version values:

ArcGIS REST Services Directory topographic production server properties

DateTimeFormat

The date and time format when a token involving date or time is used in a job output file name.

DownloadChunkSizeInKB

The size, in kilobytes, of each chunk used when job output is downloaded from the server.

ExtractionProgress

Specifies whether a job's progress is updated while data is extracted for the job. The default is False.

Tip:

When working with high-volume deployments, a value of False reduces database traffic.

extractionTimeout

The amount of time in seconds that the data extraction can run before timing out.

<file type>

Note:

This is a global property, set the ServiceIdentifier value to -1.

The following are supported file types:

  • .aprx

  • .dt2

  • .gdb

  • .pagx

  • .pdf

  • .tiff

  • .zip

The following tokens can be used to define a job output file name:

  • [JobName]—The outputName parameter value for the generateProduct SOE operation or the name of the export in the MPS app.

  • [JobId]—The globally unique identifier (GUID) created when exporting a map product using the generateProduct SOE operation or MPS app.

  • [JobStartDate]—The start date of the job in local UTC time format.

  • [User]—The user that initiated the job.

  • [ProductName]—The job's specified map product name.

  • [ProductVersion]—The job's specified map product version.

  • [SheetIdentifier]—The National Reference Number (NRN) value for the selected index.

  • [MGRS:<MGRS Precision>]—Military Grid Reference System (MGRS) that provides the sheet location.

    • [MGRS]—4Q

    • [MGRS:100km]—4QFJ

    • [MGRS:10km]—4QFJ16

    • [MGRS:1km]—4QFJ1267

    • [MGRS:100m]—4QFJ123678

    • [MGRS:10m]—4QFJ12346789

    • [MGRS:1m]—4QFJ1234567890

    • [MGRS:ICM]—1234

  • [AOI.<FieldName>]—An AOI index attribute table value.

    Note:

    This token appears in the name if the specified field contains a null value.

If the format is missing the file type extension, it is automatically appended.

Caution:

Include the [JobId] token, [JobStartDate] token, or both to help avoid file name conflicts.

JobDownloadLimitPerUser

The maximum number of jobs that a single user can download.

jobHistory

The number of days that data related to map production jobs is stored in the database. The default is 365. Job-related records in the database are permanently deleted after the set number of days.

JobsDataDirectory

Note:

This property applies to Linux only.

The path to the local directory where temporary job data is stored.

LastCleanup

The date and time that the temporary data for a job was last deleted from the server.

ProductFilesPath

Note:

This property applies to Linux only.

If the product files are not directly installed on the machine, provide the path to them or the data store ID.

productType

The map product types supported by the service. Multiple values must be separated by a comma, for example: TM, JOG.

Map product definitions have a type property, and the service returns the map products with a value that matches the value specified.

UseJobIdFolder

A global property that specifies whether the default output folder for a job is named based on the job ID. The default is True.

If the value is set to False, the output URL in the jobStatus response does not contain any job IDs.

Version

The version of the topographic server geodatabase. This value matches the current version of ArcGIS Enterprise.

The TopographicProductionServer properties REST resource also exposes the database identifier and minor version values:

ArcGIS REST Services Directory topographic production server properties

WorkflowItemId

The ID string associated with a topographic production workflow item.

WorkflowLocalJobFolder

The path to the location of a folder that contains the data for local jobs.

Product output

Completed jobs return an output URL.

The output URL contains the following values:

  • An ID based on your organization

  • The deployment's service ID

  • The job ID

The job ID is the job's globally unique identifier (GUID) with the hyphens removed, preceded by a letter that identifies the job type:

Note:

The UseJobIdFolder property determines whether job IDs appear in the output URL. If the property is set to False, the jobStatus response does not contain job IDs.

Open the output URL to review the generated product. Review each product before you distribute it to confirm that it generated completely.