Publish the Topographic Production Service

Available with Production Mapping license.

The Topographic Production Service is deployed to ArcGIS Server simultaneously with publishing a map as a web layer that contains data from ArcGIS Enterprise or a file geodatabase. After the service is deployed, you can run operations in ArcGIS Server that are configured in ArcGIS Pro as outlined below. You can also configure the self-serve Map Production System web app using the Enterprise product data files to export map products.

Note:

The following items are either required before publishing the service, or provide more information about the service:

  • The product data files must be installed on each machine in the ArcGIS Server deployment and their version must match the version of the service.
  • The service stores temporary data for each job on the server. The default location is C:\ProgramData\ESRI\TopographicProduction\jobs.
  • The output files created by the generateProduct operation are copied to the output directory of the map service. The configured map service properties impact these files and how long they are available for download.
  • The ArcGIS Server account must have read and write access to the location of the jobs directory, as well as the location of any Digital Elevation Models (DEMs) that are used.
  • If your products use DEMs, copy them or their mosaic dataset to the server and use the updateProduct operation's productName and raster parameters to update the path of their new location. Ensure that all the machines in a multimachine deployment and the ArcGIS Server account have read and write access to the new location.

Enable capabilities

Ensure that you're signed in to the ArcGIS organization that the service will deploy to and that the correct account is active before you complete the following steps to enable the Topographic Production Service capability:

  1. Click the Share tab in ArcGIS Pro.
  2. In the Share As group, click the Web Layer drop-down arrow and click Publish Web Layer.

    The Share As Web Layer pane appears.

  3. Type a name for the web layer.
  4. Optionally, complete the Summary and Tags fields.

    A summary and tags are required when sharing to an ArcGIS Enterprise 10.9 or earlier portal.

    You can enter a maximum of 128 tags.

  5. In the Data and Layer Type section:
    • Choose Map Image if you want to reference datasets in a registered Enterprise database.
      Note:

      Click the Feature check box to share the web feature layer as a dependent layer to the map image layer.

    • Choose Feature under Copy all data to copy all the layers to the hosting server's managed database.
  6. Under Location, use the Folder menu to choose a folder in your portal content in which to store the web layer. Optionally, create a folder.

    By default, the web layer is stored at the root level of your portal content.

    Tip:

    Click the Browse button Browse to browse to a folder in your portal content. You can also type a folder name in the text box.

  7. Use the Server and Folder drop-down menus to specify the federated server where the service will be published and the folder where it will be stored. Optionally, create a folder.

    By default, the service is stored in the root folder of the server.

    Note:

    The Server and Folder options appear only if you are sharing to ArcGIS Enterprise using the Reference registered data option. In this case, you can also click the Data Stores button Data Stores to open the Manage Registered Data Stores pane. Use this pane to register geodatabases and folders with federated servers.

  8. Under Share with, specify how the web layer will be shared:
    • Everyone—Share your content with the public. Anyone can access and see it.
    • My Organization—Share your content with all authenticated users in the organization. This option is available when you are signed in with an organizational account.
    • Groups—Share your content with groups to which you belong and their members.

    Leave all options unchecked to set the sharing level to the owner of the item.

  9. Click the Configuration tab.
  10. Click Configure Layers Configure Layers.
  11. In the Capabilities section, check the Topographic Production check box to enable its service.

    The list of available capabilities depends on your Enterprise version, the types of data included in your map image layer, and whether you are sharing to a server that has server object extensions or server object interceptors.

    After the capability is enabled, you can configure its properties.

Configure the service properties

Complete the following steps to configure service operations and other service properties:

  1. In the Capabilities section, for Topographic Production, click Configure Service Properties Configure Service Properties.

    The TopographicProductionServer Properties pane appears.

  2. Optionally, check any of the check boxes in the Operations section to enable or disable the service's operations.

    Topographic Production Service operations are enabled by default. The following operations are supported:

    products

    Retrieves the products that the Topographic Production Service supports.

    jobs

    Contains more operations.

    addProduct

    Adds a map product definition to the service that can be used to generate a map.

    removeProduct

    Removes a product from the Topographic Production Service.

    updateProduct

    Updates an existing product's properties.

    generateProduct

    Automates the process of producing a layout or map based on a map product.

  3. In the Properties section, specify the following properties:
    1. For tmserverDatabase, specify the database for the Topographic Production Server. This can be left blank on single-machine ArcGIS Server deployments, a geodatabase is created in the default server location: C:\ProgramData\ESRI\TopographicProduction.

      This property should be left blank only in single-machine deployments. If a multimachine deployment is used, specify the path to an Enterprise connection file. Your Enterprise organization must have read access to the specified location. When publishing multiple map services in a multimachine deployment, all of them must use the same Enterprise connection file.

      Note:

      The path that you provide updates the location of the jobs directory, which is used to store temporary data for each job. If an Enterprise connection file is used, the database user specified in the connection must be able to perform Data Manipulation Language (DML) statements in the database.

    2. For productType, specify the type of map products this service should support, such as MTM, TDS, and CTM.

      Each map product definition has a type property. When you specify a value for productType, only products that match this value are returned by the service. If you leave it blank, all products are returned. For example, if a single service contains the data to produce MTM products, specify MTM as the product type.

    3. For extractionTimeout, specify how long in seconds the extraction of data can run before timing out.

      The default is 900 seconds. If a data extraction time out error occurs when running the generateProduct operation, try increasing this value before running the operation again.

    4. For autoUpdateProducts, specify whether the service automatically updates existing map product definitions with the ArcGIS Pro product data files installed by the ArcGIS Production Mapping product files installer.

      The default is True.

    Note:

    You can make a Cleanup Interval property available through the Enterprise Manager site; it is infrequently used and unavailable by default. This property specifies the number of hours before temporary data used to produce a map product is deleted from the server. If you make it available, the default value is 24 hours.

  4. Optionally, click Configure Parameters Configure parameters to configure more properties.

    Share As Web Layer pane Configuration tab

  5. Click Configure Pooling Configure Pooling.
  6. Ensure that the Dedicated instance option is chosen in the Instance Type group.
  7. Optionally, specify the range for the number of instances per machine in the Number of instances per machine section.

    This is the minimum and maximum number of dedicated instances that can run for the service at any given time, including when the service is not in use. These are the instances that handle calls to the map service, as well as Representational State Transfer (REST) operations which don't consume many resources and are handled quickly.

    Tip:

    Adjust the range of instances as needed after monitoring the traffic to these endpoints. The generateProduct operation uses the TopographicProductionSystemTools geoprocessing service to perform the work. Adjusting the range of instances of this service impacts the throughput of generating map products.

  8. Optionally, click the Content tab to view the folder, new web layers, and sublayers with assigned IDs if available.

    If you enabled the Allow assignment of unique numeric IDs for sharing web layers option on the Map Properties dialog box, assigned IDs appear for each sublayer. To change an ID, click the number next to the layer or table. On the Layer Properties or Standalone Table Properties dialog box, on the General tab, type a custom integer ID in the Layer ID or Table ID text box. For more information, see Assign layer IDs.

You're ready to analyze and publish your map as a service web layer.

Publish the service

Once you have configured all of the settings for the service, you can analyze the configuration and publish it to your active Enterprise portal by completing the following steps:

  1. Click Analyze to check for problems.

    Errors and warnings are listed on the Messages tab. Right-click a message to open its help topic or take corrective action in the software. Errors Error must be resolved before you can share the web layer. Resolving warnings Warning is recommended but not required.

    Learn more about analyzing GIS resources

  2. After you have resolved errors, and optionally, resolved warnings, click Publish to share the web layer.

    To save a service definition for the web layer instead, click the Publish drop-down arrow and click Save As SD.

  3. When the web layer is published, click the Manage the web layer link at the bottom of the pane.

    A browser page appears. If necessary, sign in to your portal to open the web layer's item page.

Once published, the service's operations are available for use in ArcGIS GIS Server from an ArcGIS REST API, as well as in a configured, self-serve Map Production System (MPS) web app on the Enterprise portal with the ArcGIS Defense Mapping or ArcGIS Production Mapping server extension.