Un recorrido rápido por el procedimiento para crear y compartir herramientas web

Crear una herramienta web implica dos procesos: crear y compartir. El proceso de creación comienza con la creación de un modelo o una herramienta de scripts de Python en ArcGIS Pro. Una vez que haya creado y ejecutado correctamente la herramienta, puede compartirla con un portal de ArcGIS Enterprise como herramienta web. Algunos datos, parámetros de herramienta y permisos de uso compartido se deben tener en cuenta al crear y compartir. Algunas de estas consideraciones se describen en el siguiente ejemplo y en las secciones correspondientes de este tema. El siguiente flujo de trabajo describe el proceso general:

  1. Cree un script o un modelo usando las herramientas de la caja de herramientas para crear el flujo de trabajo.
  2. Reúna los datasets necesarios para la herramienta y haga que estén disponibles en una geodatabase o agréguelos al mapa en el proyecto.
  3. Ejecute la herramienta para crear una entrada correcta en el historial de geoprocesamiento.
  4. Defina la simbología de los datasets de salida en el mapa si es necesario.
  5. Comparta el elemento del historial como una herramienta web. Cuando comparta la herramienta web, podrá definir las propiedades de la herramienta para la herramienta y el servicio.

Ejemplo: examine el impacto que una canalización propuesta tendrá en la población

La siguiente herramienta de modelo es un conjunto de herramientas que examinan cuántas personas podrían verse afectadas por una fuga en una canalización. Este flujo de trabajo busca puntos de intersección entre la canalización y el río y realiza un trazado aguas abajo para determinar cuántas personas podrían verse afectadas. Este modelo se ha configurado con los datos y los parámetros del proyecto y se ha publicado como una herramienta web en la que un analista o el público general puede cambiar la ruta propuesta para la canalización con el fin de ver cómo podría afectar a la población aguas abajo. Loa resultados de la herramienta web muestran el punto en el que la canalización atraviesa el río y el resumen de la población afectada.

Modelo para realizar un análisis de la población afectada para una canalización

Diseño de la herramienta

Todas las herramientas útiles tienen parámetros de entrada y salida. Estos parámetros permiten a los usuarios suministrar valores diferentes cada vez que se ejecuta la herramienta y, por su parte, la herramienta generará diferentes análisis. Además de los parámetros de entrada y salida, las herramientas tienen generalmente datos del proyecto y datos intermedios. Son datasets sobre los que la persona que ejecuta la herramienta no suele tener control. En un modelo, los parámetros de entrada están marcados con una P. Cuando el modelo se ejecuta como herramienta, cualquier entrada con una P está disponible en el cuadro de diálogo de la herramienta para definir un valor que se debe usar al ejecutarla. Partiendo del modelo de la canalización, el usuario puede especificar la ruta de la canalización y una distancia de zona de influencia al realizar el trazado aguas abajo. Cuando alguien usa esta herramienta, la ubicación de la canalización y el tamaño de la zona de influencia cambian para mostrar el número de personas que se verán afectadas por la canalización. Las intersecciones de la canalización y la línea del trazado en este ejemplo son datasets intermedios que la herramienta de modelo produce durante la ejecución. Estos datasets intermedios no son necesarios para la persona que ejecuta la herramienta y no se devuelven como resultado. Cuando se comparte este modelo, el servicio de geoprocesamiento subyacente en el que se basa la herramienta web define dónde se deben escribir los datos intermedios y los borra cuando dejan de ser necesarios.

Parámetros de entrada de la herramienta de modelo

Al igual que los parámetros de entrada son importantes para todas las herramientas que funcionan correctamente, los parámetros de salida son igual de importantes. El parámetro de salida permite que la herramienta devuelva un resultado a la persona que la ejecuta. En ArcGIS Pro, los parámetros de salida son importantes porque estos datasets se agregan automáticamente al mapa. Una herramienta sin un parámetro de salida generaría una salida, pero no mostraría automáticamente esta información. Las herramientas web funcionan de una forma muy similar: se necesitan uno o varios parámetros de salida para devolver el resultado al usuario final. En el modelo de canalización existen dos parámetros de salida: la población de las áreas de impacto que muestra las ubicaciones de las zonas de influencia aguas abajo y la tabla de resumen de la población con el resumen de toda la población afectada. Como puede ver, la población de las áreas de impacto es a la vez un dato intermedio y de salida. Este parámetro es intermedio porque es necesario para la herramienta Resumen de estadísticas, pero se ha definido como un parámetro de modelo (P), con lo que este resultado se devolverá al cliente cuando la herramienta termine de ejecutarse.

Parámetros de salida de la herramienta de modelo
Sugerencia:

Los mismos principios de los parámetros de entrada y salida de la herramienta, datos del proyecto y datos intermedios son válidos para la creación de herramientas de script Secuencia de comandos.

Documentar la herramienta

Proporcionar una buena documentación para su herramienta web es esencial si desea que la herramienta sea encontrada, entendida y utilizada por una audiencia amplia. Una buena documentación comienza con la herramienta original. Puede suministrar a la herramienta de modelo o de script el mismo tipo de metadatos que a una herramienta del sistema.

Más información sobre la documentación de herramientas

Ejecutar la herramienta

Una vez que se ha creado la herramienta, se tiene que ejecutar correctamente. Al ejecutar la herramienta, se crea una entrada en el Historial de geoprocesamiento. Una herramienta cuya ejecución ha generado errores no se puede compartir.

Nota:

Al ejecutar un modelo en ModelBuilder no se crea una entrada en el Historial de geoprocesamiento. Las herramientas de modelo se deben ejecutar como una herramienta en el panel Geoprocesamiento.

Compartir una herramienta web

La herramientas web pueden compartirse eligiendo Análisis > Historial para abrir el panel Historial. Para compartir, haga clic con el botón derecho en un elemento que se quiere compartir y seleccione Compartir como. Para compartir como una nueva herramienta web, seleccione Compartir herramienta web para abrir el panel Compartir como herramienta web. Para sobrescribir una herramienta existente, seleccione Sobrescribir herramienta web para abrir un panel con todas las herramientas web existentes publicadas en Mi contenido.

Panel de selección Sobrescribir herramienta web

Asegúrese de seleccionar la herramienta correcta que se va a sobrescribir y haga clic en Aceptar para abrir el panel Sobrescribir herramienta web. Los procesos de configuraciones de herramientas web publicadas son los mismos para Compartir herramienta web y Sobrescribir herramienta web, como se muestra a continuación.

También puede ir a Compartir > Herramienta web para elegir Compartir herramienta web o Sobrescribir herramienta web. Si elije la opción Compartir herramienta web, seleccione un elemento de un panel de uso compartido de la herramienta con todos los elementos funcionando satisfactoriamente.

Panel Seleccionar herramienta para compartir

Si elige la opción Sobrescribir herramienta web, seleccione un elemento que se quiere sobrescribir del panel con todas las herramientas web existentes que publicó en Mi contenido. A continuación, seleccione un elemento del panel con todos los elementos funcionando satisfactoriamente con los que sobrescribir. Los pasos para sobrescribir en este flujo de trabajo se invierten al elegir de Análisis > Historial.

Definir las propiedades de la herramienta web

La herramienta de evaluación de la fuga genera entidades y una tabla. La cantidad de datos que esta herramienta genera y devuelve tiene un tamaño limitado, por lo que la herramienta web se configurará como un servicio asíncrono sin un servicio de mapas de resultado. Un ajuste predeterminado de 1000 registros como máximo será suficiente. Un nivel de mensaje de error garantizará que solo se devuelven los mensajes relativos a un posible error de la herramienta. Si la ejecución de la herramienta web se completa correctamente, los mensajes de procesamiento normales no se devolverán al usuario final.

Opciones de configuración de la herramienta web

Una herramienta web siempre está disponible en Mi contenido. Puede compartir la herramienta con su organización, con todos o con grupos seleccionados. La herramienta de evaluación de la fuga es una buena herramienta para compartirla con los usuarios de la organización que deben realizar el análisis de la canalización. Seleccionar los grupos adecuados permitirá a esos usuarios buscar y usar rápidamente la herramienta.

Opciones de uso compartido de la herramienta web

Copiar o referenciar datos

Todas las herramientas web toman los datos como entrada o usan datos del proyecto. Cuando se comparta el modelo de evaluación de la fuga como herramienta web, aceptará datos de un usuario y los procesará con respecto a los datos del proyecto referenciados en el modelo. En este punto del proceso para compartir la herramienta, debe decidir si desea copiar los datos en el servidor, crear una copia estática de los datos que usará el servicio o crear una referencia a la que pueda acceder el servicio. En este flujo de trabajo concreto, los datos del proyecto incluyen datasets del río y de población que son estáticos; es decir, estos datasets se actualizan con poca frecuencia. En este caso en concreto, tiene sentido copiar los datos en el servidor. Este proceso recopila y convierte los datos (si es necesario) en clases de entidad de geodatabase de archivos en las que se extraerán en el servidor para que los use el servicio.

Valore si el método de análisis se ha modificado ligeramente cuando el usuario no ha propuesto su propia canalización. Las propuestas de canalización alternativas se proporcionaron mediante otro proceso y el usuario suministró unas entradas diferentes a la herramienta. En este caso, la canalización propuesta se convierte en los datos del proyecto. En consecuencia, sería recomendable insertar este dataset en una geodatabase corporativa y hacer que la herramienta haga referencia a ella. Al publicar, definirá una referencia a los datos usando el data store de ArcGIS Server. El proceso de publicación mantendrá una referencia a la base de datos en lugar de crear una copia estática. En un momento posterior, un analista del proyecto podrá actualizar los datos de la geodatabase corporativa, y la herramienta web realizará un análisis de la propuesta de canalización más reciente.

Opciones de datos de la herramienta web

Analizar

El proceso AnalizarAnalizar del procedimiento para compartir una herramienta web garantiza que la herramienta se pueda publicar correctamente en el portal. Además, pueden aparecer mensajes de advertencia sobre los datos y puede llevar a cabo alguna acción si lo considera necesario. La herramienta de evaluación de la fuga ya tiene el data store configurado y la herramienta documentada, y usa herramientas compatibles que funcionan en una herramienta web, de modo que no aparecerán ni advertencias ni mensajes.

Publicar

Una vez que las propiedades de la herramienta web se hayan configurado y que haya resuelto los errores del analizador, publique la herramienta web en el portal. Dependiendo del volumen de datos que se tenga que consolidar y enviar al servidor, este proceso podría tardar unos minutos.

Usar la herramienta web

Puede encontrar y abrir las herramientas web desde la sección Portal del panel Catálogo. Además de ejecutar la herramienta en ArcGIS Pro, el servicio de geoprocesamiento Servicio de geoprocesamiento en el que se basa se puede usar en un script de Python o en una aplicación web.

Más información sobre la búsqueda y el uso de herramientas web en ArcGIS Pro