CreateGPSDDraft

Zusammenfassung

Converts Result objects and result files (.rlt) to a service definition draft file (.sddraft).

Hinweis:

A draft service definition does not contain data. A draft service alone cannot be used to publish a service.

Diskussion

CreateGPSDDraft is the first step to automating the publishing of a geoprocessing result to a GIS server using ArcPy. The output created from CreateGPSDDraft is a service definition draft file (.sddraft). A service definition draft is the combination of a result file or Result object, information about the server, and a set of service properties. A Result object can be created in a Python script by setting a variable and running a tool. For example, the following buffer result is saved to a variable called result:

import arcpy
result = arcpy.Buffer_analysis("inPts", "output.shp", "100 Meters")

Information about the server includes the server connection, server type being published to, type of service being published, metadata for the service (Item info), and data references (whether data is copied to the server).

The function returns a dictionary containing errors, warnings, and messages that you should address before creating the service definition file (.sd).

The service definition draft must be converted to a fully consolidated .sd file using the Stage Service tool. Staging compiles all the necessary information to successfully publish the GIS resource. If the data is not registered with the server, it will be added when the service definition draft is staged. The .sd file can be uploaded and published as a GIS service to a specified GIS server using the Upload Service Definition tool. This step copies the .sd file to the server, extracts required information, and publishes the GIS resource. For more information, see An overview of the Publishing toolset.

Hinweis:

If publishing to ArcGIS Enterprise or ArcGIS Server 10.9.1 or earlier, set the number of the staging version when using the Stage Service tool. For a list of server numbers, refer to the Staging Version parameter in the tool.

Syntax

CreateGPSDDraft (result, out_sddraft, service_name, {server_type}, {connection_file_path}, {copy_data_to_server}, {folder_name}, {summary}, {tags}, {executionType}, {resultMapServer}, {showMessages}, {maximumRecords}, {minInstances}, {maxInstances}, {maxUsageTime}, {maxWaitTime}, {maxIdleTime}, {capabilities}, {constantValues}, {choiceLists})

Parameter	Erläuterung	Datentyp
result [result,...]	One or multiple Result objects or result files (.rlt). Multiple results must be supplied in a list format. The following example demonstrates multiple results as input to the CreateGPSDDraft function: import arcpy result1 = arcpy.analysis.Buffer("inPts", "output.shp", "100 Meters") result2 = arcpy.management.GetCount("FireStations") arcpy.CreateGPSDDraft([result1, result2], "output.sddraft", "myservice")	Result
out_sddraft	The path and file name for the output .sddraft file.	String
service_name	The name of the service. This is the name people will see and use to identify the service. The name can only contain alphanumeric characters and underscores. No spaces or special characters are allowed. The name cannot be more than 120 characters.	String
server_type	Specifies the server type. If a connection_file_path parameter value is not provided, a server_type value must be specified. If a connection_file_path parameter value is provided, the server_type value is taken from the connection file. In this case, you can specify FROM_CONNECTION_FILE or skip the parameter. Hinweis: MY_HOSTED_SERVICES is only available when creating .sddraft files from ArcGIS Pro. ARCGIS_SERVER—The ArcGIS Server server type. This is the default. FROM_CONNECTION_FILE—The connection_file_path parameter value will be used. MY_HOSTED_SERVICES—An .sddraft file is created that will be published to the current portal. (Der Standardwert ist ARCGIS_SERVER)	String
connection_file_path	The path and file name to the ArcGIS Server connection file (.ags).	String
copy_data_to_server	Specifies whether the data referenced in the result parameter will be copied to the server. This parameter is only used if the server_type value is ARCGIS_SERVER and the connection_file_path value isn't provided. If the connection_file_path value is provided, the server's registered data stores will be used. For example, if the data in the result parameter is registered with the server, copy_data_to_server will always be False. Conversely, if the data in the result parameter is not registered with the server, copy_data_to_server will always be True. False—The data will not be copied to the server. This is the default. True—The data will be copied to the server. (Der Standardwert ist False)	Boolean
folder_name	The folder name where the service definition will be published. If the folder does not exist, it will be created. The default folder is the server root level. (Der Standardwert ist None)	String
summary	The Item Description Summary text. Use this parameter to override the user interface summary or to provide a summary if one does not exist. The summary provided here will not be persisted in the map document. (Der Standardwert ist None)	String
tags	The Item Description tags. Use this parameter to override the user interface tags or to provide tags if they do not exist. The tags provided here will not be persisted in the map document. (Der Standardwert ist None)	String
executionType	Asynchron und synchron definieren, wie der Client (die Anwendung, die den Task verwendet) mit dem Server interagiert und das Task-Ergebnis erhält. Wenn ein Service auf synchron eingestellt ist, wartet der Client, bis der Task beendet ist. In der Regel dauert die Ausführung eines synchronen Tasks kurz – fünf Sekunden oder weniger. Ein asynchroner Task braucht in der Regel länger, und der Client muss den Server regelmäßig abfragen, ob der Task beendet ist, und nach Fertigstellung das Ergebnis abrufen. Eine Webanwendung, die einen asynchronen Task verwendet, muss Logik implementiert haben, um den Task-Status zu überprüfen und das Ergebnis nach der Fertigstellung zu verarbeiten. ArcGIS for Desktop-Clients verarbeiten beide Ausführungstypen nativ. (Der Standardwert ist Asynchronous)	String
resultMapServer	Specifies whether the result of all tasks will be visualized with the service as a map (in addition to other results of the task) when publishing a geoprocessing service. The map is created on the server using a map service for transport back to the client as an image (a .jpeg file, for example). The symbology, labeling, transparency, and all other properties of the returned map are the same as the settings of the output layer. If you are creating result layers in the Python scripting environment (outside ArcGIS Pro), default symbology will be used. To maintain control over symbology, create the layer files with symbology and use them to modify the output symbology of the task. When True, a map service is automatically created on the server with the same name as the geoprocessing service. The default is False. (Der Standardwert ist False)	Boolean
showMessages	Specifies the message level that will be used for the geoprocessing service. The following are the valid message levels the service will return to the client: None—No geoprocessing messages will be returned to the client except those stating whether the process succeeded or failed. This is the default. Error—Only tool messages that produce an error will be returned to the client. Warning—All tool error and warning messages will be returned to the client. Info—All tool messages from processing will be returned to the client. (Der Standardwert ist None)	String
maximumRecords	Die maximale Anzahl von Ergebnissen, die der Service an einen Client zurückgeben kann. Wenn Sie diesen Wert auf eine große Zahl einstellen, kann Ihr GIS-Server eine Menge einzelner Datensätze oder Features verarbeiten, die an den Client gesendet werden. Wenn Sie keine Features zurückgeben möchten, setzen Sie diesen Wert auf 0 (Null). In der Regel setzen Sie diesen Wert nur dann auf Null, wenn Sie Ergebnisse mit einem Kartenservice anzeigen verwenden. (Der Standardwert ist 1000)	Integer
minInstances	The minimum number of instances a service will start and make available for use. For heavily used services, you can increase this value. (Der Standardwert ist 1)	Integer
maxInstances	The maximum number of instances a service can start and make available for use. For heavily used services, you can increase this value. Ensure that the server has adequate hardware to support the maximum number of instances indicated. (Der Standardwert ist 2)	Integer
maxUsageTime	Die maximale Zeit in Sekunden, die ein Service verwendet werden kann. Sie müssen ggf. den Standardwert von 600 Sekunden (10 Minuten) für länger dauernde Geoverarbeitungs-Tasks erhöhen. Alternativ können Sie die Zeit reduzieren, um sicherzustellen, dass ein Client den Service nicht missbräuchlich verwendet. (Der Standardwert ist 600)	Integer
maxWaitTime	Die maximale Zeit in Sekunden, die ein Client auf eine Verbindung mit einer Instanz wartet, bevor ein Timeout erfolgt. Wenn alle Instanzen mit der Verarbeitung von Anforderungen ausgelastet sind, werden nachfolgende Anforderungen in eine Warteschlange gestellt. Wenn dieses Timeout eintritt, bevor eine Instanz verfügbar wird, schlägt der Task fehl. Der Standard ist 60 Sekunden (1 Minute). (Der Standardwert ist 60)	Integer
maxIdleTime	Die maximale Zeit in Sekunden, die eine Instanz aktiv bleibt, bevor eine Poolverkleinerung erfolgt. Instanzen oberhalb der Mindestanzahl von Instanzen, die nicht verwendet wurden, werden heruntergefahren, sobald die maximale Leerlaufzeit abgelaufen ist. (Der Standardwert ist 1800)	Integer
capabilities	Specifies the capabilities a service will support. Currently, only Uploads is supported. (Der Standardwert ist None)	String
constantValues [constantValues,...]	A list of parameter names to be set as a constant. If multiple tools are included, parameter names must be qualified with the tool name, for example, ["toolX.parameterA", "toolY.parameterD"]. (Der Standardwert ist None)	String
choiceLists	Constrains values for any input parameter with a choice list input mode in the web tool or geoprocessing service. The choice list and its values must be created before using this property; you cannot use this property to add new values to the choice list. If you have a feature or raster input, you must create the layer for each value in the choice list first and use this property to constrain. The property uses a dictionary with the service task and parameter name as the key, and a list of the string values as the value, for example, {"ServiceTaskName.parameterName":["string1", "string2"]}. (Der Standardwert ist None)	Dictionary

Rückgabewert

Datentyp	Erläuterung
Dictionary	Returns a dictionary of information messages, warnings, and errors.

Codebeispiel

CreateGPSDDraft example 1: Publish to a federated server

The following script demonstrates the complete publishing of a web tool to a federated server. Automating the publishing of web tools uses a combination of ArcPy functions and geoprocessing tools in the Publishing toolset. The workflow begins by running a geoprocessing task that you want to publish. After you successfully run the geoprocessing task, sign in to your portal to proceed. Then use the CreateGPSDDraft function to create a service definition draft. The Item Description, Summary, and Tags for the input geoprocessing result are overwritten using the summary and tags parameters. The function returns an analyzer dictionary that identifies issues that may prevent successful publishing. After resolving any serious issues, the service definition can be staged. Staging takes the service definition draft and consolidates all the information needed to publish the service into a complete service definition. Use the Stage Service tool to stage the service definition. Finally, use the Upload Service Definition tool to upload the service definition to the portal and publish the web tool.

import arcpy

toolbox = "c:/gis/gp/MyAnalysisTools.tbx"
sddraft = "c:/gis/gp/drafts/AnalysisReport.sddraft"
sd = "c:/gis/gp/sd/AnalysisReport.sd"
portalurl = "https://myportal.esri.com/portal"
portalusername = "username"
portalpassword = "password"
serverURL = "https://myserver.esri.com/server"
serviceName = "AnalysisReportService"

# Run the tool and set to a result object
arcpy.ImportToolbox(toolbox)
result = arcpy.reports.MyCustomAnalysis("c:/gis/data/parcels.gdb/taxlots",
                                        "40", "MyOutput.pdf")

# Sign in to Portal
arcpy.SignInToPortal(portalurl, portalusername, portalpassword)

# Create service definition draft and return analyzer messages
analyzeMessages = arcpy.CreateGPSDDraft(
    result, sddraft, serviceName, server_type="MY_HOSTED_SERVICES",
    copy_data_to_server=True, folder_name=None, 
    summary="Analysis Service", tags="gp", executionType="Synchronous",
    resultMapServer=False, showMessages="Info", maximumRecords=5000,
    minInstances=2, maxInstances=3, maxUsageTime=100, maxWaitTime=10,
    maxIdleTime=180)

# Stage and upload the service if the sddraft analysis did not
# contain errors
if analyzeMessages['errors'] == {}:
    # The following runs StageService for ArcGIS 11 Enterprise. If you're using version
    # 10.9.1 or earlier, you must provide the staging version. For example, 
    # the staging version for 10.9.1 server is 209.   
    arcpy.server.StageService(sddraft, sd)

    # Run UploadServiceDefinition
    # Use URL to a federated server
    arcpy.server.UploadServiceDefinition(sd, serverURL)
else:
    # If the sddraft analysis contained errors, display them
    print(analyzeMessages['errors'])

CreateGPSDDraft example 2: Publish to a stand-alone server

The following script demonstrates the complete process of publishing a geoprocessing service to a stand-alone server. The workflow is similar to publishing to a federated server, except you do not need to sign in to your portal. In addition, set the parameter server type to ARCGIS_SERVER, and provide a server connection file (.ags) for the CreateGPSDDraft function. The server connection file parameter from the Upload Service Definition tool must also be provided with a server connection file. Ensure that the existing .ags file has server login credentials.

import arcpy

toolbox = "c:/gis/gp/MyAnalysisTools.tbx"
sddraft = "c:/gis/gp/drafts/AnalysisReport.sddraft"
sd = "c:/gis/gp/sd/AnalysisReport.sd"

serverconnectionfile = "c:/gis/gp/myserver.ags"
serviceName = "AnalysisReportService"

# Run the tool and set to a result object
arcpy.ImportToolbox(toolbox)
result = arcpy.reports.MyCustomAnalysis("c:/gis/data/parcels.gdb/taxlots",
                                        "40", "MyOutput.pdf")

# Create service definition draft and returns analyzer messages
analyzeMessages = arcpy.CreateGPSDDraft(
    result, sddraft, serviceName, server_type="MY_HOSTED_SERVICES",  
    connection_file_path= serverconnectionfile,
    copy_data_to_server=True, folder_name=None, 
    summary="Analysis Service", tags="gp", executionType="Synchronous",
    resultMapServer=False, showMessages="Info", maximumRecords=5000,
    minInstances=2, maxInstances=3, maxUsageTime=100, maxWaitTime=10,
    maxIdleTime=180)

# Stage and upload the service if the sddraft analysis did not
# contain errors
if analyzeMessages['errors'] == {}:
    # The following runs StageService for ArcGIS 11 server. If you're using version 10.9.1 
    # or earlier, you must provide the staging version. For example, the staging 
    # version for 10.9.1 server is 209. 
    arcpy.server.StageService(sddraft, sd)

    # Run UploadServiceDefinition
    # Use URL to a federated server 
    arcpy.server.UploadServiceDefinition(sd, serverconnectionfile)
else:
    # If the sddraft analysis contained errors, display them
    print(analyzeMessages['errors'])