Integraciones de listas

Acerca de OneRoster

Este método para integrar datos de listas en Quaver requiere que envíe un conjunto de archivos .csv (valores separados por comas) que cumplan con el formato IMS Global OneRoster (1.0 o 1.1). El conjunto de archivos de OneRoster describe las relaciones entre escuelas, usuarios, cursos, sesiones académicas, clases e inscripciones. Si bien la información solicitada por el formato OneRoster supera las necesidades de Quaver, Quaver admite la especificación OneRoster debido a su amplia aceptación como formato de intercambio de datos. En una integración de listas de OneRoster CSV con Quaver, los archivos de OneRoster se entregarán regularmente a través de sFTP para garantizar que toda la información de listas del distrito permanezca actualizada en el sistema de Quaver.

Quaver acepta los formatos OneRoster 1.0 y OneRoster 1.1. Si su distrito está produciendo una exportación de OneRoster únicamente para Quaver, sugerimos el formato 1.1, ya que es el formato más simple de producir y proporciona todos los datos que Quaver necesita para respaldar una integración de listas.
Con eso en mente, las instrucciones presentadas en las siguientes páginas pretenden simplificar la información proporcionada por el IMS Global Learning Consortium con respecto a la producción del formato OneRoster 1.1. Quaver no requiere que se envíen todos los campos. También puedes ver Especificaciones OneRoster de IMS Global.
Recuerda que una integración de rostering con Quaver requiere que también nos integremos con un Single Sign On (SSO) utilizado por su distrito.

Descripción general del formato OneRoster

De conformidad con el formato de intercambio de datos de IMS Global OneRoster v1.0, se requieren los siguientes siete archivos/tablas de datos. Tenga en cuenta que cada tabla de datos es un archivo .csv (valores separados por comas). El desglose de cada uno de los archivos enumerados a continuación se puede encontrar aquí.

• orgs.csv – La tabla de datos de organizaciones describe las organizaciones que se incluirán en la información de la lista. Por lo general, las organizaciones son escuelas o distritos. Cada fila debe ser una organización (escuela o distrito). Nota: Quaver no recopila esta información pero requiere la fila de encabezado para que la tabla cumpla con el formato OneRoster.
• usuarios.csv – La tabla de datos de usuarios describe los distintos usuarios de la organización (profesores, estudiantes, administradores, personal de TI). Incluye los nombres reales de los usuarios, así como sus direcciones de correo electrónico, nombres de inicio de sesión y otra información. Cada fila representa un usuario.
• sesionesacadémicas.csv – La tabla de datos de sesiones académicas describe los trimestres, semestres o términos durante los cuales se impartirán las clases. Cada fila representa un término con un título y fechas de inicio y finalización.
• cursos.csv – La tabla de datos de cursos establece el curso al que pueden pertenecer varias clases. Cada fila representa un curso como "Música general". Nota: Quaver no recopila esta información pero requiere la fila de encabezado para que la tabla cumpla con el formato OneRoster.
• clases.csv – La tabla de datos de clases enumera las clases impartidas para cada curso, incluido el nivel de grado y el título de la clase. Cada fila representa una clase, por ejemplo, "Música, 5.º período".
• inscripciones.csv – La tabla de datos de inscripciones asigna usuarios a sus diversas clases. Cada fila designa a un usuario que pertenece a una clase.
• datos demográficos.csv – La tabla de datos demográficos describe el sexo, el origen étnico, la fecha de nacimiento y otra información de cada usuario. Nota: Quaver no recopila esta información pero requiere la fila de encabezado para que la tabla cumpla con el formato OneRoster.

Si su distrito tiene la intención de establecer Registro automático debe enviar más archivos .csv de los necesarios para una integración estándar de OneRoster CSV. por favor refiérase a Página de registro automático para obtener detalles sobre qué campos adicionales se requieren en los archivos anteriores. Los archivos adicionales requeridos son los siguientes:

• recursos.csv – La tabla de datos de recursos contiene información sobre los recursos que se utilizarán para vincular a un maestro a una licencia de Quaver a través de una clase o curso. Esta tabla requiere un valor único para el recurso, así como el ID del proveedor (Quaver) y el ID del recurso del proveedor.
• classResources.csv – La tabla de datos de recursos de clase se utiliza para vincular un recurso de recursos.csv a una clase, lo que permite que el profesor de esa clase reciba el recurso. Esta tabla requiere un sourcedID para cada entrada, así como sourcedIDs tanto para la clase como para el recurso que se está vinculando.
• recursosdelcurso.csv – La tabla de datos de recursos del curso se utiliza para vincular un recurso de recursos.csv a una clase, lo que permite que cualquier profesor que sea propietario de una clase en ese curso reciba el recurso. Esta tabla requiere un sourcedID para cada entrada, así como sourcedIDs tanto para el curso como para el recurso que se está vinculando.

El formato es un modelo en el que se pueden mapear los datos de su organización. ¡No se preocupe si su estructura de datos no se ajusta exactamente al modelo! Las especificaciones detalladas de cada archivo explican claramente la información que Quaver requiere para crear listas de clases, que es una pequeña fracción de lo que el formato puede acomodar. Con gusto lo ayudaremos con cualquier pregunta que tenga sobre cómo mapear mejor sus datos.

Si bien Quaver preferiría recibir tablas de datos que incluyan solo información relacionada con las clases de música, no requerimos que los distritos filtren esos datos antes de enviárnoslos. Por lo tanto, no creamos clases de Quaver para un maestro en nuestro sistema hasta que se cumplan las dos condiciones siguientes:

1. El maestro inició sesión en Quaver a través de SSO usando una cuenta que puede coincidir con un maestro enviado en el archivo users.csv de OneRoster.
2. El maestro ha registrado un código de acceso al contenido de Quaver válido en su cuenta de Quaver. El código activa todo el contenido relevante para ese maestro, y lo interpretamos como una señal para crear las listas de clases del maestro. Por lo general, a los maestros se les envían sus códigos de acceso por correo electrónico fuera de este proceso de asignación de turnos. Si los maestros tienen preguntas sobre su código de acceso, deben comunicarse con su supervisor o con el representante de cuentas clave de Quaver. Nota: Las cuentas de estudiantes registradas no necesitan ingresar un código de acceso al contenido para obtener acceso al contenido de los estudiantes.

Directrices de entrada de datos de OneRoster

Cuándo ingresar datos en un campo:

• Si se requiere un campo, DEBE incluir un valor válido para ese campo en cada fila. En ocasiones, este valor no se utiliza en nuestro sistema, aunque se requiere en el formato OneRoster.
• Si se recomienda un campo, se utilizará dentro del programa Quaver, pero su inclusión es opcional.
• Si un campo no es obligatorio, no se usa dentro del programa Quaver ni es requerido por la especificación de OneRoster. Si está creando estos archivos desde cero, puede ser más fácil dejar estos campos en blanco. Incluso si no ingresa datos en campos no obligatorios, aún debe incluir el encabezado de ese campo en el archivo. Ingrese el encabezado del campo especificado en la parte superior de la columna y deje los campos de esa columna en blanco en las filas restantes (un campo en blanco en un archivo .csv parece dos comas consecutivas: ,, ).
• Quaver no utiliza ningún dato contenido en las tablas de datos orgs.csv, cursos.csv o demográficos.csv, pero son requeridos por la especificación de OneRoster. Usted puede:
  • Envíe estas tablas de datos con solo la fila de encabezados de campo y ningún otro dato (preferido).
  • Presentar los archivos con datos, de acuerdo con las especificaciones.
• Quaver solo acepta conjuntos masivos de OneRoster. No aceptamos conjuntos de archivos delta en este momento. Según las especificaciones de OneRoster, deje el estado y  fechaÚltimaModificación campos en blanco en cada archivo.

Formateo de datos en un campo:

• La primera fila de cada archivo .csv debe contener solo y todos los nombres de encabezado de campo especificados, enumerados de izquierda a derecha en el orden especificado. (Los nombres de encabezado de campo no distinguen entre mayúsculas y minúsculas).
• Si necesita enumerar varios valores en un solo campo que pueda acomodarlos, enumere los valores separados por comas y encierre todo el conjunto entre comillas dobles. (por ejemplo, "123456, 654321",...)

Antes de que pueda entregar sus archivos de lista para producción en QuaverMusic.com, debe proporcionar la dirección IP pública de la máquina que entregará sus archivos de lista. Proporcione esta IP al equipo de integraciones de Quaver en integracion@quavered.com.

Entrega de archivos de OneRoster

Paso 1: Conéctese a través de sFTP

Una vez que hayamos incluido su dirección IP en la lista blanca, nos pondremos en contacto con el agente de TI de su distrito y le enviaremos las credenciales de conexión sFTP (dominio, nombre de usuario y contraseña) por correo electrónico. Debe usar estas credenciales para conectarse con el servidor de Quaver usando sFTP. Puede establecer esta conexión utilizando cualquier cliente sFTP compatible. Quaver opera en el puerto sFTP predeterminado 22. Una conexión exitosa se abrirá automáticamente al directorio raíz de su distrito.

Paso 2: Entregar archivos de lista

Localice los archivos de OneRoster en su sistema de archivos local y cargue los archivos de OneRoster en su directorio raíz en el servidor de Quaver. Asegúrese de que todos los archivos tengan el nombre exactamente como se especifica antes de la transferencia y verifique que la transferencia de cada archivo se haya completado correctamente.

Por favor, hazlo NO:

• Cargue cualquier archivo adicional en el directorio raíz
• Entregar un conjunto de archivos comprimidos
• Mantenga los archivos de respaldo en el directorio raíz

Paso 3: prueba de usuario

Después de que su primer conjunto de archivos se entregue a producción, necesitaremos probar con un maestro de Quaver en el distrito para asegurarnos de que sus listas se construyan correctamente cuando pasan por el flujo de trabajo típico. Debe identificar a un maestro que actualmente use Quaver y esté dispuesto a participar. Cuanto más receptivo pueda ser este maestro, más rápido podrá proceder la evaluación.

La prueba implica dos pasos:

1. El maestro iniciará sesión en Quaver utilizando el método de inicio de sesión único de su distrito. Luego, verán el aprovisionamiento de nuestra cuenta. El maestro iniciará sesión en Quaver utilizando el método de inicio de sesión único de su distrito. Luego, verán nuestra página de aprovisionamiento de cuentas. Cuando se le solicite, el maestro debe seleccionar “Vincular cuenta de QuaverEd existente” e ingrese sus credenciales de cuenta de Quaver. Obtenga más información sobre este paso de aprovisionamiento de cuentas.

2. El maestro evaluador deberá verificar sus Clases y Cuentas de estudiantes en la sección Administrador de estudiantes del Panel del maestro. Si la prueba es exitosa, el maestro debería ver que sus listas se completan automáticamente.

Paso 4: programar la entrega regular de archivos

Una vez que verificamos que un maestro recibe sus clases a través del flujo de trabajo establecido, puede configurar una transferencia de archivos recurrente. Puede enviar conjuntos de archivos actualizados al servidor de producción con una frecuencia diaria. Mantener sus archivos actualizados garantiza que los maestros siempre reciban clases de Quaver que coincidan con los datos del SIS de su distrito. Procesamos los archivos todas las noches, así que asegúrese de que su transferencia de archivos haya terminado antes de las 4:00 a. m., hora central.

Paso 5: liberación

Recuerde que una integración de SSO debe acompañar a una integración de registro. Por lo tanto, antes de lanzar esta funcionalidad en todo el distrito, debemos confirmar que:

1. Tanto un maestro como un estudiante de Quaver han iniciado sesión en Quaver usando el enlace SSO con éxito.
2. El maestro de Quaver que inició sesión usando el enlace SSO ha visto que sus listas aparecen correctamente en Quaver.

Una vez que hayamos confirmado que el enlace SSO y las listas funcionan correctamente, puede iniciar la funcionalidad en todo el distrito cuando lo desee. Debe notificar a sus usuarios de Quaver cuando la funcionalidad esté disponible y usted es responsable de capacitar a sus usuarios sobre cómo acceder a Quaver desde el sistema de su distrito. Puedes compartir nuestro instrucciones de aprovisionamiento de cuenta con los usuarios de su distrito para facilitar su transición al uso de SSO para acceder a Quaver.

Paso 6: Soporte

Quaver continuará apoyando la integración de listas con su distrito durante el plazo de nuestro contrato. Estamos comprometidos a brindar soporte receptivo para nuestras integraciones y trabajaremos con usted para resolver cualquier problema que pueda surgir. Si necesita modificar el SSO de su distrito o la configuración de la lista en cualquier momento, notifíquenos antes de realizar cualquier cambio para que podamos brindar acceso ininterrumpido a sus usuarios de Quaver.

Nota: Esto es especialmente cierto al cambiar su esquema sourcedId, lo que interrumpirá la experiencia de sus usuarios en QuaverMusic.com. Notifíquenos antes de realizar cambios en el esquema de sourcedId en sus archivos de lista.

Configuración de la API del campus infinito

Cómo configurar el intercambio de datos API de Infinite Campus con Quaver

Paso 1: Genere las credenciales de API de InfiniteCampus para QuaverEd

1. Inicie sesión en Infinite Campus como administrador
2. Navegue hasta Administración del sistema > Interoperabilidad de aprendizaje
3. Presione Agregar aplicación, luego desplácese hasta la parte inferior y haga clic en Conectarse a otras aplicaciones
4. En el campo Nombre de la aplicación, ingrese "QuaverEd"
5. Para la versión de OneRoster, seleccione OneRoster 1.1 con OAuth 1.0 y haga clic Generar

Tenga en cuenta el campus infinito Nombre de host de la API (URL base), Clave del consumidor y Secreto del consumidor – serán necesarios para completar la Integración Infinite Campus en QuaverEd.

Paso 2: comparta las credenciales de la API de QuaverEd con el soporte de integraciones de QuaverEd

Póngase en contacto con nuestro equipo de soporte de integraciones en integracion@quavered.com y proporcione las credenciales generadas en el Paso 1. El equipo de integración de Quaver configurará nuestros sistemas para usar su conexión API de InfiniteCampus para registrar a los estudiantes y maestros que inician sesión a través de su método SSO seleccionado.

Paso 3: Pruebas

Para probar que la sincronización de la lista funciona correctamente, haga que un maestro de Quaver con licencia inicie sesión a través de una cuenta configurada. Single Sign On plataforma. Cuando un maestro con licencia de Quaver ha iniciado sesión con éxito a través de SSO y llegaron a su cuenta de Quaver, deberían ver sus listas activadas en Quaver.

Recuerde que una integración de listas de InfiniteCampus con QuaverEd también requiere que los usuarios puedan iniciar sesión a través de una integración de inicio de sesión único.

Paso 4: liberación

Cuando hayamos confirmado que todo funciona como se esperaba, seguiremos adelante y publicaremos su integración por nuestra parte.

Todos los profesores de corchea debe: iniciar sesión a través de un configurado Inicio de sesión único plataforma para activar la sincronización de la lista con Quaver.

Acerca del registro automático

Una integración de registro automático proporciona automáticamente los niveles de acceso apropiados y crea cuentas para sus maestros utilizando sus datos de OneRoster. Al hacerlo, esta integración elimina la necesidad de que los maestros registren su Código de acceso de maestros para obtener acceso a Quaver. Para hacer esto, usamos el nombre y el correo electrónico del maestro junto con sus escuelas asociadas para determinar su acceso y crear su cuenta. Se puede lograr una integración simple proporcionando los siguientes datos con un SSO y la integración de listas:

• Nombre, apellido, correo electrónico, función (es decir, profesor, alumno, etc.)
• OneRoster organizaciones datos con ID NCES en el campo "identificador".

Nota: Si no se proporcionan los datos de las organizaciones de OneRoster, los maestros pueden tener la opción de seleccionar con qué escuelas están asociados.

Se puede lograr una integración más granular utilizando el conjunto de datos de recursos del formato OneRoster. Se puede configurar una integración utilizando el servicio de recursos de OneRoster a través de OneRoster.CSV enviados a través de SFTP, o con API ClassLink OneRoster (otras API no admiten actualmente el servicio de recursos). Este servicio es principalmente útil si desea controlar qué maestros tienen acceso o si tienen varios productos de QuaverEd. Estos son los datos que necesitamos para proporcionar este servicio:

• Un SSO o integración de listas que proporciona los siguientes datos para los usuarios docentes: nombre, apellido, correo electrónico.
• OneRoster organizaciones datos con ID NCES en el campo "identificador".
• OneRoster recursos datos con "vendorResourceIds" apropiados (QuaverEd los proporcionará)
• OneRoster claseRecursos y cursoRecursos para asociar los recursos de QuaverEd con la clase inscrita de un maestro.
• Profesores en OneRoster usuarios están asociados con una organización que tiene una licencia válida de QuaverEd y están inscritos como maestros en una clase con el recurso adecuado.

Es importante tener en cuenta que una integración de la lista con Quaver requiere que también integremos a través de Single Sign On (SSO) para su distrito. Para configurar una integración de registro automático, comuníquese con el departamento de integración en Integration@Quavered.com.