Presentación
La API xAPI (anteriormente Tin Can API) es una especificación de software para e-learning. Este tipo de software permite que el contenido y los sistemas de aprendizaje se comuniquen entre sí de una forma que registre todo tipo de experiencias de aprendizaje, que luego se almacenan en un Learning Record Store (LRS). Un LRS puede estar dentro de sistemas tradicionales de gestión del aprendizaje o existir de manera independiente.
Requisitos y limitaciones
- Docebo es compatible con el estándar Tin Can 1.0.
- El tamaño máximo de los archivos es de 2 GB.
- El contenido xAPI (Tin Can API) debe cargarse como un paquete ZIP.
- El LRS de Docebo funciona en conjunción con la plataforma Docebo; para poder vincular las actividades completadas por los usuarios con el progreso del curso, es necesario que reconozcan el ID de la actividad pasado en la declaración xAPI. Para que el LRS reconozca estos ID de actividad, cargue paquetes xAPI con un descriptor tincan.xml adecuado en ellos.
- Puede cargar contenido xAPI/TinCan a cursos de e-learning, formación guiada por un instructor (ILT) y formación virtual guiada por un instructor (VILT).
Carga de paquetes xAPI
Puede cargar un paquete xAPI desde su dispositivo o hacerlo a través de un enlace externo. Recomendamos cargar paquetes xAPI desde la página Material de formación, donde puede reutilizarlos en distintos cursos. También puede cargar paquetes xAPI directamente desde dentro de un curso: consulte Carga de archivos xAPI desde dentro de un curso.
Carga de archivos xAPI desde la página Materiales de formación
Para acceder a la página Material de formación, inicie sesión como Superadministrador o Usuario avanzado, abra el Menú de administrador desde el icono de engranaje en la esquina superior derecha de su plataforma y, en la sección E-learning, haga clic en Material de formación.
En el panel izquierdo, seleccione la carpeta a la que desee cargar los archivos, luego haga clic en el botón + Nuevo. El menú desplegable muestra dos opciones para xAPI:
- xAPI desde archivo: cargue uno o más paquetes xAPI desde su dispositivo, siguiendo los pasos que se detallan más abajo.
- xAPI desde URL: enlace un paquete xAPI a través de una URL externa. Consulte Enlazado de contenido xAPI como material de formación para obtener más instrucciones.
También puede iniciar esta carga desde el Centro de contenidos: abra el Menú de administrador desde el icono de engranaje en la esquina superior derecha de su plataforma y, en la sección E-learning, haga clic en Centro de contenidos. Haga clic en el botón + Nuevo y seleccione xAPI desde archivo.
Para cargar archivos xAPI desde su dispositivo:
- Seleccione hasta 20 archivos ZIP para cargar. Cada archivo puede tener hasta 2 GB de tamaño.
- Si está cargando desde el Centro de contenidos, seleccione la carpeta de destino desde el panel derecho.
- Una vez que se inicie la carga, aparecerá un panel en la esquina superior derecha de la pantalla. Si lo cierra, puede reabrirlo haciendo clic en el icono de nube (Subidas) en la esquina superior derecha. El panel muestra el estado en tiempo real de cada archivo.
- Puede navegar libremente dentro de la plataforma mientras se completan las cargas. Tenga en cuenta que actualizar la página o cerrar la pestaña interrumpirá todas las cargas en curso. El navegador mostrará una confirmación emergente antes de salir de la página.
- Para cancelar una carga específica, haga clic en la X junto al archivo correspondiente en el panel. Para cancelar todas las cargas en curso, haga clic en Cancelar en el panel.
- Una vez que la carga esté completa, puede hacer clic en el nombre del archivo para ir a la página de edición del material de formación, o bien hacer clic en el icono de carpeta para navegar a la carpeta donde se ha guardado el archivo.
Carga de archivos xAPI desde dentro de un curso
Aunque puede cargar paquetes xAPI directamente dentro de un curso, recomendamos usar en su lugar la página Material de formación, ya que admite cargas masivas y permite la reutilización en distintos cursos.
Desde el Menú de administrador (el icono de engranaje en la esquina superior derecha de su plataforma), busque el elemento Gestión de cursos en la sección E-learning. Busque el curso para el cual desee cargar el material de formación xAPI y haga clic en su descripción. Luego, vaya a la pestaña Materiales de formación.
Desde aquí, haga clic en Añadir material de formación y seleccione xAPI (Tin Can) en el menú desplegable.
La página de subida tiene tres pestañas: xAPI (Tin Can), Información adicional y Seguridad mejorada. En la pestaña Tin Can, seleccione Cargar archivo para seleccionar el archivo xAPI (Tin Can API) desde su dispositivo y configure si desea seguir todas las actividades en el paquete. Si lo marca (esta es la configuración predeterminada), la plataforma rastreará todas las actividades y subactividades. De esta manera, al completar el primer módulo del material de formación Tin Can (considerando que un material Tin Can está compuesto por varios módulos), todo el Tin Can se marca como completado. Si la opción Seguir todas las actividades no está seleccionada, solo se rastrearán las actividades principales del paquete, y todos los módulos deberán completarse para que el Tin Can se marque como completado.
La plataforma identifica el contenido Tin Can como completado cuando los alumnos pulsan el botón Cerrar (también llamado Salir o Enviar). No pulsar este botón puede dar lugar a que el progreso del aprendizaje no se envíe desde el paquete Tin Can a la plataforma y que el contenido Tin Can no se marque como completado. Por esta razón, se recomienda encarecidamente incluir una pantalla de finalización en sus paquetes Tin Can para que se muestre cuando el paquete Tin Can confirme que los datos de seguimiento han sido transferidos, así como para mostrar el botón Cerrar en esta pantalla.
Mientras se carga el archivo, vaya a la pestaña Información adicional para rellenar una descripción breve de su archivo y seleccionar una miniatura. También puede cambiar el título o la miniatura del material de formación más adelante.
También puede añadir etiquetas a su material de formación para que sea más fácil localizarlo en la búsqueda global de su plataforma. Si la función de etiquetado automático está habilitada en su plataforma, algunas etiquetas pueden generarse automáticamente en función del contenido de su material, según lo entienda su plataforma mediante el uso de la inteligencia artificial (tenga en cuenta que esto solo funciona para el contenido en inglés, español, francés, alemán, italiano y portugués). Puede editar o eliminar etiquetas en cualquier momento, con un límite de 15 etiquetas por material de formación y 32 caracteres por etiqueta (más información sobre los tipos de contenidos que pueden etiquetarse). Recuerde que, por motivos de seguridad, la inteligencia artificial de la plataforma no accede a contenidos privados (es decir, contenidos para cuyo acceso se requiera autenticación) y, por tanto, solo puede generar etiquetas automáticamente para contenidos públicos. Al cargar contenidos privados, le sugerimos que añada las etiquetas manualmente.
A tener en cuenta: La función de etiquetado automático puede tener problemas al procesar material de formación xAPI creado mediante determinadas herramientas de autoría que incrustan contenidos textuales directamente en archivos de programación y comprimen las imágenes de tal modo que su calidad no permite el Reconocimiento Óptico de Caracteres (OCR). Actualmente estamos trabajando para afrontar esta limitación colaborando con algunos de los principales proveedores de herramientas de autoría.
Cuando haya terminado, pulse Guardar cambios. Si el formato del archivo es correcto, el paquete xAPI se subirá como material del curso y se mostrará un mensaje en la parte superior izquierda de su pantalla.
Después de completarse la carga, llegará a la pestaña Materiales de formación. Haga clic en el icono de menú al final de la fila del material de formación xAPI y seleccione Configuración para configurar el material de formación. Al configurar el Modo de vista, tenga en cuenta que el Modo cine impide que los alumnos utilicen sus micrófonos. Si su contenido xAPI requiere acceso al micrófono, recomendamos seleccionar Reproducción en una nueva ventana en su lugar.
Enlazado de contenido xAPI como material de formación
Como opción para subir contenido xAPI desde su dispositivo, puede enlazarlo desde una URL externa. Como primer paso, debe crear una lista predefinida de URL fuente en la plataforma. Este paso asegura que la plataforma pueda reproducir el contenido para los alumnos. Para hacerlo, acceda al Menú de administrador y seleccione la opción Ajustes avanzados en la sección Configuración. Luego, vaya a la pestaña E-learning.
Vaya al campo Contenido externo xAPI (Tin Can) y añada la URL del material de formación en el campo de texto correspondiente. Puede añadir hasta 20 URL.
Para admitir URL adicionales, use un dominio comodín. Por ejemplo, introduzca http://www.domain.com/* sin especificar el nombre o extensión del archivo de contenido, e incluya un asterisco (*) al final de la URL. Al añadir material de formación a un curso, podrá especificar el nombre y la extensión del archivo individualmente (por ejemplo, file_name_1.zip después del dominio). Tenga en cuenta que los dominios comodín deben añadirse manualmente, no es posible hacerlo mediante API.
Al utilizar este método, el dominio introducido contará como una de las 20 URL permitidas, pero podrá añadir más de 20 contenidos xAPI externos.
Haga clic en Añadir para confirmar el dominio, que aparecerá listado bajo el campo de entrada.
Para añadir una clave Salt a una URL, haga clic en el icono de candado al final de la fila de la URL. Luego, introduzca y confirme la clave Salt y pulse la marca de verificación.
Si no añade una clave Salt, el tercero tratará el contenido como cualquier otro contenido xAPI lanzado desde su plataforma. Sin embargo, añadir una clave Salt genera una suma de verificación que valida el lanzamiento del contenido, permitiendo al tercero confirmar la autenticidad del mismo.
Cuando haya terminado, pulse Guardar.
Una vez que haya configurado las URL fuente, navegue a la página Material de formación. En el panel izquierdo, seleccione la carpeta a la que desee añadir el contenido, luego haga clic en el botón + Nuevo y seleccione xAPI desde URL. También puede hacerlo desde el Centro de contenidos. En este caso, tendrá que seleccionar la carpeta de destino en el panel lateral.
En la página de carga, seleccione la opción Desde URL, luego seleccione una URL del menú desplegable Seleccionar URL, que mostrará todas las URL añadidas en el paso previo.
Si selecciona un dominio comodín que no incluya el nombre y la extensión del archivo, aparecerá el campo Ruta adicional bajo el campo Seleccionar URL para que pueda insertar el nombre y la extensión del material de formación.
A tener en cuenta: Puede añadir la carpeta o subcarpeta en la que se encuentra su archivo, ya sea en el campo Seleccionar URL o en el campo Ruta adicional, lo que le ofrece una flexibilidad considerable a la hora de subir material de formación xAPI.
Introduzca un título y una descripción para el contenido en los campos de texto correspondientes. Luego, decida si desea seguir todas las actividades del paquete. Si habilita esta opción (que es la configuración predeterminada), la plataforma rastreará todas las actividades y subactividades. Si la deshabilita, solo se rastrearán las actividades principales del paquete.
Vaya a la pestaña Información adicional y, de forma opcional, configure una descripción breve para el contenido y seleccione una miniatura. También puede añadir etiquetas a su material de formación para que sea más fácil localizarlo en la búsqueda global de su plataforma. Si la función de etiquetado automático está habilitada en su plataforma, algunas etiquetas pueden generarse automáticamente en función del contenido de su material, según lo entienda su plataforma mediante el uso de la inteligencia artificial. El etiquetado automático se basa en la capacidad de la plataforma para extraer texto o generar una transcripción. Consulte la lista completa de tipos de contenidos admitidos para la extracción de texto y la generación de transcripciones. Puede editar o eliminar etiquetas en cualquier momento, con un límite de 15 etiquetas por material de formación.
Finalmente, vaya a la pestaña Seguridad mejorada, donde puede configurar la adición de un código OAuth a la URL de lanzamiento, y luego seleccionar el cliente OAuth del menú desplegable correspondiente. Haga clic en Guardar cambios para crear el material de formación.
También puede enlazar contenido xAPI desde dentro de un curso: navegue a la pestaña Materiales de formación del curso correspondiente, haga clic en Añadir material de formación, seleccione xAPI (Tin Can), seleccione la opción Desde URL y siga los mismos pasos desde la selección de una URL en adelante.
Gestión de la configuración del material de formación
Una vez cargado el material de formación, puede gestionar su configuración como se describe en el artículo Gestión de la configuración y los requisitos previos del material de formación.
Buenas prácticas
-
Si desea rastrear su paquete xAPI (Tin Can) en remoto, deberá cargar el paquete directamente a su plataforma. Su plataforma Docebo no admite el rastreo completamente anónimo. Si desea enviar declaraciones xAPI (Tin Can) a nuestra plataforma, puede hacerlo a través del siguiente formato de enlace:
https://www.lmsaddress.com/tcapi/. Además, los usuarios deben tener una dirección de correo electrónico válida asociada a su cuenta para que la plataforma almacene datos de seguimiento para materiales de formación xAPI. - Recomendamos cargar y gestionar sus materiales de formación xAPI desde la página Material de formación, donde puede cargar múltiples archivos a la vez y reutilizarlos en varios cursos.