Exemplos de usuários de arquivo simples do Snapshot

Os exemplos a seguir demonstram a composição dos feeds de dados do Usuário (Pessoa) ao mesmo tempo que atendem a uma variedade de casos de uso. Esses exemplos utilizam o feed de dados mais simples possível. Há casos em que mais informações podem ser exigidas pela sua instituição. Elas são atendidas pela adição dos cabeçalhos e dados necessários ao feed de dados. A análise dos requisitos e planejamento do Sistema de informações do aluno (SIA) e do registrador de sua instituição ajudará a determinar a profundidade dos dados necessários para preencher corretamente o Blackboard, atendendo às suas metas de dados e ciclo de vida.

Usuários

Os dados do usuário são o principal conjunto de informações que descreve quem tem acesso ao Blackboard, sua função em sua instituição e sua função no sistema Blackboard. No contexto de dados do SIA, os objetos do usuário geralmente são chamados de "pessoa" e isso é refletido nos padrões existentes. Antes de muitos desses padrões, a Blackboard usa "PESSOA" e "USUÁRIO" para se referir a registros relacionados ao usuário com base no contexto. Os exemplos a seguir usarão "pessoa" para fazer referência ao registro e "usuário" para fazer referência à pessoa.

Gerenciamento de dados do arquivo simples do Snapshot

A estrutura do Sistema de informações do aluno (SIA) oferece suporte a uploads de feed de dados de arquivo simples do Snapshot por meio de um upload de feed de interface do usuário e por meio de um conjunto de URLs fornecidos pelo sistema Blackboard.

Acesse as informações de HTTP e carregue o arquivo de feed por meio do menu de integração na UI de integração de sistemas de informações do aluno para integração de dados de administração do sistema.

Em ambos os casos, o comportamento da operação de dados é orientado pela configuração da integração e pelo tipo de operação selecionado. O tipo de operação de dados selecionado controla como os dados no feed são "interpretados" e cada URL fornecerá diferentes resultados para atender às metas desejadas da sua integração.

Os dados podem ser fornecidos à Blackboard e, posteriormente, atualizados, excluídos ou alterados. Assim, você pode começar com o conjunto de dados mais simples e aumentar conforme a mudança nos requisitos de dados da sua instituição.

As operações a seguir estão disponíveis por meio da IU e do HTTP.

Os objetos associados às operações de pessoa são:

Os exemplos fornecidos são demonstrados usando o recurso de arquivo de feed de upload da IU da estrutura do Snapshot. Para automatizar ou utilizar operações programáticas de linha de comando, consulte Automação de arquivo simples do Snapshot.

Um lembrete sobre chaves de fonte de dados

Todos os objetos de dados dão suporte à capacidade de alterar a chave da fonte de dados para o agrupamento desse conjunto de dados e podem ser usados para alterar a fonte de dados associada – Observação: este não é um campo obrigatório em feeds de dados baseados em Framework e, a menos que indicado, os exemplos abaixo pressupõem que a integração está configurada para usar uma única fonte de dados.

Para saber mais, consulte Gerenciamento de chave da fonte de dados.

Uma observação sobre mapeamento de campo

O mapeamento de campo fornece a capacidade de alterar os dados recebidos antes de serem armazenados no Blackboard. Isso permite que você tenha controle total sobre os dados armazenados e atenda às regras específicas do Blackboard quando os dados do Sistema de informações do aluno (SIA) fornecidos são insuficientes, como a criação de senhas de usuário. Quando aplicado a um campo de objeto Usuário, o script associado é executado por usuário, alterando ou fornecendo os dados antes de serem armazenados no Blackboard. Uma explicação completa do Mapeamento de Campo para arquivo simples do Snapshot é fornecida em Mapeamento de Campo de arquivo simples do Snapshot.

Uma observação sobre senhas

As senhas são necessárias para acessar no Blackboard, mas não são um campo obrigatório nos feeds de dados PERSON. Se uma senha não for fornecida no feed de dados, uma senha SHA512 aleatória será gerada e armazenada no banco de dados da Blackboard. Isso não é um problema se você estiver usando autenticação externa (como LDAP), mas o que acontece se você estiver usando o banco de dados Blackboard para armazenar senhas de acesso do usuário? Você deve fornecer a senha na criação do usuário, pois não será possível acessar.

Se você executar um feed e definir a senha para um usuário que altere subsequentemente a senha, o acesso será quebrado. Em uma operação de atualização, você pode optar por não atualizar o campo de senha. Isso permitirá que a Blackboard retenha a senha atual na atualização. Se você não selecionar essa opção, a senha será alterada e o usuário precisará ser notificado da alteração.

Exemplos da operação de pessoa

Em um nível alto, você pode aplicar três padrões de feed de dados de integração do SIA a todas as operações de dados do usuário, e a seleção do padrão depende dos dados que você pode fornecer e das metas de integração.

Por fim, e este não é um padrão de feed do Sistema de informações do aluno (SIA), mas vale a pena mencionar, você também pode desabilitar e excluir com base apenas no DSK utilizando a ferramenta de gerenciamento de fonte dados disponível na interface do usuário. Você deve ser muito discreto ao gerenciar os dados fornecidos pelo SIA dessa maneira. Isto é extremamente útil para eliminar dados que nunca foram ou deixaram de ser fornecidos através do Sistema de informações do aluno (SIA), tais como dados que resultam de operações de teste.

Apenas o básico: Pessoas

Todas as contas de usuário requerem um conjunto básico de informações para estabelecer uma conta. Esse conjunto de informações é detalhado em Formato de dados de arquivo simples do Snapshot e Cabeçalho de arquivo simples do Snapshot.

Dados em resumo

O conjunto de dados ou cabeçalhos mínimos necessários para criar uma conta de usuário no Blackboard consiste em:

A estrutura do SIA, conforme uma configuração de integração, fornece valores padrão para campos não obrigatórios ou os ignora. Dois campos úteis que não são obrigatórios para um feed de pessoa são EMAIL e SYSTEM_ROLE. E-mail é necessário para corresponder e fornecer notificações por e-mail aos usuários da Blackboard por e-mail da Blackboard, portanto, você deve considerar fornecer esses dados em seu feed. Padrões SYSTEM_ROLE para a configuração definida de NONE.

Como adicionar informações pessoais

Existem dois casos para adicionar informações pessoais. O primeiro é armazenar informações pessoais de maneira aditiva, resultando na adição ou atualização de registros, conforme apresentado no feed de dados. A segunda é ATUALIZAR as informações da PESSOA que já estão no Blackboard, resultando na adição de registros novos ou atualizados de registros existentes, conforme apresentado no arquivo de dados, ao mesmo tempo em que desativa os registros existentes que não estão presentes no arquivo de dados.

Exemplos da operação de armazenamento

Exemplo #1: Criar contas pessoais

Você deseja adicionar usuários ao Blackboard sem afetar as contas existentes. Você tem sua integração configurada para usar a mesma fonte de dados para todos os dados de entrada.

Pré-requisito

Nenhum.

Requisitos mínimos do feed de dados

EXTERNAL_PERSON_KEY
USER_ID
PASSWD
FIRSTNAME
LASTNAME

Solução

Criar um arquivo de dados pessoas.txt que contenha os cabeçalhos exigidos e os dados associados por pessoa que você quer adicionar ao sistema. Por exemplo:

Use a IU para carregar este arquivo conforme o tipo de dados PESSOAIS, mediante operação de ARMAZENAMENTO. A conta de usuário será criada e você poderá acessar como o usuário.

Condição a posteriori

Os registros pessoais para aanderson_test, bbrown_test e gcarlin_test são criados.

Exemplo #2: Atualizar contas de usuário

Você criou as contas de usuário e precisa alterá-las. Por exemplo, o exemplo anterior não incluía endereços de e-mail de nenhum usuário. Você tem o endereço de e-mail para aanderson_test.

Pré-requisito

Nenhum – as atualizações ocorrerão em registros criados anteriormente, os dados incluídos onde um registro não existe no Blackboard resultarão na criação do registro.

Solução

Criar um arquivo de dados pessoas.txt que contenha os cabeçalhos exigidos e os dados associados por pessoa que você quer adicionar ao sistema. Por exemplo:

Use a IU para carregar este arquivo conforme o tipo de dados PESSOAIS, mediante operação de ARMAZENAMENTO. A conta de usuário será atualizada.

Condição a posteriori

O registro pessoal para aanderson_test é atualizado para incluir o endereço de e-mail fornecido.

Os registros pessoais para bbrown_test e gcarlin_test não são afetados.

Pessoa: Conclua a operação de atualização

COMPLETE REFRESH opera de maneira diferente de STORE. COMPLETE REFRESH executa duas operações que equivalem a uma comparação dos dados no arquivo de feed e dos registros no Blackboard de propriedade da integração: armazenar novos registros, atualizar registros existentes ou desativar registros no Blackboard que não estão no arquivo de dados.

Exemplo: Atualização completa

Os dados fornecidos pelo Sistema de informações do aluno (SIA) contêm uma captura de tela completa das PESSOAS que devem ter acesso ao Blackboard. Esses dados contêm registros pessoais a serem adicionados, registros pessoais a serem atualizados e registros que foram excluídos desde operações COMPLETE REFRESH anteriores, que devem ser tratados adequadamente por configuração (desabilitar ou excluir).

Pré-requisito

Nenhum.

Requisitos mínimos do feed de dados

EXTERNAL_PERSON_KEY
USER_ID
PASSWD
FIRSTNAME
LASTNAME

Solução

Uso dos dados da nossa última operação de armazenamento e exclusão do gcarlin_test do feed de dados:

Condição a posteriori

O registro pessoal para aanderson_test é retido e não é afetado.

O registro pessoal para bbrown_test é retido e atualizado para incluir o endereço de e-mail.

O registro pessoal para gcarlin_test é marcado como desabilitado ou pronto para exclusão de acordo com a configuração de integração.

Pessoa: Atualização completa por operação de fonte de dados

A ATUALIZAÇÃO COMPLETA PELA FONTA DE DADOS realiza uma operação de ATUALIZAÇÃO COMPLETA, porém, restringe os dados afetados apenas aos que estiverem associados à fonte de dados da integração.

Exemplo: atualização completa por fonte de dados

Os dados fornecidos pelo Sistema de informações do aluno (SIA) contêm uma captura de tela completa das PESSOAS que devem ter acesso ao Blackboard. Esses dados contêm registros pessoais a serem adicionados, registros pessoais a serem atualizados e registros que foram excluídos desde operações REFRESH anteriores que devem ser tratados adequadamente por configuração (desabilitar ou excluir). Além disso, todos os dados nessa atualização são direcionados usando a mesma fonte de dados definida na integração e você quer que APENAS os dados relacionados a essa chave da fonte de dados sejam afetados.

Pré-requisito

Nenhum.

Requisitos mínimos do feed de dados

EXTERNAL_PERSON_KEY
USER_ID
PASSWD
FIRSTNAME
LASTNAME

Solução

Usar os dados da nossa última operação de armazenamento e exclusão do gcarlin_test do feed de dados:

Condição a posteriori

O registro pessoal para aanderson_test é retido e não é afetado.

O registro pessoal para bbrown_test é retido e atualizado para incluir o endereço de e-mail.

O registro pessoal criado anteriormente para gcarlin_test é marcado como desabilitado ou pronto para exclusão de acordo com a configuração de integração.

Se outros registros pessoais forem gerenciados por essa integração, eles NÃO serão desabilitados ou excluídos devido à sua ausência no feed de dados acima, a menos que tenham a mesma fonte de dados especificada pela integração.

Disponibilidade da conta pessoal

A configuração de disponibilidade da conta PERSON permite que uma conta no Blackboard acesse o sistema (disponível) ou não (indisponível). Observe que isso não é o mesmo que desativar uma conta, o que não apenas torna a conta indisponível, mas também significa que ela não está disponível para outras operações, como gerenciamento de associação. A adição desse cabeçalho do feed de dados não afeta o uso acima demonstrado de armazenamento, atualização completa, atualização completa pela fonte de dados para criar registros pessoais.

Exemplo: disponibilidade da conta pessoal

Seu Sistema de informações do aluno (SIA) controla a disponibilidade de acesso ao Blackboard para os usuários, e seu feed de dados indica se os usuários individualmente têm acesso ao Blackboard. Você quer fazer alterações no acesso do usuário individual usando a criação/atualização de PESSOAS.

Pré-requisito

Nenhum.

Requisitos mínimos do feed de dados

EXTERNAL_PERSON_KEY
USER_ID
PASSWD
FIRSTNAME
LASTNAME
AVAILABILE_IND

Solução

Adicione o cabeçalho AVAILABLE_IND ao seu feed de dados e forneça o caractere único de Y para disponível e N para indisponível.

Condição a posteriori

Armazenamento

Somente os registros pessoais para aanderson_test, bbrown_test e gcarlin_test são atualizados (eles foram criados anteriormente) e ddarling_test é criado.

Atualização completa

Os registros pessoais para aanderson_test, bbrown_test e gcarlin_test são atualizados (eles foram criados anteriormente) e ddarling_test é criado. Todos os outros registros serão desabilitados ou marcados para exclusão devido à sua ausência no feed de dados acima.

Atualização completa pela fonte de dados

Os registros pessoais para aanderson_test, bbrown_test e gcarlin_test são atualizados (eles foram criados anteriormente) e ddarling_test é criado.

Se outros registros pessoais forem gerenciados por essa integração, eles NÃO serão desabilitados ou excluídos devido à sua ausência no feed de dados acima, a menos que tenham a mesma fonte de dados especificada pela integração. A atualização completa pela fonte de dados opera apenas nos registros da fonte de dados da integração.

Desativar registros pessoais

A desabilitação de um registro pessoal no Blackboard o torna inacessível para fins de acesso (o status desabilitado substitui a configuração de disponibilidade) e também torna o registro inacessível para operações de interface do usuário. Por exemplo, não é possível adicionar um registro de pessoa desabilitado a um curso por meio da IU. Além disso, para excluir um registro do Blackboard, esse registro deve primeiro ser desabilitado.

A desabilitação de registros pode seguir dois modelos: desabilitada pela exclusão de dados do feed em operações de ATUALIZAÇÃO e desabilitada pelo uso do ROW_STATUS do cabeçalho do feed.

As operações pessoais acima que usam as operações de atualização demonstram como desativar por exclusão. O caso e o exemplo a seguir demonstram por meio do uso de ROW_STATUS.

Exemplo: Desabilitar registros pessoais

Os Alunos se matriculam ou não precisam mais ter acesso ao Blackboard. Você é obrigado a excluir totalmente o acesso e a presença deles no Blackboard (ao contrário de tornar o registro indisponível, o que apenas restringe o acesso). Se você estiver usando operações de armazenamento, para desabilitar os usuários será necessário desabilitar explicitamente o usuário usando o cabeçalho ROW_STATUS. Isso também é útil em operações manuais fora do escopo dos feeds do SIA.

Pré-requisito

Os registros direcionados existem no sistema Blackboard.

Requisitos mínimos do feed de dados

EXTERNAL_PERSON_KEY
USER_ID
PASSWD
FIRSTNAME
LASTNAME
ROW_STATUS

Solução

Adicionar o cabeçalho ROW_STATUS ao feed de dados e fornecer uma entrada de ENABLED para habilitado e DISABLED para desabilitado.

Condição a posteriori

Armazenamento

Somente os registros pessoais para aanderson_test, bbrown_test, gcarlin_test e ddarling_test são criados ou atualizados com o ROW_STATUS é atualizado explicitamente.

Atualização completa

Os registros pessoais para aanderson_test, bbrown_test, gcarlin_test e ddarling_test são criados ou atualizados; Todos os outros registros serão desabilitados ou marcados para exclusão devido à sua ausência no feed de dados acima.

Atualização completa pela fonte de dados

Os registros pessoais para aanderson_test, bbrown_test, gcarlin_test e ddarling_test são criados ou atualizados, com o ROW_STATUS é explicitamente atualizado.

Se outros registros pessoais forem gerenciados por essa integração, eles NÃO serão desabilitados ou excluídos devido à sua ausência no feed de dados acima, a menos que tenham a mesma fonte de dados especificada pela integração. A atualização completa pela fonte de dados opera apenas nos registros da fonte de dados da integração.

Gerenciar funções na instituição secundária do usuário

Como um licenciado da Comunidade, você tem acesso a funções adicionais que podem ser atribuídas aos usuários. Elas são úteis para gerenciar o acesso aos materiais e guias no Portal da comunidade.

O gerenciamento de funções secundárias é uma atividade separada da criação ou atualização de usuários e, como tal, o gerenciamento de funções secundárias não faz parte do feed de dados de criação/atualização pessoal.

Exemplo: Adicionando funções de instituição secundária do usuário

Você precisa fornecer conteúdo do portal específico para alunos e corpo docente da escola de engenharia.

Pré-requisito

Você criou uma nova função institucional usando a IU do administrador do sistema (consulte...) denominada "ENGINEERING_STUDENT"

Requisitos mínimos do feed de dados

EXTERNAL_PERSON_KEY
ROLE_ID

Solução

Criar um feed de Institutional_Role que contenha os registros a serem criados/atualizados.

Assim como com outros objetos de dados, você também pode fornecer o ROW_STATUS para habilitar ou desabilitar o acesso pessoal ao conteúdo associado à função secundária. Por exemplo:

Condição a posteriori

Armazenamento

Somente os registros de Função de Instituição Secundária para aanderson_test, bbrown_test, gcarlin_test e d são criados ou atualizados com a Função de Instituição Secundária.

Atualização completa

Os registros de Função da Minha instituição Secundária para aanderson_test, bbrown_test, gcarlin_test e d são criados ou atualizados; Todos os outros registros serão desabilitados ou marcados para exclusão devido à sua ausência no feed de dados acima.

Atualização completa pela fonte de dados

Os registros de Função de Instituição Secundária para aanderson_test, bbrown_test, gcarlin_test e d são criados ou atualizados.

Se outros registros pessoais forem gerenciados por essa integração, eles NÃO serão desabilitados ou excluídos devido à sua ausência no feed de dados acima, a menos que tenham a mesma fonte de dados especificada pela integração. A atualização completa pela fonte de dados opera apenas nos registros da fonte de dados da integração.

Observadores

Os observadores são um usuário de caso especial em que a conta está vinculada a outra conta de usuário em uma supervisão ou capacidade de observação. O observador pode acessar e ver seus cursos e atividades de usuário associados.

Uma conta de Observador requer as mesmas informações que um Usuário para a criação da conta e tem uma camada adicional de 'Gerenciamento de Associação de Usuários' em que o Observador é associado a uma conta de Usuário vinculando o external_person_keys das duas contas.

A conta do observador é criada exatamente como você criaria qualquer conta de usuário seguindo os requisitos de processamento de dados da sua instituição.

Exemplo #1: Criar associação de observador

Você deseja associar um aluno à sua conta de pai (ou outro usuário adequado) para que a atividade possa ser observada.

Pré-requisito

Você criou um Aluno identificado por um external_person_key (test_student_100 neste exemplo) e um observador identificado por um external_person_key (test_student_100_observer e test_student_200_observer neste exemplo).

Requisitos mínimos em matéria de dados

O external_person_key do Observer: EXTERNAL_OBSERVER_KEY

external_person_key do Aluno observado: EXTERNAL_USER_KEY

Solução

Criar um arquivo de dados que contenha a external_person_key do observador e a chave pessoal externa do aluno.

Use a IU para carregar este arquivo conforme o tipo de dados PESSOAIS, mediante operação de ARMAZENAMENTO. A associação será criada e você poderá acessar como o observador e visualizar a atividade do curso do aluno.

Exemplo #2: Atualizando um registro de associação de observador

Você precisa alterar uma associação.

Pré-requisito

Você criou uma associação entre test_student_200_observer e test_student_100, mas a conta de Aluno associada deve ser test_student_200.

Solução

Criar um arquivo que contenha a revisão.

Use a IU para carregar este arquivo conforme o tipo de dados PESSOAIS, mediante operação de ARMAZENAMENTO.

Condição a posteriori

A associação será atualizada e você poderá acessar como observador e visualizar a atividade do curso do aluno correto.

Exemplo #3: Desabilitar registros de associação de observadores

Uma associação do observador não é mais necessária e você deseja desabilitá-la.

Pré-requisito

Você criou associações entre alunos e observadores.

Solução

(Utilizando os dados usados neste exemplo de linha de discussão)

Você criou anteriormente associações usando o método de armazenamento e o seguinte arquivo:

Existem dois padrões relacionados ao feed para atender ao requisito de desabilitar uma associação do observador, dependendo de seus requisitos:

Desativando um subconjunto de associações de observadores

Para desabilitar um subconjunto de dados, você pode criar um feed de associação e carregá-lo na operação de exclusão. Por exemplo:

Para excluir a associação entre test_student_100_observer|test_student_100 no conjunto de dados de trabalho, você pode criar um arquivo de feed que contenha o seguinte e carregá-lo usando a operação de exclusão:

Desativando um subconjunto de associações de observadores ao armazenar associações novas/existentes

Para desabilitar um subconjunto de dados que também permita a atualização existente ou o armazenamento de novas associações, você pode criar um arquivo de associação que contenha associações existentes e novas, excluindo aquelas que você deseja desabilitar e carregar usando a operação de atualização completa. Por exemplo, usando o conjunto de trabalho de:

Queremos desabilitar a associação do test_student_200_observer | test_student_200, portanto, o arquivo conterá somente a associação test_student_100_observer | test_student_100. Se também quiséssemos adicionar duas novas associações (desde que as contas de usuários tenham sido criadas), poderíamos carregar o seguinte:

Condição a posteriori

O registro para test_student_200_observer|test_student_200 está desabilitado.

Saiba Mais