Configuración de la herramienta web

La configuración que se elige al compartir una herramienta como herramienta web define la forma en que las aplicaciones cliente la consumen. Los parámetros de la herramienta más habituales y que se cambian con más frecuencia se pueden definir al compartir. Los ajustes menos habituales se pueden modificar en ArcGIS Server Manager después de compartir la herramienta. Parte de la configuración avanzada solo se puede definir en la página web del Administrador de ArcGIS Server. Son pocas las herramientas web (servicios de geoprocesamiento) cuya configuración avanzada tendrá que modificar en alguna ocasión.

Sugerencia:

Use ArcGIS Server Manager para administrar y modificar la configuración de la herramienta publicada.

Configuración

En las subsecciones siguientes se describe la configuración que se puede usar al compartir una herramienta web.

General

ParámetroDescripción

Nombre

El nombre de la herramienta web que se va a compartir con el portal. Este nombre debe ser único en el portal y no puede contener espacios ni caracteres especiales. Este parámetro se hereda de los metadatos de la herramienta.

Resumen

El resumen y las etiquetas que ayudan a describir el documento y permiten la búsqueda de la herramienta web. Cada parámetro se hereda de los metadatos de la herramienta. Este parámetro se hereda de los metadatos de la herramienta. Para compartir la escena web en un portal de ArcGIS Enterprise 10.9 o un portal anterior, se requieren un resumen y etiquetas.

Puede utilizar un máximo de 128 etiquetas.

Etiquetas

Versión

La versión del servidor ArcGIS Enterprise o ArcGIS Server con la que compartirá. Este parámetro solo está habilitado al guardar una definición de servicio de una herramienta web o servicio de geoprocesamiento.

Datos

Controla si los datos se copian en el servidor (pasan a ser estáticos) o si la herramienta web sigue haciendo referencia a ellos. Una entrada coincidente en el data store del servidor se debe configurar para sus datos para que utilice la configuración Referencia a datos registrados. Si el data store del servidor no define los datos, se copiarán durante la publicación. Solo es aplicable cuando se publica como herramienta web o cuando se guarda como definición de servicio conectado. Si guarda el resultado como definición de servicio sin conexión, asegúrese de que se pueda hacer referencia a todos los datos de su parámetro si elige Datos de referencia ya que no hay alternativa para copiar los datos si el data store del servidor no define sus datos.

Localización

  • Carpeta: seleccione o cree una carpeta del portal donde se creará el elemento de la herramienta web. La configuración predeterminada es la raíz del portal.
  • Servidor y carpeta: en el caso del servidor, las herramientas web se deben compartir con un portal con uno o varios servidores federados. Si el portal tiene más de un servidor federado, puede elegir en qué servidor se publicará la herramienta web. En el caso de la carpeta, puede seleccionar una carpeta existente o crear una en el sitio de ArcGIS Server. La configuración predeterminada es la raíz del sitio de ArcGIS Server.

Compartir con

Defina con quién y con qué grupos se compartirá la herramienta web. Una herramienta web siempre se comparte con Mi contenido. Compartir una herramienta web con Todos hace que el elemento sea público, cualquiera que tenga acceso al sitio web del portal puede encontrarlo y usarlo, y los propietarios de grupos pueden incluirlo en el contenido de su grupo. Compartir una herramienta web con ArcGIS Enterprise hace que la herramienta web se comparta con todos los miembros de su portal que tengan acceso a un elemento. Puede optar por compartirla con cualquier grupo al que pertenezca.

Configuración

ParámetroDescripción

Cargar

Controla si un cliente puede cargar un archivo en su servidor para utilizarlo como entrada para la herramienta web. La operación de carga la utilizan principalmente los clientes web que necesitan un modo de enviar un archivo al servidor para su procesamiento. Una vez que se completa la carga, la operación devuelve un Id. único para el archivo que la aplicación web puede transferir a la herramienta web.

Esta opción está desactiva por defecto. Permitir las cargas en el servicio puede suponer un riesgo de seguridad. Active esta opción únicamente si es necesario.

Modo de ejecución: síncrono o asíncrono

Los modos sincrónico y asíncrono definen cómo el cliente (la aplicación que utiliza la herramienta web) interactúa con la herramienta web y obtiene la salida. Cuando una herramienta web se define como sincrónica, el cliente espera que la tarea finalice. Normalmente, un servicio sincrónico se ejecuta con rapidez (en unos segundos). Un servicio asíncrono suele tardar más tiempo en ejecutarse y el cliente debe preguntar periódicamente al servidor si el servicio ha terminado y, si ha terminado, obtener el resultado. Una aplicación web con un servicio asíncrono debe tener lógica implementada para verificar el estado y administrar el resultado una vez finalizada la ejecución. Los clientes de ArcGIS Desktop administran ambos tipos de ejecución de forma nativa.

Muestra la salida en la capa de imágenes del mapa

Al publicar una herramienta web, puede ver la salida como una imagen de mapa. La imagen de mapa se crea en el servidor y se transporta de nuevo al cliente como una imagen (un archivo .tiff con información de estilos). La simbología, el etiquetado, la transparencia y el resto de propiedades de la imagen de mapa son iguales que las de la capa de salida de la sesión de ArcGIS Pro cuando publicó originalmente. Estos son algunos motivos por los que debería utilizar Muestra la salida en la capa de imágenes del mapa:

  • Si la herramienta genera un gran número de entidades que el cliente debe simbolizar y dibujar, será más rápido para el cliente recibir una imagen de mapa.
  • Por razones de distribución de datos, no desea enviar al cliente ninguna entidad, solo una imagen de mapa.
  • El resultado de la herramienta es un dataset no transportable, como una red o una topología. La única forma de enviar la salida al cliente es usar una imagen de mapa.
Nota:

Una imagen de mapa de salida solo se puede usar cuando la herramienta web se ha definido como Asíncrona.

Este parámetro no se admite al publicar una herramienta web en Kubernetes.

Nivel del mensaje

Puede devolver mensajes de diferentes niveles al cliente que ha ejecutado la herramienta web de la forma siguiente:

  • Ninguno: no se devuelven mensajes de geoprocesamiento al cliente, solo una indicación de si la ejecución se realizó correctamente o si falló. Esta es la opción predeterminada.
  • Error: solo se devuelven al cliente los mensajes de la herramienta que indican un error.
  • Advertencia: se devuelven al cliente todos los mensajes de advertencia y de error de la herramienta.
  • Info: se devuelven al cliente todos los mensajes de ejecución de la herramienta.
Precaución:

Todos los mensajes, independientemente de su nivel, pueden contener rutas y nombres de dataset, lo que puede suponer un riesgo de seguridad. El nivel Info es detallado y normalmente contiene referencias a rutas y nombres de dataset. En general, devuelva mensajes durante el desarrollo, pero desactívelos en la producción.

Cantidad máxima de registros devueltos

El número máximo de resultados que el servicio puede devolver a un cliente. La configuración de este valor como un gran número significa que el servidor SIG puede manejar el envío de varios registros o entidades individuales al cliente. Si no desea devolver ninguna entidad, establezca este valor en 0 (cero). Por lo general, este valor se debe establecer en cero cuando se habilita Muestra la salida en la capa de imágenes del mapa.

Los ajustes ya mencionados se pueden modificar en ArcGIS Server Manager después de compartir la herramienta web, con la excepción del resumen y las etiquetas. Esta información de descripción se puede actualizar en la página de elemento de la herramienta web compartida en el portal.

Contenido

Los siguientes ajustes solo se pueden modificar en el momento de la publicación de una herramienta web.

Agregar herramienta

Para agregar herramientas del historial de geoprocesamiento a la herramienta web existente, haga clic en el botón Agregar herramienta Agregar herramienta de la pestaña Contenido. Para eliminar herramientas, haga clic en el nombre de la herramienta y seleccione Eliminar.

Configurar propiedades de la herramienta

Es posible modificar las propiedades de la herramienta haciendo clic en el botón Editar a la derecha del nombre de la herramienta.

ParámetroDescripción

Nombre

El nombre de la herramienta. El nombre se hereda de la etiqueta de metadatos de la herramienta.

Descripción

La descripción de la herramienta. La descripción no se hereda de los metadatos de la herramienta. Si está en blanco, proporcione una descripción y se quedará siempre que comparta desde el historial.

Es posible modificar las siguientes propiedades para cada parámetro:

ParámetroDescripción

Nombre

El nombre y la descripción del parámetro. Ambos se heredan del nombre y descripción del parámetro de los metadatos de la herramienta. Es posible modificarlos aquí y los metadatos originales de la herramienta no se verán afectados.

Descripción

Tipo

El tipo de parámetro define si el cliente debe proporcionar un valor para que la herramienta se ejecute correctamente. En la pestaña Contenido solo puede cambiar parámetros opcionales a requeridos. Para cambiar un parámetro requerido para que sea opcional, cierre el panel Compartir, edite las propiedades de la herramienta y vuelva a ejecutar la herramienta para crear un nuevo resultado.

Modo de entrada

El modo de entrada determina cómo los clientes introducirán las entidades en su tarea:

  • Valor definido por el usuario: el cliente proporciona un valor para el parámetro.
  • Lista de opciones: el cliente recibe una lista de cadenas de caracteres (la lista de opciones) y debe elegir una o más cadenas de caracteres de la lista de opciones. Según el tipo de datos de la entrada, las cadenas de caracteres pueden ser los nombres de capas o simples opciones de palabras clave.
  • Constante: la herramienta utiliza el valor suministrado para el parámetro cuando creó el resultado. Dado que el valor es constante, el cliente no puede cambiarlo, por lo que no será un parámetro de tarea cuando se publique el servicio.

Tipo de geometría (solo se aplica al conjunto de entidades y a la capa de entidades)

El tipo de geometría proviene de las entidades de entrada y salida que se utilizan para crear el resultado. No se puede modificar en la pestaña Contenido. Es necesario volver a ejecutar la herramienta con entidades del tipo de geometría especificado y compartir el resultado creado por la ejecución.

Esquema (se aplica al conjunto de entidades, capa de entidades, conjunto de registros y vista de tabla)

El esquema es una lista de los campos (atributos) que el cliente debe suministrar cuando se construyen las entidades de entrada a la herramienta. Dicha lista de campos es la misma que la capa o el dataset que se utilizaron como entrada o salida para la herramienta que creó el resultado.

Valor predeterminado

El valor de parámetro que se especifica al ejecutar la herramienta es el que determina el valor predeterminado de la herramienta. Para agregar o modificar el valor predeterminado de un parámetro, ejecute de nuevo la herramienta con el parámetro correspondiente.

El siguiente parámetro solo es aplicable a la salida de tipo de datos de entidades.

ParámetroDescripción

Salida de servicio de entidades

El parámetro de salida opcional que permite a los usuarios guardar la salida como un servicio de entidades al consumir la herramienta web. Este parámetro solo se admite al publicar como herramienta web. No se admite la publicación de un servicio de geoprocesamiento en un servidor independiente.

Configuración de Web Manager

La configuración de las subsecciones a continuación solo se puede modificar en ArcGIS Server Web Manager. Los ajustes de configuración ya mencionados también se pueden modificar en Web Manager después de publicar el servicio.

Nota:

Si se modifica cualquiera de los siguientes ajustes, se reinicia el servicio.

Parámetros

ParámetroDescripción

Clúster

El servicio clúster se ejecutará bajo. Este ajuste solo se puede modificar si ArcGIS Server participa en un clúster.

Directorios

Los directorios utilizados por el servidor para escribir los archivos al ejecutar una herramienta.

Recursos

ParámetroDescripción

WPS

Habilita las capacidades de WPS en servicios de geoprocesamiento y permite que otros clientes se conecten y consuman herramientas mediante protocolos OGC estándar.

Más información sobre los WPS

Agrupación

ParámetroDescripción

Número de instancias

Número mínimo y máximo de instancias del servicio. Los valores predeterminados son 1 (mínimo) y 2 (máximo). Definir un valor mínimo de 0 reduce los recursos del sistema; una instancia se iniciará cuando lo solicite un cliente.

El tiempo máximo que un cliente puede utilizar un servicio

La cantidad máxima de tiempo, en segundos, que un servicio se puede utilizar. Es posible que deba aumentar el valor predeterminado de 600 segundos (10 minutos) para tareas de geoprocesamiento que duren mucho tiempo. Alternativamente, puede ser necesario reducir este tiempo para garantizar que un cliente no abusará de sus servicios.

El tiempo máximo que el cliente debe esperar para obtener un servicio

La cantidad máxima de tiempo, en segundos, que el cliente debe esperar para conectarse a una instancia antes de que caduque. Cuando todas las instancias están ocupadas procesando solicitudes, las solicitudes posteriores están a la cola. Si este tiempo de inactividad se acaba antes de que esté disponible una instancia, la tarea fallará. El valor predeterminado es 60 segundos (1 minuto).

El tiempo máximo que una instancia inactiva se puede mantener en ejecución

La cantidad máxima de tiempo, en segundos, que una instancia seguirá activa antes de que tenga lugar el acortamiento de grupo Todas las instancias que superen el mínimo de instancias que no se hayan utilizado se cerrarán una vez que finalice el valor máximo de tiempo de inactividad.

Procesos

ParámetroDescripción

Reciclaje

Controla la frecuencia y la programación del reciclaje de un servicio. De manera predeterminada, se realiza una vez cada 24 horas a partir de medianoche.

Los servicios de geoprocesamiento solo se ejecutan con un alto grado de aislamiento, a diferencia de otros tipos de servicios que se pueden ejecutar con un aislamiento alto o bajo.