サマリー
The function converts an address locator into a Service Definition Draft (.sddraft) file, which can be used to create a service definition for publishing a geocode service.
説明
CreateGeocodeSDDraft is the first step to automating the publishing of an address locator to a geocode service using ArcPy. The output created from the CreateGeocodeSDDraft is a Service Definition Draft (.sddraft) file. A Service Definition Draft is the combination of address locator properties, information about the server, and a set of service properties.
Information about the server includes the server connection, server type being published to, metadata for the service (Item info), and data references (whether or not data is being copied to the server).
Service properties include operations such as geocoding and reverse geocoding supported by the service, maximum number of candidates returned by the service when geocoding a single address, or the maximum number of records to be processed in each batch job when performing batch geocoding.
The function returns a dictionary containing errors and other potential issues that you should address prior to creating your Service Definition file.
A Service Definition Draft file can be authored without knowing the specific server connection information. In this case, the connection_file_path parameter may be omitted; however, the server_typemust be provided. A server connection can be provided later when the Service Definition Draft file is published using the Upload Service Definition tool.
構文
CreateGeocodeSDDraft (loc_path, out_sddraft, service_name, {server_type}, {connection_file_path}, {copy_data_to_server}, {folder_name}, {summary}, {tags}, {max_candidates}, {max_batch_size}, {suggested_batch_size}, {supported_operations})| パラメーター | 説明 | データ タイプ |
loc_path | A string that represents the catalog path to the address locator. Valid formats for the address locator are locator files (.loc) in a file folder or locators in a geodatabase. | String |
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.
(デフォルト値は次のとおりです 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 address locator 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 address locator is registered with the server, then copy_data_to_server will always be False. Conversely, if the data in the address locator is not registered with the server, then copy_data_to_server will always be True. (デフォルト値は次のとおりです 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 when the service definition is published as a service. The default folder is the server root level. (デフォルト値は次のとおりです 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. (デフォルト値は次のとおりです 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. To specify multiple tags, separate each tag with a comma within the string. (デフォルト値は次のとおりです None) | String |
max_candidates | The maximum number of candidates returned by the service when geocoding a single address. (デフォルト値は次のとおりです 500) | Integer |
max_batch_size | The maximum number of records to be processed in each batch job when performing batch geocoding. (デフォルト値は次のとおりです 1000) | Integer |
suggested_batch_size | The recommended number of records to pass in each batch job when performing batch geocoding. (デフォルト値は次のとおりです 1000) | Integer |
supported_operations [supported_operations,...] | The built-in operations supported by the service. The parameter should be specified as a list containing one or more of the following string keywords:
For example, to specify that the service should only support geocoding operations and should not allow any reverse geocoding operations, the parameter should be specified as ["GEOCODE"]. (デフォルト値は次のとおりです [GEOCODE, REVERSE_GEOCODE, SUGGEST]) | List |
戻り値
| データ タイプ | 説明 |
| Dictionary | Returns a dictionary of information messages, warnings, and errors. |