Regras para todos os arquivos CSV
- Os valores dos arquivos diferenciam maiúsculas de minúsculas.
- Um valor em branco é representado por duas vírgulas sem espaços entre elas. Por exemplo, excluir colchetes, [,,], indica um valor em branco; já [, ,] indica um caractere de espaço, que é interpretado como um valor inválido.
- Os arquivos CSV devem ter um cabeçalho (primeira linha) que seja uma correspondência exata, incluindo maiúsculas/minúsculas, ao formato listado nos exemplos das seções a seguir.
- As linhas subsequentes do arquivo contêm os dados a serem processados (inseridos, atualizados e excluídos).
- Os nomes de arquivo são padrão (usuários, organizações e assim por diante).
Manifesto
Você deve incluir um arquivo de manifesto com cada pacote. O manifesto contém a versão e a lista de arquivos que você está enviando para o Brightspace e mostra se os dados da lista indicam o valor de cada pacote.
- O nome do arquivo deve ser manifest.csv.
- O valor pode ter uma das seguintes opções:
- Bulk (Em massa) — para importar instantâneos em massa. Os campos status e datelastmodified devem ser deixados em branco ao usar o modo em massa. O modo em massa só faz exclusões implícitas das inscrições.
- Delta — para importar deltas. Os campos status e datelastmodified devem ser preenchidos. Esse é o único modo que permite exclusões explícitas.
- Absent (Ausente) — se um arquivo não for enviado, ele deverá ser marcado como ausente.
A seguir, há um exemplo de conteúdo do manifesto (junto com a linha de cabeçalho necessária):
propertyName,value
manifest.version,1.0
oneroster.version,1.1
file.academicSessions,delta
file.categories,absent
file.classes,delta
file.classResources,absent
file.courses,delta
file.courseResources,absent
file.demographics,absent
file.enrollments,delta
file.lineItems,absent
file.orgs,delta
file.users,delta
file.resources,absent
file.results,absent
|
Observação: o uso do CSV OneRoster no modo Bulk permite que o SIS cancele automaticamente a inscrição dos usuários de cursos e seções se eles não estiverem mais incluídos no arquivo em massa. Esse recurso garante que o Brightspace permaneça sincronizado com o SIS sem exigir dados explícitos de cancelamento de inscrição nos arquivos do OneRoster. |
Sessões acadêmicas
A seguir, há duas linhas de exemplo de conteúdo para sessão acadêmica (com a linha de cabeçalho necessária). O arquivo consiste em nove colunas obrigatórias e cada uma deve ser preenchida com um valor válido ou ser deixada em branco, dependendo do formato do arquivo.
sourcedId,status,dateLastModified,title,type,startDate,endDate,parentSourcedId,schoolYear
TERM_LW11,active,2016-04-30T00:00:00Z,Spring TERM_LW11,term,2017-04-30,2017-06-30,,2017
GRADINGPERIOD_LW11,active,2016-04-30T00:00:00Z,Full Spring GRADINGPERIOD_LW11,gradingPeriod,2017-04-30,2017-06-30,TERM_LW11,2017
| Coluna |
Campo |
Obrigatório |
Valores aceitos |
Observações |
| 1 |
SourceId |
Y |
|
Armazenado com IPSIS para mapeamento para uma unidade organizacional do Brightspace |
| 2 |
Status |
Y |
ativo, a ser excluído |
Usado para criar/atualizar ou excluir a sessão acadêmica. Obrigatório se dateLastModified estiver presente e se estiver enviando deltas. |
| 3 |
Data da Última Alteração |
N |
AAAA-MM-DDTHH:mm:SS:ssZ |
"Rastreamento interno" |
| 4 |
Título |
Y |
|
Nome da unidade organizacional e Código da unidade organizacional |
| 5 |
Tipo |
Y |
gradingPeriod, semester, schoolyear, term |
Tipo de unidade organizacional |
| 6 |
StartDate |
Y |
AAAA-MM-DD |
A data de início da sessão acadêmica pode ser copiada para as datas de início das ofertas de curso associadas. |
| 7 |
EndDate |
Y |
AAAA-MM-DD |
A data final da sessão acadêmica pode ser copiada para as datas finais das ofertas de curso associadas. |
| 8 |
ParentSourceId |
N |
|
Ignorado |
| 9 |
Ano escolar |
Y |
AAAA |
Não mapeado |
Organizações
A seguir, há quatro linhas de exemplo de conteúdo para organizações (com a linha de cabeçalho necessária). O arquivo consiste em sete colunas obrigatórias e cada uma deve ser preenchida com um valor válido ou ser deixada em branco, dependendo do formato do arquivo.
sourcedId,status,dateLastModified,name,type,identifier,parentSourcedId
DISTRICT_LW11,active,2016-04-30T00:00:00Z,DISTRICT_LW11,district,,
SCHOOL_LW111,active,2016-04-30T00:00:00Z,SCHOOL_LW111,school,,DISTRICT_LW11
DISTRICT_LW12,active,2016-04-30T00:00:00Z,DISTRICT_LW12,district,,
SCHOOL_LW121,active,2016-04-30T00:00:00Z,SCHOOL_LW121,school,,DISTRICT_LW12
| Coluna |
Campo |
Obrigatório |
Valores aceitos |
Observações |
| 1 |
SourceId |
Y |
|
Armazenado com IPSIS para mapeamento para uma unidade organizacional do Brightspace |
| 2 |
Status |
N |
ativo ou a ser excluído |
Criar/atualizar ou excluir a unidade organizacional. Obrigatório se dateLastModified estiver presente e se estiver enviando deltas |
| 3 |
Data da Última Alteração |
N |
AAAA-MM-DDTHH:mm:SS:ssZ |
"Rastreamento interno" |
| 4 |
Nome |
Y |
|
Nome e código da unidade organizacional (se o identificador não estiver preenchido) |
| 5 |
Tipo |
Y |
departamento, escola, distrito, local, estado, nacional |
Tipo de unidade organizacional |
| 6 |
Identificador |
N |
|
Código da unidade organizacional (se informado) |
| 7 |
ParentSourcedId |
N |
|
O SourceId da unidade organizacional principal não é especificamente necessário; no entanto, sem ele, as unidades organizacionais não farão parte de uma hierarquia |
Cursos
A seguir, há duas linhas de exemplo de conteúdo para cursos (junto com a linha de cabeçalho necessária). O arquivo consiste em dez colunas obrigatórias e cada uma deve ser preenchida com um valor válido ou ser deixada em branco, dependendo do formato do arquivo.
sourcedId,status,dateLastModified,schoolYearSourcedId,title,courseCode,grades,orgSourcedId,subjects,subjectCodes
COURSE_LW11,active,2017-04-30T00:00:00Z,,The ways of the Force,COURSE_LW11,,SCHOOL_LW111,,
COURSE_LW12,active,2017-04-30T00:00:00Z,,French As A Second Language,COURSE_LW12,,SCHOOL_LW111,,
| Coluna |
Campo |
Obrigatório |
Valores aceitos |
Observações |
| 1 |
SourceId |
Y |
|
Armazenado com IPSIS para mapeamento para uma unidade organizacional do Brightspace (modelo de curso) |
| 2 |
Status |
N |
ativo ou a ser excluído |
Criar/atualizar ou excluir o modelo de curso. Obrigatório se dateLastModified estiver presente e se estiver enviando deltas |
| 3 |
Data da Última Alteração |
N |
AAAA-MM-DDTHH:mm:SS:ssZ |
"Rastreamento interno" |
| 4 |
SchoolYearSourceId |
N |
|
Ignorado |
| 5 |
Título |
Y |
|
Nome e código da unidade organizacional (se o identificador não estiver preenchido) |
| 6 |
CourseCode |
N |
|
Código da unidade organizacional (se fornecido) |
| 7 |
Notas |
N |
|
Ignorado
|
| 8 |
OrgSourceId |
Y |
|
SourceID da unidade organizacional principal (ou seja, Escola) |
| 9 |
Assuntos |
N |
|
Ignorado |
| 10 |
SubjectCodes |
N |
|
Ignorado |
Aulas
A seguir, há três linhas de exemplo de conteúdo para aulas (junto com a linha de cabeçalho necessária). O arquivo consiste em 14 colunas obrigatórias e cada uma deve ser preenchida com um valor válido ou ser deixada em branco, dependendo do formato do arquivo. Cada registro é criado como uma oferta de curso, com uma só seção para ela.
sourcedId,status,dateLastModified,title,grades,courseSourcedId,classCode,classType,location,schoolSourcedId,termSourcedIds,subjects,subjectCodes,periods
CLASS_LW111,active,2017-04-30T00:00:00Z,The Force 101,,COURSE_LW11,CLASS_LW111,scheduled,,SCHOOL_LW111,TERM_LW11,,,
CLASS_LW112,active,2017-04-30T00:00:00Z,The Force Advanced,,COURSE_LW11,CLASS_LW112,scheduled,,SCHOOL_LW111,TERM_LW11,,,
CLASS_LW121,active,2017-04-30T00:00:00Z,French - Reading LW1,,COURSE_LW12,CLASS_LW121 fr-reading,scheduled,,SCHOOL_LW111,TERM_LW11,,,
| Coluna |
Campo |
Obrigatório |
Valores aceitos |
Observações |
| 1 |
SourceId |
Y |
|
Armazenado com IPSIS para mapeamento para uma unidade organizacional do Brightspace (oferta de curso) |
| 2 |
Status |
N |
ativo ou a ser excluído |
Criar/atualizar ou excluir a oferta de curso e seção (definir como inativo ou excluir com base na Configuração de administração do IPSIS). Obrigatório se dateLastModified estiver presente |
| 3 |
Data da Última Alteração |
N |
AAAA-MM-DDTHH:mm:SS:ssZ |
"Rastreamento interno" |
| 4 |
Título |
Y |
|
Nome da unidade organizacional e código da unidade organizacional (se classCode não for fornecido) |
| 5 |
Notas |
N |
|
Ignorado |
| 6 |
CourseSourceId |
Y |
|
SourceID da unidade organizacional principal (modelo do curso) |
| 7 |
ClassCode |
N |
|
Código da unidade organizacional (se informado) |
| 8 |
ClassType |
Y |
sala de aula, programado |
Ignorado |
| 9 |
Local |
N |
|
Ignorado
|
| 10 |
SchoolSourceId |
Y |
|
SourceID da unidade organizacional principal (ou seja, Escola) |
| 12 |
TermsSourceId |
Y |
|
SourceID da unidade organizacional principal (ou seja, semestre) |
| 12 |
Assuntos |
N |
|
Ignorado |
| 13 |
SubjectCodes |
N |
|
Ignorado |
| 14 |
Periods |
N |
|
Ignorado |
Usuários
A seguir, há cinco linhas de exemplo de conteúdo para usuários (junto com a linha de cabeçalho necessária). O arquivo consiste em 18 colunas obrigatórias e cada uma deve ser preenchida com um valor válido ou ser deixada em branco, dependendo do formato do arquivo.
|
sourcedId,status,dateLastModified,enabledUser,orgSourcedIds,role,username,userIds,givenName,familyName,middleName,identifier,email,sms,phone,agentSourcedIds,grades,password
STUDENT_LW11,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,student,STUDENT_LW11,,Luke,Walker,,,email@email.com,,,"PARENT_LW11,TEACHER_LW11,GUARDIAN_LW11",,
STUDENT_LW12,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,student,STUDENT_LW12,,Prince,Lee,,,email@email.com,,,"PARENT_LW11,GUARDIAN_LW11",,
PARENT_LW11,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,parent,PARENT_LW11,,Bartholomew,Vadery,,,email@email.com,,,"STUDENT_LW11,STUDENT_LW12",,
GUARDIAN_LW11,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,guardian,GUARDIAN_LW11,,Obi,Kennedy,,,email@email.com,,,"STUDENT_LW11,STUDENT_LW12",,
TEACHER_LW11,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,teacher,TEACHER_LW11,,Mac,Yodad,,,email@email.com,,,"STUDENT_LW12,STUDENT_LW11",,
|
| Coluna |
Campo |
Obrigatório |
Valores possíveis |
Observações |
| 1 |
SourcedId |
Y |
|
Armazenado com Pacote de integração para sistemas de informação ao aluno para mapeamento para um uso do Brightspace. Se o identificador não for fornecido, sourcedId se tornará o ID definido da organização. |
| 2 |
Status |
N |
ativo ou a ser excluído |
Ativo por padrão (depende da configuração da IU)
Obrigatório se DateLastModified estiver presente
Inativo ou a ser excluído desativa o usuário |
| 3 |
Data da Última Alteração |
N |
YYYY-MM-DDTHH:mm:SS*,s*ssZ |
"Rastreamento interno" |
| 4 |
EnabledUser |
Y |
verdadeiro ou falso |
Ativo no LMS se verdadeiro |
| 5 |
OrgSourceIds |
Y |
|
Inscrição da unidade organizacional da escola |
| 6 |
Função |
Y |
|
Função na organização |
| 7 |
UserName |
Y |
|
UserName
|
| 8 |
UserIds |
N |
|
Ignorado |
| 9 |
GivenName |
Y |
|
FirstName |
| 10 |
FamilyName |
Y |
|
LastName |
| 11 |
MiddleName |
N |
|
MiddleName |
| 12 |
Identificador |
N |
|
OrgDefinedId (se informado) |
| 13 |
E-mail |
N |
|
ExternalEmail |
| 14 |
Sms |
N |
|
Ignorado |
| 15 |
Telefone |
N |
|
Ignorado |
| 16 |
AgentSourcedIds |
N |
|
Usado para indicar a relação pai/responsável |
| 17 |
Notas |
N |
|
Ignorado |
| 18 |
Senha |
N |
|
|
Inscrições
A seguir, há uma linha de exemplo de conteúdo para inscrições (junto com a linha de cabeçalho necessária). O arquivo consiste em dez colunas obrigatórias e cada uma deve ser preenchida com um valor válido ou ser deixada em branco, dependendo do formato do arquivo. Um usuário especificado será inscrito em uma oferta de curso e uma seção
|
sourcedId,status,dateLastModified,classSourcedId,schoolSourcedId,userSourcedId,role,primary,beginDate,endDate
STUDENT_CLASS_LW1111,active,2017-04-30T00:00:00Z,CLASS_LW111,SCHOOL_LW111,STUDENT_LW11,student,,,
|
| Coluna |
Campo |
Obrigatório |
Valores possíveis |
Observações |
| 1 |
SourceId |
Y |
|
*Rastreamento interno* |
| 2 |
Status |
N |
ativo ou a ser excluído |
Ativo por padrão
Obrigatório se DateLastModified estiver presente |
| 3 |
Data da Última Alteração |
N |
AAAA-MM-DDTHH:mm:SS:ssZ |
"Rastreamento interno" |
| 4 |
UserSourcedId |
Y |
|
Usuário a ser inscrito |
| 5 |
ClassSourcedId |
Y |
|
Aula na qual fazer inscrição |
| 6 |
SchoolSourcedId |
Y |
verdadeiro ou falso |
Ignorado |
| 7 |
Função |
Y |
Os únicos valores permitidos são administrador, supervisor, aluno e professor. |
Função na unidade organizacional de oferta de curso
|
| 8 |
Chave primária |
N |
|
Ignorado |
| 9 |
BeginDate |
N |
|
Ignorado |
| 10 |
EndDate |
N |
|
Ignorado |