É importante observar que, para os fins deste documento, o uso do termo "instantâneo" refere-se ao processo geral de obtenção de dados pontuais do SIA que são armazenados em um arquivo simples que, por sua vez, é consumido pelo Learn – não pelo controlador de instantâneo.
O Instantâneo fornece a capacidade de integrar usando dados pontuais, conforme provisionados pelo SIA, com dois tipos de integração suportados (leia: formatos de dados) na Estrutura do SIA para Instantâneo – XML de instantâneo e Arquivo simples de instantâneo (ou dados delimitados). Esse último, o Arquivo simples de instantâneo, é o formato compatível com versões futuras e receberá atualização para suportar novos objetos de dados. O XML de instantâneo só receberá atualizações de manutenção.
O processamento para os dois tipos de integração de instantâneo é realizado por publicação de HTTP do arquivo de dados para o ponto de extremidade apropriado.
Suporte a dados
| Objeto de dado | Suporte de arquivo simples de instantâneo | Suporte de XML de instantâneo |
|---|---|---|
| Usuários | Sim | Sim |
| Cursos | Sim | Sim |
| Associações (Matrículas e exercícios de pessoal) |
Sim | Sim |
| Categorias do catálogo | Sim | Sim |
| Comunidades | Sim | Sim |
| Observadores | Sim | Sim |
| Funções na instituição | Sim | Sim |
| Nós | Sim | |
| Cursos de listas cruzadas | Sim | |
| Períodos | Sim | |
| Padrões (como Atributo de cursos) | Sim |
Requisitos
Capacidade do SIA de gerar dados formatados para o tipo de integração escolhido – XML de instantâneo ou Arquivo simples de instantâneo com o delimitador apropriado.
Outro ponto que vale a pena reiterar: o Controlador de instantâneo e o formato de dados XML de instantâneo não devem ser a primeira opção de integração, uma vez que estão apenas recebendo atualizações de manutenção e não suporte a objetos novos ou desenvolvimento de recursos. Espera-se que, em algum momento no futuro, seja feito um aviso sobre o término do suporte com tempo suficiente para a adaptação do cliente.
Consulte a seção de exemplos do Enterprise 1.1 para obter dados de amostra, observando que o formato de dados é ligeiramente diferente entre as duas versões suportadas do Enterprise 1.1 (padrão e vista).
Configuração: Tipos de integração do instantâneo
Além da compreensão dos dados envolvidos em qualquer integração do SIA, a configuração dos tipos de integração da Integração do instantâneo requer conhecimento dos recursos do SIA e dos pontos de extremidade, com o objetivo de saber se os objetos de dados suportados no tipo de Instantâneo selecionado atendem aos objetivos de integração do cliente. Além disso, é necessário entender o formato de arquivo específico. Você pode criar uma integração de Instantâneo por meio das seguintes etapas na UI da Integração do SIA para o Administrador do sistema do Learn: Integração de dados > Integrações do sistema de informação do aluno
As etapas a seguir servem para os dois tipos de Integração do instantâneo. A principal diferença em selecionar o tipo de integração depende se os dados são XML (escolha o XML de instantâneo) ou delimitados (Arquivo simples de instantâneo).
- Selecione Criar integração
- Selecione XML de instantâneo ou Arquivo simples do instantâneo
- Na próxima tela, serão apresentadas as opções editáveis para a configuração:
Para executar a configuração avançada (Mapeamento de dados, por exemplo), uma integração deve ser configurada com o status Teste ou Ativo
- Nome da integração: insira XML de instantâneo ou Arquivo simples do instantâneo
- Descrição (opcional): insira o que quiser para descrever a integração. Por exemplo: Testar o XML de instantâneo ou Testar arquivo simples do instantâneo
- O Nome de usuário compartilhado é usado para as operações de publicação de dados, assim como a Senha compartilhada
- Configure o Status de integração:
- Inativo – A Integração não realiza processamento
- Ativo – A integração realiza processamento e atualiza os dados do Learn
- Teste – A integração realiza processamento e não atualiza o Learn
- Configurar os níveis de detalhamento do log – para Teste, é recomendado selecionar Todas as mensagens de diagnóstico e depuração. Para Ativo, é recomendado usar uma configuração mais baixa, como Somente erros ou Erros e avisos.
- Em seguida, selecione a chave de fonte de dados (DSK) a ser usada para esta integração. Você pode selecionar o uso de uma DSK existente específica, criar uma nova chave ou usar a fonte de dados fornecida no feed. Observe que, em todos os casos, uma DSK deve ser criada antes que os feeds de dados possam ser processados.
- Apenas o Arquivo simples de instantâneo suporta o gerenciamento de nós pai. Selecione adequadamente para atender aos objetivos do cliente.
- Por fim, selecione os objetos tratados por esta integração e como tratar a paridade. Geralmente, os padrões são adequados.
- Observe que você pode ter vários tipos de integração, cada uma lidando com um subconjunto exclusivo de objetos de integração disponíveis.
- Selecione Enviar e sua nova integração de Instantâneo será exibida na lista de integrações.
Mais uma etapa deve ser concluída para dar suporte à integração do Instantâneo, que é configurar o sistema do SIA para publicar dados para o Learn ou configurar um cron do lado do servidor do aplicativo ou trabalho de lote para publicar os dados para o Learn. Observe que os pontos de extremidade do Instantâneo são específicos para a tarefa necessária a ser executada.
A publicação do lado do servidor de aplicativos para o Learn é realizada usando CURL, ou aplicativo semelhante, desencadeada por um cron ou trabalho de lote:
curl -k -w %{http_code} -H "Content-Type:text/plain" -u SHARED_USERNAME:SHARED_PASSWORD --data-binary @PATH_TO_TEST_FILE ENDPOINT_URL
Substituir:
SHARED_USERNAME com o nome de usuário compartilhado
SHARED_PASSWORD com a senha compartilhada
PATH_TO_TEXT_FILE com o caminho para o arquivo de dados xml
Replace ENDPOINT_URL com o URL de terminal.
Você pode visualizar uma lista dos pontos de extremidade no servidor acessando a página Informações HTTP fora do menu de contexto da sua integração de arquivo simples:
Administração do sistema (Building blocks) > Integração de dados > Integrações do Sistema de Informação do Aluno > (menu de contexto da sua integração) > Informações HTTP)
Se for suportado por um aplicativo de nível médio ou pelo SIA, os dados podem ser publicados diretamente no ponto de extremidade seguindo o protocolo acima.
Uma vez que a etapa acima for concluída e o SIA for habilitado para gerar dados e publicar ou salvar em arquivo para publicação no Learn, você começará a visualizar os registros na integração.
Avalie os dados e determine se você precisa fazer ajustes usando a Configuração avançada/Mapeamento de campo nos objetos de dados disponíveis. Consulte a seção Mapeamento de campo na seção final dos exemplos para obter uma descrição dessa funcionalidade.
Para saber mais sobre o processamento de arquivos de dados, consulte Automação do arquivo simples de instantâneo.
Integrações do instantâneo
As integrações de instantâneos são baseadas em conjuntos de dados que atendem a objetivos específicos. Por exemplo, para gerenciar Usuários ou Cursos no sistema. Dos dois tipos suportados, XML de instantâneo e o Arquivo simples de instantâneo, apenas o Arquivo simples de instantâneo deve ser considerado o mais compatível com os objetos de dados suportados do Learn.
Assim como em todos os tipos de integração "baseados em arquivo" (os tipos Instantâneo e Enterprise 1.1), existem dois processos para consumir dados nesses arquivos: o uso do Arquivo de feed de upload da GUI ou o uso de uma transferência de dados http (por exemplo: cURL). No caso da transferência de dados http, um cron ou trabalho em lote pode ser usado para acionar a operação. Além disso, desde que seja suportado pelo SIA ou nível médio, um fluxo de dados pode ser publicado diretamente.
Cada operação é obtida por meio de um ponto de extremidade específico. Esses pontos de extremidade para o servidor de aplicativos estão disponíveis por meio do link de Informações HTTP de integrações encontrados no menu.
Pontos de extremidade de instantâneo
Pontos de extremidade de operações de instantâneo para Arquivo simples
Use essas informações para configurar seu SIA para publicar (POST) arquivos de feed de Arquivo simples de instantâneo na sua integração. Objetos armazenados continuarão a existir e reter seus dados. Objetos excluídos são removidos. A atualização completa removerá todos os objetos existentes que não estão no feed file. A publicação de um arquivo de um tipo de objeto específico para um ponto de extremidade não correspondente falhará. Por exemplo: publicar um arquivo de dados do Curso para um ponto de extremidade de Pessoa falhará.
Desativar um curso desativará as matrículas nesse curso. Esse é um novo comportamento.
Você também pode encontrar um URL do ponto de extremidade da operação na interface de usuário do Blackboard Learn. Navegue até Painel do administrador > Integração de dados > Integrações dos Sistemas de Informação do Aluno. Localize a integração, abra o menu e selecione Informações HTTP. Os URLs do ponto de extremidade da integração estarão listados.
| Operação | URL de ponto de extremidade |
|---|---|
| Curso – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/course/store |
| Curso – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/course/refresh |
| Curso – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/course/refreshlegacy |
| Curso – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/course/delete |
| Associação de curso – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/courseassociation/store |
| Associação de curso – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/courseassociation/refresh |
| Associação de curso – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/courseassociation/refreshlegacy |
| Associação de curso – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/courseassociation/delete |
| Categoria do curso – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategory/store |
| Categoria do curso – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategory/refresh |
| Categoria do curso – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategory/refreshlegacy |
| Categoria do curso – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategory/delete |
| Associação da categoria do curso – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategorymembership/store |
| Associações da categoria do curso – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategorymembership/refresh |
| Associação da categoria do curso – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategorymembership/refreshlegacy |
| Associação da categoria do curso – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/coursecategorymembership/delete |
| Matrícula em curso – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/membership/store |
| Matrícula em curso – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/membership/refresh |
| Matrícula em curso – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/membership/refreshlegacy |
| Matrícula em curso – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/membership/delete |
| Associação de padrão do curso – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/standardsassociation/store |
| Associação de padrão do curso – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/standardsassociation/refresh |
| Associação de padrão do curso – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/standardsassociation/refreshlegacy |
| Associação de padrão do curso – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/standardsassociation/delete |
| Nó de hierarquia – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/node/store |
| Nó de hierarquia – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/node/refresh |
| Nó de hierarquia – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/node/refreshlegacy |
| Nó de hierarquia – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/node/delete |
| Associação de observador – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/associateobserver/store |
| Associação de observador – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/associateobserver/refresh |
| Associação de observador – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/associateobserver/refreshlegacy |
| Associação de observador – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/associateobserver/delete |
| Comunidade – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organization/store |
| Comunidade – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organization/refresh |
| Comunidade – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organization/refreshlegacy |
| Comunidade – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organization/delete |
| Associação da comunidade – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationassociation/store |
| Associação da comunidade – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationassociation/refresh |
| Associação da comunidade – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationassociation/refreshlegacy |
| Associação da comunidade – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationassociation/delete |
| Categoria da comunidade – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategory/store |
| Categoria da comunidade – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategory/refresh |
| Categoria da comunidade – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategory/refreshlegacy |
| Categoria da comunidade – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategory/delete |
| Associação de categoria da comunidade – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategorymembership/store |
| Associação de categoria da comunidade – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategorymembership/refresh |
| Associação de categoria da comunidade – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategorymembership/refreshlegacy |
| Associação de categoria da comunidade – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationcategorymembership/delete |
| Associação da comunidade – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationmembership/store |
| Associação da comunidade – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationmembership/refresh |
| Associação da comunidade – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationmembership/refreshlegacy |
| Associação da comunidade – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/organizationmembership/delete |
| Pessoa – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/person/store |
| Pessoa – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/person/refresh |
| Pessoa – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/person/refreshlegacy |
| Pessoa – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/person/delete |
| Período – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/term/store |
| Período – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/term/refresh |
| Período – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/term/refreshlegacy |
| Período – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/term/delete |
| Associação de usuário – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/userassociation/store |
| Associação de usuário – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/userassociation/refresh |
| Associação de usuário – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/userassociation/refreshlegacy |
| Associação de usuário – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/userassociation/delete |
| Função secundária do usuário na instituição – Armazenar | https:///webapps/bb-data-integration-flatfile-BB/endpoint/secondaryinstrole/store |
| Função secundária do usuário na instituição – Atualização completa | https:///webapps/bb-data-integration-flatfile-BB/endpoint/secondaryinstrole/refresh |
| Função secundária do usuário na instituição – Atualização completa por DSK | https:///webapps/bb-data-integration-flatfile-BB/endpoint/secondaryinstrole/refreshlegacy |
| Função secundária do usuário na instituição – Excluir | https:///webapps/bb-data-integration-flatfile-BB/endpoint/secondaryinstrole/delete |
Se você conhece o Snapshot herdado, o tipo de Arquivo simples da estrutura do SIA não traz nenhuma alteração ao formato, a não ser pela adição de cabeçalhos para os novos objetos de dados suportados. Para saber mais, consulte Formato de dados do arquivo simples de instantâneo e Exemplos de arquivo simples de instantâneo.
Pontos de extremidade de operação de instantâneo para XML
Use essas informações para configurar seus feed files SIA como POST XML para esta integração. Objetos armazenados continuarão a existir e reter seus dados. Objetos excluídos são removidos. A atualização completa removerá todos os objetos existentes que não estão no feed file. A publicação de um objeto que contenha um tipo de objeto incorreto resultará em falha.
| Operação | Ponto de extremidade |
|---|---|
| Usar status de registro | https:///webapps/bb-data-integration-ss-xml-BB/endpoint |
| Atualização completa | https:///webapps/bb-data-integration-ss-xml-BB/endpoint/refresh |
| Excluir somente | https:///webapps/bb-data-integration-ss-xml-BB/endpoint/delete |
