Skip to main content

Formato de dados de arquivo simples do Snapshot

Se você conhecer o versões anteriores do Snapshot (Ferramentas de linha de comando do Snapshot), 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 e o requisito de incluir alguns campos anteriormente opcionais.

As mesmas regras de ordenação se aplicam aos arquivos simples do Snapshot e ao versões anteriores do Snapshot. Resumindo, os feeds não serão bem-sucedidos, a menos que as dependências sejam resolvidas. Por exemplo, um feed de associação não terá sucesso até que o feed do usuário e o feed do curso que contêm os objetos relacionados à associação sejam processados, ou um curso filho não pode ser vinculado a um curso pai até que o curso mestre (pai) seja criado. Essa lógica também se aplica aos períodos e nós.

Observe também que o comportamento do sistema no processamento de dados publicados nos terminais é configurável por meio da página de edição de integração.

Dica

Para obter uma descrição completa dos URLs e suas funções, consulte arquivo simples do Snapshot.

Clientes ANGEL mudando para o Blackboard

Existem diferenças entre os formatos de feed de dados Blackboard e ANGEL. Essas diferenças são destacadas no caminho de conhecimento de mapeamento de dados ANGEL para BLACKBOARD.

Conjunto de caracteres aceitável para os dados de integração

O conjunto de caracteres seguros incluído nos campos de dados principais é:

A-Z a-z 0-9 . ' , " : ! ? $ @ [ ] { } – _ *

As senhas e as chaves externas também podem conter:

% & # < > = \ + /

Amostras usando campos de dados mínimos

Observe que essas amostras são os dados mínimos necessários para o feed. Os objetos adicionais para cada feed podem ser derivados da UI de cabeçalhos personalizados da configuração avançada do arquivo simples do Snapshot da Estrutura do SIA. Além disso, você pode derivar a natureza necessária de um campo da UI do Mapeamento de campo. No final deste documento, há uma lista completa com descrições, exemplos de valores padrão e aceitáveis para cada objeto. Os URLs completos utilizados para a sua instalação são detectáveis por meio da UI da administração da Estrutura do SIA em Configuração HTTP. Para saber mais, consulte arquivo simples do Snapshot.

As amostras abaixo usam o caractere da barra vertical "|" como delimitador. Você poderá selecionar qual delimitador será usado quando você configurar sua implementação.

Para obter exemplos de uso de dados mais complexos, consulte Exemplos de arquivo simples do Snapshot.

Usuários

Tarefa: Criar/atualizar usuários (pessoas)

URL: Repositório ou atualização de pessoa

Amostra:

external_person_key|user_id|passwd|firstname|lastname|system_role

testPerson1|aanderson_test|changeme|Alpha|Anderson|none

testPerson2|bbrown_test|changeme|Beta|Brown|none

testPerson3|ccharlie_test|changeme|Chi|Charlie|none

testPerson4|ddavis_test|changeme|Delta|Davis|none

testPerson5|eedwards_test|changeme|Epsilon|Edwards|none

Nota

Embora o campo e-mail não seja obrigatório para criar um usuário, o fato de não criar um não limitará os recursos do sistema, como o envio por e-mail de notificações de curso etc.

Tarefa: Excluir/Desabilitar usuários (Pessoas)

URL: Exclusão de pessoa

Amostra:

external_person_key

testPerson1

Tarefa: Alimentação de Função da Instituição Secundária da Pessoa

URL: Armazenamento/Atualização/Exclusão de Funções

Amostra:

external_person_key|role_id

testPerson1|ALUMNI

testPerson1|PROSPECTIVE_STUDENT

testPerson2|ALUMNI

Tarefa: Alimentação da Associação de Pessoa para Observador

URL: Associação Armazenar/Atualizar/Excluir

Amostra:

external_observer_key|external_user_key

testPerson6|testPerson1

Cursos

Tarefa: Criar/Atualizar novos Cursos

URL: Armazenamento ou atualização do curso

Amostra:

external_course_key|course_id|course_name

testCourse1|TEST_COURSE_1|Test Course 1

testCourse2|TEST_COURSE_2|Test Course 2

testCourse3|TEST_COURSE_3|Test Course

Tarefa: Determinar a nova visualização do curso

URL: Armazenamento ou atualização do curso

Amostra:

external_course_key|course_id|course_name|course_experience

testCourse1|TEST_COURSE_1|Test Course 1|Origina

testCourse2|TEST_COURSE_2|Test Course 2|Ultra

testCourse3|TEST_COURSE_3|Test Course 3|Instructor choice

Os valores suportados são: Original, Ultra ou Escolha do instrutor. Esses valores são apenas inseridos e não podem ser atualizados por meio da estrutura do SIA.

Tarefa: Excluir/Desabilitar novos Cursos

URL: Exclusão do curso

Amostra:

external_course_key

testCourse1

Adicione o campo template_course_key ao arquivo de feed do curso quando desejar que um novo curso seja preenchido com o conteúdo de um curso mestre. Por exemplo, todos os novos cursos de matemática devem conter inicialmente os materiais de um curso mestre de matemática.

Organizações

Tarefa: Criar/atualizar novas organizações

URL: Armazenamento ou atualização de organizações

Amostra:

external_organization_key|organization_id|organization_name

testOrg1|TEST_ORG_1|Test Org 1

testOrg2|TEST_ORG_2|Test Org 2

testOrg3|TEST_ORG_3|Test Org 3

Tarefa: Desabilitar novas organizações

URL: Exclusão de organizações

Amostra:

external_organization_key

testOrg1

Associações

Tarefa: Criar/atualizar associações de curso

URL: Armazenamento ou atualização de associação do curso

Amostra:

external_person_key|external_course_key|role

testPerson1|testCourse1|instructor

testPerson1|testCourse2|student

testPerson2|testCourse1|student

testPerson3|testCourse1|student

testPerson4|testCourse2|instructor

testPerson5|testCourse3|student

Tarefa: Desativar associações de curso

URL: Exclusão de associação ao curso

Amostra:

external_person_key|external_course_key

testPerson1|testCourse1

Tarefa: Criar/atualizar associações de organização

URL: Repositório ou atualização de associação à organização

Amostra:

external_person_key|external_organization_key|role

testPerson1|testOrg1|instructor

testPerson1|testOrg2|student

testPerson2|testOrg1|student

testPerson3|testOrg1|student

testPerson4|testOrg2|instructor

testPerson5|testOrg3|student

Tarefa: Desabilitar associações de organização

URL: Repositório ou atualização de associação à organização

Amostra:

external_person_key|external_organization_key|role

testPerson1|testOrg1|instructor

Períodos

Tarefa: Criar/Atualizar Termos

URL: Repositório de Termos ou Atualização

Amostra:

external_term_key|name

testTerm1|Test Term 1

Tarefa: Desabilitar um termo

URL: URL de exclusão de termo

Amostra:

external_term_key

testTerm1

Nós

Tarefa: Criar/Atualizar Nós

URL: Armazenamento ou atualização de nós

Amostra:

external_node_key|name

testNode1|Test Node 1

testNode2|Test Node 2

Tarefa: Desabilitar Termos

URL: Exclusão de nó

Amostra:

external_node_key

testNode1

Associação de nó

Tarefa: Criar/Atualizar/Desabilitar Associação de Curso para Nó

URL: Armazenar/Atualizar/excluir Associação de Cursos

Amostra:

external_association_key|external_course_key|external_node_key

testCourseAssociation1|testCourse1|testNode1

testCourseAssociation2|testCourse2|testNode2

Tarefa: Criar/Atualizar/Desabilitar Associação de Usuário para Nó

URL: Associação de usuários Armazenar/Atualizar/Excluir

Amostra:

external_association_key|external_user_key|external_node_key

testUserAssociation1|testPerson1|testNode1

testUserAssociation2|testPerson2|testNode1

testUserAssociation3|testPerson1|testNode2

Tarefa: Criar/Atualizar/Desabilitar Organização para Feed de Associação de Nó

URL: Associação da Organização Armazenar/Atualizar/Excluir

Amostra:

external_association_key|external_organization_key|external_node_key

testOrgAssociation1|testOrg1|testNode1

testOrgAssociation2|testOrg2|testNode2

Compatibilidade de categoria

Tarefa: Criar/Atualizar/Desabilitar o feed de categorias do curso

URL: Categoria do curso Armazenar/Atualizar/Excluir

Amostra:

external_category_key|title

testCourseCategory1|Course Category 1

testCourseCategory2|Course Category 2

Tarefa: Criar/Atualizar/Desabilitar Feed de Categoria de Organizações

URL: Organizações Categoria Armazenar/Atualizar/Excluir

Amostra:

external_category_key|title

testOrgCategory1|Org Category 1

testOrgCategory2|Org Category 2

Tarefa: Criar/Atualizar/Desabilitar o Feed de Associação da Categoria do Curso

URL: Categoria do curso Armazenamento de associação / Atualizar / Excluir

Amostra:

external_course_key|external_category_key|available_ind

testCourse1|testCourseCategory1|Y

testCourse2|testCourseCategory2|Y

testCourse3|testCourseCategory1|Y

Tarefa: Criar/Atualizar/Desabilitar o Feed de Associação de Categoria da Organização

URL: Categoria da organização Armazenamento/Atualização/Exclusão de associação

Amostra:

external_organization_key|external_category_key|available_ind

testOrg1|testOrgCategory1|Y

testOrg2|testOrgCategory2|Y

testOrg3|testOrgCategory1|Y

Pensão alimentícia para pais e filhos

Adicione o campo 'master_course_key' a um feed de curso quando houver um relacionamento pai/filho for desejado.

Nota

Você deve criar cursos pai antes de atribuir relacionamentos filho.

Tarefa: Criar um relacionamento pai-filho entre cursos

URL: Armazenamento/atualização do curso

Amostra:

external_course_key|course_id|course_name|master_course_key

testCourse1|TEST_COURSE_1|Test Course 1|

testCourse2|TEST_COURSE_2|Test Course 2|testCourse1

testCourse3|TEST_COURSE_3|Test Course 3|testCourse1

testCourse4|TEST_COURSE_4|Test Course 4|

testCourse5|TEST_COURSE_5|Test Course 5|testCourse4

Nesse exemplo, TEST_COURSE_2 e TEST_COURSE_3 são filhos do curso pai TEST_COURSE_1, enquanto que TEST_COURSE_4 não é. Você também pode executar um feed de curso filho separadamente de um feed de curso em que todos os cursos conteriam um item para o script master_course_key apropriado – use Curso Armazenar para essa operação para reter cursos previamente armazenados.

Cópia/modelo do curso

Adicione o campo 'template_course_key' ao feed do curso quando desejar que um novo curso seja preenchido com o conteúdo de um curso "mestre". Por exemplo: todos os novos cursos de matemática devem conter inicialmente os materiais de um curso de mestrado em matemática.

Amostra:

external_course_key|course_id|course_name|master_course_key|template_course_key

testCourse1|TEST_COURSE_1|Test Course 1||test_course_templateplate1

testCourse2|TEST_COURSE_2|Test Course 2|testCourse1|

testCourse3|TEST_COURSE_3|Test Course 3|testCourse1|

testCourse4|TEST_COURSE_4|Test Course 4||test_course_template1

Dica

Para entender melhor a cópia e os modelos de cursos, consulte Criar cursos copiando cursos existentes.

Saiba Mais