Conceptos básicos de XLSForm

XLSForm es un estándar abierto que simplifica la creación de formularios. La creación se realiza en un formato legible por el hombre utilizando una hoja de cálculo. Para obtener más información sobre XLSForm, visite https://xlsform.org/. Survey123 admite la mayoría (pero no todas) de las características del estándar XLSForm.

Existen numerosas opciones para crear hojas de cálculo compatibles con XLSForm. Microsoft Excel es la más común, pero hay otras opciones, como Kingsoft Spreadsheets, Google Sheets u OpenOffice Calc. También hay builders de XForms en línea que exportan hojas de cálculo XLSForm que se pueden usar con ArcGIS Survey123.

Para ayudarle a crear los formularios, ArcGIS Survey123 incluye la herramienta de escritorio Survey123 Connect, que funciona en paralelo con la herramienta de creación de XLSForm para crear archivos XLS. Survey123 Connect le permite obtener una vista previa de sus archivos XLSForm durante su creación o edición, publicar los formularios en ArcGIS Online y ArcGIS Enterprise, y crear capas de entidades en función de la especificación del formulario para la captura de datos. ArcGIS Survey123 Connect está disponible para Windows, macOS y Ubuntu.

Una vez que los formularios se han publicado en ArcGIS, puede usar el sitio web de Survey123 para compartir los formularios con los miembros de sus organizaciones de ArcGIS. También puede analizar los mapas y las tablas para los datos capturados a través de la aplicación de campo Survey123, además de exportar los resultados de la encuesta. Si no se ha familiarizado con el flujo de trabajo entre Survey123 Connect y el sitio web, consulte los tutoriales en vídeo de Survey123.

Para los fines de este tema, supondremos que va a usar ArcGIS Survey123 Connect y Microsoft Excel para crear sus formularios.

Normalmente, cada libro de trabajo de Excel tiene dos hojas de cálculo: survey y choices. Más adelante, se describe también una tercera hoja de cálculo denominada settings. Las hojas de cálculo tienen un conjunto de columnas obligatorias que deben estar presentes para que el formulario funcione. Además, cada hoja de cálculo tiene un conjunto de columnas opcionales que ofrecen un mayor control sobre el comportamiento de cada entrada en el formulario. Todas las entradas deben tener valores en las columnas obligatorias, pero las columnas opcionales se pueden dejar en blanco. Las columnas que se agregan al libro de trabajo de Excel, ya sean obligatorias u opcionales, pueden aparecer en cualquier orden. Puede omitir columnas opcionales y dejar cualquier número de filas en blanco. Todo el formato del archivo .xls se pasa por alto, así que puede usar líneas divisorias, sombreados y otros formatos de fuentes para que el formulario resulte más legible.

Hoja de cálculo survey

Esta hoja de cálculo define la estructura general del formulario. Contiene la lista completa de preguntas e información sobre cómo deben aparecer en el formulario. Normalmente, cada fila representa una pregunta; sin embargo, hay otras características que se describen a continuación y que se pueden agregar al formulario para mejorar la experiencia del usuario.

La hoja de cálculo survey presenta tres columnas obligatorias: type, name y label o hint.

  • La columna type especifica el tipo de pregunta de XLSForm que se va a agregar. Hay una lista bien definida de tipos de preguntas posibles para esta columna.
  • La columna name determina el nombre de la columna de la capa de entidades de ArcGIS en la que se almacenará la respuesta a la pregunta. No se admiten espacios ni caracteres especiales en esta columna. No puede haber dos filas con el mismo contenido.
  • Las columnas label y hint contienen el texto para las preguntas. Este es el texto que verá en el formulario. Una pregunta requiere al menos una columna label o hint; se recomienda proporcionar la primera para evitar mensajes de advertencia. Se admiten espacios y caracteres especiales en estas columnas. Como alternativa, puede utilizar columnas de traducción. Ambas columnas también admiten el uso limitado de código HTML y variables que se reemplazarán en su encuesta con la respuesta a otra pregunta. Para obtener más información, consulte Notas.

Hoja de cálculo choices

Esta hoja de cálculo se usa para especificar las opciones de respuesta para las preguntas con varias respuestas. Cada fila representa una opción de respuesta. Las opciones de respuesta con el mismo nombre de lista se consideran parte de un conjunto relacionado de opciones y aparecen juntas para una pregunta. También permite reutilizar un conjunto de opciones para varias preguntas (por ejemplo, preguntas de sí o no).

La hoja de cálculo choices tiene tres columnas obligatorias: list name, name y label.

  • La columna list name permite agrupar un conjunto de opciones de respuesta relacionadas. Las opciones con el mismo nombre de lista se presentan como el conjunto de respuestas para una pregunta.
  • La columna name especifica el valor que se conserva en ArcGIS. Los valores de la columna name no aceptan caracteres especiales.
  • La columna label muestra la opción de respuesta tal y como se desea que aparezca en el formulario. Como alternativa, puede utilizar columnas de traducción de etiquetas.

Al crear formularios en Excel, la sintaxis que utilice debe ser precisa. Por ejemplo, si escribe Choices o choice en lugar de choices, el formulario no funcionará.

Hoja de cálculo settings

La hoja de cálculo settings es opcional y le permite personalizar más el formulario. La personalización disponible incluye un título que se muestra mientras se edita el formulario, un nombre de instancia para identificar de forma única cada formulario completado y un identificador de versión único para la encuesta, entre otros. Para obtener más información, consulte Settings.

Hojas de cálculo complementarias

Las plantillas de Survey123 incluyen hojas de cálculo que contienen las propiedades, operadores y funciones que se pueden utilizar en el formulario. Estas hojas de cálculo también se utilizan para rellenar las listas desplegables y otras reglas de validación de datos en las hojas de cálculo survey y settings. Para garantizar que la validación de datos funcione del modo esperado, se recomienda no modificar el contenido de las hojas de cálculo complementarias.

Tipos de preguntas

XLSForm admite diversos tipos de preguntas. La siguiente tabla enumera las preguntas que puede introducir en la columna type de su XLSForm, qué entrada se acepta para la pregunta y el tipo de campo que se crea en la capa de entidades de ArcGIS asociada a esa pregunta cuando se publica el formulario. El autor de la encuesta puede cambiar el tipo de campo de muchos de estos tipos de preguntas. Los tipos de preguntas cuyo tipo de campo no se puede cambiar se identifican en la tabla siguiente. Para obtener más información, consulte Columnas personalizadas de Esri.

Tipo de preguntaEntrada de respuestaTipo de campo predeterminado

entero

Entrada de número entero.

esriFieldTypeInteger

decimal

Entrada decimal.

esriFieldTypeDouble

rango

Entrada de un rango determinado de números.

esriFieldTypeInteger

texto

Respuesta de texto libre.

esriFieldTypeString

select_one list_name

Pregunta con varias opciones en la que el usuario solo puede seleccionar una respuesta. Reemplace list_name con el nombre de su lista de opciones. Puede cambiar el tipo de campo; sin embargo, el nombre de opción siempre se trata como una cadena de caracteres en la aplicación de campo cuando se utiliza en expresiones.

esriFieldTypeString

select_multiple list_name

Pregunta con varias opciones en la que el usuario puede seleccionar varias respuestas. Reemplace list_name con el nombre de su lista de opciones. No puede cambiar el tipo de campo y el nombre de opción siempre se trata como una cadena de caracteres en la aplicación de campo cuando se utiliza en expresiones.

esriFieldTypeString

rank list_name

Pregunta de clasificación; clasificación de una lista de opciones en orden. Reemplace list_name con el nombre de su lista de opciones. No puede cambiar el tipo de campo y el nombre de opción siempre se trata como una cadena de caracteres en la aplicación de campo cuando se utiliza en expresiones.

esriFieldTypeString

nota

Muestra una nota en la pantalla; no acepta entradas. También puede visualizar cálculos ocultos.

esriFieldTypeString

geopoint

Captura una coordenada GPS dada. No puede cambiar el tipo de campo.

esriFieldTypeGeometry

geotrace

Captura una línea de un mapa. No puede cambiar el tipo de campo.

esriFieldTypeGeometry

geoshape

Captura un polígono de un mapa. No puede cambiar el tipo de campo.

esriFieldTypeGeometry

fecha

Entrada de fecha.

esriFieldTypeDate

tiempo

Entrada de hora.

esriFieldTypeString

dateTime

Acepta una entrada de fecha y hora.

esriFieldTypeDate

imagen

Tome una foto.

Adjunto

begin group

Inicie un grupo de preguntas.

No aplicable

end group

Finalice un grupo de preguntas.

No aplicable

begin repeat

Inicie un conjunto de preguntas que se repiten.

No aplicable

end repeat

Finalice un conjunto de preguntas que se repiten.

No aplicable

calcular

Realiza un cálculo con los valores del formulario. Este tipo de pregunta está oculto y no aparece en el formulario.

esriFieldTypeString

nombre de usuario

Cuando se inicia sesión en ArcGIS Online o ArcGIS Enterprise, este campo se rellena automáticamente con el nombre de usuario de la cuenta. Este tipo de pregunta está oculto y no aparece en el formulario.

esriFieldTypeString

email

Cuando se inicia sesión en ArcGIS Online o ArcGIS Enterprise, este campo se rellena automáticamente con la dirección de correo electrónico de la cuenta. Este tipo de pregunta está oculto y no aparece en el formulario.

esriFieldTypeString

oculto

Un campo que no aparece en el formulario. Use las columnas bind::esri:fieldType y bind::esri:fieldLength para especificar el esquema de datos.

esriFieldTypeString

barcode

Escanea un código de barras.

esriFieldTypeString

start

Fecha y hora de inicio de la encuesta.

esriFieldTypeDate

end

Fecha y hora de finalización de la encuesta.

esriFieldTypeDate

deviceid

Id. único generado por Survey123 que representa al dispositivo específico con el que se respondió a la encuesta. No es lo mismo que la Identidad Internacional de Equipo Móvil (IMEI, por sus siglas en inglés) del dispositivo móvil, ya que Survey123 se ejecuta en dispositivos que pueden no tener una IMEI.

esriFieldTypeString

audio

Grabación de muestras de audio.

Adjunto

file

Cargue un archivo en el dispositivo.

Adjunto

Por ejemplo, para recopilar el nombre y las coordenadas GPS de una tienda, debe escribir lo siguiente:

Una pregunta de texto y geopunto en un formulario

El formulario de muestra Question Types incluye todos los tipos de preguntas admitidos por ArcGIS Survey123. También puede consultar la referencia rápida para saber cómo se representan estos tipos de preguntas en el diseñador web y la aplicación web de Survey123.

Preguntas con varias opciones

XLSForm admite preguntas select_one (seleccionar solo una respuesta), select_multiple (seleccionar varias respuestas) y de clasificación (ordenar una lista de opciones). Para escribir una pregunta con varias opciones de respuesta, es necesario agregar una hoja de cálculo choices al libro de trabajo de Excel. El siguiente ejemplo muestra una pregunta select_one:

Seleccionar una pregunta en un formulario
Seleccionar una opción en un formulario

La entrada yes_no de la hoja de cálculo survey debe coincidir con la entrada yes_no de la columna list name de la hoja de cálculo choices. Esto garantiza que el formulario muestra la lista correcta de opciones de respuesta para una pregunta concreta.

Cuando se publican las encuestas en ArcGIS con Survey123 Connect, las opciones de las preguntas select_one se convierten en dominios de geodatabase para la capa de entidades de ArcGIS.

También puede agregar preguntas con varias respuestas que permitan seleccionar varias respuestas, como las siguientes:

Seleccionar varias preguntas en un formulario
Seleccionar varias opciones en un formulario

De forma predeterminada, estas opciones aparecen en el orden proporcionado en la hoja choices. En su lugar, puede aleatorizar el orden en el que aparecen estas opciones introduciendo randomize=true en la columna de parámetros.

Precaución:

Todos los valores capturados en una pregunta select_multiple o de clasificación se guardan como una lista separada por comas, por lo que debe evitar el uso de comas en la columna de nombre de su lista de opciones. Tenga en cuenta también que las preguntas select_multiple y de clasificación envían solo el nombre de una opción a la capa de entidades, en lugar del nombre y la etiqueta enviados por las preguntas select_one.

El valor de una pregunta de clasificación permanecerá vacío hasta que el usuario modifique el orden de las opciones. Si se ha establecido un valor predeterminado, el orden predeterminado se aplicará, a menos que el usuario modifique el orden de las opciones.

Una respuesta individual para una pregunta select_multiple se puede devolver con la función selected-at. Lo siguiente devuelve el valor de nombre de la primera respuesta obtenida para una pregunta select_multiple:

selected-at(${species}, 0)

Para enviar la etiqueta de una respuesta, puede usar la función jr:choice-name. Para obtener el valor de etiqueta de la segunda respuesta obtenida de la misma pregunta select_multiple, use lo siguiente:

jr:choice-name(selected-at(${species}, 1), '${species}')

Especificar otros

A menudo, para las preguntas con varias opciones, las encuestas incluyen una opción para que los encuestados marquen Otros cuando una opción de respuesta no aparezca en la lista. A continuación, se suele pedir al encuestado que especifique la otra opción. En XLSForm, es posible hacerlo incluyendo or_other a continuación del nombre de lista de la opción de respuesta en la hoja de cálculo survey. La hoja de cálculo choices no se modifica. Vea lo siguiente:

Seleccionar varias u otra pregunta en un formulario
Nota:

La etiqueta del campo Especificar otro no se mostrará en idiomas distintos del inglés. Para obtener más información, incluidas las soluciones alternativas, consulte Problemas conocidos.

Listas externas de opciones

Puede almacenar listas de opciones para preguntas select_one y select_multiple en un archivo CSV externo. Es ideal para listas de opciones muy grandes, así como listas de opciones que se administran fuera de Survey123. El archivo CSV debe contener las columnas name y label. Hay dos formas de incluir un archivo CSV: colocar manualmente el archivo en la carpeta de contenido multimedia de la encuesta o vincular a un archivo .csv alojado en ArcGIS.

Para incluir una pregunta con una lista externa de opciones, introduzca el tipo de pregunta, select_one_from_file o select_multiple_from_file, y el nombre del archivo .csv, por ejemplo, select_one_from_file CoverType.csv. Los nombres de archivo distinguen entre mayúsculas y minúsculas y no permiten espacios.

Nota:

Si el archivo .csv no tiene un encabezado de columna o tiene una coma final al final de las filas del archivo, el archivo no se importa a la encuesta.

Si coloca manualmente el archivo .csv en la carpeta de contenido multimedia de la encuesta y posteriormente carga un archivo .csv con el mismo nombre en ArcGIS y lo vincula a la encuesta, el archivo .csv de la encuesta se actualiza a partir del contenido vinculado (si es más reciente).

Para vincular un archivo .csv a una encuesta, realice lo siguiente:

  • Asegúrese de que el archivo .csv esté alojado en ArcGIS Online o ArcGIS Enterprise y que tenga los mismos permisos de uso compartido que la encuesta.
  • Asegúrese de que la encuesta se ha publicado en ArcGIS antes de intentar vincular el contenido.
  • En Survey123 Connect, vaya a la pestaña Contenido vinculado de la encuesta y haga clic en el botón Vincular contenido. Seleccione CSV y busque y seleccione el archivo .csv que desee vincular.

Para ver la lista externa en Survey123 Connect, en la pestaña Contenido vinculado, puede optar por descargar el archivo con el botón Descargar Descargar. De este modo, se coloca una copia del archivo .csv en la carpeta de contenido multimedia de la encuesta. Los archivos vinculados se descargan automáticamente con la encuesta en la aplicación de campo Survey123.

Las listas externas de opciones no se deben confundir con selecciones externas, donde las opciones deben figurar en una hoja de cálculo adicional.

Metadatos

XLSForm tiene las siguientes opciones de tipos de datos para la captura de metadatos:

Tipo de metadatosDescripción

start

Fecha y hora de inicio de la encuesta.

end

Fecha y hora de finalización de la encuesta.

nombre de usuario

Registra el nombre de usuario del usuario que tiene la sesión iniciada actualmente en ArcGIS Online o ArcGIS Enterprise. Este tipo de datos no acepta entradas.

email

Registra la dirección de correo electrónico del usuario que tiene la sesión iniciada actualmente en ArcGIS Online o ArcGIS Enterprise. Este tipo de datos no acepta entradas.

deviceid

Id. único generado por Survey123 que representa al dispositivo específico con el que se respondió a la encuesta. No es lo mismo que la Identidad Internacional de Equipo Móvil (IMEI, por sus siglas en inglés) del dispositivo móvil, ya que Survey123 se ejecuta en dispositivos que pueden no tener una IMEI.

Nota:

No se admiten los siguientes elementos de metadatos XLSForm: subscriberid, simserial y phonenumber.

Para capturar todos estos metadatos, agregue lo siguiente al principio de la encuesta:

Preguntas de metadatos en un formulario

ArcGIS Survey123 captura automáticamente las entradas de metadatos descritas anteriormente. No se representan como preguntas en el formulario, pero verá los valores una vez que se haya enviado la encuesta.

Si agrega los tipos start o end, ArcGIS Survey123 habilita automáticamente el tiempo en la capa de entidades para la encuesta. De esta forma, puede filtrar el contenido de la encuesta en función de la fecha en la que se enviaron los datos. Agregar las entradas start y end también resulta útil si se desea determinar con exactitud el tiempo que ha transcurrido desde que se abrió el formulario hasta que se marcó como completado.

Sugerencias

En ocasiones, se desea agregar una sugerencia a una pregunta del cuestionario para aclarar al usuario cómo se debe responder a la pregunta, pero no se quiere que la sugerencia forme parte de la pregunta. Puede agregar sugerencias a preguntas en XLSForm. Agregue una columna hint e incluya el mensaje de sugerencia. Vea el siguiente ejemplo:

Sugerencias sobre preguntas en un formulario

También puede agregar sugerencias de orientación a una pregunta con la columna guidance_hint. Las sugerencias de orientación indican al usuario cómo responder a una pregunta, pero están ocultas hasta que el usuario hace clic en el botón de sugerencia de orientación que aparece junto a la sugerencia. Las sugerencias de orientación solo se pueden usar si ya existe una sugerencia para la pregunta.

Pregunta con una sugerencia y una sugerencia de orientación

También se puede proporcionar texto de marcador de posición para preguntas que acepten una entrada escrita (como preguntas de texto, enteros y decimales y preguntas select_one con apariencia autocomplete) definiendo el parámetro placeholderText en la columna body::esri:style. Al utilizar placeholderText=@[hint] o placeholderText=@[guidance_hint], la sugerencia o sugerencia de orientación se ocultará y el texto de sugerencia se colocará dentro del área de entrada de la pregunta. El texto de marcador de posición aparecerá en el área de entrada si la pregunta está vacía.

Nota:

No se admiten sugerencias para las preguntas begin repeat ni begin group.

No se admite texto de marcador de posición en la aplicación web Survey123.