Os exemplos fornecidos demonstram a composição dos feeds de dados do período enquanto atendem a uma variedade de casos de uso. Esses exemplos usam o feed de dados mais simples possível exigido para atender ao caso de uso. Existem mais cabeçalhos de feed do período para uso na criação de registros de associação — a análise do sistema de informações da sua instituição e os requisitos e o planejamento do registrador ajudarão a determinar a profundidade dos dados necessária para preencher corretamente o Learn para atender aos seus dados e metas do ciclo de vida do período (e do Curso/Organização associados).

Os exemplos são baseados nas configurações padrão do Learn visíveis na IU de configuração da integração. Alterar esses elementos de configuração resultará em alterações nos resultados de exemplo. Explicações dessas configurações estão disponíveis em Visão geral da estrutura do SIA. Além disso, supõe-se que, a menos que observado de outra forma, a integração esteja configurada para usar a mesma fonte de dados para todos os dados de entrada.


Sobre o objeto período

O objeto período oferece outro meio útil para organizar e controlar o acesso a cursos e organizações. Ao usar um objeto período para controlar o acesso ao curso, as configurações especificadas pelo período substituem aquelas fornecidas nos dados do curso. Isso significa que se você especificar datas de início e de término e duração no nível do curso, elas serão substituídas pelas especificadas no período associado.

Este tópico descreve o uso do arquivo simples de instantâneo para criar e gerenciar objetos do período e apresenta um único exemplo do uso do objeto do período em um feed de dados do curso.

Gerenciamento de dados do arquivo simples de instantâneo

A estrutura do SIA é compatível com uploads do feed de dados de arquivos simples de instantâneos por meio de um upload do feed de IU e por meio de um conjunto de URLs fornecido pelo sistema do Learn.

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 exemplos usam o recurso de arquivo de feed de upload da IU da estrutura do instantâneo. Para automatizar ou usar linhas de comando/operações de programação, consulte Automação de arquivo simples de instantâneo.

Operações

Os dados podem ser fornecidos ao Learn e, posteriormente, atualizados, removidos ou corrigidos. 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:

Operação Descrição
Armazenar Armazenar ou Atualizar um registro fornecido pela configuração da integração.

Ao usar esse tipo de operação, os dados contidos no arquivo de feed são armazenados ou atualizados (por definições de configuração) em todas as fontes de dados que pertencem à integração.

Para saber mais sobre a “propriedade” de dados, consulte Visão geral da estrutura do SIA. Para saber mais sobre chaves de fonte de dados, consulte Visão geral da chave de fonte de dados.

Atualizar Armazenar, atualizar, oudesativar a presença de um registro fornecido no Feed e no Learn.

Essa operação armazena ou atualiza os dados contidos no feed de dados e, ao mesmo tempo, desabilita os dados que não estão contidos no feed de dados associado à integração em todas as fontes de dados.

Excluir Desativar registro fornecido.

Esta operação desabilita, por configurações de integração, os registros contidos no feed de dados associado à integração em todas as fontes de dados.

Os objetos associados às operações de período são:

TERM Armazenamento, atualização completa, exclusão, atualização completa pela fonte de dados

Os exemplos fornecidos são demonstrados usando o recurso de arquivo de feed de upload da IU da estrutura do instantâneo. Para automatizar ou utilizar linhas de comando/operações de programação, consulte Automação de arquivo simples de instantâneo.

Um lembrete sobre chaves de fonte de dados

Todos os objetos de dados oferecem suporte à capacidade de alterar a chave de fonte de dados para o agrupamento do conjunto de dados e podem ser usados para alterar a fonte de dados associada. Nota: este não é um campo obrigatório em feeds de dados baseados na estrutura e, a menos que indicado, os exemplos fornecidos presumem que a integração esteja configurada para usar uma única fonte de dados. Consulte Visão geral da chave de fonte de dados.

Uma observação sobre mapeamento de campo

O mapeamento de campo fornece a capacidade de alterar os dados de entrada antes de serem armazenados no Learn. Isso permite que você tenha controle sobre os dados que são armazenados e permite que você cumpra as regras específicas do Learn quando os dados fornecidos pelo SIA forem insuficientes, (por exemplo, a criação de senhas de usuário quando uma senha não for fornecida no feed de dados).

Quando aplicado a um campo do objeto de Período, o script associado é executado de acordo com o objeto, alterando ou fornecendo os dados antes de serem armazenados no Learn. Uma explicação completa do mapeamento de campo é fornecida em Mapeamento de campo personalizado de arquivo simples de instantâneo.

Exemplos de período

Em um nível alto, você pode identificar três padrões de feed de dados de integração do SIA que podem ser aplicados a todas as operações de dados do período, e a seleção do padrão depende dos dados que você pode fornecer.

  • Usando um único arquivo de feed, você pode armazenar e atualizar registros (armazenar) utilizando um processo separado para desativar (excluir) registros
  • Usando um único arquivo de feed, você pode armazenar, atualizar e desativar (atualizar) registros
  • Usando uma combinação de arquivos, você pode armazenar com um, desativar com um segundo.

Finalmente, e esse não é um padrão de feed do SIA, mas vale a pena mencionar, você também pode desativar e limpar com base no DSK sozinho, utilizando a ferramenta de gerenciamento de fonte dados disponível na IU. Você deve ser muito discreto ao gerenciar dessa maneira os dados fornecidos pelo SIA. Isso é extremamente útil ao remover dados que não são mais fornecidos pelo SIA, ou nunca foram fornecidos por meio dele, ou são resultados de operações de teste.

Apenas os princípios básicos: TERM

Todos os objetos do período requerem um conjunto básico de informações a ser estabelecido. Esse conjunto de informações é detalhado no Formato de dados de arquivo simples de instantâneo e Descrições do cabeçalho de arquivo simples de instantâneo.

Dados em breve

O conjunto mínimo de dados ou os cabeçalhos necessários para criar uma conta de associação no Learn consistem em:

  • EXTERNAL_TERM_KEY: um identificador exclusivo para este registro de período.
  • DATA_SOURCE_KEY: um identificador exclusivo para os dados define este registro. Observação: isso é fornecido no feed ou por meio da configuração de integração
  • NOME: o nome associado ao período. Observe que, como é o que é pesquisado na pesquisa de registros de períodoS, é útil usar uma convenção de nomenclatura que facilita diferenciar seus períodoS ao longo do tempo. Por exemplo: use "Artes e Ciências do Outono de 2013" em vez de "Outono"

A estrutura do SIA por uma configuração de integração fornece valores padrão para campos não obrigatórios ou os ignora. Três pontos de dados úteis que não são obrigatórios para um feed de período são DESCRIPTION, AVAILABLE_IND, ROW_STATUS. Eles operam da mesma maneira que com outros objetos do Learn. Além disso, para usar o objeto de período para controlar o acesso ao curso, você usará os pontos de dados START_DATE e END_DATE. Eles serão abordados em um caso de uso abaixo.

Cada um desses cabeçalhos é descrito completamente em Descrições do cabeçalho do arquivo simples de instantâneo.

Adicionar objetos de período

Para usar o objeto de período para controlar a disponibilidade do curso, primeiro você deve criar o objeto de período.

Existem dois casos para adicionar informações sobre o período. O primeiro é armazenar informações sobre a associação de maneira aditiva, resultando na adição ou atualização de registros, conforme apresentado no feed de dados. O segundo é atualizar informações sobre o período já presentes no Learn, resultando na adição de novos registros ou na atualização de registros já existentes, conforme apresentado no arquivo de dados, ao mesmo tempo que desabilita os registros já existentes do Learn que não estão presentes no arquivo de dados do período.

Exemplos da operação de armazenamento

Exemplo 1: Criar períodos

Você deseja adicionar períodos para seu ano acadêmico 2013-2014 ao Learn sem afetar os registros existentes. É necessário ter diferentes períodos para sua escola de Medicina e escola de Artes e Ciências.

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_TERM_KEY
NOME

Solução

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

EXTERNAL_TERM_KEY|NAME

AS_FA.2013|Arts and Sciences Fall 2013
AS_WI.2014|Arts and Sciences Winter 2014
AS_SP.2014|Arts and Sciences Spring 2014
AS_SU.2014|Arts and Sciences Summer 2014
MED_T1.2013|School of Medicine Term 1 2013
MED_T2.2014|School of Medicine Term 2 2013
MED_T3.2014|School of Medicine Term 3 2013

Use a IU para carregar um arquivo que contenha o que está acima por meio do tipo de dados período usando a operação STORE. Os registros do período serão criados e você poderá descobri-los por meio das ferramentas de período do administrador do sistema.

Pós-condições

Os objetos de Período são criados para as duas escolas: Quatro para Artes e Ciências e três para a Escola de Medicina.

Exemplo 2: Atualizar períodos

Você deseja adicionar e atualizar períodos para seu ano acadêmico 2013-2014 sem afetar os registros existentes. Além disso, deseja controlar explicitamente a disponibilidade e o status ativado dos registros de período. A escola de Artes e Ciências tem diferentes datas de início e de término por período, assim você deseja definir as datas de início e de término do período de cada escola para controlar a visibilidade dos cursos associados.

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_TERM_KEY
NOME
AVAILABILITY_IND
DURAÇÃO
END_DATE
ROW_STATUS
START_DATE

Solução

Criar um arquivo de dados terms.txt que contenha os cabeçalhos exigidos e os dados associados por período que você quer adicionar ou atualizar no sistema.

Para utilizar corretamente START_DATE e END_DATE, uma duração também deve ser especificada (intervalo). Por exemplo:

EXTERNAL_TERM_KEY|NAME|START_DATE|END_DATE|DURATION|AVAILABLE_IND|ROW_STATUS
AS_FA.2013|Arts and Sciences Fall 2013|20130915|20131205|RANGE|Y|ENABLED
AS_WI.2014|Arts and Sciences Winter 2014|20140103|20140418|RANGE|Y|ENABLED
AS_SP.2014|Arts and Sciences Spring 2014|20140420|20140520|RANGE|Y|ENABLED
AS_SU.2014|Arts and Sciences Summer 2014|20140608|20140820|RANGE|Y|ENABLED
MED_T1.2013|School of Medicine Term 1 2013|20130801|20131215|RANGE|Y|ENABLED
MED_T2.2014|School of Medicine Term 2 2014|20140110|20140602|RANGE|Y|ENABLED
MED_T3.2014|School of Medicine Term 3 2014|20140603|20140818|RANGE|Y|ENABLED

Pós-condições

Os objetos de período são criados ou atualizados, definindo explicitamente a disponibilidade do registro de período e o início e o fim de cada período. Quando associado a um curso, o período associado controlará a visibilidade do curso.

Exemplos da operação de atualização

Exemplo: Criar ou desativar períodos

Você deseja adicionar e atualizar períodos para seu ano acadêmico 2013-2014 ao mesmo tempo que desativa os registros que não são mais necessários. Além disso, deseja controlar explicitamente a disponibilidade e o status ativado dos registros de período. A escola de Artes e Ciências tem diferentes datas de início e de término por período, assim você deseja definir as datas de início e de término do período de cada escola para controlar a visibilidade dos cursos associados.

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_TERM_KEY
NOME
AVAILABILITY_IND
DURAÇÃO
END_DATE
ROW_STATUS
START_DATE

Solução

Criar um arquivo de dados terms.txt que contenha os cabeçalhos exigidos e os dados associados por período que você quer adicionar ou atualizar no sistema.

Para utilizar corretamente START_DATE e END_DATE, uma duração também deve ser especificada (intervalo). Por exemplo:

EXTERNAL_TERM_KEY|NAME|START_DATE|END_DATE|DURATION|AVAILABLE_IND|ROW_STATUS
AS_FA.2013|Arts and Sciences Fall 2013|20130915|20131205|RANGE|Y|ENABLED
AS_WI.2014|Arts and Sciences Winter 2014|20140103|20140418|RANGE|Y|ENABLED
AS_SP.2014|Arts and Sciences Spring 2014|20140420|20140520|RANGE|Y|ENABLED
AS_SU.2014|Arts and Sciences Summer 2014|20140608|20140820|RANGE|Y|ENABLED
MED_T1.2013|School of Medicine Term 1 2013|20130801|20131215|RANGE|Y|ENABLED
MED_T2.2014|School of Medicine Term 2 2014|20140110|20140602|RANGE|Y|ENABLED
MED_T3.2014|School of Medicine Term 3 2014|20140603|20140818|RANGE|Y|ENABLED

Pós-condições

COMPLETE_REFRESH
Os registros de períodos contidos no arquivo de dados são criados ou atualizados explicitamente, definindo a disponibilidade do registro de períodos e fornecendo a disponibilidade de alcance em que os cursos associados a esses períodos ficarão disponíveis (start_date) e quando ficarão indisponíveis (end_date). Assim como em todas as operações de COMPLETE_REFRESH, todos os registros que não estão contidos no conjunto de dados enviado são desativados (feed de dados: ROW_STATUS=DISABLED, banco de dados: ROWSTATUS=0).

COMPLETE_REFRESH_BY_DATA_SOURCE
Os registros de períodos contidos no arquivo de dados são criados ou atualizados explicitamente, definindo a disponibilidade do registro de períodos e fornecendo a disponibilidade do alcance em que os cursos associados a esses períodos ficarão disponíveis (start_date) e quando ficarão indisponíveis (end_date). Assim como em todas as operações de COMPLETE_REFRESH_BY_DATA_SOURCE, todos os registros que não estão contidos nos dados enviados E que tenham uma chave de fonte de dados que corresponda à fonte de dados configurada para integração serão desativados (feed de dados: ROW_STATUS=DISABLED, banco de dados: os registros ROWSTATUS=0).TERM não associados à fonte de dados configurada para integração não são afetados.

Usar o período em feeds do curso

Organizações e cursos compartilham os mesmos padrões para o gerenciamento de período. Os exemplos fornecidos manterão um foco no uso do objeto de período do curso.

Embora seja possível controlar a disponibilidade dos cursos usando duração, datas, disponibilidade e status da linha, usar o objeto de período permite que o aplicativo com as mesmas configurações para grupos de cursos seja associado a um objeto de período. O período é um elemento de dados opcional nos feeds do curso.
Os resultados operacionais normais devem ser antecipados com base na operação escolhida para enviar os dados para o Learn.

Exemplo: Gerenciar disponibilidade

No exemplo, você criou objetos de período para cada um dos seus períodos de 2014 para Artes e Ciências e agora as Escolas Médicas desejam gerenciar a disponibilidade de alguns dos cursos de cada escola usando esses objetos de período.

Pré-requisito

Você criou os objetos de período aos quais deseja associar seus cursos. Não há pré-condições; os cursos serão criados e associados ao período fornecido ou serão atualizados com a associação de períodos, conforme observado pelo tipo de duração do período.

Requisitos mínimos do feed de dados

EXTERNAL_COURSE_KEY
COURSE_ID
COURSE_NAME
DURAÇÃO
TERM_KEY

Solução

Criar um arquivo de dados termmanagedcourses.txt que contenha os cabeçalhos exigidos e os dados associados por curso que você quer adicionar ou atualizar no sistema.

Para utilizar corretamente START_DATE e END_DATE, é necessário especificar também um DURATION (RANGE). Por exemplo:

EXTERNAL_COURSE_KEY|COURSE_ID|COURSE_NAME|DURATION|TERM_KEY
AHIST.101-01.03.FA2013|AHIST.101-01.03.FA2013|Art History 101|TERM|AS_FA.2013
AHIST.101-01.03.WI2013|AHIST.101-01.03.WI2013|Art History 101|TERM|AS_WI.2014
AHIST.101-01.03.SP2013|AHIST.101-01.03.SP2013|Art History 101|TERM|AS_SP.2014
AHIST.101-01.03.SU2013|AHIST.101-01.03.SU2013|Art History 101|TERM|AS_SU.2014
ANAT.100-01.T1|ANAT.100-01.T1|Basic Anatomy|TERM|MED_T1.2013
ANAT.100-01.T2|ANAT.200-01.T2|Intermediate Anatomy|TERM|MED_T2.2014
ANAT.100-01.T3|ANAT.300-01.T3|Advanced Anatomy|TERM|MED_T3.2014

Pós-condições

Os cursos no feed de dados são criados ou atualizados e ficarão visíveis aos usuários conforme ditado pelos parâmetros do período associado a cada curso. O efeito em outros dados do sistema é ditado pela operação usada para carregar os dados no Learn:

Armazenamento
Ao usar o armazenamento, nenhum outro dado é afetado. Apenas os dados contidos no arquivo de feed de dados são adicionados ou atualizados.

ATUALIZAÇÃO COMPLETA
Ao usar a atualização completa, os dados contidos no arquivo são adicionados ou atualizados. Todos os outros dados gerenciados por esta fonte de dados são desativados devido a uma ausência no arquivo de dados, independentemente da fonte de dados.

ATUALIZAÇÃO COMPLETA PELA FONTE DE DADOS
Ao usar a atualização completa pela fonte de dados, os dados contidos no arquivo são adicionados ou atualizados. Todos os outros dados gerenciados por essa fonte de dados e associados à fonte de dados configurada para integração são desativados. Os dados que não estiverem no arquivo de feed e não associados à fonte de dados de integração não serão afetados.


Saiba mais

Visão geral da estrutura SIA

Descrições de cabeçalho do arquivo simples de instantâneo

Formato de dados do arquivo simples de instantâneo

Automação do arquivo simples de instantâneo