CreateGPSDDraft

Summary

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

Note:

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

Discussion

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.

Note:

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	Explanation	Data Type
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. Note: 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. (The default value is 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. (The default value is 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. (The default value is 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. (The default value is 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. (The default value is None)	String
executionType	Asynchronous and synchronous define how the client (the application using the task) interacts with the server and gets the result from the task. When a service is set to synchronous, the client waits for the task to finish. Typically, a synchronous task executes quickly—five seconds or less. An asynchronous task typically takes longer to execute, and the client must periodically ask the server if the task has finished and, if it has finished, get the result. A web application using an asynchronous task must have logic implemented to check the status of a task and handle the result once execution is finished. ArcGIS Desktop clients handle both execution types natively. (The default value is 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. (The default value is 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. (The default value is None)	String
maximumRecords	The maximum number of results the service can return to a client. Setting this value to a large number means your GIS server can handle sending a lot of individual records or features to the client. If you don't want to return any features, set this value to 0 (zero). Typically, you set this value to zero only when you enable View result with a map service. (The default value is 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. (The default value is 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. (The default value is 2)	Integer
maxUsageTime	The maximum time, in seconds, that a service can be used. You may need to increase the default of 600 seconds (10 minutes) for long-running geoprocessing tasks. Alternatively, you may need to reduce this time to ensure a client will not abuse your services. (The default value is 600)	Integer
maxWaitTime	The maximum time, in seconds, that a client will wait to connect with an instance before timing out. When all instances are busy processing requests, subsequent requests are queued. If this time-out elapses before an instance becomes available, the task will fail. The default is 60 seconds (1 minute). (The default value is 60)	Integer
maxIdleTime	The maximum time, in seconds, that an instance will continue to be active before pool shrinking occurs. Any instances above the minimum number of instances that have not been used will be shut down once the idle maximum time value has elapsed. (The default value is 1800)	Integer
capabilities	Specifies the capabilities a service will support. Currently, only Uploads is supported. (The default value is 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"]. (The default value is 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"]}. (The default value is None)	Dictionary

Return Value

Data Type	Explanation
Dictionary	Returns a dictionary of information messages, warnings, and errors.

Code sample

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'])