Directrices de creación de aplicaciones
Una aplicación analítica de Alteryx es un programa autónomo que realiza una función específica para el usuario. La interfaz debe ser simple y la aplicación debe estar diseñada con un único objetivo en mente. Esta aplicación debe realizar un rango limitado de tareas centradas en una experiencia de usuario óptima. Si se tiene en cuenta que los usuarios ejecutan las aplicaciones que creas en un navegador web, el diseño del back-end debe ser ingenioso, elegante y eficiente.
Conjunto de datos vintage más reciente
Cuando creas una aplicación que utiliza un conjunto de datos específico, asegúrate de configurar el conjunto de datos seleccionado para utilizar la versión vintage más reciente. Esto significa que Alteryx Designer utiliza automáticamente la versión más reciente del conjunto de datos que está instalada en la computadora del usuario. Esto se aplica a las herramientas Análisis demográfico (Allocate), las herramientas Análisis de comportamiento (Solocast), las herramientas Calgary, los tiempos de manejo, el geocodificador y el mapa básico de referencia en las herramientas de mapeo. Para establecer el conjunto de datos, en Designer, ve a Opciones>Configuración de usuario>Editar configuración de usuario>Herramientas, y utiliza la sección Valores predet. para conjuntos de datos a fin de realizar las selecciones.
Pestaña Metainformación
La información que completas en la pestaña Metainformación de la ventana Configuración de flujo de trabajo se muestra en los detalles de la aplicación en la web.
Utilizar nombre de archivo: esta opción presenta el nombre del archivo.
Personalizado: selecciona esta opción para darle un nombre fácil de usar a la aplicación. Por ejemplo, el archivo de la aplicación en sí podría llamarse Descargar_datos_meteorológicos, por lo que el nombre personalizado sería el mismo, pero sin los guiones bajos: Descargar datos meteorológicos.
Descripción: la descripción que se ingresa aquí es la descripción que se muestra en la web para la aplicación, así que asegúrate de que sea precisa y fácil de entender.
URL: el campo URL proporciona la capacidad de incluir un enlace hacia un sitio web externo.
Texto para mostrar (opcional): utiliza este campo para proporcionar el texto mostrado para la dirección URL.
(Sólo macros) Configuración de la herramienta: Esta configuración sólo se aplica a las macros. Para obtener más información sobre el repositorio de macros, consulta Macros en la pestaña Herramientas de Configuración de usuario. Esta configuración permite crear varias versiones de una macro. Las macros guardadas en el repositorio de macros aparecen en la paleta de herramientas.
Nombre de la herramienta raíz: ingresa un nombre para la herramienta. Puedes tener varias herramientas con el mismo nombre de raíz; sin embargo, solo aparece una herramienta en la paleta de herramientas.
Versión de la herramienta: ingresa el número de versión de la herramienta. La versión más reciente de una herramienta aparece en la paleta de herramientas. Para ver un menú en el que puedes acceder a versiones anteriores de una herramienta de macro, arrastra la herramienta al lienzo y haz clic en ella con el botón secundario.
¿Herramienta en base de datos?: selecciona esta opción si la herramienta se puede utilizar en un flujo de trabajo con herramientas en base de datos.
(Sólo macros) Paleta de herramientas: la configuración sólo se aplica a los flujos de trabajo macros. Para obtener más información sobre el repositorio de macros, consulta Macros en la pestaña Herramientas de Configuración de usuario. Esta configuración controla cómo se muestran las macros en la paleta de herramientas. Las macros guardadas en el repositorio de macros aparecen en la paleta de herramientas.
Nombre de categoría: ingresa el nombre de la categoría en la que se debe mostrar la macro en la paleta de herramientas.
Etiquetas de búsqueda: ingresa los términos que un usuario puede utilizar para buscar y localizar la macro. De forma predeterminada, Nombre de archivo, Nombre personalizado, Nombre del autor y Nombre de la empresa se incluyen como etiquetas de búsqueda.
Autor: proporciona los detalles del creador de la aplicación analítica.
Nombre: ingresa el nombre del autor.
Empresa: ingresa la empresa con la que está afiliado el autor.
Derechos de autor: ingresa la información de derechos de autor.
Establecer como predeterminado: selecciona esta opción para deshacer el trabajo y utilizar el texto predeterminado.
Recordar como predeterminado: guarda el texto ingresado como predeterminado.
Extensión .yxwz
Cuando crees una aplicación, asegúrate de haber guardado el archivo como archivo YXWZ, aunque hayas cambiado el tipo de flujo de trabajo a aplicación analítica. Si la extensión del archivo se deja como .yxmd, se abrirá como un flujo de trabajo y no como una aplicación.
Las aplicaciones creadas en la versión 9.0 ya no se pueden guardar como archivos YXMD.
Entrada de mapa
La herramienta Entrada de mapa le da al consumidor de la aplicación la capacidad de seleccionar una ubicación o dibujar un polígono o una línea mediante la característica Entrada de mapa. Las preguntas de mapa deben ser cortas y descriptivas, y siempre se debe usar un mapa básico. Cuando elijas un mapa básico, asegúrate de seleccionar Versión vintage más reciente.
Por último, si se selecciona el modo Dibujar, asegúrate de que la configuración El usuario puede etiquetar características esté siempre marcada. Esto le da al usuario la opción de agregar un nombre a cada uno de sus polígonos personalizados.
Salida de informe
Si cuando guardas una aplicación en Alteryx Server la salida del informe se presenta como PCXML, la aplicación ofrece la opción de que los usuarios finales no solo puedan previsualizar el informe en la Web, sino también descargarlo en cualquiera de nuestros formatos de informe compatibles. Entre los formatos de informe compatibles, se incluyen PDF, Microsoft Word, Microsoft Excel y HTML.
Cuando creas una aplicación, la salida puede ser cualquiera de nuestros formatos de informe compatibles. Para utilizar PCXML, establece el modo de salida en la herramienta Presentación para seleccionar un archivo de salida específico y, para el archivo de salida, utiliza NOMBRE_APLICACIÓN.pcxml.
Cuando previsualices un informe en PCXML, no verás los pies de página, pero estarán disponibles cuando lo descargues como documento de Excel, Word o PDF.
Archivos de lectura/escritura: macros en una aplicación
En el caso de las aplicaciones web, solo puedes leer y escribir archivos que estén dentro de la misma carpeta que tu aplicación o en una carpeta inferior, en otras palabras, cualquier carpeta que esté dentro de la carpeta que contiene la aplicación (puede estar más de un nivel por debajo). Esta regla también se aplica a las macros que desees utilizar para tu aplicación, a menos que sea una macro estándar que forme parte del instalador del producto Alteryx o de un instalador de datos.
%temp%
No utilices %temp% para escribir en el directorio temporal cuando crees flujos de trabajo o aplicaciones para guardarlas en Server. Mantén todas las rutas de archivo dentro del flujo de trabajo. Si desarrollas una aplicación encadenada, utiliza solo el nombre del archivo en lugar de cualquier ruta de archivo, por ejemplo, .\fileOutput.yxdb y no %temp%\fileOutput.yxdb o algo similar. Para seleccionar un archivo, navega hasta él y, a continuación, cambia la ruta de dependencia del archivo a una ruta relativa a través de la ventana Dependencias del flujo de trabajo.
Herramientas y eventos prohibidos
Estas herramientas y eventos de Alteryx Designer están prohibidos en la Galería de la Comunidad, también conocida como Alteryx Analytics Gallery, debido a las numerosas configuraciones y acciones posibles que se pueden realizar:
Si tu flujo de trabajo utiliza una de las herramientas o eventos prohibidos de manera segura, puedes solicitar una exención para ejecutar el flujo de trabajo en Gallery. Para solicitar una exención, realiza lo siguiente:
Envía un correo electrónico a curator@alteryx.com y explica cómo y por qué se utiliza cada herramienta prohibida, junto con el propósito general del flujo de trabajo.
Publica el flujo de trabajo en tu estudio privado y marca la opción Otros pueden descargar este flujo de trabajo.
Agrega el flujo de trabajo a una colección y compártelo con el administrador de Alteryx por correo electrónico a curator@alteryx.com.
Espera hasta dos días hábiles para que revisen tu flujo de trabajo y, luego, un administrador de Alteryx te enviará el estado de la solicitud por correo electrónico.
Las macros predictivas incluidas con Designer que utilizan la herramienta R están permitidas en la Galería de la Comunidad.
Características de aplicación no compatibles para la Web
Estas no son compatibles en el entorno web de la Galería de la Comunidad
Examinar carpeta
Examinar archivo (Guardar como); la carga funciona bien en la web.
Si una aplicación arroja algún error en el entorno de escritorio, no puedes guardarla en Server.
Las cadenas de aplicaciones de más de siete aplicaciones no funcionan en Server.
Prácticas recomendadas para la creación de aplicaciones
Actualizar acciones
Cuando emplees la herramienta Acción en Actualizar/Cambiar valor, a menos que sea realmente necesario, no utilices la opción Reemplazar una cadena específica. Si cambias la configuración de la herramienta en el flujo de trabajo debido a un desarrollo continuo, es posible que termines truncando esa herramienta Acción, ya que esa cadena específica podría dejar de existir. Obviamente, hay veces en que necesitas usar esa opción, pero solo ten en cuenta que, si cambia esa cadena en la herramienta, es posible que también necesites actualizar la herramienta Acción.
Actualizar desvíos
Si utilizas una herramienta Acción para actualizar una herramienta Desvío, intenta completar y actualizar el desvío para ambas posibilidades, es decir, desvío a la izquierda y desvío a la derecha. De lo contrario, si solo actualizas para una condición y cambias el flujo de trabajo durante el desarrollo, entonces no tuviste en cuenta cuándo necesitas que el flujo de trabajo vaya por el otro lado.
Finalizar desvíos
Todos los desvíos deben terminar, especialmente antes de unir cualquier flujo de datos de un desvío a cualquier otra parte del flujo de trabajo. Una herramienta Fin del desvío no requiere configuración, por lo que es fácil de usar. Asegúrate de utilizarla o de finalizar el desvío con una herramienta Salida.
Utilizar la herramienta Mensaje de error
Cuando escribas las preguntas, ten en cuenta a tu usuario y anticípate a los errores más comunes. Debes emitir mensajes de error con una herramienta Mensaje de error. Por ejemplo, si el usuario debe seleccionar una opción y, luego, arroja un error cuando no selecciona nada, esto puede evitar que el motor arroje errores que podrían no ser lo suficientemente significativos para que el usuario entienda cómo solucionarlos. Lo ideal es arrojar un error por cada pregunta que el usuario necesita rellenar. También puedes establecer condiciones más complejas para asegurarte de que llenen las cosas correctamente. Por ejemplo, si necesitan rellenar un cuadro de texto con hasta cinco áreas comerciales separadas por comas (por ejemplo, 1, 2, 3, 4, 5), puedes usar una condición de RegEx para asegurarte de que no haya más de cuatro comas en el cuadro de texto.
Emitir errores con la herramienta Mensaje
En esta misma línea, trata de anticipar los casos en los que la aplicación podría fallar incluso cuando esté configurada correctamente. Por ejemplo, el usuario puede ingresar una dirección que no se geocodifique y no produzca resultados. Puedes manejar fácilmente los mensajes en tu aplicación mediante la filtración de geocódigos erróneos y, luego, mediante la herramienta Mensaje para devolver un mensaje al usuario: “La dirección que proporcionaste no se geocodificó. Comprueba que la dirección sea válida y realiza los cambios pertinentes o ingresa una dirección diferente y vuelve a ejecutarla”.
Actualizar XML sin procesar, evadir metacaracteres HTML
Si utilizas XML sin procesar para una herramienta o usas caracteres especiales en tus aplicaciones, ten en cuenta que en la Web esto puede no funcionar como se espera. Por ejemplo, la selección de una herramienta Lista desplegable o herramienta Cuadro de lista en el motor puede contener texto como: Age By Sex Summary Report:<Report Type=“summary”>Age By Sex Summary Report</Report>
Pero cuando esto se usa en la Web, en realidad no muestra la pregunta correctamente y, por lo tanto, cuando se usa en una acción, es probable que no tenga el efecto deseado. Una solución es cambiar el texto a:Age By Sex Summary Report:<Report Type="summary">Age By Sex Summary Report</Report>
Entonces, si utilizas la respuesta a la pregunta en una acción, debes actualizarla para que sea: EscapeXMLMetacharacters([AllocateSummaryReport])
Se agregó la función Evadir metacaracteres XML a la biblioteca de Fórmula en la versión 8.0. Puedes acceder a ella desde la categoría Especializadas. Esta función reemplaza todos los metacaracteres XML por sus versiones con escape.
Árboles de variables demográficas
La Web y el motor devuelven diferentes valores cuando se deja vacío un árbol de variables demográficas. Si la aplicación tiene un árbol de variables demográficas como tipo de pregunta, es posible que desees escribir una condición que compruebe si el usuario seleccionó algo o dejó esto vacío. Para el motor, puedes escribir algo como lo siguiente:
[AllocateVariables] == "<Variables />"
Cuando el árbol de variables no tiene nada seleccionado, se devuelve <Variables />. Sin embargo, en la Web, el valor devuelto realmente no es nada, por lo que necesitarías que la condición sea:
isempty([AllocateVariables])
Obviamente, queremos que las aplicaciones funcionen tanto en la Web como en el escritorio, por lo que la condición realmente debe ser:
[AllocateVariables] == "<Variables />" or isempty([AllocateVariables])
Si también nos preocupa el uso de los caracteres <, > y / en la Web, podríamos cambiar la condición para que sea:
REGEX_CountMatches([AllocateVariables], "Variables") == 1 o isempty([AllocateVariables])
Herramienta Apilar
Es mejor mantener una herramienta Apilar configurada manualmente fuera de cualquier aplicación porque, en la mayoría de los casos, el flujo de trabajo cambia en tiempo de ejecución. En lugar de configurar la herramienta Apilar en modo manual, inserta las herramientas Seleccionar en cada conexión que se introduzca en la herramienta Apilar. Cuando configures la herramienta Seleccionar, cambia el nombre y el orden de los campos según sea necesario, y ten cuidado de no incluir campos dinámicos/desconocidos. Configura la herramienta Apilar mediante Configurar automáticamente por nombre o Configurar automáticamente por posición.
Contenedores de herramientas y organización de la aplicación
La organización de la aplicación se realiza, en parte, mediante el uso de diferentes contenedores de herramientas para las distintas secciones de la aplicación. Por ejemplo, todas las herramientas Generación de informes suelen ser la última sección de una aplicación y se pueden colocar en un contenedor de herramientas etiquetado como “Generación de informes”.
Una herramienta Contenedor de herramientas puede codificarse por colores según la función que resalte. Los contenedores de herramientas codificados por colores facilitan la comprensión de lo que hace una aplicación, sobre todo cuando se ve con un zoom pequeño. Esto es útil durante la solución de problemas o la depuración de una aplicación que otra persona creó.
Las herramientas de interfaz deben colocarse en sus propios contenedores y codificarse por color como tales. Para aplicaciones con varias pestañas, es útil colocar las herramientas que componen cada pestaña en su propio contenedor.
Anotaciones para flujos de trabajo y aplicaciones
Las anotaciones son cuadros de texto que se adjuntan a una herramienta específica y pueden ser muy útiles para describir el rol de herramientas individuales. Uno de los principales beneficios es que, si mueves la herramienta, la anotación se mueve con ella. En Configuración de flujo de trabajo, establece las Anotaciones que se deben mostrar.
Si es necesario, también puedes configurar anotaciones individuales para que se coloquen en la parte superior o inferior de una herramienta. Para cambiar la anotación, haz clic en la herramienta, selecciona la pestaña Anotación y selecciona Colocar la anotación en la parte superior o anula su selección.
Pautas específicas de una macro
Todas las pautas anteriores se aplican a las macros y a las aplicaciones, con las siguientes excepciones que se aplican solo a las macros.
Entradas de macro
Una herramienta Entrada de macro debe incluir datos. La inclusión de datos hace que sea mucho más fácil la solución de problemas o la depuración si algo sale mal. Hay una entrada de texto integrada dentro de la herramienta Entrada de macro. Este es el método preferido para las entradas de macro. Si necesitas un archivo más grande para que actúe como entrada de datos, deberás incluirlo en la macro siempre que sea posible. Las dependencias de archivos de datos para una macro deben denominarse según el patrón a continuación:
Nombredelamacro.Nombredelarchivodedatos.yxdb
Los nombres de entrada y salida no deben tener un número de herramienta asociado. En la pestaña Propiedades de entrada de macro, asegúrate de que el nombre sea lo suficientemente descriptivo. El nombre especificado aquí será visible para usuarios cuando configuren la herramienta Macro.
Cuando hay varias entradas y salidas, la adición de una abreviatura de conector ayuda al usuario a configurar la herramienta, ya que proporciona una etiqueta en el ancla de la herramienta cuando esta se coloca en el lienzo. Consulta Herramienta Entrada de macro o Herramienta Salida de macro para obtener más información.
Nomenclatura de las pestañas
Los nombres de las pestañas deben ser descriptivos para facilitar su uso mientras el usuario configura la herramienta Macro. Las pestañas son visibles para el usuario en el momento de la configuración. El nombre predeterminado de la pestaña es “Preguntas”; no es un nombre muy descriptivo y esto suele ser un descuido a la hora de desarrollar una macro (o aplicación) con una sola pestaña. Consulta la ventana Diseñador de interfaz.
Macros compatibles
Las macros compatibles utilizadas en un flujo de trabajo principal deben estar presentes en la macro principal o en un directorio compatible, y deben tener un nombre como: NombreDelPrincipal.NombreDelSoporte.yxmc