Se você conhecer o Instantâneo legado (Ferramentas de linha de comando do Instantâneo), 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 de Instantâneo e ao Instantâneo legado. 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 pontos de extremidade é configurável por meio da página de edição de integração.
Para obter uma descrição completa dos URLs e suas funções, consulte Arquivo simples de instantâneo.
Mudança de clientes ANGEL para o Learn
Existem diferenças entre os formatos de feed de dados Learn e ANGEL. Essas diferenças são evocadas no caminho de conhecimento do mapeamento de dados do ANGEL para o LEARN.
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 da utilização de 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 de instantâneo 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 de instantâneo.
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 amostras de uso de dados mais complexas, consulte Exemplos de arquivo simples de instantâneo.
Usuários
Tarefa: criar/atualizar usuários (pessoas)
URL: pessoa, armazenar ou atualizar
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
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/desativar usuários (pessoas)
URL: pessoa, excluir
Amostra:
external_person_key
testPerson1
Tarefa: feed de funções secundárias da pessoa na instituição
URL: função armazenar/atualizar/excluir
Amostra:
external_person_key|role_id
testPerson1|ALUMNI
testPerson1|PROSPECTIVE_STUDENT
testPerson2|ALUMNI
Tarefa: pessoa para o feed de associação de observadores
URL: associação, armazenar/atualizar/excluir
Amostra:
external_observer_key|external_user_key
testPerson6|testPerson1
Cursos
Tarefa: criar/atualizar novos cursos
URL: curso, armazenar ou atualizar
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 3
Tarefa: determinar a visualização do curso
URL: curso, armazenar ou atualizar
Amostra:
external_course_key|course_id|course_name|course_experience
testCourse1|TEST_COURSE_1|Test Course 1|Original
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/desativar novos cursos
URL: curso, excluir
Amostra:
external_course_key
testCourse1
Adicione o campo template_course_key ao arquivo de feed do curso quando quiser 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.
Comunidades
Tarefa: criar/atualizar novas organizações
URL: organizações, armazenar ou atualizar
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: desativar novas organizações
URL: organizações, excluir
Amostra:
external_organization_key
testOrg1
Associações
Tarefa: criar/atualizar associações de curso
URL: associação de curso, armazenar ou atualizar
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: associação de curso, excluir
Amostra:
external_person_key|external_course_key
testPerson1|testCourse1
Tarefa: Criar/Atualizar Associações de comunidades
URL: associação de organização, armazenar ou atualizar
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: desativar associações de organização
URL: associação de organização, armazenar ou atualizar
Amostra:
external_person_key|external_organization_key|role
testPerson1|testOrg1|instructor
Períodos
Tarefa: criar/atualizar períodos
URL: período, armazenar ou atualizar
Amostra:
external_term_key|name
testTerm1|Test Term 1
Tarefa: desativar um período
URL: período, excluir URL
Amostra:
external_term_key
testTerm1
Nós
Tarefa: criar/atualizar nós
URL: nó, armazenar ou atualizar
Amostra:
external_node_key|name
testNode1|Test Node 1
testNode2|Test Node 2
Tarefa: desativar períodos
URL: Nó Excluir
Amostra:
external_node_key
testNode1
Associações de nós
Tarefa: criar/atualizar/desativar associação de curso para nó
URL: associação de curso, armazenar/atualizar/excluir
Amostra:
external_association_key|external_course_key|external_node_key
testCourseAssociation1|testCourse1|testNode1
testCourseAssociation2|testCourse2|testNode2
Tarefa: Criar/Atualizar/Desativar Associação de usuário para nó
URL: associação de usuário, 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/desativar feed de associação de organização para nó
URL: associação de 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/desativar feed de categoria 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/desativar feed de categoria de organizações
URL: categoria de organizações, armazenar/atualizar/excluir
Amostra:
external_category_key|title
testOrgCategory1|Org Category 1
testOrgCategory2|Org Category 2
Tarefa: Criar/Atualizar/Desativar Feed de Associação da categoria do curso
URL: Associação da Categoria do curso Armazenar/Atualizar/Excluir
Amostra:
external_course_key|external_category_key|available_ind
testCourse1|testCourseCategory1|Y
testCourse2|testCourseCategory2|Y
testCourse3|testCourseCategory1|Y
Tarefa: Criar/Atualizar/Desativar Feed de associação da categoria da comunidade
URL: Associação da categoria da comunidade Armazenar/Atualizar/Excluir
Amostra:
external_organization_key|external_category_key|available_ind
testOrg1|testOrgCategory1|Y
testOrg2|testOrgCategory2|Y
testOrg3|testOrgCategory1|Y
Compatibilidade de pai e filho
Adicione o campo 'master_course_key' a um feed de curso quando houver um relacionamento pai/filho for desejado.
Você deve criar cursos pai antes de atribuir relacionamentos filho.
Tarefa: Criar um relacionamento Pai/Filho entre cursos
URL:Curso Armazenar/Atualizar
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 de 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 mestre de 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_template1
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
Para entender melhor a cópia e os modelos de cursos, consulte Criar cursos copiando cursos existentes.