MapServiceDraft

摘要

MapServiceDraft 类允许您配置地图服务属性和创建服务定义草稿 (.sddraft) 文件，该文件可共享到 ArcGIS Server。

说明

要创建 MapServiceDraft 对象，请使用 arcpy.sharing.CreateSharingDraft 函数并将 server_type 参数设置为 STANDALONE_SERVER 以及将 service_type 参数设置为 MAP_SERVICE。 然后，可通过设置服务级别属性配置 MapServiceDraft 对象。 可以使用 targetServer 属性以指定将地图服务发布到的服务器。 在配置 MapServiceDraft 对象后，可使用 exportToSDDraft 函数将其保存到服务定义草稿 (.sddraft) 文件。 然后，可以使用过渡服务和上传服务定义工具将其过渡并共享到 ArcGIS Server。 有关详细信息，请参阅 arcpy.sharing 简介。

将 .sddraft 文件过渡并上传到服务器后，可使用缓存工具集中的工具（如管理地图服务器缓存切片工具）创建和管理地图服务器缓存以加快地图服务显示。 您也可以通过使用 XML 库（如 xml.dom.minidom 库）编辑 .sddraft 文件来修改切片方案。 但是，由于切片方案 XML 结构比较复杂，建议尽量使用缓存工具集。

代码示例可用于以下用途：

• 将地图服务发布至服务器文件夹
• 覆盖地图服务
• 发布引用注册数据的地图服务
• 发布缓存地图服务
• 发布从现有缓存中提取的地图服务
• 创建并发布离线服务定义

属性

属性	说明	数据类型
copyDataToServer (可读写)	指定是否将地图中的数据复制到服务器。 值为 True 时，将复制地图中的所有数据，包括在服务器中注册的数据。 值为 False 时，将仅复制未在服务器中注册的数据；服务将参考已在服务器中注册的数据。	Boolean
credits (可读写)	地图服务草稿的配额。	String
description (可读写)	地图服务草稿的描述。	String
offline (可读写)	指定是否使用服务器连接。 如果设置为 False，则必须向 targetServer 属性提供服务器 URL 或 ArcGIS Server 连接文件 (.ags)，才能使用 exportToSDDraft 函数创建服务定义草稿 (.sddraft) 文件。 如果设置为 True，则可以在未填充 targetServer 属性的情况下，创建服务定义草稿文件。	Boolean
overwriteExistingService (可读写)	指定是否覆盖具有相同名称的现有服务。	Boolean
serverFolder (可读写)	要将服务发布到的服务器文件夹名称。 默认文件夹是服务器的根文件夹。 如果不存在此文件夹，则会进行创建。	String
serverType (只读)	通过 CreateSharingDraft 函数创建 MapServiceDraft 时指定的服务器类型。 从 serverType 的 MapServiceDraft 中返回的唯一可能的值为 STANDALONE_SERVER。 STANDALONE_SERVER 的 serverType 表示支持为 ArcGIS Server 创建地图服务。	String
serviceName (可读写)	地图服务的名称。 用户可以看到该名称并使用该名称来识别服务。 名称只能包含字母数字字符和下划线。 不允许使用空格或特殊字符。 名称不能超过 120 个字符。	String
summary (可读写)	地图服务草稿的摘要。	String
tags (可读写)	地图服务草稿的标签。 标签可以逗号或分号分隔。	String
targetServer (可读写)	地图将发布至的服务器。 可以使用以下任一格式指定此服务器： ArcGIS Server 连接文件 (.ags) 的完整路径。 ArcGIS Server URL。 如果您在 ArcGIS Pro 工程中拥有 ArcGIS Server 的发布者或管理员连接，且您要在脚本中打开此工程或在 ArcGIS Pro 中运行脚本，请使用此选项。 有关详细信息，请参阅连接到 GIS 服务器。 提示： targetServer 也可以在上传服务定义工具中的 in_server 参数中使用。 以下代码示例对此进行了演示。	String
useLimitations (可读写)	地图服务草稿的使用限制。	String

方法概述

方法	说明
exportToSDDraft (out_sddraft)	将 MapServiceDraft 转换为服务定义草稿 (.sddraft) 文件。

方法

exportToSDDraft (out_sddraft)

参数	说明	数据类型
out_sddraft	输出服务定义草稿 (.sddraft) 文件的路径和文件名。	String

在配置 MapServiceDraft 后，即可将其作为服务定义草稿 (.sddraft) 文件进行保存。然后可以使用过渡服务和上传服务定义工具将其过渡并共享到 ArcGIS Server。

代码示例

发布地图服务

以下脚本将为地图创建地图服务定义草稿 (.sddraft) 文件，并设置元数据属性。 地图服务将发布到独立 ArcGIS Server 中的文件夹。

import arcpy
import os

# Set output file names
outdir = r"C:\Project\Output"
service_name = "MapServiceDraftExample"
sddraft_filename = service_name + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)
sd_filename = service_name + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps('World')[0]

# Create MapServiceDraft and set metadata and server folder properties
target_server_connection = r"C:\Project\gisserver.ags.esri.com (publisher).ags"
sddraft = arcpy.sharing.CreateSharingDraft("STANDALONE_SERVER", "MAP_SERVICE", service_name, m)
sddraft.targetServer = target_server_connection
sddraft.credits = "These are credits"
sddraft.description = "This is description"
sddraft.summary = "This is summary"
sddraft.tags = "tag1, tag2"
sddraft.useLimitations = "These are use limitations"
sddraft.serverFolder = "MyServerFolder"

# Create Service Definition Draft file
sddraft.exportToSDDraft(sddraft_output_filename)

# Stage Service
print("Start Staging")
arcpy.StageService_server(sddraft_output_filename, sd_output_filename)

# Publish to server
print("Start Uploading")
arcpy.UploadServiceDefinition_server(sd_output_filename, target_server_connection)

print("Finish Publishing")

覆盖地图服务

以下脚本将覆盖地图服务。 如果服务名称已存在，则将覆盖该服务。 否则，将创建新服务。

import arcpy
import os

# Set output file names
outdir = r"C:\Project\Output"
service_name = "MapServiceDraftExample"
sddraft_filename = service_name + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)
sd_filename = service_name + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps('World')[0]

# Create MapServiceDraft and set overwrite property
target_server_connection = r"C:\Project\gisserver.ags.esri.com (publisher).ags"
sddraft = arcpy.sharing.CreateSharingDraft("STANDALONE_SERVER", "MAP_SERVICE", service_name, m)
sddraft.targetServer = target_server_connection
sddraft.overwriteExistingService = True

# Create Service Definition Draft file
sddraft.exportToSDDraft(sddraft_output_filename)

# Stage Service
print("Start Staging")
arcpy.StageService_server(sddraft_output_filename, sd_output_filename)

# Publish to server
print("Start Uploading")
arcpy.UploadServiceDefinition_server(sd_output_filename, target_server_connection)

print("Finish Publishing")

发布引用注册数据的地图服务

以下脚本将发布引用注册数据的地图服务。 必须已在服务器上注册数据存储，才能引用数据。

import arcpy
import os

# Set output file names
outdir = r"C:\Project\Output"
service_name = "MapServiceDraftExample"
sddraft_filename = service_name + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)
sd_filename = service_name + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps('World')[0]

# Create MapServiceDraft and set copyDataToServer property to false to reference registered data
target_server_connection = r"C:\Project\gisserver.ags.esri.com (publisher).ags"
sddraft = arcpy.sharing.CreateSharingDraft("STANDALONE_SERVER", "MAP_SERVICE", service_name, m)
sddraft.targetServer = target_server_connection
sddraft.copyDataToServer = False

# Create Service Definition Draft file
sddraft.exportToSDDraft(sddraft_output_filename)

# Stage Service
print("Start Staging")
arcpy.StageService_server(sddraft_output_filename, sd_output_filename)

# Publish to server
print("Start Uploading")
arcpy.UploadServiceDefinition_server(sd_output_filename, target_server_connection)

print("Finish Publishing")

发布缓存地图服务

以下脚本通过调用管理地图服务器缓存切片工具以创建地图服务缓存切片，来发布缓存地图服务。

import arcpy
import os
import xml.dom.minidom as DOM

# Set output file names
outdir = r"C:\Project\Output"
service_name = "MapServiceDraftExample"
sddraft_filename = service_name + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)
sd_filename = service_name + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps('World')[0]

# Create MapServiceDraft
target_server_connection = r"C:\Project\gisserver.ags.esri.com (publisher).ags"
sddraft = arcpy.sharing.CreateSharingDraft("STANDALONE_SERVER", "MAP_SERVICE", service_name, m)
sddraft.targetServer = target_server_connection

# Create Service Definition Draft file
sddraft.exportToSDDraft(sddraft_output_filename)

"""Modify the .sddraft to enable caching"""
# Read the file
doc = DOM.parse(sddraft_output_filename)

configProps = doc.getElementsByTagName('ConfigurationProperties')[0]
propArray = configProps.firstChild
propSets = propArray.childNodes
for propSet in propSets:
    keyValues = propSet.childNodes
    for keyValue in keyValues:
        if keyValue.tagName == 'Key':
            if keyValue.firstChild.data == "isCached":
                keyValue.nextSibling.firstChild.data = "true"

# Write to a new .sddraft file
sddraft_mod_xml = service_name + '_mod_xml' + '.sddraft'
sddraft_mod_xml_file = os.path.join(outdir, sddraft_mod_xml)
f = open(sddraft_mod_xml_file, 'w')
doc.writexml(f)
f.close()

try:
    # Stage Service
    print("Start Staging")
    arcpy.StageService_server(sddraft_mod_xml_file, sd_output_filename)
    warnings = arcpy.GetMessages(1)
    print(warnings)

    # Publish to server
    print("Start Uploading")
    arcpy.UploadServiceDefinition_server(sd_output_filename, target_server_connection)
    print("Finish Publishing")

    # Manage Map server Cache Tiles
    # For cache, use multiple scales separated by semicolon (;)
    # For example, "591657527.591555;295828763.795777"
    arcpy.server.ManageMapServerCacheTiles(target_server_connection + os.sep + service_name + ".MapServer", "591657527.591555",
                                           "RECREATE_ALL_TILES")
except Exception as stage_exception:
    print("Analyzer errors encountered - {}".format(str(stage_exception)))

except arcpy.ExecuteError:
    print(arcpy.GetMessages(2))

发布从现有缓存中提取的地图服务

以下脚本将为地图创建地图服务定义草稿 (.sddraft) 文件。 该脚本将在地图服务上启用要素访问，并使用现有缓存，通过使用 xml.dom.minidom 标准 Python 库来修改服务定义草稿文件以绘制服务。 然后，会将修改后的服务定义文件发布到 ArcGIS Server。

import arcpy
import os
import xml.dom.minidom as DOM

# Set output file names
outdir = r"C:\Project\Output"
service_name = "MapServiceDraftExample"
sddraft_filename = service_name + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)
sd_filename = service_name + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps('World')[0]

# Create MapServiceDraft
target_server_connection = r"C:\Project\gisserver.ags.esri.com (publisher).ags"
sddraft = arcpy.sharing.CreateSharingDraft("STANDALONE_SERVER", "MAP_SERVICE", service_name, m)
sddraft.targetServer = target_server_connection

# Create Service Definition Draft file
sddraft.exportToSDDraft(sddraft_output_filename)

"""Modify the .sddraft file to keep existing cache and enable feature access"""
# Read the file
doc = DOM.parse(sddraft_output_filename)

# Find all elements named TypeName
# This is where the extensions are defined
typeNames = doc.getElementsByTagName('TypeName')
for typeName in typeNames:
    # Get the TypeName to enable
    if typeName.firstChild.data == "FeatureServer":
        extension = typeName.parentNode
        for extElement in extension.childNodes:
            # Enable feature access
            if extElement.tagName == 'Enabled':
                extElement.firstChild.data = 'true'

# Turn off caching
configProps = doc.getElementsByTagName('ConfigurationProperties')[0]
propArray = configProps.firstChild
propSets = propArray.childNodes
for propSet in propSets:
    keyValues = propSet.childNodes
    for keyValue in keyValues:
        if keyValue.tagName == 'Key':
            if keyValue.firstChild.data == "isCached":
                keyValue.nextSibling.firstChild.data = "false"

# Enable feature access capabilities
configProps = doc.getElementsByTagName('Info')[0]
propArray = configProps.firstChild
propSets = propArray.childNodes
for propSet in propSets:
    keyValues = propSet.childNodes
    for keyValue in keyValues:
        if keyValue.tagName == 'Key':
            if keyValue.firstChild.data == "WebCapabilities":
                keyValue.nextSibling.firstChild.data = "Map,Query,Data"

# Use existing cache
configProps = doc.getElementsByTagName('KeepExistingMapCache')[0]
configProps.firstChild.data = "true"

# Write to a new .sddraft file
sddraft_mod_xml = service_name + '_mod_xml' + '.sddraft'
sddraft_mod_xml_file = os.path.join(outdir, sddraft_mod_xml)
f = open(sddraft_mod_xml_file, 'w')
doc.writexml(f)
f.close()

# Stage Service
print("Start Staging")
arcpy.StageService_server(sddraft_mod_xml_file, sd_output_filename)

# Publish to server
print("Start Uploading")
arcpy.UploadServiceDefinition_server(sd_output_filename, target_server_connection)

print("Finish Publishing")

创建并发布离线服务定义

以下脚本将创建一个离线服务定义，并将其发布为地图服务。

import arcpy
import os

# Set output file names
outdir = r"C:\Project\Output"
service_name = "MapServiceDraftExample"
sddraft_filename = service_name + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)
sd_filename = service_name + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps('World')[0]

# Create MapServiceDraft and set offline property
# The targetServer property is not needed when the offline property is set to True
sddraft = arcpy.sharing.CreateSharingDraft("STANDALONE_SERVER", "MAP_SERVICE", service_name, m)
sddraft.offline = True

# Create Service Definition Draft file
sddraft.exportToSDDraft(sddraft_output_filename)

# Stage Service
print("Start Staging")
arcpy.StageService_server(sddraft_output_filename, sd_output_filename)

# Publish to server
print("Start Uploading")
arcpy.UploadServiceDefinition_server(sd_output_filename, r"C:\Project\gisserver.ags.esri.com (publisher).ags")

print("Finish Publishing")