Saltar al contenido

Aplicación de Flujo de Formularios de Jitterbit

Descripción general

Jitterbit proporciona la aplicación de Flujo de Formularios a través de Jitterbit Marketplace. Construida con Jitterbit App Builder, es una aplicación de creación de formularios y recopilación de datos basada en plantillas. Los administradores ensamblan plantillas de formularios reutilizables a partir de secciones, formularios y campos, y luego los usuarios finales completan esas plantillas a través de un asistente guiado, paso a paso. Las presentaciones pasan por un ciclo de revisión y aprobación, con notificaciones por correo electrónico en cada etapa.

Descargas la aplicación como un paquete de lanzamiento de App Builder (un archivo .LP) desde Marketplace e instálala en tu propia instancia de App Builder, donde puedes configurarla y ampliarla para adaptarla a tu proceso.

Esta página describe cómo funciona la aplicación, sus características principales y modelo de datos, y cubre los requisitos previos, cómo descargar e instalar la aplicación, cómo configurarla para tu entorno, cómo se controla el acceso, y pasos comunes de solución de problemas.

Cómo funciona

A un alto nivel, el Flujo de Formularios pasa de construir una plantilla, a completar presentaciones en base a ella, a revisar esas presentaciones:

flowchart TD A["Administrator builds
a form template"] --> B["Define sections, forms,
fields, and visibility rules"] B --> C["Template available
for submissions"] C --> D["User starts
a submission"] D --> E["Complete the
guided wizard"] E --> F["Submit"] F --> G{"Reviewer
decision"} G -->|Approve| H["Submission locked,
approval email sent"] G -->|Request revision| I["Submission reopened,
revision email sent"] I --> E

Características principales

Cuando instalas y configuras el Flujo de Formularios, proporciona las siguientes capacidades:

  • Constructor de plantillas: Crea cuestionarios personalizados organizados en secciones y formularios, utilizando una variedad de tipos de campos que incluyen texto, área de texto, número, fecha, casilla de verificación, botón de opción, menú desplegable y contenido HTML.

  • Entrada de datos guiada: Los usuarios finales completan una presentación a través de un asistente con un árbol de navegación en el lado izquierdo que agrupa secciones y formularios en secuencia y rastrea el progreso a medida que avanzan.

  • Visibilidad condicional: Las reglas evalúan las respuestas de un usuario en tiempo real para mostrar u ocultar campos individuales o formularios completos, y para hacer que los campos sean obligatorios, basándose en respuestas anteriores.

  • Ciclo de revisión y aprobación: Cada plantilla designa un revisor. Cuando un usuario envía una entrada, esta pasa a un estado de revisión donde solo ese revisor puede aprobarla o rechazarla. La aprobación bloquea la presentación; el rechazo la reabre para ediciones.

  • Notificaciones por correo electrónico: La aplicación envía correos electrónicos en eventos clave del ciclo de vida (envío, aprobación y rechazo). El contenido del mensaje se basa en registros de plantilla configurables, por lo que los administradores pueden editar el texto sin cambiar la lógica de la aplicación.

Ciclo de vida y estados

Form Flow rastrea el estado de cada envío de usuario final (instancia) en dos niveles: el estado general del envío y el progreso de las secciones, formularios y campos individuales dentro de él.

Estado del envío

Un envío pasa por tres estados generales desde la creación hasta la aprobación:

flowchart LR IP["In Progress"] -->|Submit| UR["Under Review"] UR -->|Approve| C["Completed"] UR -->|Reject| IP
  • En Progreso: El estado inicial para un nuevo envío. Si el revisor rechaza una entrada enviada, regresa a este estado para que el usuario pueda hacer ediciones.

  • En Revisión: Se establece cuando el usuario envía. El envío pasa al revisor asignado.

  • Completado: Se establece cuando el revisor aprueba, lo que bloquea el envío.

Estados de secciones y formularios

A medida que un usuario trabaja en un envío, sus secciones y formularios avanzan a través de estos estados:

  • Las secciones y formularios comienzan como No Comenzado.

  • Una sección cambia a En Progreso cuando el usuario la abre, y un formulario cambia a En Progreso cuando el usuario responde su primer campo.

  • Al enviar, las secciones y formularios que están En Progreso se convierten en Enviados, y los que aún están No Comenzado se convierten en Omitidos.

  • Cuando el revisor aprueba, el estado general del envío se convierte en Completado, pero los estados de sección y formulario no cambian: permanecen como Enviados u Omitidos.

  • Si el revisor rechaza el envío, las secciones y formularios Enviados regresan a En Progreso y los Omitidos regresan a No Comenzado, para que el usuario pueda editar y volver a enviar.

Modelo de datos

Form Flow es completamente autónomo: almacena todas las plantillas, envíos y respuestas en sus propias tablas y no requiere una conexión a una base de datos externa.

Cada tabla tiene un tipo de uso de datos, establecido por su Opción de Instalación, que controla cómo se trata su datos cuando la aplicación se instala en un nuevo entorno: los datos de Desarrollador se reemplazan al instalar, los datos Compartidos se inicializan una vez, y los datos Usuario se dejan para que cada entorno los complete.

Tabla Tipo de uso Propósito
FieldType Desarrollador Registro de tipos de campo de entrada soportados.
TemplateStatus Desarrollador Estados del ciclo de vida del envío (En Progreso, En Revisión, Completado).
SectionStatus Desarrollador Estados de navegación y bloqueo de secciones.
FormStatus Desarrollador Estados de entrada y permisos del formulario.
Operator Desarrollador Operadores de comparación utilizados por las reglas de visibilidad.
VisibilityAction Desarrollador Resultados de visibilidad (Oculto, Visible).
Template Compartido Registro raíz para una plantilla de formulario reutilizable.
Section Compartido Un agrupamiento de formularios dentro de una plantilla.
Form Compartido Un paso individual dentro de una sección.
FormField Compartido Un solo campo de entrada y sus configuraciones.
FieldOption Compartido Valores de elección para campos de opción y desplegables.
FormVisibility Compartido Reglas que muestran u ocultan formularios completos.
FieldVisibility Compartido Reglas que muestran u ocultan campos individuales.
Parameter Compartido Configuraciones globales y valores de entorno.
WorkflowTemplate Compartido Plantillas de asunto y cuerpo de correo electrónico.
TemplateInstance Usuario Una ejecución única de un template por parte de un usuario final.
SectionInstance Usuario Estado de progreso para una sección dentro de una ejecución.
FormInstance Usuario Estado de progreso para un formulario dentro de una ejecución.
FieldResponse Usuario Una respuesta individual capturada de un usuario.

Nota

Eliminar un Template cascada a sus registros hijos Section, Form, FormField y FieldOption; eliminar un TemplateInstance cascada a sus registros hijos SectionInstance, FormInstance y FieldResponse. Estas acciones de eliminación están restringidas a administradores.

Requisitos

Para usar Form Flow, necesitas lo siguiente:

  • Una licencia de Jitterbit Harmony con acceso a App Builder. Esto habilita la descarga desde el Marketplace; si tu organización no está licenciada para App Builder, la acción Descargar app se reemplaza por una acción de solicitud Obtener app (ver Descargar e instalar).

  • Una instancia de App Builder que ejecute App Builder 4.63, la versión para la cual se construyó el paquete actual. Cada paquete se instala solo en su versión exacta de App Builder; si tu instancia está en una versión diferente, contacta a soporte de Jitterbit para solicitar un paquete correspondiente.

  • Una base de datos PostgreSQL para tu instancia de App Builder.

  • Un servidor de correo SMTP saliente configurado en tu instancia de App Builder. Las notificaciones de la app dependen de ello; sin el enrutamiento SMTP, las notificaciones por correo electrónico no se envían.

Descargar e instalar

Descargar la app desde Marketplace

  1. Inicia sesión en el portal de Harmony en https://login.jitterbit.com y abre Marketplace.

  2. Localiza la app llamada Form Flow. Puedes usar la barra de búsqueda o, en el panel de Filtros bajo Tipo, seleccionar App para mostrar solo apps.

  3. Haz clic en la tarjeta de la app para abrir el panel de Detalles. Revisa los Requisitos de la app (la versión de App Builder y la base de datos que necesita).

  4. Haz clic en el enlace Ir a la documentación de la app para abrir esta documentación en una pestaña separada y mantenla abierta como referencia.

  5. Haz una de las siguientes acciones, dependiendo de si tu organización está licenciada para App Builder:

    • Descargar app: Si tu organización está licenciada para App Builder, haz clic en Descargar app, ya sea en la tarjeta de la app o en el panel de Detalles. Tu navegador guarda el archivo .LP en su ubicación de descargas, y una notificación Archivo de App Builder descargado con éxito confirma la descarga.
  6. Obtener aplicación: Si tu organización no tiene licencia para App Builder, la acción se etiqueta como Obtener aplicación. El panel de Detalles muestra un mensaje que indica que se requiere una licencia de App Builder, con un botón de Enviar. Haz clic en Enviar para enviar una solicitud para que un representante se comunique contigo sobre App Builder; una notificación de Mensaje enviado con éxito lo confirma.

Instalar la aplicación en App Builder

Instala el archivo .LP descargado en tu instancia de App Builder:

  1. Inicia sesión en App Builder y ve a IDE.

  2. En Desplegar, haz clic en Instalar versión.

  3. Haz clic en + Paquete, luego en Examinar y selecciona el archivo .LP que descargaste.

  4. Haz clic en Guardar. El panel de Versión muestra la información del paquete, luego cierra el diálogo de Paquete.

  5. Confirma que los detalles sean correctos, luego haz clic en Instalar.

Para previsualizar el contenido de un paquete antes de instalarlo, haz clic en el botón Manifiesto.

Modificando la aplicación en un entorno de desarrollo

La fuente de datos de la aplicación se instala sellada. Si despliegas la aplicación en un entorno de desarrollo y tienes la intención de modificarla, desella la fuente de datos para que puedas editar los objetos de la aplicación. Déjala sellada en QA y producción para preservar la equivalencia entre entornos. Consulta Sellar o desellar una fuente de datos.

Configuración e instalación

Después de instalar la aplicación en un nuevo entorno, completa los siguientes pasos para prepararla para su uso:

  1. Asignar usuarios a grupos. Agrega a tus usuarios al grupo de acceso apropiado, ya sea Administrador de Flujo de Formularios o Usuario de Flujo de Formularios. Consulta Seguridad y acceso.

  2. Verificar formatos de correo electrónico de los usuarios. La notificación de rechazo se envía a la cuenta del creador de la presentación. Confirma que las cuentas de usuario utilicen direcciones de correo electrónico válidas para que las notificaciones se resuelvan correctamente. Consulta solución de problemas relacionada.

  3. Establecer la URL del entorno. En la configuración de Parameter, actualiza el valor de AppBuilderURL para que coincida con la URL raíz de tu entorno, de modo que los enlaces en las notificaciones por correo electrónico se resuelvan correctamente.

  4. Actualizar el revisor de la plantilla de muestra. La aplicación se envía con una "Plantilla de Incorporación de Empleados" de muestra. Ábrela y reemplaza el correo electrónico del revisor de marcador de posición en el campo ApproverEmail con una dirección válida y monitoreada.

La aplicación también incluye datos de búsqueda de muestra y una plantilla de muestra para que sus características funcionen inmediatamente después de la instalación.

Seguridad y acceso

Form Flow utiliza la seguridad basada en roles de App Builder con dos grupos de acceso, Administrador de Form Flow y Usuario de Form Flow. El acceso a cada área es el siguiente:

Área Administrador de Form Flow Usuario de Form Flow
Constructor de plantillas Acceso completo Crear y modificar plantillas
Espacio de trabajo de envíos Acceso completo Ver y comenzar envíos
Formularios de envío en vivo Acceso completo Completar entradas de formularios
Página de remediación de rechazos Acceso completo Solo lectura, accesible a través de acciones de flujo de trabajo
Datos de búsqueda y configuraciones Acceso completo Sin acceso (menús ocultos)
Eliminación de registros Acceso completo No permitido

Las acciones de aprobación y rechazo están disponibles solo para el revisor cuyo correo electrónico coincide con el ApproverEmail en la plantilla. Para todos los demás usuarios, esas acciones están deshabilitadas. Cuando se envía un envío, sus campos se vuelven de solo lectura; un rechazo del revisor los reabre para su edición.

Reglas de negocio

La lógica de Form Flow se implementa como reglas de negocio de App Builder. Los nombres de las reglas siguen la convención de Target (Purpose or Subtype) Descriptor de App Builder, por lo que la palabra inicial identifica la tabla sobre la que actúa la regla. Las tablas a continuación enumeran las reglas por área funcional para ayudarte a localizarlas y comprenderlas cuando extiendas la aplicación.

Reglas de configuración de plantillas

Regla Propósito
Template (Business Object) Gestiona los registros de configuración de la plantilla principal.
Template (List) Lista de selección de plantillas activas.
Section (Business Object) Gestiona los registros de diseño de secciones.
Section (List) Lista de selección de secciones configuradas.
Form (Business Object) Gestiona los registros de un solo paso de formulario dentro de una sección.
Form (List) Lista estructural utilizada para el mapeo de plantillas.
FormField (Form Fields) Agrega campos de formulario en el constructor de plantillas y controla el panel de opciones de campo.
FormField (List) Selector de campo utilizado al definir reglas de visibilidad, agrupado por sección y formulario.
FieldOption (Business Object) Gestiona listas de opciones para campos de selección.
FieldOption (List) Lista de referencia de valores de opción.

Reglas de tiempo de ejecución (instancia)

Regla Propósito
TemplateInstance (Business Object) Gestiona la ejecución de la presentación de un usuario.
TemplateInstance (Default) Status Establece una nueva instancia como En Progreso.
TemplateInstance (Navigation) Ordena secciones y formularios activos en el espacio de trabajo.
TemplateInstance (Reject Submission) Regresa a la página de rechazo y captura el motivo del rechazo.
TemplateInstance (Subquery) Navigation Steps Agrega índices de navegación para el seguimiento del progreso.
TemplateInstance (Subquery) Navigation Union Une la navegación de secciones y formularios en una sola lista.
TemplateInstance (Update) Status Completed Establece el estado de la instancia como Completada.
TemplateInstance (Update) Status In Progress Revierte el estado de la instancia a En Progreso.
TemplateInstance (Update) Status Under Review Escala el estado de la instancia a En Revisión.
FormInstance (Business Object) Rastrea un paso de formulario dentro de una ejecución.
FormInstance (Insert) Forms Clona instancias de formularios en vivo del template.
FormInstance (Subquery) Form Navigation Secuencia formularios para la lista de navegación.
FormInstance (Update) Status Change On Reject Al rechazar, establece Presentado a En Progreso y Omitido a No Comenzado.
FormInstance (Update) Status Change On Submit Al enviar, establece En Progreso a Presentado y No Comenzado a Omitido.
FormInstance (Update) Status In Progress Marca un formulario como En Progreso en la primera edición.
SectionInstance (Business Object) Rastrea una sección dentro de una ejecución.
SectionInstance (Insert) Section Clona instancias de sección en vivo del template.
SectionInstance (Subquery) Section Navigation Construye el nivel de sección de la lista de navegación.
SectionInstance (Update) Status Change On Reject Al rechazar, revierte los estados de la sección.
SectionInstance (Update) Status Change On Submit Al enviar, avanza los estados de la sección.
SectionInstance (Update) Status In Progress Marca una sección como En Progreso cuando se abre.
FieldResponse (Responses) Captura las respuestas del usuario en la página de presentación y aplica lógica de mostrar/ocultar y requeridos.
FieldResponse (Insert) Fields Clona registros de respuestas de los campos del template.
FieldResponse (Validation) Required Response Verifica los campos requeridos antes de avanzar al siguiente formulario o sección.
FieldResponse (Validation) Template Required Response Verifica todos los campos requeridos antes de la presentación final.

Reglas de visibilidad

Regla Propósito
FormVisibility (Business Object) Gestiona reglas que muestran u ocultan formularios completos.
FormVisibility (Subquery) Count By Template Devuelve el conteo de reglas de visibilidad de formularios por plantilla.
FieldVisibility (Business Object) Gestiona reglas que muestran u ocultan campos individuales.
FieldVisibility (Subquery) Count By Template Devuelve el conteo de reglas de visibilidad de campos por plantilla.
FieldResponse (Visibility) Marca un campo como requerido o disponible según las respuestas del usuario.
FieldResponse (Subquery) Field Visibility Action Resuelve el estado de visibilidad a nivel de campo.
FieldResponse (Subquery) Form Visibility Action Resuelve el estado de visibilidad a nivel de formulario.

Reglas de búsqueda y configuraciones

Regla Propósito
FieldType (Business Object) / FieldType (List) Gestiona los tipos de campo soportados.
TemplateStatus (Business Object) / TemplateStatus (List) Gestiona los estados del ciclo de vida de las presentaciones.
SectionStatus (Business Object) / SectionStatus (List) Gestiona los estados de las secciones.
SectionStatus (List) Form and Section Statuses Lista combinada de estados de formularios y secciones.
SectionStatus (Subquery) Navigation Statuses Une los estados de sección y formulario para el panel de navegación.
FormStatus (Business Object) / FormStatus (List) Gestiona los estados de los formularios.
FormStatus (Subquery) Form and Section Status Union Consolida los estados de formularios y secciones para indexación.
FormStatus (Subquery) Navigation Statuses Une los estados de formularios y secciones para el panel de navegación.
Operator (Business Object) / Operator (List) Gestiona operadores de comparación para reglas de visibilidad.
VisibilityAction (Business Object) / VisibilityAction (List) Gestiona los resultados de visibilidad (Oculto, Visible).
Parameter (Business Object) Proporciona acceso en tiempo de ejecución a configuraciones globales.
Parameter (Application Settings) Respaldan la página de configuraciones donde los administradores editan parámetros globales.

Reglas de notificación

Regla Propósito
Email (Submission Under Review) Envía la notificación cuando se presenta una solicitud.
Email (Submission Approved) Envía la notificación cuando se aprueba una solicitud.
Email (Submission Requires Revision) Envía la notificación cuando se rechaza una solicitud.
WorkflowTemplate (Business Object) Gestiona las definiciones del asunto y cuerpo del mensaje.
WorkflowTemplate (List) Lista de selección de plantillas de notificación.

Configurando reglas de visibilidad

Las reglas de visibilidad (en las tablas FormVisibility y FieldVisibility) controlan lo que un usuario ve según sus respuestas. Cada regla se define por las siguientes propiedades:

  • Campo de formulario fuente: El campo cuyo valor se monitorea.

  • Opción de campo: Una elección específica en un campo de selección (una opción de botón de radio o desplegable).

  • Operador: La comparación utilizada para evaluar la entrada.

  • Valor de comparación: El valor con el que se compara la entrada en vivo.

  • Acción de visibilidad: El resultado aplicado cuando la regla es verdadera, ya sea Oculto o Visible.

  • Formulario o campo dependiente: El objetivo cuyo display y requisito son cambiados por la regla.

Se imponen dos comportamientos al configurar una regla:

  • La selección directa y la expresión son mutuamente excluyentes. Se puede evaluar ya sea una opción de campo específica, o un operador y un valor de comparación, pero no ambos. Cuando se selecciona una opción de campo, el operador y el valor de comparación se borran y se bloquean.

  • Un campo oculto no puede ser requerido. Cuando la acción de visibilidad es Oculto, la configuración de requerido se desactiva, se deshabilita y se bloquea. Un campo solo puede hacerse condicionalmente requerido cuando su acción es Visible.

Nota

Las comparaciones de expresión se evalúan contra el Valor almacenado de una opción, no contra la Etiqueta mostrada en pantalla. Consulta la solución de problemas relacionada.

Solución de problemas

Una notificación de rechazo no se envía

  • Síntoma: Un revisor rechaza una presentación, pero el correo electrónico de notificación no se envía y los estados de la presentación no se revierten.

  • Causa posible: La notificación se envía a la dirección en la cuenta del creador de la presentación. Si esa cuenta utiliza un valor que no es una dirección de correo electrónico válida, el servidor SMTP no puede resolver el destinatario.

  • Resolución: Confirma que las cuentas de usuario utilicen direcciones de correo electrónico válidas. Alternativamente, actualiza la regla de notificación de rechazo para leer el destinatario desde un campo de correo electrónico dedicado en el perfil del usuario.

Una regla de visibilidad de menú desplegable nunca se evalúa como verdadera

  • Síntoma: Una regla de visibilidad que apunta a un campo de menú desplegable utiliza un operador y un valor de comparación, pero la regla nunca se evalúa como verdadera durante las pruebas.

  • Causa posible: La regla se evalúa en función del Valor almacenado de la opción, no de la Etiqueta mostrada en pantalla.

  • Resolución: Abre las opciones del campo y confirma que el valor de comparación de la regla coincida exactamente con la entrada en la columna de Valor de la opción.

Una presentación anterior muestra una opción con tachado

  • Síntoma: Cuando revisas una presentación anterior, un valor seleccionado de menú desplegable o lista aparece con una línea a través de él.

  • Causa posible: La respuesta almacenada se mapea a una opción que desde entonces ha sido desactivada en los datos de búsqueda.

  • Resolución: Esto es esperado. La aplicación preserva la respuesta original por precisión histórica y aplica un tachado para indicar que la opción ya no está disponible para nuevas presentaciones. No se requiere ninguna acción a menos que desees reactivar la opción.

Para obtener más ayuda, revisa los registros de tu App Builder y contacta a soporte de Jitterbit.