Es importante tener en cuenta que en el contexto de este documento, el uso del término "instantánea" pertenece al proceso general de la toma de datos puntuales de SIS que se almacenan en un archivo sin formato que, a continuación, es consumido por Learn, no el controlador de instantáneas.
Una instantánea proporciona la capacidad de integrar mediante datos puntuales según se haya aprovisionado en SIS con dos tipos de integración compatibles (léase: formatos de datos) en el marco de trabajo SIS para Instantánea: XML de Instantánea y Archivo de instantánea sin formato (o datos delimitados). Este último, el archivo de instantánea sin formato, es el formato compatible "en adelante" y recibirá actualizaciones para ofrecer compatibilidad a los nuevos objetos de datos. La instantánea XML solo recibirá actualizaciones de mantenimiento.
El procesamiento de ambos tipos de integración de instantáneas se realiza a través de una publicación HTTP del archivo de datos en el extremo adecuado.
Datos compatibles
| Objeto de datos | Compatibilidad con achivos de instantánea sin formato | Compatibilidad con instantáneas XML |
|---|---|---|
| Usuarios | Sí | Sí |
| Cursos | Sí | Sí |
| Afiliaciones (Inscripciones y actividades del personal) |
Sí | Sí |
| Categorías de catálogo | Sí | Sí |
| Organizaciones | Sí | Sí |
| Observadores | Sí | Sí |
| Roles institucionales | Sí | Sí |
| Nodos | Sí | |
| Cursos en todas las listas | Sí | |
| Periodos | Sí | |
| Estándares (como atributo de curso) | Sí |
Requisitos
La capacidad de SIS de generar datos con el formato para el tipo de integración elegida: instantánea XML o archivo de instantánea sin formato con el delimitador adecuado.
Un punto en el que vale la pena insistir es que el controlador de instantáneas y el formato de datos de instantánea XML no deben ser la primera opción de integración elegida ya que solo recibirán actualizaciones de mantenimiento y no recibirán compatibilidad con nuevos objetos ni el desarrollo de funciones. Se espera que en algún momento en el futuro, se realizará el anuncio de la retirada del soporte con el margen de tiempo suficiente para el ajuste del cliente.
Consulte Enterprise 1.1 en la sección de ejemplos para obtener muestras de datos. Tenga en cuenta que el formato de datos es ligeramente diferente entre las dos vertientes compatibles de Enterprise 1.1 (estándar y Vista).
Instalación: Tipos de integración de instantáneas
Además de comprender los datos involucrados en cualquier integración SIS, la configuración de los tipos de integración de instantáneas requieren los conocimientos de las funciones de SIS y los extremos, y debe tenerse en cuenta si los objetos de datos compatibles en el tipo de instantánea seleccionado cumplen con los objetivos de integración del cliente. Además, es necesario comprender el formato de archivo específico. Puede crear una integración de instantáneas mediante los pasos siguientes en la interfaz del usuario de la integración de SIS del administrador del sistema de Learn: Integración de datos > Integraciones del sistema de información de estudiantes
Los pasos a continuación son los mismos para ambos tipos de integración de instantánea, la diferencia clave de la selección del tipo de integración es si los datos son XML (elija XML de instantánea) o delimitados (archivo de instantánea sin formato).
- Seleccione Crear integración
- Seleccione Instantánea XML o Archivo de instantánea sin formato
- En la pantalla siguiente se le presentarán opciones editables para la configuración:
Para realizar la configuración avanzada (asignación de datos, por ejemplo) debe establecerse una integración en estado de Prueba o Activo.
- Nombre de integración: introduzca Instantánea XML o Archivo de instantánea sin formato
- Descripción (opcional): escriba la descripción que desee para la integración. Por ejemplo: Probar Instantánea XML o Probar archivo de instantánea sin formato
- Se utiliza un nombre de usuario compartido para las operaciones de publicación de datos ya que cuenta con contraseña compartida.
- Configure el estado de la integración:
- Inactiva: la integración no realiza ningún procesamiento.
- Activa: la integración realiza procesamientos y actualizaciones de los datos de Learn.
- Prueba: la integración realiza procesamientos y actualizaciones de los datos de Learn.
- Configuración de los niveles de detalle del registro: se recomienda que para las pruebas se seleccionen todos los mensajes de diagnóstico y de depuración. Para Activa, se recomienda el uso de una configuración inferior como Solo errores o Errores y advertencias.
- A continuación, seleccione la clave de origen de datos (DSK) a utilizar para esta integración. Puede seleccionar utilizar un DSK existente específico, crear una nueva clave o utilizar el origen de datos proporcionado en la fuente. Tenga en cuenta que en todos los casos debe crearse un DSK antes de que se procesen las fuentes de datos.
- Únicamente los archivos de instantánea sin formato son compatibles con la gestión de nodos principales. Seleccione adecuadamente para satisfacer los objetivos del cliente.
- Finalmente, seleccione los objetos gestionados por esta integración y cómo gestionar la paridad. Normalmente, las opciones predeterminadas están bien.
- Tenga en cuenta que es posible que tenga múltiples tipos de integración, cada uno encargándose de un único subconjunto de objetos de integración disponible.
- Envíe y su nueva integración de instantánea aparecerá en la lista de integraciones.
Debe completarse un paso más para admitir la integración de instantáneas y es la configuración del sistema SIS para que publique datos en Learn o la configuración de un servidor de aplicación en cron o una tarea por lotes para publicar datos en Learn. Tenga en cuenta que los extremos de instantánea son específicos de la tarea necesaria a realizar.
La publicación por parte del servidor de aplicaciones en Learn se logra mediante CURL o una aplicación similar activada por un cron o una tarea por lotes:
curl -k -w %{http_code} -H "Content-Type:text/plain" -u SHARED_USERNAME:SHARED_PASSWORD --data-binary @PATH_TO_TEST_FILE ENDPOINT_URL
Realice los siguientes reemplazos:
SHARED_USERNAME por el nombre de usuario compartido
SHARED_PASSWORD por la contraseña compartida
PATH_TO_TEXT_FILE por la ruta al archivo de datos xml
Replace ENDPOINT_URL por la dirección URL de extremo.
En la página de Información de HTTP en el menú contextual de su integración de archivos sin formato, podrá ver una lista de los extremos en el servidor:
Administrador del sistema (Building Blocks) > Integración de datos > Integraciones del sistema de información de estudiantes > (Menú contextual de su integración) > Información de HTTP
Si es compatible con una aplicación de nivel medio o con SIS, los datos pueden publicarse directamente en el extremo tras el protocolo anterior.
Una vez se ha completado lo anterior y se ha activado SIS para que genere datos y los publique o los guarde en un archivo para su publicación en Learn, debería empezar a ver registros en la integración.
Evalúe los datos y determine si necesita realizar ajustes con la Configuración avanzada/Asignación de campos en los objetos de datos disponibles. Consulte la sección sobre Asignación de campos al final de la sección de ejemplos para obtener una descripción de esta función.
Para obtener más información acerca del procesamiento de los archivos de datos, consulte Automatización de los archivos de instantánea sin formato.
Integraciones de instantánea
Las integraciones de instantánea se basan en conjuntos de datos que cumplen con propósitos específicos. Por ejemplo, para gestionar usuarios o cursos en el sistema. De los dos tipos admitidos, XML de instantánea y archivo de instantánea sin formato, solo el archivo de instantánea sin formato puede considerarse como el más actualizado con los objetos de datos compatibles de Learn.
Como sucede con todos los tipos de integración "basadas en archivos" (tipos de instantánea y Enterprise 1.1), existen dos procesos para el consumo de datos en estos archivos: el uso de un archivo de fuentes de carga de la interfaz gráfica del usuario o el uso de una transferencia de datos HTTP (por ejemplo: cURL). En el caso de la transferencia de datos HTTP, puede utilizarse cron o a una tarea por lotes para activar la operación. Además se incluye, compatible con SIS o nivel medio, la opción de publicar directamente un flujo de datos.
Cada una de las operaciones se realiza mediante un extremo específico. Estos extremos del servidor de aplicaciones están disponibles a través del enlace de información HTTP de las integraciones desde el menú contextual.
Extremos de instantánea
Extremos de operación de instantáneas para los archivos sin formato
Utilice esta información para configurar sus archivos de introducción de instantánea sin formato POST a SIS para su integración. Los objetos almacenados van a seguir existiendo y conservando sus datos. Los objetos eliminados van a borrarse. La Actualización completa va a eliminar cualquier objeto existente que no se encuentre en el archivo de introducción. Fallará la publicación de un archivo de un tipo de objeto específico a un extremo que no concuerde. Por ejemplo: fallará la publicación de un archivo de datos de curso a un extremo de persona.
La desactivación de un curso desactivará las afiliaciones de ese curso. Este es un nuevo comportamiento.
También puede encontrar la URL del extremo de una operación en la interfaz de usuario de Blackboard Learn. Diríjase al Panel del administrador > Integración de datos > Integraciones del sistema de información de estudiantes. Busque la integración, abra el menú y seleccione información de HTTP. The integration's endpoint URLs are listed.
| Operación | URL de extremo |
|---|---|
| Curso (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/course/store |
| Curso (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/course/refresh |
| Curso (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/course/refreshlegacy |
| Curso (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/course/delete |
| Asociación del curso (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/courseassociation/store |
| Asociación del curso (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/courseassociation/refresh |
| Asociación del curso (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/courseassociation/refreshlegacy |
| Asociación del curso (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/courseassociation/delete |
| Categoría del curso (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategory/store |
| Categoría del curso (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategory/refresh |
| Categoría del curso (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategory/refreshlegacy |
| Categoría del curso (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategory/delete |
| Afiliación a la categoría del curso (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategorymembership/store |
| Afiliación a la categoría del curso (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategorymembership/refresh |
| Afiliación a la categoría del curso (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategorymembership/refreshlegacy |
| Afiliación a la categoría del curso (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategorymembership/delete |
| Afiliación al curso (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/membership/store |
| Afiliación al curso (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/membership/refresh |
| Afiliación al curso (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/membership/refreshlegacy |
| Afiliación al curso (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/membership/delete |
| Asociación estándar del curso (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/standardsassociation/store |
| Asociación estándar del curso (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/standardsassociation/refresh |
| Asociación estándar del curso (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/standardsassociation/refreshlegacy |
| Asociación estándar del curso (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/standardsassociation/delete |
| Nodo de la jerarquía (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/node/store |
| Nodo de la jerarquía (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/node/refresh |
| Nodo de la jerarquía (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/node/refreshlegacy |
| Nodo de la jerarquía (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/node/delete |
| Asociación del observador (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/associateobserver/store |
| Asociación del observador (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/associateobserver/refresh |
| Asociación del observador (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/associateobserver/refreshlegacy |
| Asociación del observador (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/associateobserver/delete |
| Organización (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organization/store |
| Organización (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organization/refresh |
| Organización (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organization/refreshlegacy |
| Organización (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organization/delete |
| Asociación de la organización (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationassociation/store |
| Asociación de la organización (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationassociation/refresh |
| Asociación de la organización (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationassociation/refreshlegacy |
| Asociación de la organización (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationassociation/delete |
| Categoría de la organización (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategory/store |
| Categoría de la organización (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategory/refresh |
| Categoría de la organización (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategory/refreshlegacy |
| Categoría de la organización (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategory/delete |
| Afiliación a la categoría de la organización (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategorymembership/store |
| Afiliación a la categoría de la organización (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategorymembership/refresh |
| Afiliación a la categoría de la organización (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategorymembership/refreshlegacy |
| Afiliación a la categoría de la organización (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategorymembership/delete |
| Afiliación a la organización (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationmembership/store |
| Afiliación a la organización (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationmembership/refresh |
| Afiliación a la organización (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationmembership/refreshlegacy |
| Afiliación a la organización (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationmembership/delete |
| Persona (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/person/store |
| Persona (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/person/refresh |
| Persona (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/person/refreshlegacy |
| Persona (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/person/delete |
| Período (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/term/store |
| Período (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/term/refresh |
| Período (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/term/refreshlegacy |
| Período (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/term/delete |
| Asociación del usuario (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/userassociation/store |
| Asociación del usuario (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/userassociation/refresh |
| Asociación del usuario (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/userassociation/refreshlegacy |
| Asociación del usuario (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/userassociation/delete |
| Rol de institución secundario del usuario (Guardar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/secondaryinstrole/store |
| Rol de institución secundario del usuario (Completar la actualización) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/secondaryinstrole/refresh |
| Rol de institución secundario del usuario (Completar la actualización por DSK) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/secondaryinstrole/refreshlegacy |
| Rol de institución secundario del usuario (Eliminar) | https:///webapps/bb-data-integration-flatfile-BB/endpoint/secondaryinstrole/delete |
Si está familiarizado con las instantáneas anteriores del tipo de archivo sin formato del marco de trabajo SIS, no hay ningún cambio de formato aparte de la adición de los encabezados en los nuevos objetos de datos compatibles. Para obtener más información, consulte, Formato de los datos de los archivos de instantánea sin formato y Ejemplos de archivos de instantánea sin formato.
Extremos de operación de instantáneas para XML
Utilice esta información para configurar el SIS para archivos de introducción de datos XML POST en esta integración. Los objetos almacenados van a seguir existiendo y conservando sus datos. Los objetos eliminados van a borrarse. La Actualización completa va a eliminar cualquier objeto existente que no se encuentre en el archivo de introducción. Si publica un objeto que contenga un tipo de objeto incorrecto, se producirá un error.
| Operación | Extremo |
|---|---|
| Utilizar el estado del registro | https:///webapps/bb-data-integration-ss-xml-BB/endpoint |
| Completar la actualización | https:///webapps/bb-data-integration-ss-xml-BB/endpoint/refresh |
| Solo eliminar | https:///webapps/bb-data-integration-ss-xml-BB/endpoint/delete |
