Arquivo simples de instantâneo

É 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

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 dos Sistemas de Informação do Aluno (SIA)

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).

1. Selecione Criar integração.

2. Selecione XML do instantâneo ou Arquivo simples de instantâneo. Na próxima tela, selecione as opções de 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

3. Nome da integração: insira XML do instantâneo ou Arquivo simples de instantâneo.
4. Descrição (opcional): insira o que quiser para descrever a integração. Por exemplo: Testar o XML do instantâneo ou Testar arquivo simples de instantâneo.
5. O Nome de usuário compartilhado e a Senha compartilhada são usados para operações de publicação de dados.
6. Definir o Status de integração:
   1. Inativo – A Integração não realiza o processamento.
   2. Ativo – A integração realiza o processamento e atualiza os dados do Learn.
   3. Teste – A integração realiza o processamento e não atualiza o Learn.
7. Configurar os níveis de detalhamento do log. Para Teste, recomendamos que você selecione 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.
8. 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. NOTA:  Em todos os casos, uma DSK deve ser criada antes que os feeds de dados possam ser processados.
9. Apenas o Arquivo simples de instantâneo suporta o gerenciamento de nós pai. Selecione adequadamente para atender aos seus objetivos.
10. Selecione os objetos tratados por esta integração e como tratar a paridade. Geralmente, os padrões são adequados. NOTA:  Você pode ter vários tipos de integração, cada uma lidando com um subconjunto exclusivo de objetos de integração disponíveis.
11. 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

Substituir ENDPOINT_URL pelo URL do ponto de extremidade.

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 dos Sistemas 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.

Criar um arquivo de dados

1. Nas Ferramentas para administradores, em Integrações, selecione Integração de dados.
2. Selecione Integrações dos Sistemas de Informações do Aluno (SIA).
3. No menu suspenso Criar integração, selecione Arquivo simples de instantâneo se você estiver criando um arquivo manualmente.
4. Informe um Nome da integração (obrigatório). Você tem a opção de inserir uma descrição.
5. Você pode adicionar segurança inserindo um Nome de usuário compartilhado e uma Senha compartilhada. Isso é usado com mais frequência para publicação no ponto de extremidade.
6. No Delimitador de arquivo feed, selecione o caractere que separa os campos em seu arquivo de dados.
7. Em Status de integração, selecione inativo, ativo ou teste.
8. No Nível de detalhamento do log, selecione o quão detalhado você deseja que seus logs sejam. 

A área Suporte de dados permite que você faça uma segmentação lógica de dados. Por exemplo, se você tem dois sistemas de informações de alunos diferentes para dois campi diferentes, você pode segmentar para esses dois campi separados. Ou se você quiser segmentar os dados por diferentes períodos acadêmicos. 

1. Na Fonte de dados do Learn, você pode selecionar se a fonte de dados deve ser definida nos dados de entrada ou usar a mesma Fonte de dados do Learn para todos os novos dados de entrada. 
2. Você tem a opção de inserir um Prefixo de código de identificação do lote. Isso é usado para prefixar identificadores de objetos criados por essa integração a fim de evitar conflitos de código. Não é recomendado que isso seja modificado depois que os dados forem criados para essa integração.
3. Selecione a colocação de nós em Nó de hierarquia principal.

Em Configuração avançada, você tem uma série de opções para, por exemplo, lidar com situações em que registros específicos não estão presentes em um lote. Para este caso de uso, deixaremos as seleções padrão no lugar.

Depois de inserir seus dados, selecione Enviar. Isso criará seu arquivo para integração.

Carregar um arquivo de dados para integração:  

1. No Painel do administrador, em Integrações, selecione Integração de dados.
2. Selecione Integração do sistema de informações do aluno.
3. Selecione o menu do arquivo que você deseja carregar. Selecione Carregar um arquivo de feed.
4. No menu Tipo de dados, selecione seu tipo de dados. Os mais comuns para integrações são Nó de hierarquia (se o seu arquivo representar sua hierarquia), Associação de curso, Associação de organização e Associação de usuários. 
5. Para Tipo de operação, a opção mais comum é Armazenar. 
   • Use a Atualização completa ao fazer comparações de dados completas e para excluir algo que não está no arquivo. Tome cuidado com essa opção. 
   • Use Excluir para excluir os registros que você está carregando. 
6. Selecione Enviar.

Você pode verificar o log do SIA para confirmar que ele foi adicionado. Para arquivos maiores, isso pode levar alguns minutos para carregar. Selecione Logs em Ferramentas e utilitários e selecione Logs SIA. 

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 de 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.

Se você conhece o instantâneo 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 compatíveis. 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.

Saiba mais

Visão geral da estrutura do SIA

Visão geral da chave de fonte de dados