ArcGIS for Desktop

  • Documentation
  • Pricing
  • Support

  • My Profile
  • Help
  • Sign Out
ArcGIS for Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS for Desktop

A complete professional GIS

ArcGIS for Server

GIS in your enterprise

ArcGIS for 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
  • Pricing
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

Help

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • More...

Manage Map Server Cache Status

  • Summary
  • Usage
  • Syntax
  • Code Sample
  • Environments
  • Licensing Information

Summary

Manages internal data kept by the server about the built tiles in a map or image service cache.

Usage

  • This tool can remove or rebuild the cache completion status information reported in ArcMap or ArcGIS Server Manager.
  • This tool is useful for rebuilding the cache status after you manually copy tiles into the cache directory or build tiles on demand.

  • This tool is the only way to build a status for a cache created with a previous release of ArcGIS Server.

  • Rather than creating a status for the entire cache, you can alternatively use this tool to create status reports for custom areas of interest and scale levels. You do this by setting the Manage Mode parameter (manage_mode in Python) to REPORT_BUNDLE_STATUS. The report is stored in a new file geodatabase named Status.gdb, specifically within a feature class named TaskStatus that you can display and view in ArcMap.

    Note that your cache directory also contains a Status.gdb that pertains to the entire cache and is updated when you use the other Manage Mode options for this tool. You cannot substitute a custom Status.gdb in this location.

Syntax

ManageMapServerCacheStatus_server (input_service, {scales}, manage_mode, {num_of_caching_service_instances}, {report_folder}, {report_extent}, {area_of_interest})
ParameterExplanationData Type
input_service

The map or image service for which the status will be modified.

This is a string containing both the server and service information. To see how to construct this string, open ArcCatalog, select your service in the Catalog tree, and note the text in the Location toolbar. Then change the backslashes to forward slashes, for example, GIS Servers/arcgis on MYSERVER (admin)/USA.MapServer.

String
scales
(Optional)

The scale levels for which the status will be modified. This parameter is only applicable when building a custom status using the REPORT_BUNDLE_STATUS option for the manage_mode parameter.

Double
manage_mode
  • DELETE_CACHE_STATUS —Deletes the status information used by the server.
  • REBUILD_CACHE_STATUS —Deletes, then rebuilds the status information used by the server.
  • REPORT_BUNDLE_STATUS —Creates status information in a new file geodatabase named Status.gdb in a folder you specify in the Output Folder parameter. This option is used when you want to create a custom status report for a particular area of interest or set of scales.
String
num_of_caching_service_instances
(Optional)

The total number of instances of the System/CachingTools service that you want to dedicate toward running this tool. You can increase the maximum number of instances per machine of the System/CachingTools service using the Service Editor window available through an administrative connection to ArcGIS Server. Ensure your server machines can support the chosen number of instances.

This tool uses three instances by default, if that many are available. Using a larger number of instances with this tool may cause the operation to slow down.

Long
report_folder
(Optional)

Output folder for the Status.gdb. This parameter is only applicable when building a custom status using the REPORT_BUNDLE_STATUS option.

The account running ArcGIS for Desktop needs write access to this folder.

This folder must not already have a Status.gdb in it.

Folder
report_extent
(Optional)

A rectangular extent defining the area for which the status will be built. This parameter is only applicable when building a custom status using the REPORT_BUNDLE_STATUS option.

Note that the Area Of Interest parameter allows you to specify an area of interest that is nonrectangular.

Extent
area_of_interest
(Optional)

An area of interest (polygon) that determines what geography the status report will cover. This can be a feature class, or it can be a feature that you interactively define in ArcMap. This parameter is only applicable when building a custom status using the REPORT_BUNDLE_STATUS option.

Feature Set

Code Sample

ManageMapServerCacheStatus exampleDelete the status information for a cache.

# Name: ManageMapServerCacheStatus.py
# Description: The following stand-alone script demonstrates how to delete 
# status of cache using ManageMapServerCachStatus tool  

# Requirements: os, sys, time and 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
connectionFile = r"C:\Users\<username>\AppData\Roaming\ESRI\Desktop10.1\ArcCatalog"
server = "arcgis on MyServer_6080 (publisher)"
serviceName = "Rainfall.MapService"
inputService = connectionFile + "\\" + server + "\\" + serviceName
scales = ""
manageMode = "DELETE_CACHE_STATUS"
numOfCachingServiceInstances = "2"
outputFolder = ""
areaOfInterest = ""
reportExtents = ""


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

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

# use "scales[0]","scales[-1]","scales[0:3]"

try:
    starttime = time.clock()
    result = arcpy.ManageMapServerCacheStatus_server(inputService, 
                                                     manageMode, scales,
                                                     numOfCachingServiceInstances,
                                                     outputFolder,
                                                     areaOfInterest, 
                                                     reportExtents)                                           
    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 "Reported the Bundle status for scale =" + str(scales[-1]) + "of " +\
    serviceName + "at " + outputFolder + "\n using specified feature class " +\
    areaOfInterest + " 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 3 \n" "Line %i" % tb.tb_lineno)
    report.write(e.message)

report.close()

Environments

This tool does not use any geoprocessing environments

Licensing Information

  • ArcGIS for Desktop Basic: Yes
  • ArcGIS for Desktop Standard: Yes
  • ArcGIS for Desktop Advanced: Yes
Feedback on this topic?

ArcGIS for Desktop

  • Home
  • Documentation
  • Pricing
  • Support

ArcGIS Platform

  • ArcGIS Online
  • ArcGIS for Desktop
  • ArcGIS for Server
  • ArcGIS for Developers
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Insiders Blog
  • User Conference
  • Developer Summit
Esri
© Copyright 2016 Environmental Systems Research Institute, Inc. | Privacy | Legal