Parámetros

Ciertos tipos de preguntas de XLSForm presentan parámetros adicionales que le permiten controlar el estilo o el comportamiento de las preguntas de una encuesta. En algunos casos, estos parámetros complementan las apariencias que admite un tipo de pregunta. No todos los parámetros son compatibles con todas las aplicaciones de envío (Survey123 Mobile, la aplicación de campo Survey123 y la aplicación web Survey123). Para obtener más información sobre la compatibilidad con las aplicaciones, consulte las tablas de parámetros siguientes, organizadas por tipo de pregunta y por la columna de XLSForm de la hoja de cálculo de la encuesta que acepta cada parámetro.

Puede agregar varios parámetros para una pregunta a la misma columna separando los parámetros con espacios. Por ejemplo, una pregunta de rango puede tener los parámetros startColor, endColor y color en la columna body::esri:style, como se muestra a continuación:

startColor=Orange endColor=White color=#FF6347

General

En esta sección se describen los parámetros que puede utilizar en las columnas bind::esri:parameters y body::esri:style de XLSForm para varios tipos de preguntas.

En la tabla siguiente se describe el parámetro que puede utilizar en la columna de XLSForm de bind::esri:parameters para los tipos de pregunta text, integer, decimal, note, date, time, dateTime, select_one, select_multiple, geopoint, calculate, y hidden.

bind::esri:parameters

ParámetroDescripciónAplicación de envío
calculationMode

Controla cuándo se realiza el cálculo de una pregunta.

Valores: auto | manual | always | whenEmpty

Ejemplos:

calculationMode=manual
calculationMode=always

Aplicación web

Aplicación de campo

En la tabla siguiente se describe el parámetro que puede utilizar en la columna de XLSForm de body::esri:style XLSForm para los tipos de pregunta text, integer, decimal, select_one (con la apariencia autocomplete), select_multiple (con la apariencia autocomplete)* y barcode.

body::esri:style

ParámetroDescripciónAplicación de envío
placeholderText

Especifica el texto que aparece en el área de entrada de la pregunta cuando ésta está vacía.

Valores: @[hint] | @[guidance_hint]

Ejemplos:

placeholderText=@[hint]
placeholderText=@[guidance_hint]

Survey123 Mobile

Aplicación de campo

*Solo compatible con Survey123 Mobile.

Audio

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de bind::esri:parameters para el tipo de pregunta audio.

bind::esri:parameters

ParámetroDescripciónAplicación de envío
códec

Especifique el códec preferido de una grabación de audio. Se pueden proporcionar varios códecs separados por comas. Se utilizará el primer códec que sea compatible con el dispositivo.

Valor: <codec name>

Ejemplo:

codec=amr-nb,aac

Survey123 Mobile

Aplicación de campo

fileName

Especifique el nombre de archivo.

Valores: <expression>

Ejemplos:

fileName=concat("JobID-", ${job_id})
fileName=concat(${asset_id}, "_", 
  format-date(now(), "%Y%m%d%H%M%S"))

Aplicación web

max-duration

Especifica la duración máxima en segundos de una grabación de audio. La duración predeterminada en la aplicación web es 600 (10 minutos).

Valor: <seconds>

Ejemplo:

max-duration=45

Survey123 Mobile

Aplicación web

Aplicación de campo

max-size

Especifique el tamaño de archivo máximo de una grabación de audio en megabytes. El tamaño predeterminado en la aplicación de campo es de 10 MB.

Valor: <megabytes>

Ejemplo:

max-size=5

Survey123 Mobile

Aplicación de campo

Código de barras

En la tabla siguiente se describe el parámetro que puede utilizar en la columna de XLSForm de body::esri:style para el tipo de pregunta barcode.

body::esri:style

ParámetroDescripciónAplicación de envío

barcodeType

Especifique los tipos de códigos de barras que pueden escanear los usuarios. Se pueden proporcionar varios tipos, separados por comas. Cuando no se proporciona el parámetro barcodeType, se pueden escanear todos los tipos de códigos de barras admitidos, excepto aztec, code39, datamatrix, maxicode y pdf417.

Valores: all | 1d | 2d | <barcode types>

  • all: todos los tipos admitidos excepto code39 y pdf417.
  • 1d: todos los tipos unidimensionales excepto code39.
  • 2d: todos los tipos bidimensionales excepto pdf417.

Tipos unidimensionales: codabar | code128 | code39 | code93 | ean13 | ean8 | itf | upca | upce | upceanextension

Tipos bidimensionales: aztec | datamatrix | maxicode | pdf417 | qrcode | rss14 | rssexpanded

Ejemplos:

barcodeType=qrcode,aztec,code128
barcodeType=ean8,itf
barcodeType=2d
barcodeType=pdf417

Aplicación de campo

Archivo

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de bind::esri:parameters para el tipo de pregunta file.

bind::esri:parameters

ParámetroDescripciónAplicación de envío
fileName

Especifique el nombre de archivo.

Valores: <expression>

Ejemplos:

fileName=concat("JobID-", ${job_id})
fileName=concat(${asset_id}, "_", 
  format-date(now(), "%Y%m%d%H%M%S"))

Aplicación web

max-size

Especifica el tamaño máximo del archivo en megabytes. El valor predeterminado es de 10 MB.

Valor: <megabytes>

Ejemplo:

max-size=5

Aplicación web

Grupos

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de body::esri:style para el tipo de pregunta being group.

body::esri:style

ParámetroDescripciónAplicación de envío

backgroundColor

borderColor

Especifica los colores de fondo y de los bordes de un grupo o una página. Para obtener más información, consulte Colores de grupos, páginas y repeticiones.

Valores: <HTML color name> | <hex color code>

Ejemplos:

backgroundColor=LightBlue
borderColor=#4682B4
backgroundColor=#C7FFC7 borderColor=#3C6D9E

Survey123 Mobile

Aplicación de campo

diseño

Especifica el estilo de diseño de la cuadrícula de un grupo.

Valores: dynamic-grid | fixed-grid

Ejemplo:

layout=fixed-grid

Aplicación de campo

Imágenes

En esta sección se describen los parámetros que puede utilizar en las columnas de XLSForm especificadas para el tipo de pregunta image.

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de bind::esri:parameters.

bind::esri:parameters

ParámetroDescripciónAplicación de envío
allowAdds

Deshabilita la adición de nuevas imágenes al editar los registros existentes.

Valor: false

Ejemplo:

allowAdds=false

Aplicación de campo

fileName

Especifique el nombre de archivo.

Valores: <expression>

Ejemplos:

fileName=concat("JobID-", ${job_id})
fileName=concat(${asset_id}, "_", 
  format-date(now(), "%Y%m%d%H%M%S"))

Aplicación web

Aplicación de campo

max-size

Especifica el tamaño máximo del archivo en megabytes. El valor predeterminado es de 10 MB.

Valor: <megabytes>

Ejemplo:

max-size=5

Aplicación web

smartAnnotation

Para una pregunta de imagen con apariencia annotate, genera automáticamente gráficos de anotación de etiquetas y cuadros delimitadores alrededor de los objetos detectados. Incorpore estas propiedades para definir el estilo y el formato de la anotación.

Propiedad requerida: <model_name>

Propiedades opcionales: minScore | cameraPreview | label | class | boundingBoxes | outlineWidth | fontSize | font | bold | italic

Ejemplos:

smartAnnotation=modelname
  &cameraPreview=true&minScore=0.52
smartAnnotation=modelname&
  cameraPreview=true&minScore=0.52
  &class=classname1,classname2
  &label=false&bold=true

Aplicación de campo

smartAttributes

Realice la detección de objetos o la clasificación de imágenes y utilice los resultados EXIF en su encuesta.

Propiedad requerida: <model_name>

Propiedades opcionales: minScore | cameraPreview | label | class

Ejemplos:

smartAttributes=modelname
  &cameraPreview=true&minScore=0.45
smartAttributes=modelname
  &cameraPreview=true
  &class=classname1,classname2
  &label=false

Aplicación de campo

redaction

Genere automáticamente o agregue manualmente cuadros delimitadores y aplique efectos de edición en el área objetivo.

Propiedad requerida: <model_name> | @faces | @manual

Propiedades opcionales: minScore | cameraPreview | label | class | effect | symbol | fillColor | scale

Ejemplos:

redaction=modelname
  &cameraPreview=true&effect=blur
redaction=@manual&effect=blockout
redaction=@faces&cameraPreview=true
  &class=classname1,classname2
  &label=false@effect=symbol&symbol=🐻

Aplicación de campo

watermark

topLeftWatermark

topCenterWatermark

topRightWatermark

leftCenterWatermark

centerWatermark

rightCenterWatermark

bottomLeftWatermark

bottomCenterWatermark

bottomRightWatermark

Especifica la posición de una marca de agua de imagen. Incorpora propiedades para definir el contenido y el formato. Para más información, véase Marcas de agua.

Propiedades: text | color | outlineColor | outlineWidth | haloColor | size | font | bold | italic | margin | image | imageSize

Ejemplos:

watermark="Example Text
  &outlineColor=White"
bottomLeftWatermark="Example Text
  &bold=true"
topRightWatermark="@[latitude longitude]
  &size=20"

Aplicación de campo

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de body::esri:style para el tipo de pregunta image.

body::esri:style

ParámetroDescripciónAplicación de envío
allowRename

Especifique si los usuarios pueden editar el nombre de archivo de forma manual.

Valores: true | false

Ejemplo:

allowRename=false

Aplicación de campo

fileNameVisible

Especifique si el nombre de archivo está visible en la encuesta.

Valores: true | false

Ejemplo:

fileNameVisible=true

Aplicación de campo

footerText

En el caso de una pregunta image con apariencia signature, especifique el texto que debe aparecer en la parte inferior de la ventana emergente de la firma. Si no se especifica ningún valor, las sugerencias de orientación de la pregunta aparecerán debajo de la firma. Esto se puede cambiar a las sugerencias de la pregunta utilizando footerText=@[hint].

Valores: <none> | @[hint]

Ejemplos:

footerText
footerText=@[hint]

Survey123 Mobile

Aplicación de campo

método

Especifique el método de captura para las preguntas image. El valor map solo se admite para las preguntas image con apariencia annotate.

Valores: browse | camera | map

Ejemplos:

method=camera
method=map
method=browse,camera,map

Aplicación web

Aplicación de campo

palette

En el caso de una pregunta image con apariencia annotate, especifique una paleta de herramientas de dibujo personalizada.

Valor: <palette name>

Ejemplo:

palette=SiteLayout

Aplicación de campo

previewHeight

Define la altura de la vista previa de la imagen una vez seleccionada esta. Use previewHeight=0 si desea que su vista previa de imagen tenga el máximo tamaño sin ningún espacio vacío innecesario.

Valores: <lines> | <lines>lines | <percentage of screen height>% | <pixels>pixels

Ejemplos:

previewHeight=3lines
previewHeight=120pixels

Aplicación de campo

En la tabla siguiente se describe el parámetro que puede utilizar en la columna de XLSForm de parameters para el tipo de pregunta image.

parameters

ParámetroDescripciónAplicación de envío
max-pixels

En el caso de las preguntas image, define el tamaño máximo de la imagen en el borde más largo, conservando la relación de aspecto original.

En el caso de una pregunta image con apariencia signature, define la anchura máxima de la ventana emergente de la firma.

En el caso de las preguntas image con apariencia draw, cambia el lienzo a una imagen cuadrada (1:1).

Valor: <pixels>

Ejemplos:

max-pixels=1500
max-pixels=400

Aplicación web

Aplicación de campo

Preguntas de mapa

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm para los tipos de pregunta geopoint, geotrace y geoshape.

En la tabla siguiente se describe el parámetro que puede utilizar en la columna de XLSForm de bind::esri:parameters.

bind::esri:parameters

ParámetroDescripciónAplicación de envío

geocodificación

Defina el localizador desde el que se devolverán los resultados geocodificados.

Valor: <locator item ID>

Ejemplo:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

Aplicación web

Aplicación de campo

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de body::esri:style para los tipos de pregunta geopoint, geotrace y geoshape.

body::esri:style

ParámetroDescripciónAplicación de envío
height

Define la altura de la vista previa de mapa.

Valores: <lines> | <lines>lines | <percentage of screen height>% | <pixels>pixels

Ejemplos:

previewHeight=6lines
previewHeight=250pixels

Aplicación de campo

lineColor2

fillColor3

Especifica los colores de línea y de relleno de la entidad de línea o polígono. Se aplica solo a la vista previa del mapa en Survey123. Para más información, consulte Simbología de geometría.

Valores: <HTML color name> | <hex color code>

Ejemplo:

lineColor=Black 
fillColor=#9EFFF5

Survey123 Mobile

Aplicación de campo

lineWidth2

Especifica el ancho de línea en píxeles de la entidad de línea o polígono. Se aplica solo a la vista previa del mapa en Survey123.

Valor: <pixels>

Ejemplos:

lineWidth=3

Survey123 Mobile

Aplicación de campo

map

Define un mapa base predeterminado.

Valores: <map name> | <map item ID>

Ejemplos:

map="World Topography"
map=de26a3cf4cc9451298ea173c4b324736

Aplicación web

Aplicación de campo

mapTools

Controle las herramientas de mapas que están disponibles para preguntas geopoint, geotrace, y geoshape.

Valores: search | mapSwitcher | zoom | home | locate

Ejemplos:

mapTools=zoom
mapTools=search,locate

Aplicación de campo

method2

Especifica el método de captura. Cuando se utiliza el método de vértice, es posible configurar los parámetros adicionales.

Valores: sketch | vertex

Valores adicionales para vértice, aplicables solo en la aplicación de campo: streaming | beep | haptic | edit

Ejemplos:

method=vertex
method=vertex,streaming
method=vertex,streaming,haptic

Aplicación web

Aplicación de campo

minCaptureZoomLevel

Especifique el nivel mínimo en el que se puede capturar geometría.

Valor: <integer>

Ejemplo:

minCaptureZoomLevel=17

Aplicación web

overlay

Muestra las ubicaciones de los puntos de la primera pregunta geopoint de una repetición en cualquier otra pregunta geopoint, geoshape o geotrace de su encuesta. Incorpora propiedades para definir el contenido y el estilo.

Valor: <repeat name>

Propiedades: view | preview | icon | iconColor | iconOutlineColor | iconSize | label | labelColor | labelOutlineColor | fontSize

Ejemplos:

overlay=campsites&preview=true
overlay=hydrants&label=asset_id&icon=hydrant&iconColor=Red

Aplicación de campo

precision

Especifique el número de posiciones decimales que se capturarán en la pregunta de mapa y que se mostrarán en el panel de respuesta individual de la encuesta. Si este parámetro no está configurado, todas las posiciones decimales disponibles se capturan en la pregunta de mapa, pero solo se muestran seis posiciones decimales en el panel de respuesta individual.

Valor: <integer>

Ejemplo:

precision=4

Aplicación web

snapMode

Especifique el comportamiento de alineación. Los puntos se pueden alinear a otras entidades, y las líneas y polígonos se pueden alinear a otras entidades o a sí mismos. Solo está disponible si method=vertex.

Valores: feature | self2

Ejemplo:

snapMode=feature
snapMode=self
snapMode=self,feature

Aplicación web

symbol1

Especifique un archivo .png para utilizarlo como marcador de puntos en el mapa. Incorpore propiedades para definir la posición y la escala.

Valor: <file name>.png

Propiedades: x | y | scale

Ejemplo:

symbol=meter.png?x=0.6&y=0.1&scale=1.5

Aplicación de campo

1—Admitido únicamente con el tipo de pregunta geopoint.

2—Admitido únicamente con los tipos de pregunta geoshape y geotrace.

3—Admitido únicamente con el tipo de pregunta geoshape.

Preguntas de varias opciones

En la tabla siguiente se describe el parámetro que puede utilizar en la columna de XLSForm de parameters XLSForm para los tipos de pregunta select_one, select_multiple y rank.

parameters

ParámetroDescripciónAplicación de envío
randomize

Ordenar aleatoriamente las opciones de una lista de opciones.

Valores: true

Ejemplo:

randomize=true

Aplicación web

Aplicación de campo

Rango

En esta sección se describen los parámetros que puede utilizar en las columnas de XLSForm especificadas para el tipo de pregunta range. Al combinar parámetros, deben separarse mediante un espacio.

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de body::esri:style. Para obtener más información, consulte Opciones de estilo.

body::esri:style

ParámetroDescripciónAplicación de envío

startColor

endColor

color

Especifique colores para el control deslizante de rango:

  • Color del control deslizante al principio del rango.
  • Color del control deslizante al final del rango.
  • Color que rellena el espacio entre el inicio del control deslizante y el valor seleccionado.

Valores: <HTML color name> | <hex color code>

Ejemplos:

startColor=Blue endColor=Red
startColor=Orange endColor=White color=#FF6347
endColor=#262626 color=Yellow

Survey123 Mobile

Aplicación web

Aplicación de campo

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de parameters para el tipo de pregunta range. Para obtener más información, consulte Parámetros del control deslizante de rango.

parameters

ParámetroDescripciónAplicación de envío

start

end

step

Especifique los valores inicial, final y de paso del control deslizante de rango.

Valores: <integer> | <decimal>

Ejemplos:

start=0 end=50 step=5
start=10.25 end=1 step=0.25

Survey123 Mobile

Aplicación web

Aplicación de campo

Repeticiones

En esta sección se describen los parámetros que puede utilizar en las columnas de XLSForm especificadas para el tipo de pregunta begin repeat.

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de bind::esri:parameters.

bind::esri:parameters

ParámetroDescripciónAplicación de envío
allowAdds

Permite agregar nuevos registros de repetición.

Valores: true | false

Ejemplo:

allowAdds=true

Aplicación de campo

allowUpdates

Permite modificar los registros de repetición existentes.

Valores: true | false

Ejemplo:

allowUpdates=false

Aplicación de campo

query

Permite mostrar los registros repetidos existentes en el formulario. Especifique parámetros de consulta adicionales para filtrar los registros disponibles.

Valores: <none> | "SQL statement"

Ejemplos:

query
query="severity='high'"

Aplicación de campo

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de body::esri:style para el tipo de pregunta begin repeat.

body::esri:style

ParámetroDescripciónAplicación de envío

backgroundColor

borderColor

Especifica los colores de fondo y de los bordes de una repetición. Para obtener más información, consulte Colores de grupos, páginas y repeticiones.

Valores: <HTML color name> | <hex color code>

Ejemplos:

backgroundColor=LightBlue
borderColor=#4682B4
backgroundColor=#C7FFC7 borderColor=#3C6D9E

Survey123 Mobile

Aplicación de campo

addRecordMode

Para una repetición con apariencia tabular, especifique el modo del botón Agregar registro y de la opción Copiar en un registro nuevo en la vista tabular. El valor predeterminado es row. Cuando el valor es row, el nuevo registro se agrega a la vista tabular. Cuando el valor es form, el nuevo registro se abre en la vista de formulario.

Valores: row | form

Ejemplo:

addRecordMode=form

Survey123 Mobile

editInFormView

Para una repetición con apariencia tabular, muestre u oculte la opción Editar en la vista de formulario en la vista tabular. El valor predeterminado es true.

Nota:

Cuando la repetición contiene errores, la opción Editar en la vista de formulario está habilitada incluso si el parámetro editInFormView está establecido en false.

Valores: true | false

Ejemplo:

editInFormView=false

Survey123 Mobile

copyToNewRecord

Para una repetición con apariencia tabular, muestre u oculte la opción Copiar en un registro nuevo en la vista tabular. Esta opción permite a los usuarios duplicar un registro de la repetición. El valor predeterminado es true. El parámetro addRecordMode determina cómo se agrega el registro duplicado.

Valores: true | false

Ejemplo:

copyToNewRecord=true

Survey123 Mobile

editInTabularView

Para una repetición con apariencia tabular, habilite o deshabilite la edición en la vista tabular. El valor predeterminado es true. Cuando el valor es false, todas las celdas de la vista tabular son de solo lectura.

Valores: true | false

Ejemplo:

editInTabularView=false

Survey123 Mobile

En la tabla siguiente se describe el parámetro que puede utilizar en la columna de XLSForm de body::esri:style para las preguntas incluidas en repeticiones tabulares.

body::esri:style

ParámetroDescripciónAplicación de envío

showInTabularView

Para una repetición con apariencia tabular, muestre la pregunta como una columna en la vista tabular. El valor predeterminado es false.

Valores: true | false

Ejemplo:

showInTabularView=true

Survey123 Mobile

Texto

En esta sección se describen los parámetros que puede utilizar en las columnas de XLSForm especificadas para el tipo de pregunta text.

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de bind::esri:parameters.

bind::esri:parameters

ParámetroDescripciónAplicación de envío
geocodificación

En el caso de las preguntas text con apariencia geocode, define el localizador desde el que se devolverán los resultados geocodificados cuando utilice la apariencia geocode.

Valor: <locator item ID>

Ejemplo:

geocode=36ff9e8c13e042a58cfce4ad87f55d19

Aplicación web

Aplicación de campo

En la tabla siguiente se describen los parámetros que puede utilizar en la columna de XLSForm de body::esri:style para el tipo de pregunta text.

body::esri:style

ParámetroDescripciónAplicación de envío
defaultHeight

Para una pregunta de texto con apariencia multiline, defina la altura inicial del cuadro de texto. La altura del cuadro de texto aumenta para adaptarse al texto de la respuesta.

Valor: <number of lines>

Ejemplo:

defaultHeight=5

Aplicación de campo

indicator

En el caso de las preguntas text con apariencia geocode, permite que los resultados geocodificados muestren la dirección y la distancia desde la ubicación actual del dispositivo.

Valores: direction | distance | none

Ejemplos:

indicator=none
indicator=direction
indicator=direction,distance

Aplicación de campo

maxResults

En el caso de las preguntas text con apariencia geocode, especifique el número máximo de resultados a devolver. El valor predeterminado es 6.

Valor: <number of results>

Ejemplo:

maxResults=10

Aplicación web

Aplicación de campo

proximidad

En el caso de las preguntas text con apariencia geocode, especifica si los resultados geocodificados solo muestran resultados dentro de un determinado radio de la ubicación del dispositivo.

Valores: <distance>m | km | ft | mi | yd

Ejemplos:

proximity=3km
proximity=1000ft

Aplicación de campo

sugerencias

En el caso de las preguntas de texto con apariencia geocode, cambie la forma en que se rellenan las sugerencias. La opción predeterminada es Sí.

Valores: yes | no

Ejemplo:

suggestions=no

Aplicación de campo

Telémetro

En la tabla siguiente se describe el parámetro que puede utilizar en la columna de XLSForm de bind::esri:parameters para los tipos de pregunta text, integer y decimal con el fin de recuperar valores de un telémetro.

bind::esri:parameters

ParámetroDescripciónAplicación de envío

medición

Para una pregunta de texto, entero o decimal con apariencia de telémetro, establezca qué mediciones se almacenarán en la pregunta. Encierre la lista de valores entre comillas si los valores incluyen espacios.

Valores: height | azimuth | horizontalDistance | slopeDistance | inclination | multipleHeights

Ejemplos:

measurement=height
measurement=height,azimuth,horizontalDistance
measurement="multipleHeights,Height 1,Height 2"

Aplicación de campo