Résumé
The function converts Result objects and result files (.rlt) into Service Definition Draft (.sddraft) files.
Discussion
CreateGPSDDraft is the first step to automating the publishing of a geoprocessing result to a GIS Server using ArcPy. The output created from the CreateGPSDDraft is a Service Definition Draft (.sddraft) file. 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 to a tool execution, for example, the following buffer result gets 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, the type of service being published, metadata for the service (Item info), and data references (whether or not data is being copied to the server).
The function returns a Python dictionary containing errors and other potential issues that you should address prior to creating your Service Definition file.
Syntaxe
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})| Paramètre | Explication | Type de données |
result [result,...] | A reference to one or multiple Result objects or result files (.rlt) on disk. Multiple results must be supplied in a list format. The following example demonstrates multiple results as input to the CreateGPSDDraft function. | Result |
out_sddraft | A string that represents the path and file name for the output Service Definition Draft (.sddraft) file. | String |
service_name | A string that represents 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 in length. | String |
server_type | A string representing the server type. If a connection_file_path parameter is not supplied, then a server_type must be provided. If a connection_file_path parameter is supplied, then the server_type is taken from the connection file. In this case, you can choose FROM_CONNECTION_FILE or skip the parameter entirely.
(La valeur par défaut est ARCGIS_SERVER) | String |
connection_file_path | A string that represents the path and file name to the ArcGIS for Server connection file (.ags). | String |
copy_data_to_server | A Boolean that indicates whether the data referenced in the result will be copied to the server or not. The copy_data_to_server parameter is only used if the server_type is ARCGIS_SERVER and the connection_file_path isn't specified. If the connection_file_path is specified, then the server's registered data stores are used. For example, if the data in the result is registered with the server, then copy_data_to_server will always be False. Conversely, if the data in the result is not registered with the server, then copy_data_to_server will always be True. (La valeur par défaut est False) | Boolean |
folder_name | A string that represents a folder name to which you want to publish the service definition. If the folder does not currently exist, it will be created. The default folder is the server root level. (La valeur par défaut est None) | String |
summary | A string that represents the Item Description Summary. 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. (La valeur par défaut est None) | String |
tags | A string that represents 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. (La valeur par défaut est None) | String |
executionType | Les termes synchrone et asynchrone définissent la façon dont le client (l'application utilisant la tâche) interagit avec le serveur et obtient le résultat à partir de la tâche. Lorsqu'un service est synchrone, le client attend la fin de la tâche. En général, une tâche synchrone s'exécute rapidement, 5 secondes ou moins. L'exécution d'une tâche asynchrone dure généralement plus longtemps et le client doit régulièrement demander au serveur si la tâche est terminée et, si elle est terminée, obtenir le résultat. Une application Web qui utilise une tâche asynchrone doit être dotée d'une logique qui vérifie l'état d'une tâche et gère le résultat une fois l'exécution terminée. Les clients ArcGIS for Desktop gèrent les deux types d'exécution en mode natif. (La valeur par défaut est Asynchronous) | String |
resultMapServer | When publishing a geoprocessing service, you can choose to view the result of all tasks with the service as a map (in addition to other results of your task). The map is created on the server using a Map Service for transport back to the client as an image (a .jpeg, for example). The symbology, labeling, transparency, and all other properties of the returned map are the same as the settings of your output layer. Remember, if you are creating result layers within the Python scripting environment (outside ArcMap), default symbologies will be used. To maintain control over symbology you will need to pre-create layer files with rich symbology and use them to modify the output symbology of your task. When you choose this option, a map service is automatically created on the server with the same name as your geoprocessing service. (La valeur par défaut est False) | Boolean |
showMessages | A string setting the message level for the geoprocessing service. The following is a list of valid message levels the service will return to the client.
(La valeur par défaut est None) | String |
maximumRecords | Nombre maximal de résultats que le service peut renvoyer à un client. Si cette valeur est définie sur un nombre élevé, cela signifie que votre serveur SIG peut gérer l'envoi de nombreux enregistrements individuels ou d'entités au client. Si vous ne souhaitez pas renvoyer d'entités, définissez cette valeur sur 0 (zéro). En général, cette valeur est définie sur zéro uniquement lorsque vous activez l'option Visionner le résultat avec un service de carte. (La valeur par défaut est 1000) | Integer |
minInstances | An integer value representing the minimum number of instances a service will start and make available for use. For heavily used services you may want to increase this value. (La valeur par défaut est 1) | Integer |
maxInstances | An integer value representing the maximum number of instances a service can start and make available for use. For heavily used services you may need to increase this value. Ensure the server has adequate hardware to support the maximum number of instances you will allow. (La valeur par défaut est 2) | Integer |
maxUsageTime | Durée maximale, exprimée en seconde, d'utilisation d'un service. Vous pouvez avoir besoin d'augmenter la valeur par défaut à 600 secondes (10 minutes) pour les tâches de géotraitement avec une durée d'exécution plus longue. Il peut aussi être nécessaire de réduire cette durée pour éviter qu'un client n'abuse de vos services. (La valeur par défaut est 600) | Integer |
maxWaitTime | Période maximale, exprimée en seconde, durant laquelle un client doit attendre pour se connecter à une instance avant la période d'expiration. Lorsque toutes les instances sont occupées avec le traitement de demandes, les demandes sont placées dans une file d'attente. Si cette période d'expiration s'écoule avant qu'une instance ne soit disponible, la tâche échoue. La valeur par défaut est de 60 secondes (1 minute). (La valeur par défaut est 60) | Integer |
maxIdleTime | Période maximale, exprimée en seconde, durant laquelle un client doit attendre pour se connecter à une instance avant la période d'expiration. Toutes les instances inutilisées au-delà du nombre minimal d'instances sont arrêtées dès que la période d'inactivité a atteint la valeur limite définie. (La valeur par défaut est 1800) | Integer |
Valeur renvoyée
| Type de données | Explication |
| Dictionary | Returns a Python Dictionary of information messages, warnings, and errors. |