Objetivo

Este instructivo explica cómo crear, programar, compartir y utilizar una Distribución de datos en Vor-Tex. También muestra cómo suscribirse desde el portal para desarrolladores y consultar o descargar los resultados de las ejecuciones. En el video se muestra el recorrido completo, desde el asistente hasta la descarga del archivo en el portal.

Antes de comenzar

• Necesita una API publicada con el método que va a ejecutar la distribución, y un usuario de la cuenta con acceso a ese método para usarlo como ejecutor.
• Si va a compartir con un grupo, créelo antes en Configuraciones › Cuenta › Grupos.

Crear una distribución de datos

1. Ingrese a Distribuciones de datos desde el menú lateral y haga clic en Nueva distribución de datos.

   

2. En el paso Descripción, complete el Título y la Descripción y haga clic en Continuar.

3. En el paso Programación, defina cuándo debe ejecutarse: elija una frecuencia (por hora, diaria, semanal o mensual) y la hora, o escriba una expresión cron. Revise la descripción generada. Mantenga marcada la opción Activo para habilitar la creación periódica de instancias; puede desmarcarla para pausar la distribución. Marque Permitir a los suscriptores adjuntar el resultado si desea que el suscriptor pueda recibir el archivo adjunto en su correo. Haga clic en Continuar.

4. En el paso Método API, seleccione el método que ejecutará la distribución, el formato de salida y complete los parámetros requeridos. Elija el Modo de ejecución:

   • Ejecución única (un ejecutor): ejecuta el método una vez con las credenciales del Usuario ejecutor que elija.
   • Una ejecución por usuario suscrito: ejecuta el método una vez por cada usuario suscripto, con las credenciales de cada uno.

5. Configure la Plantilla de evaluación, una plantilla Jinja que decide si la respuesta del método se considera exitosa: debe devolver True para indicar éxito o False en caso contrario. Si la deja vacía, cualquier respuesta correcta del método cuenta como éxito. Haga clic en Guardar.

Verificar y ejecutar la distribución

Después de guardar vuelve al listado; al abrir la distribución se ve su ficha: la próxima ejecución, los contadores de instancias en progreso, fallidas y exitosas, y el historial. Si necesita generar una instancia sin esperar la programación, use Ejecutar ahora: la instancia aparece en el historial en progreso y, cuando el método responde, pasa a Éxito con el archivo generado para descargar.

Compartir la distribución

En el listado, seleccione la distribución y abra la acción de compartir. En la ventana, elija los usuarios, grupos o roles que podrán verla y suscribirse, revise la lista de destinatarios y haga clic en Guardar.

Suscribirse desde el portal para desarrolladores

1. Ingrese al portal para desarrolladores y desplácese hasta la sección Distribuciones de datos de la página de inicio.

   

2. En la pestaña Disponibles, localice la distribución y haga clic en Suscribirse. Desde esta vista también puede consultar el detalle y la próxima ejecución.

3. Una vez suscripto, la distribución aparece en Mis suscripciones. Desde allí puede ver el detalle, activar o desactivar las notificaciones por correo, pedir el resultado adjunto si la distribución lo permite, y cancelar la suscripción.

Suscribirse solo da acceso a los resultados desde el portal. Para recibir un aviso por correo hay que activar la notificación en la suscripción; el adjunto es opcional y solo aparece si fue habilitado en la configuración de la distribución.

Consultar y descargar resultados

Al abrir Ver detalle se muestra el historial de ejecuciones, con filtros por estado: todas, exitosas, fallidas o en progreso. Antes de la primera ejecución el historial está vacío. Cuando una ejecución finaliza correctamente, el registro muestra la fecha, el estado Éxito y el archivo generado: haga clic en Descargar para obtenerlo.

Resultado esperado

La distribución queda programada y disponible para los usuarios, grupos o roles con los que fue compartida. Los usuarios pueden suscribirse, recibir notificaciones, recibir el resultado adjunto si fue habilitado, consultar el historial y descargar los archivos de cada ejecución exitosa.

Errores frecuentes

• La instancia queda en Fallida: el método respondió con error, el usuario ejecutor no tiene acceso al método, o la plantilla de evaluación devolvió False. Revise el error de la instancia en la ficha.
• El desarrollador no ve la distribución en Disponibles: no fue compartida con su usuario, grupo o rol.
• No se generan instancias: la distribución está desactivada. Edítela y marque Activo.
• En el modo por suscriptor no se ejecuta nada: todavía no hay usuarios suscriptos; las instancias se crean una por cada suscripción.

Artículos relacionados

• Gestionar grupos de usuarios
• Crear métodos de APIs
• Probar un método