Configuración de la herramienta web

Los ajustes de los parámetros que elija al compartir una herramienta como herramienta web definen cómo los consumen las aplicaciones cliente. 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 pueden modificarse en ArcGIS Server Manager una vez compartida la herramienta. Algunos ajustes avanzados solo pueden configurarse en la API REST del administrador de ArcGIS Server. Son pocas las herramientas web (servicios de geoprocesamiento) cuya configuración avanzada tendrá que modificar en alguna ocasión.

Configuración

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

General

Dispone de los siguientes ajustes de parámetros generales:

Parámetro	Descripción
Nombre	El nombre de la herramienta web que se compartirá con su 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. Estos parámetros se heredan 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 de ArcGIS Enterprise o ArcGIS Server con la que compartirá. Este parámetro solo está habilitado al guardar una definición de servicio sin conexión de una herramienta web o servicio de geoprocesamiento.
Datos	Especifica qué ocurrirá con los datos: Datos sin URL: 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 que los datos utilicen la opción Referencia a datos registrados. Si el data store del servidor no configura los datos, estos 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 una definición de servicio sin conexión, asegúrese de que se pueda hacer referencia a todos los datos del parámetro si elige la opción Datos de referencia, ya que no hay alternativa para copiar los datos si el data store del servidor no define los datos. Datos de URL: controla si los datos se mantienen como una URL o se convierten a otro tipo de datos durante la publicación. Esta opción se proporciona en ArcGIS Pro 3.2 o posterior. Los datos de URL hacen referencia a la URL de tipos diferentes de capas web o servicios. Solo se pueden configurar capas de entidades, servicios de entidades y subcapas de entidades de capas de imágenes web. Cuando se activa la casilla de verificación Convertir capa de entidades, la capa o servicio de entidades del parámetro o datos del proyecto se convierten en una clase de entidad durante la publicación. Si se desactiva, se conservará la URL de la capa de entidades. No hay opción de convertir la URL de las capas de imágenes web, ya que una URL siempre se conservará durante la publicación. Esta opción está activada de forma predeterminada. Más información acerca de cómo copiar, referenciar y utilizar datos de URL
Ubicación	Especifica dónde se creará el elemento de la herramienta web: 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 su portal tiene más de un servidor federado, puede elegir el servidor en el cual 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	Especifica 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

Dispone de los siguientes ajustes de parámetros de configuración:

Parámetro	Descripció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	Especifica 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 configura como Sincrónica, el cliente espera a que finalice la tarea. Normalmente, un servicio sincrónico se ejecuta con rapidez (en unos segundos). Cuando se establece como Asíncrona, el servicio suele tardar más en ejecutarse y el cliente debe comprobar periódicamente el servidor para determinar si el servicio ha finalizado y, en caso afirmativo, 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.
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 otras propiedades de la imagen de mapa son las mismas que las de la capa de salida de la sesión de ArcGIS Pro cuando se 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 operació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 operació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. Establecer este valor en un número elevado significa que el servidor SIG puede manejar el envío de muchos 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 de los parámetros mencionados anteriormente pueden modificarse en ArcGIS Server Manager una vez compartida la herramienta web, a 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 una herramienta web existente, haga clic en el botón 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

Para configurar las propiedades de la herramienta, haga clic en el botón de edición situado junto al nombre de la herramienta.

Propiedad	Descripción
Nombre	El nombre de la herramienta. De forma predeterminada, se basa en los 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.

Las siguientes propiedades pueden configurarse para cada parámetro:

Propiedad	Descripción
Nombre	El nombre y la descripción del parámetro. Ambas propiedades heredan el nombre del parámetro y la descripción 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.
Mantener el tipo de datos como Compuesto	Esta propiedad solo está disponible cuando el parámetro es un tipo de dato compuesto. Especifica si el parámetro se publicará como tipo de dato compuesto (activado). El valor predeterminado no está activado.
Modo de entrada	Especifica cómo introducirán los clientes las entidades en la tarea. Para diseñar y utilizar la GUI, consulte Modo de entrada de un parámetro. Valor definido por el usuario: el cliente proporciona un valor para el parámetro. Lista de opciones: se proporciona una lista de cadenas de caracteres (la lista de opciones) y el cliente debe elegir una o varias de las cadenas 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: se utilizará el valor que proporcionó 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. Modo mixto: definido por el usuario y lista de opciones: solo disponible para los parámetros Compuesto o Tabla de valores. Puede configurar el modo de entrada para cada tipo de datos de compuesto, o cada tipo de datos para cada columna de la tabla de valores. Si algún tipo de datos no admite la lista de opciones, solo estará disponible para la configuración la opción definida por el usuario.
Convertir tipo de datos a cadena de caracteres	Esta propiedad solo se aplica al tipo de datos de unidad de área. Especifica si la unidad de área se convertirá al tipo de datos de cadena de caracteres (activado) o se publicará como unidad de área (desactivado). El valor predeterminado no está activado.
Eliminar valor predeterminado	A partir de ArcGIS Pro 3.3, cuando esté activado, el valor predeterminado utilizado al ejecutar la herramienta se eliminará durante el proceso de publicación. El valor predeterminado no está activado.
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.
Utilizar solo capas predeterminadas	Esta propiedad solo se aplica al modo de entrada de lista de opciones. Especifica si solo las opciones que se utilizan al ejecutar la herramienta se marcarán en la vista de lista bajo esta casilla (activada). El valor predeterminado no está activado.
Tipo de geometría	Esta propiedad se aplica solo a las 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. Debe volver a ejecutar la herramienta utilizando entidades del tipo de geometría especificado y compartir el resultado creado por esa operación.
Esquema	Esta propiedad se aplica solo a entidades y tablas. 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.

Los siguientes parámetros de configuración se aplican a toda la herramienta:

Parámetro	Descripción
Agregar parámetro opcional de servicio de entidades de salida	Un parámetro de salida opcional que especifica si la salida se puede guardar como un servicio de entidades al consumir la herramienta web (activado). Este parámetro solo se admite cuando se publica como herramienta web con modo asíncrono. Por lo demás, no está disponible para su configuración. El valor predeterminado está activado.
Eliminar todos los valores predeterminados	A partir de ArcGIS Pro 3.3, cuando esté activado, se eliminarán todos los valores predeterminados utilizados al ejecutar la herramienta, y se activará automáticamente la casilla de verificación Eliminar valor predeterminado en la configuración de parámetros de la herramienta que se mostró anteriormente. El valor predeterminado no está activado

Ajustes de ArcGIS Server Manager

Los ajustes de los parámetros de las subsecciones siguientes solo pueden modificarse en ArcGIS Server Manager. Los ajustes de configuración ya mencionados también se pueden modificar en ArcGIS Server Manager después de publicar el servicio.

Nota:

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

Parámetros

Dispone de los siguientes ajustes de parámetros:

Parámetro	Descripció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 archivos al ejecutar la herramienta.

Capacidades

Dispone de los siguientes ajustes de parámetros de funcionalidad:

Parámetro	Descripció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

Dispone de los siguientes ajustes de parámetros de agrupación:

Parámetro	Descripció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. Como alternativa, puede reducir este tiempo para garantizar que un cliente no se aproveche de los 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

Dispone de los siguientes ajustes de parámetros de procesos:

Parámetro	Descripción
Reciclaje	Controla con qué frecuencia y cuándo se recicla 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.