Propiedades del parámetro de tarea (REST)
En este tema
- Tipo de datos
- Nombre de visualización
- de dirección
- Valor predeterminado
- Tipo de parámetro
- Categoría
- Lista de selección
Cada tarea de geoprocesamiento tiene al menos un parámetro. Cada parámetro de tarea tiene un conjunto de propiedades descriptivas para ayudarle a entender el parámetro y proporcionar el valor adecuado para la ejecución satisfactoria de la tarea. La captura de pantalla siguiente muestra un ejemplo de parámetro de tarea Distancia, como se ve en la página de tarea de geoprocesamiento en el directorio de servicios. La importancia de cada propiedad se describe a continuación.
Tipo de datos
El tipo de datos del parámetro especifica el tipo de valor que el cliente debe proporcionar para el parámetro. El valor de un parámetro puede ser tan simple como una cadena de caracteres, largo, doble, booleano o fecha. O puede ser un conjunto de entidades (un grupo de entidades con atributos similares clase de entidad), una tabla o un ráster. Por ejemplo, si el tipo de datos es largo, debe proporcionar un valor numérico entre −2.147.483.648 y 2.147.483.647. Cualquier otro decimal o valores de cadena de texto tendrá como resultado un comportamiento inesperado de la herramienta. Del mismo modo, si es un tipo de datos ráster, debe proporcionar datos ráster adecuados para la correcta ejecución de la herramienta. La lista de abajo muestra los tipos de datos de un parámetro de tarea y sus valores esperados.
| Tipo de datos | Valor | Ejemplo de representación JSON |
GPLong | Un valor entero entre −2.147.483.648 y 2.147.483.647 | |
GPDouble | Valores decimales | |
GPString | Cadena de caracteres | TestString |
GPBoolean | verdadero o falso | verdadero |
GPLinearUnit | Un valor que tiene un valor de distancia y su unidad de medición como pies, kilómetros, millas, etc. | { "distancia": 345.678, "unidades": "EsriMiles" } |
GPDate | Número que representa la cantidad de milisegundos desde la época (1 de enero de 1970) en UTC. |
|
GPDataFile | Cualquier tipo de archivo como .txt, .pdf, .csv, etc. | { "url" : "http://myserver/myfile" } |
GPRasterDataLayer | Los datos ráster que constan de una matriz de celdas (o píxeles) organizada en filas y columnas (cuadrícula) en la que cada celda contiene un valor que representa información. | { "url" : "http://myserver/lake.tif", "format" : "tif" } |
GPRecordSet | Tablas que están representadas en filas y columnas. |
|
GPFeatureRecordSetLayer | Entidades que tienen una geometría, referencia espacial, definiciones de campo y entidades. | GPFeatureRecordSetLayer JSON |
GPMultiValue | Un conjunto de valores de parámetro GP del mismo tipo de datos. Por ejemplo, GPMultiValue:GPString, GPMultiValue:GPLinearUnit |
["Parcelas", "Farolas"] [ { "distancia" : 345.67, "unidades" : "esriMiles "}, { "distancia": 36, "unidades" : "EsriMiles" } ] |
Nota:
- Para los parámetros GPRecordSet y GPFeatureRecordSetLayer, si tiene una gran cantidad de registros y entidades, puede almacenar la estructura JSON en un archivo y proporcionar la dirección URL como entrada. Por ejemplo, { "url" : "http://myserver/myfeatures/afile.txt"}. El archivo de texto debe tener conjuntos e datos o de registros en formato JSON.
- En el caso del tipo de datos GPMultiValue:GPFeatureRecordSetLayer, el conjunto de entidades deben tener definiciones de campo para que la ejecución sea satisfactoria.
Nombre de visualización
El nombre de visualización es un nombre significativo para el parámetro.
de dirección
La dirección le ayuda a identificar si el parámetro es un parámetro de entrada o de salida.
- esriGPParameterDirectionInput : Parámetro de entrada
- esriGPParameterDirectionOutput : Parámetro de salida
Cuando se ejecuta una tarea, el cliente necesita proporcionar los valores para los parámetros de entrada única. Cuando la tarea se ejecuta correctamente, los parámetros de salida serán creado por el servidor y el cliente puede acceder a los valores de estos parámetros de salida.
Valor predeterminado
Al publicar un servicio de geoprocesamiento, las tareas de geoprocesamiento se crean a partir de los resultados satisfactorios de la herramienta de geoprocesamiento. El Valor predeterminado muestra los valores de los parámetros en el resultado a partir del cual se creó la tarea. El valor predeterminado de un parámetro de entrada es un ejemplo del valor de parámetro que debería ser aprobado para el éxito de la ejecución de la tarea, y el valor predeterminado de un parámetro de salida es un ejemplo de salida esperada de la tarea.
- El valor predeterminado de GPFeatureRecordSet y GPRecordSet tendrá información adicional en el esquema del conjunto de entidades/registros. El esquema incluye GeometryType, HasZ, HasM, Referencia espacial, Campos y Entidades. La captura de pantalla siguiente muestra un esquema de ejemplo del tipo de datos GPFeatureRecordSet.
El cliente debería proporcionar conjuntos de entidades de entrada que cumplan con el esquema definido por el valor predeterminado para el éxito de la ejecución de la herramienta. La propiedad Entidades del esquema será nula en la mayoría de los casos. Sin embargo, si la tarea se publicó con la opción Incluir entidades , las entidades incluidas se enumeran en el valor predeterminado.
- Los parámetro GPDataFile, GPRasterData y GPRasterDataLayer no tiene valores predeterminados.
Tipo de parámetro
Hay tres tipos de parámetros:
- esriParameterTypeRequired: El parámetro es necesario para una ejecución satisfactoria. El cliente debe proporcionar un valor para el parámetro cuando ejecuta una operación en la tarea recurso.
- esriParameterTypeOptional: El parámetro es opcional para una ejecución satisfactoria.
- esriParameterTypeDerived: El valor de parámetro es un parámetro de salida derivado de otros parámetros de entrada y por eso el cliente no tiene que proporcionar un valor.
Categoría
Cuando hay muchos parámetros de entrada y de salida, normalmente se agrupan en categorías concretas para una mejor comprensión por el autor de la herramienta. La captura de pantalla siguiente muestra un ejemplo de categorías como se ven el cuadro de diálogo ArcGIS for Desktop.
La categoría especifica si el parámetro pertenece a una categoría específica como diseñó el autor de la herramienta. El valor de categoría se puede utilizar cuando diseña widgets para tareas de geoprocesamiento.
Lista de selección
Algunos parámetros GPString tendrán una opción adicional Lista de propiedad. Una lista de selección es un conjunto predefinido de valores determinados por el responsable de publicación para el éxito de la ejecución de la herramienta. El cliente debe elegir uno de los valores de la lista de selección para el éxito de la ejecución. La tarea fallará si el cliente proporcionó un valor distinto a los valores de la lista de selección. La captura de pantalla siguiente muestra una lista de selección de valores de Red de calles, Red de bici o Red de paseo para el parámetro Transportation_mode_network de GPString. Cuando se proporcionan estos valores de la lista de selección, el cliente debe elegir uno de los valores para el éxito de la ejecución.
Más información sobre cómo crear valores de lista de selección para parámetros al publicar una tarea