Una herramienta de script es una herramienta de geoprocesamiento que ejecuta un script o un tipo de archivo que se puede ejecutar. Las herramientas de script ejecutan estos scripts mediante una herramienta de geoprocesamiento como interfaz para el script. Cuando crea una herramienta de script, tiene que especificar los parámetros que necesita el script para ejecutarlo. Los parámetros más comunes son datasets de entrada y salida, nombres de campo y cadenas elegidas de una lista. Cuando se ejecuta la herramienta de script, los valores de los parámetros pasan al script y este los utiliza.
Numerosas herramientas de script ejecutan un script de Python (.py) que utiliza ArcPy, un paquete de sitio de Python que se instala con ArcGIS. ArcPy proporciona acceso a las herramientas de geoprocesamiento así como a las funciones adicionales, las clases y los módulos que le permiten crear flujos de trabajo simples o complejos. A través de ArcPy, un script puede acceder al entorno de geoprocesamiento de ArcGIS; de ese modo, ofrece ventajas como la proyección al vuelo, la admisión de un conjunto de selección, la validación de entradas, el envío de mensajes de error y el registro del historial.
Las herramientas de script también pueden ejecutar un script R (.r) que utilice la biblioteca arcgisbinding R.
Más información sobre el R-ArcGIS Bridge
Las herramientas de secuencias de comandos se crean en una caja de herramientas. Para crear una herramienta de script, haga clic con el botón derecho en una caja de herramientas del panel Catálogo y seleccione Nuevo > Script.
Propiedades
Al crear una herramienta de script, aparece el cuadro de diálogo de propiedades de esa herramienta de script con las siguientes pestañas laterales:
- General
- Parámetros
- Ejecución
- Validación
- Entornos
Pestaña General
La pestaña General incluye las propiedades siguientes:
- Nombre: nombre identificativo unívoco de la herramienta.
- Etiqueta: nombre de la herramienta que se muestra en la caja de herramientas y cuando la herramienta está abierta en el cuadro de diálogo de herramientas.
- Descripción: la breve descripción de la herramienta que se muestra al situar el puntero sobre ella.
- Resumen: la descripción de la herramienta que aparece al situar el puntero sobre el icono de ayuda en el cuadro de diálogo para abrir la herramienta.
- Ilustración: una imagen que aparece con el resumen de la herramienta al situar el puntero sobre el icono de ayuda en el cuadro de diálogo para abrir la herramienta.
- Atributos:
- Mostrar banner de que la herramienta modifica los datos de entrada: active esta opción para mostrar un banner en la parte superior del cuadro de diálogo de la herramienta para indicar que la herramienta modifica los datos de entrada.
- No agregar las salidas de herramienta al mapa: active esta opción para agregar el dataset de salida de la herramienta automáticamente a un mapa abierto.
Nota:
El atributo de propiedad de la herramienta seguirá respetándose aun cuando la opción de geoprocesamiento Agregar datasets de salida a un mapa abierto también esté seleccionada.
- Mostrar botón de alternancia Habilitar Deshacer: active esta opción para mostrar el botón de alternancia Habilitar Deshacer junto al botón Ejecutar del cuadro de diálogo de la herramienta.
- Mostrar banner de que la herramienta consume créditos de ArcGIS: active esta opción para mostrar un banner en la parte superior del cuadro de diálogo de la herramienta si la herramienta consume créditos.
- Icono: una pequeña imagen que aparece cuando la herramienta se agrega a la cinta, a la barra de herramientas de acceso rápido o a la galería Análisis.
Puede cambiar las propiedades especificando valores en el cuadro de texto o haciendo clic en el icono para buscar un nuevo archivo de imagen que usar como ilustración o icono.
Nota:
Si la caja de herramientas es una caja de herramientas heredada (.tbx), también existe una propiedad para almacenar la ruta del script de origen de la herramienta en relación con el archivo de caja de herramientas. Si la caja de herramientas es una caja de herramientas de ArcGIS (.atbx), este comportamiento se administra de forma diferente. Si el script se encuentra en el mismo directorio que el archivo .atbx o se encuentra en una carpeta secundaria desde donde se almacena .atbx, se mantiene una ruta relativa. Si el script y el archivo .atbx son completamente independientes, se mantiene una ruta absoluta.
Nota:
Si se trata de una caja de herramientas heredada (.tbx), no se admiten las propiedades Resumen, Ilustración, Icono y Atributos.
Pestaña Parámetros
La pestaña Parámetros contiene una tabla de las propiedades de parámetro, en la que cada fila corresponde a un parámetro. La tabla estará vacía de forma predeterminada. Para cada parámetro, defina una serie de propiedades, como la etiqueta que se muestra en el panel Geoprocesamiento, el tipo de datos que acepta el parámetro y si el parámetro es opcional u obligatorio. Debe establecer como mínimo las propiedades Etiqueta, Nombre, Tipo de datos, Tipo y Dirección del atributo.
| Propiedad | Descripción |
|---|---|
Etiqueta | El nombre del parámetro se muestra en la herramienta. |
Nombre | Nombre del parámetro cuando se llama a la herramienta de script como una función desde un script de Python diferente. |
Tipo de datos | Especifica el tipo de datos que acepta el parámetro. Esto determina el control que se usa en la herramienta. Por ejemplo, si selecciona Capa de entidades, puede seleccionar una capa en un mapa activo o ir a una clase de entidad. |
Tipo | Los parámetros pueden ser obligatorios u opcionales. Si el parámetro es obligatorio, debe tener un valor o la herramienta no se podrá ejecutar. Si el parámetro es opcional, la herramienta se puede ejecutar sin especificar un valor. |
Dirección | Los parámetros pueden ser de entrada o de salida. Los parámetros de entrada representan los datos existentes que se deben procesar o los valores que se deben usar en el procesamiento. Los parámetros de salida representan los datos que la herramienta crea o los valores calculados. |
Descripción | Ayuda para cada parámetro de la herramienta, que incluye instrucciones, información y tipos de datos o valores aceptables. Las descripciones de los parámetros aparecen en el cuadro de diálogo de la herramienta cuando se pasa el ratón por encima del botón Información |
Categoría | Al especificar el nombre de una categoría, el parámetro se incluye en un grupo desplegable en el cuadro de diálogo de la herramienta. |
Filtro | Los filtros permiten especificar determinados tipos de un dataset, archivo o campo, valores específicos o valores de un rango son entradas aceptables para una herramienta. Por ejemplo, puede filtrar un parámetro de clase de entidad de forma que solo las clases de entidades de puntos sean aceptables o puede filtrar un parámetro numérico para que solo sean aceptables los valores comprendidos entre 1 y 10. |
Dependencia | Puede hacer que un parámetro dependa de otro parámetro. Por ejemplo, un parámetro de campo depende de un parámetro de dataset. Al definir esta dependencia, se hace de forma que se puede seleccionar un campo del dataset dependiente. |
Predeterminado | Valor que se define automáticamente para el parámetro cuando aparece el cuadro de diálogo de la herramienta. |
Entorno | Un parámetro puede derivar su valor predeterminado de un entorno de geoprocesamiento. Si se ha definido un entorno de geoprocesamiento especificado, el valor se utilizará como valor predeterminado para el parámetro proporcionado cuando aparece el cuadro de diálogo de la herramienta. |
Simbología | Ruta de un archivo de capa que define la simbología del parámetro. Por ejemplo, puede hacer que un parámetro del dataset de salida tenga la misma simbología del archivo de capa cuando la salida se cree y se agregue al mapa. |
situado junto a la etiqueta del parámetro.Pestaña Ejecución
La pestaña Ejecución incluye propiedades relacionadas con el código de origen de la herramienta de script, o la ruta a un archivo de script Python o R. La pestaña también incluye opciones para integrar y proteger con contraseña el código fuente de la herramienta de script, o exportar el código fuente a un nuevo archivo.
Puede integrar el código fuente dentro de la caja de herramientas o enlazarlo a un archivo de script externo. Independientemente de la ubicación del código fuente, la pestaña incluye un editor de código que puede utilizar para modificar el código; también puede hacer clic en el botón Abrir en editor de scripts para abrir el código en un editor de scripts. Puede especificar su editor de scripts preferido en las opciones de geoprocesamiento.
Pestaña Validación
La pestaña Validación muestra el código de validación de la herramienta de script. La validación permite personalizar el modo en que los parámetros de la herramienta responden e interactúan con los valores y otros parámetros de la herramienta de script. El código de validación está escrito en Python.
El bloque de código ToolValidator de Python proporciona un control del aspecto, los comportamientos y los mensajes de la herramienta de script. Puede editar el código de validación directamente en un editor de código o hacer clic en el botón Abrir en Editor de script para abrir el código de validación en el editor de script preferido, que se puede establecer e el cuadro de diálogo de opciones de geoprocesamiento.
Pestaña Entornos
La pestaña Entornos muestra las listas Entornos admitidos y Entornos no admitidos. Puede agregar o eliminar entornos entre estas listas. Solo los entornos de la lista Entornos no admitidos se mostrarán en la pestaña Entornos del cuadro de diálogo de la herramienta de script.