Publicar un notebook como una herramienta web

ArcGIS Notebooks le permite publicar notebooks como herramientas web. Los administradores y autores de notebooks con el privilegio Publicar herramientas web pueden publicar notebooks de su propiedad como herramientas web. Cuando un notebook se publica como herramienta web, se crea un servicio de geoprocesamiento asíncrono en ArcGIS Notebook Server y se registra como herramienta web. Existe una relación de uno a uno entre el notebook y la herramienta web, lo que significa que solo es posible publicar una herramienta web por notebook. Las herramientas web pueden ser utilizadas por cualquier aplicación cliente que funcione con servicios de geoprocesamiento asíncronos RESTful.

La publicación de un notebook como herramienta web es compatible con notebooks con la versión 6.0 o posterior del tiempo de ejecución. Para comprobar la información de tiempo de ejecución de un notebook, haga clic en el botón Información de la cinta superior del editor del notebook o en la pestaña Configuración de la página Elemento de notebook. Consulte Ver bibliotecas disponibles de Python para obtener más información sobre los tiempos de ejecución de los notebooks.

El editor de notebooks le permite configurar parámetros de entrada y salida para un notebook. Los parámetros de entrada corresponden a las variables de entrada de un notebook que desea externalizar para la entrada del usuario cuando se ejecuta el notebook como herramienta web. Los parámetros de salida representan las variables de salida de un notebook que desea devolver como salidas de herramientas web. Cuando registra una o varias variables de entrada o salida y publica un notebook, los parámetros pasan a estar disponibles como parámetros de entrada o salida de la herramienta web correspondiente.

Nota:

No es necesario definir parámetros de entrada o salida al publicar un notebook como herramienta web. Por ejemplo, es posible que los notebooks que realizan tareas con entradas y salidas predefinidas, como las capas de entidades a las que hace referencia itemId, no requieran parámetros de entrada ni de salida.

Nota:

Los siguientes tipos de datos se admiten como parámetros de entrada o de salida: Cadena de caracteres, Largo, Doble, Booleano, Conjunto de entidades, Conjunto de registros, Fecha, Unidad lineal, Capa de datos ráster y Archivo. Para obtener más información, consulte Tipos de datos de servicios de geoprocesamiento en la documentación de API REST de ArcGIS.

Cuando se ejecuta una herramienta web, ArcGIS Notebook Server realiza una ejecución automática del notebook en el equipo del servidor del notebook abriendo un nuevo contenedor y ejecutando el notebook sin ninguna interacción del usuario. Los usuarios con el privilegio de ejecutar herramientas web y con los que se ha compartido la herramienta web pueden acceder a la herramienta web y ejecutarla. Además del privilegio de ejecutar herramientas web, se requiere cualquier otro privilegio necesario para la ejecución del notebook. Consulte el tema Tipos de usuarios, roles y privilegios para obtener más información sobre los privilegios.

Nota:

Al crear un notebook para compartirlo como herramienta web, si el notebook hace referencia a un archivo del directorio de su espacio de trabajo como datos de entrada, dichos archivos no estarán disponibles para otros usuarios con los que se comparta el notebook o la herramienta web. Si tiene archivos a los que es necesario hacer referencia como datos de entrada en el notebook, puede hacer referencia al archivo a través de un elemento compartido en su contenido de ArcGIS o cargar y hacer referencia al archivo desde un directorio de datos personalizado registrado con ArcGIS Notebook Server.

De forma predeterminada, ArcGIS Notebook Server está configurado para ejecutar un máximo de 10 notebooks concurrentes y no interactivos por cada equipo de ArcGIS Notebook Server. Incluye las ejecuciones desencadenadas por herramientas web, tareas programadas, la API de executeNotebook y desencadenadores webhook. Los administradores pueden aumentar este límite, en caso necesario.

Nota:

Si no ve las opciones Parámetros o Publicar en el editor de notebooks, significa que no tiene el privilegio Publicar herramientas web o no es el propietario del notebook. Si se encuentra en un notebook recién creado, las opciones Parámetros y Publicar no se muestran hasta que se guarde el notebook.

Configurar parámetros de entrada

Los parámetros de entrada representan variables de entrada de un notebook que se han externalizado cuando se ejecuta un notebook como herramienta web. Con el panel Parámetros del editor del notebook, puede configurar y agregar parámetros de entrada como variables a su notebook.

1. En el editor de notebooks, haga clic en Parámetros.
2. Haga clic en Agregar.
3. Seleccione la entrada para Dirección.
4. Introduzca un nombre para Nombre de variable.

   Nota:

   Debe coincidir con un nombre de variable que esté en el código del notebook o que ya esté configurado en el notebook.

5. Introduzca un nombre para Nombre de visualización para el parámetro de la herramienta web.
6. Desde el menú desplegable Tipo de datos, seleccione un tipo de datos para el parámetro de entrada.
7. Introduzca un valor para Valor predeterminado para el parámetro de entrada. Consulte Tipos de datos de servicios de geoprocesamiento para conocer la sintaxis de los valores predeterminados para los tipos de datos compatibles.
8. Para Descripción, introduzca una descripción para el parámetro de entrada.
9. Haga clic en Guardar para guardar el parámetro de entrada.
10. Para agregar más parámetros de entrada, repita los pasos del 1 al 9.
11. Después de agregar todos los parámetros de entrada, seleccione una celda de su notebook para insertar los parámetros y haga clic en Insertar como variables.
12. Haga clic en Guardar para guardar el notebook.

Configurar parámetros de salida

Puede configurar la salida de un notebook publicado como herramienta web configurando parámetros de salida desde el panel Parámetros del editor de notebooks.

1. En el editor de notebooks, haga clic en Parámetros.
2. Haga clic en Agregar.
3. Seleccione la salida para el parámetro Dirección.
4. Introduzca un nombre para Nombre de variable.

   Nota:

   Debe coincidir con un nombre de variable que esté en el código del notebook o que ya esté configurado en el notebook.

5. Introduzca un nombre para Nombre de visualización para el parámetro de la herramienta web.
6. Desde el menú desplegable Tipo de datos, seleccione un tipo de datos para el parámetro de salida.
7. Introduzca un valor para Valor predeterminado para el parámetro de salida. Consulte Tipos de datos de servicios de geoprocesamiento para conocer la sintaxis de los valores predeterminados para los tipos de datos compatibles.
8. Para Descripción, escriba una descripción para el parámetro de salida.
9. Haga clic en Aceptar para guardar el parámetro de salida.
10. Seleccione una celda de su notebook. Haga clic en el botón Agregar para agregar el fragmento de código de Python para escribir la salida de la herramienta web.

    Se recomienda seleccionar una celda cerca de la parte inferior del notebook, debajo de las celdas donde se crean las salidas.

11. Inspeccione el fragmento de código agregado para asegurarse de que los nombres de variables de salida coincidan con la salida definida en el notebook y realice los ajustes adicionales que considere necesarios en el fragmento de código.
12. Repita los pasos del 1 al 11 para cualquier parámetro de salida adicional.
13. Haga clic en Guardar para guardar el notebook.

Publicar una herramienta web

Puede publicar un notebook como una herramienta web desde el panel Publicar del editor de notebooks.

1. Guarde su notebook para asegurarse de que se publica la copia más reciente del notebook.
2. Ejecute manualmente las celdas del notebook de forma interactiva para garantizar que no existan errores.

Nota:

Omita las celdas que contienen los fragmentos de código para los parámetros de salida, ya que no se ejecutan en modo interactivo.
3. Haga clic en Publicar en la cinta del editor del notebook.
4. Introduzca un título y una descripción para la herramienta web en los campos Título y Descripción en el panel Publicar.
5. Verifique todos los parámetros de entrada y salida.
6. Haga clic en Publicar para publicar el notebook como una herramienta web.
7. Una vez que la herramienta web se haya publicado correctamente, haga clic en Ver detalles para ver la página de detalles del elemento de la herramienta web.
8. Haga clic en Compartir para abrir la ventana Compartir.
   1. Seleccione Organización para compartir la herramienta web con todos los usuarios de su organización.
   2. Haga clic en Editar uso compartido de grupo para compartir la herramienta web con grupos específicos.
   3. Seleccione los grupos con los que desea compartir.
   4. Haga clic en Aceptar.
   5. Haga clic en Guardar.

Compartir una herramienta web

Para compartir o actualizar la configuración de uso compartido de una herramienta web de notebook existente con su organización o grupos específicos de su organización, siga los pasos siguientes.

Nota:

Los usuarios con los que se comparte la herramienta web deben tener el privilegio Ejecutar herramientas web y cualquier privilegio adicional necesario para ejecutar el notebook para poder ejecutar la herramienta web compartida.

Nota:

Introducido en la versión 11.2, ahora puede compartir una herramienta web de notebook en un nivel diferente al nivel en el que se publicó el notebook. Por ejemplo, una herramienta web de notebook se puede compartir con la organización incluso cuando el notebook en sí no se ha compartido con la organización. Para garantizar que una herramienta web publicada en una versión anterior pueda utilizar este cambio, sobrescriba la herramienta web.

1. Compruebe que ha iniciado sesión en Portal for ArcGIS y que tiene los privilegios suficientes para compartir contenido con su organización.
2. Haga clic en Contenido.
3. Haga clic en la casilla situada al lado del título de la herramienta web que desee compartir.
4. Haga clic en Compartir.
   1. Seleccione Organización para compartir la herramienta web con todos los usuarios de su organización.
   2. Haga clic en Editar uso compartido de grupo para compartir la herramienta web con grupos específicos.
   3. Seleccione los grupos con los que desea compartir.
   4. Haga clic en Aceptar.
   5. Haga clic en Guardar.

Sobrescribir una herramienta web

Al sobrescribir una herramienta web se actualizará una herramienta web para usar la última instantánea de ese notebook. Puede sobrescribir una herramienta web de un notebook en el panel Publicar del editor de notebooks.

1. Si es necesario actualizar un parámetro de entrada o salida existente, siga los pasos de la sección Editar un parámetro de entrada o salida existente de este tema.
2. Si va a agregar nuevos parámetros de entrada o de salida, siga los pasos de las secciones Configurar parámetros de entrada o Configurar parámetros de salida de este tema.
3. Haga clic en Guardar para asegurarse de que se publica la última copia del notebook.
4. Ejecute manualmente cada celda del notebook para asegurarse de que no existan errores.

   Nota:

   No ejecute las celdas que contienen los fragmentos de código para los parámetros de salida, ya que no se ejecutarán en modo interactivo.

5. Haga clic en Publicar.
6. Haga clic en Sobrescribir para sobrescribir la herramienta web.

Eliminar una herramienta web

Puede eliminar una herramienta web publicada desde un notebook eliminando el elemento de la herramienta web.

1. En la cinta superior del editor de notebooks, haga clic en Publicar.
2. Haga clic en Ver detalles para ver la página de detalles del elemento de la herramienta web.
3. Haga clic en Configuración.
4. Haga clic en Eliminar elemento y confirme que desea eliminar el elemento de la herramienta web y el servicio de geoprocesamiento publicado en ArcGIS Notebook Server.

Nota:

Si se elimina el elemento del notebook desde el que se publica la herramienta web, también se eliminará el elemento de la herramienta web.

Editar un parámetro de entrada o salida existente

Puede realizar cambios en un parámetro de entrada o de salida existente desde el panel Parámetros del editor de notebooks.

Nota:

Si un notebook ya se ha publicado como herramienta web, debe activar el botón de alternancia Habilitar edición en el panel Parámetros antes de realizar cambios en sus parámetros. Tenga cuidado a la hora de realizar cambios en sus parámetros una vez publicado el notebook como herramienta web, ya que estos cambios podrían dañar cualquier aplicación web que utilice la herramienta web.

1. En la cinta superior del editor de notebooks, haga clic en Parámetros.
2. Haga clic en el botón de opciones situado junto al parámetro y haga clic en Editar.
3. Actualice el parámetro y haga clic en Guardar.
   1. Si se actualizó un parámetro de entrada, borre o elimine manualmente la celda existente con las variables de entrada y repita el paso para insertar los parámetros de entrada como variables en el notebook.
   2. Si se actualizó un parámetro de salida, borre manualmente el fragmento de código correspondiente a la variable de salida y repita los pasos para agregar el fragmento de código para el parámetro de salida al notebook.
4. Haga clic en Guardar para guardar el notebook.

Eliminar un parámetro de entrada o salida existente

Puede eliminar parámetros de entrada o salida existentes desde el panel Parámetros.

1. En la cinta superior del editor de notebooks, haga clic en Parámetros.
2. Haga clic en el botón de opciones situado junto al parámetro y haga clic en Eliminar.
3. Haga clic en Eliminar para eliminar permanentemente el parámetro.
4. Borre o elimine manualmente la variable de entrada o el fragmento de código de salida del notebook.
5. Haga clic en Guardar para guardar el notebook.

Usar la extensión de mapa

Cuando ejecuta una herramienta web en Visor de mapas, si se modifican la extensión de procesamiento y el sistema de coordenadas de salida, estos se pasarán al notebook como una variable Python denominada context, junto con otros parámetros de entrada, como se ve a continuación.

context = {
    "extent": {
        "ymin": 1759249.9654418486,
        "xmin": 6481923.176042713,
        "ymax": 1795442.256243616,
        "xmax": 6531137.243576055,
        "spatialReference": {"latestWkid": 2229, "wkid": 102645},
    },
    "outSR": {"latestWkid": 4269},
}

Puede utilizar el valor de la variable context para establecer la extensión y el sistema de coordenadas de salida de los flujos de trabajo de análisis espacial en su notebook. Para probar sus flujos de trabajo de análisis espacial antes de publicar el notebook como herramienta web, declare la variable context con un valor predeterminado.

Cuando esté listo para publicar, inserte los parámetros de entrada como variables después de la celda donde declare la variable context.

Solución de problemas de la ejecución de una herramienta web

Después de publicar un notebook como herramienta web, puede validar si la herramienta web se ejecuta correctamente ejecutando la tarea desde el directorio de servicios ArcGIS Notebook Server.

1. En un navegador web, abra el directorio de servicios https://notebookserver.domain.com/webadaptorcontext/rest/services de ArcGIS Notebook Server.
2. Inicie sesión como el propietario de la herramienta web.
3. Identifique el servicio y vaya a la página de tareas.
4. Haga clic en Enviar trabajo.
5. Introduzca cualquier parámetro de entrada y haga clic en Enviar trabajo.
6. De manera opcional, haga clic en el vínculo Volver a comprobar los detalles del trabajo para verificar el estado del trabajo.

   Si la herramienta web se completa correctamente, se proporcionan vínculos a las salidas. De forma predeterminada, se proporciona una vista previa HTML de la ejecución del notebook como salida, tanto para ejecuciones exitosas como fallidas.

7. Descargue y visualice la vista previa HTML del notebook para verificar si se ha producido algún problema con la ejecución de la herramienta web.
8. Si la herramienta web falla, confirme que el notebook se ejecuta correctamente en el editor de notebooks.