ArcMap

Generate Map Server Cache Tiling Scheme

Summary

Generates an XML tiling scheme file that defines the scale levels, tile dimensions, and other properties for a map service cache. This tool is useful when creating a tiling scheme to use in multiple caches. You can load the tiling scheme file when you create a cache in ArcGIS Desktop or ArcGIS Server Manager, or you can run Create Map Server Cache and pass in the tiling scheme file as a parameter.

A tiling scheme describes how clients should reference the tiles in a cache and is a mapping between the spatial reference of the source map document and the tiling grid. The tiling grid uses a level of detail (scales), row, and column reference scheme. The scheme also defines the scale levels (levels of detail) at which the cache has tiles, the size of the tiles in pixels, and the screen resolution for which the tiles are intended to be most commonly displayed. A tiling scheme is needed to generate a map cache.

Usage

  • If you've already defined a cache in ArcGIS Desktop or ArcGIS Server Manager, then you do not have to run this tool. You will already have a tiling scheme (conf.xml) in the cache folder, which you can reference when you create other caches.

  • By default, the tiling origin starts at the upper left of the coordinate system used by the service's source map document.

  • Once the cache has been created, the scale levels are the only part of the tiling scheme that can be changed. Use Manage Map Server Cache Scales to add or remove scale levels.

Syntax

arcpy.server.GenerateMapServerCacheTilingScheme(map_document, data_frame, tile_origin, output_tiling_scheme, num_of_scales, scales, dots_per_inch, tile_size)
ParameterExplanationData Type
map_document

The source map document to be used for the tiling scheme.

File
data_frame

The data frame to be used for the tiling scheme.

String
tile_origin

The upper left corner of the tiling scheme, in coordinates of the spatial reference of the source data frame.

Point
output_tiling_scheme

Path and file name of the tiling scheme file to create.

File
num_of_scales

Number of scale levels in the tiling scheme.

Long
scales
[scales,...]

Scale levels to include in the tiling scheme. These are not represented as fractions. Instead, use 500 to represent a scale of 1:500, and so on.

Value Table
dots_per_inch

The dots per inch of the intended output device. If a DPI is chosen that does not match the resolution of the output device, the scale of the map tile will appear incorrect. The default value is 96.

Long
tile_size

The width and height of the cache tiles in pixels. The default is 256 by 256. For the best balance between performance and manageability, avoid deviating from standard dimensions of 256 by 256 or 512 by 512.

  • 128 x 128 —128 by 128 pixels
  • 256 x 256 —256 by 256 pixels
  • 512 x 512 —512 by 512 pixels
  • 1024 x 1024 —1024 by 1024 pixels
String

Code sample

GenerateMapServerCacheTilingScheme example

Creates a map cache tiling scheme with four scales.

# Name: GeneateMapServerCacheTilingScheme.py
# Description: The following stand-alone script demonstrates how to create map
#               server cache schema using a given map document at a given
#               "pathForOutputXml"
# Requirements: os, sys, time & traceback modules

# Any line that begins with a pound sign is a comment and will not be executed
# Empty quotes take the default value.
# To accept arguments from the command line replace values of variables to
#                                                           "sys.argv[]"

# Import system modules
import arcpy
from arcpy import env
import os, sys, time, datetime, traceback, string

# Set environment settings
env.workspace = "C:/data"

# List of input variables for map service properties
mapDocument = "C:/data/101/Portland/mxd/_M_Portland_classic_FGDB_Local.mxd"
dataFrame = "" 
outputTilingScheme = "C:/data/port.xml"
tileOrigin = ""
numOfScales = "4"
scales = "500000,250000,125000,64000"
tileSize = "256 x 256"
dotsPerInch = "96"

currentTime = datetime.datetime.now()
arg1 = currentTime.strftime("%H-%M")
arg2 = currentTime.strftime("%Y-%m-%d %H:%M")
file = r'C:/data/report_%s.txt' % arg1

# print results of the script to a report
report = open(file,'w')

try:
    starttime = time.clock()
    result = arcpy.GenerateMapServerCacheTilingScheme_server(mapDocument, dataFrame,
                                                             tileOrigin, outputTilingScheme,
                                                             numOfScales, scales,
                                                             dotsPerInch, tileSize)
    finishtime = time.clock()
    elapsedtime = finishtime-starttime

    #print messages to a file
    while result.status < 4:
        time.sleep(0.2)
    resultValue = result.getMessages()
    report.write ("completed " + str(resultValue))

    print " Created MapServer cache tiling schema successfully using"
    mapDocument + " at "+ outputTilingScheme + " in " + str(elapsedtime)
    " sec \n on " + arg2
    
except Exception, e:
    # If an error occurred, print line number and error message
    tb = sys.exc_info()[2]
    report.write("Failed at step 1 \n" "Line %i" % tb.tb_lineno)
    report.write(e.message)
    
print "Created Map server Cache Tiling schema "

report.close()

Environments

Licensing information

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

Related topics