Processo Migração de Dados

De Gennera Apps
Ir para: navegação, pesquisa

O processo de migração de dados é realizado por meio de arquivos de importação, que seguem um layout específico e que devem ser gerados, pelo responsável na instituição, com base nos dados do sistema legado da instituição de ensino para que sejam posteriormente importados na plataforma da Gennera.

De todas as etapas do processo de implantação, a fase de migração dos dados é a que exige mais atenção, já que muitas vezes, os usuários da instituição de ensino não possuem o conhecimento técnico necessário para a geração dos arquivos.

Em muitos casos, pode ser necessário contratar um especialista externo para realizar a geração dos arquivos de importação com o auxílio dos usuários da instituição de ensino, que conhecem com mais profundidade os processos de negócio e sabem operar o sistema legado.

A plataforma da Gennera conta com um módulo específico para validar os arquivos de importação que deve ser utilizado durante a etapa de geração dos arquivos. Após a validação, a equipe de migração de dados da Gennera iniciará o processo de carga dos dados para que o responsável pela instituição de ensino possa aprovar, encerrando o processo de migração de dados.

Índice

Formato dos Arquivos

Os arquivos de importação devem seguir as seguintes regras:

  • Devem conter o nome das colunas no cabeçalho
  • Devem ser codificados em UTF-8
  • Devem ter os dados, entre as colunas, separados por TAB
  • Devem ser respeitados os campos indicados como obrigatórios
  • Os números decimais devem utilizar "." (ponto), e não "," (vírgula), para separar a parte inteira das casas decimais
    • 1000 é um valor válido
    • 9.5 é um valor válido
    • 1,5 é um valor inválido
  • As datas devem ser formatadas utilizando o padrão DD/MM/AAAA e devem ser válidas
    • 01/01/2002 é um valor válido
    • 99/99/9999 é um valor inválido
  • O arquivo deve possuir um total de no máximo 20000 registros
  • As colunas devem seguir o padrão separadas por underline (_) ou no formato camelCase.
    • Ex:
      • id_person: formato underline(_)
      • idPerson: formato camelCase

Arquivos de Importação

Dados cadastrais básicos

Curso

Informações dos Cursos.

Nome do Arquivo: Curso.csv

Modelo de exemplo: Curso template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_course Identificador do curso Somente Números Ex: 123, 67 integer Sim
name Nome do curso O nome do curso na instituição de ensino text Sim
code Código do curso EF, EM, EM2, ES, etc text
level Nome do nível do curso Educação Superior, Educação Básica text
type Nome do tipo do curso Cursos Sequencias, Graduação, Pós Graduação, Extensão text
coordinator Coordenador(a) Nome do coordenador do curso text
grade Titulação do Coordenador(a) bacharelado, etc text
secretary Nome do secretário João Paulo, etc text
secretary_subscription Inscrição do secretário Descrição da inscrição text
authorization Autorização Descrição da autorização text
recognition Reconhecimento Descrição do reconhecimento text
code_inep Código do Curso no INEP/E-MEC Código do Curso no INEP/E-MEC text
modality Modalidade Presencial, A distância, semipresencial text
search Se igual a true, o importador irá procurar um curso ja existente com o mesmo nome. Se for encontrado o sistema fará o vínculo com o mesmo. Caso contrário o processo segue normalmente e irá criar um novo curso. false/true boolean

Currículo

Informações dos currículos.

Nome do Arquivo: Curriculo.csv

Modelo de exemplo: Currículo template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_curriculum Identificador do currículo Somente Números Ex: 123, 67 integer Sim
name Nome do currículo O nome do currículo na instituição de ensino text Sim
id_course Identificador do curso Somente Números Ex: 123, 67 integer Sim Curso
workload_duration Carga Horária da Aula (minutos) integer
min_duration_enrollment Quantidade mínima de matrículas (número) integer
max_duration_enrollment Quantidade máxima de matrículas (número) integer
min_workload_required Carga horária mínima de disciplinas obrigatórias (horas) integer
min_workload_optional Carga horária mínima de disciplinas optativas (horas) integer
min_workload_elective Carga horária mínima de disciplinas eletivas (horas) integer
min_workload_enrollment Carga horária mínima por matrícula (horas) integer
max_workload_enrollment Carga horária máxima por matrícula (horas) integer
workload_complementary_activity Carga horária de atividade complementar (horas) integer
extension_curricular_workload Carga horária de curricularização da extensão (horas) integer
search Se igual a true, o importador irá procurar um currículo já existente com o mesmo nome. Se for encontrado o sistema fará o vínculo com o mesmo. Caso contrário o processo segue normalmente e irá criar um novo currículo. false/true boolean

Atividade Complementar

Informações das atividades complementares dos currículos.

Nome do Arquivo: Atividade_complementar.csv

Modelo de exemplo: Atividade Complementar template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_complementary_activity Identificador da Atividade complementar Somente Números Ex: 123, 67 integer Sim
name Nome da atividade O nome da atividade complementar text Sim
id_curriculum Identificador do currículo Somente Números Ex: 123, 67 integer Sim Currículo
workload_duration Carga Horária da Aula (minutos) integer
max_workload Carga Horária Máxima integer
min_workload Carga Horária Mínima integer
scholarship Bolsa/remuneração true/false boolean

Módulo

Informações dos módulos.

Nome do Arquivo: Modulo.csv

Modelo de exemplo: Módulo template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_module Identificador do módulo Somente Números Ex: 123, 67 integer Sim
name Nome do módulo O nome do módulo na instituição de ensino text Sim
index Ordem crescente em que será apresentado o módulo Somente Números Ex: 1, 2, 3 ... integer Sim
search Se igual a true, o importador irá procurar um módulo já existente com o mesmo nome. Se for encontrado o sistema fará o vínculo com o mesmo. Caso contrário o processo segue normalmente e irá criar um novo módulo. false/true boolean
id_curriculum Identificador do currículo Somente Números Ex: 123, 67 integer Sim Currículo

Disciplina

Informações das disciplinas.

Nome do Arquivo: Disciplina.csv

Modelo de exemplo: Disciplina template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_subject Identificador da disciplina Somente Números Ex: 123, 67 integer Sim
name Nome da disciplina O nome da disciplina na instituição de ensino text Sim
index Ordem crescente em que será apresentada a disciplina Somente Números Ex: 1, 2, 3 ... integer Sim
credit número de créditos Somente Números Ex: 4, 5, 5.5 ... numeric Sim
required Obrigatoriedade true, false boolean
workload Carga horária Presencial Somente Números Ex: 95, 100, ... numeric
remote_workload Carga horária Remota Somente Números Ex: 95, 100, ... numeric
code Código descritivo da disciplina PT, MAT, etc text
extension Extensão true, false boolean
extension_attendance_workload Carga Horária Presencial de Extensão Somente Números Ex: 95, 100, ... numeric
experience_workload Carga Horária Prática Somente Números Ex: 95, 100, ... numeric
theory_workload Carga Horária Teórica Somente Números Ex: 95, 100, ... numeric
match_subject_by_code Busca automaticamente disciplinas com o mesmo código mas em outros currículos e relaciona a equivalência entre elas true, false boolean
id_module Identificador do módulo Somente Números Ex: 123, 67 integer Sim Módulo
blended Indicativo semipresencial (caso for true, híbrido deve ser false) true, false boolean
hybrid Indicativo híbrido (caso for true, semipresencial deve ser false) true, false boolean

Plano de Ensino

Informações do plano de ensino da Disciplina.

Nome do Arquivo: PlanoEnsino.csv

Modelo de Exemplo:

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_subject Identificador da Disciplina aonde será importado o Plano de Ensino Somente Números Ex: 123, 67 integer Sim Disciplina
id_syllabus Identificador único para o Plano de Ensino Somente Números Ex: 123, 67 integer Sim
syllabus Ementa text
goals Objetivos text
program_content Conteúdo Programático text
methodology_approach Abordagem de Metodologia text
evaluation_process Processo de Avaliação text
bibliographic_reference Referência Bibliográfica Básica text
complementary_biblographic Referência Bibliográfica Complementar text
skills_and_competences Habilidades e Competências text

Calendário Acadêmico

Informações dos calendários acadêmicos.

Nome do Arquivo: CalendarioAcademico.csv

Modelo de exemplo: Calendário template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_academic_calendar Identificador do calendário acadêmico Somente Números Ex: 123, 67 integer Sim
name Descrição do calendário acadêmico Nome do calendário na instituição de ensino text Sim
start_date Data inicial do calendário 31/01/1990 date Sim
end_date Data inicial do calendário 31/01/1990 date Sim
code Código do Calendário A1, 20102, etc text
reference_year Ano Referência 2010, 20182 text
search Se igual a true, o importador irá procurar um calendário já existente com o mesmo nome. Se for encontrado o sistema fará o vínculo com o mesmo. Caso contrário o processo segue normalmente e irá criar um novo calendário. false/true boolean

Semana do Calendário Acadêmico

Informações das semanas dos calendários acadêmicos.

Nome do Arquivo: SemanaCalendarioAcademico.csv

Modelo de exemplo:

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_academic_calendar_week Identificador da semana calendário acadêmico Somente Números Ex: 123, 67 integer Sim
id_academic_calendar Código ÚNICO que identifica o calendário acadêmico Somente Números Ex: 123, 67 integer Sim
name Descrição da semana do calendário acadêmico Nome da semana do calendário na instituição de ensino text Sim
start_date Data inicial do calendário 31/01/1990 date Sim
end_date Data inicial do calendário 31/01/1990 date Sim

Período

Informações dos períodos.

Nome do Arquivo: Periodo.csv

Modelo de exemplo: Período template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_period Identificador do período Somente Números Ex: 123, 67 integer Sim
name Descrição do período Nome do período na instituição de ensino text Sim
start_date Data inicial do calendário 31/01/1990 date Sim
end_date Data inicial do calendário 31/01/1990 date Sim
code Código do Período P1, P2, etc text
index Ordem crescente do período 1, 2, 3, 4 integer Sim
retake_period Período de recuperação true, false boolean
id_academic_calendar Identificador do calendário acadêmico Somente Números Ex: 123, 67 integer Sim Calendário Acadêmico
search Se igual a true, o importador irá procurar um período já existente com o mesmo nome. Se for encontrado o sistema fará o vínculo com o mesmo. Caso contrário o processo segue normalmente e irá criar um novo período. false/true boolean

Pessoa

Dados completos das pessoas cadastradas na instituição de ensino.

Nome do Arquivo: Pessoa.csv

Modelo de exemplo: Pessoa template

Filtro: Todos os registros existentes

Obrigatório: Sim

  • Atenção:

Se já existir os cadastros feito manualmente no produto Pessoas e seja necessário ter o vínculo das mesmas em forma de arquivo, tem uma solução.

Basta criar os arquivos com 4 informações necessárias (id_person, id_student, name, cpf ou cnpj).

O sistema verificará com o auxílio das informações (name e cpf ou cnpj) se a pessoa já se encontra cadastrada.

Caso encontre, o sistema fará o vinculo deixando o registro com o status integrado.

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_person Código ÚNICO que identifica a pessoa na instituição de ensino 001, 002, 003, etc integer sim
id_student Código ÚNICO que identifica o aluno na instituição de ensino que poderá ser o mesmo valor de id_person 001, 002, 003, etc integer
profile O perfil da pessoa 1 (Professor), 2 (Aluno), 3 (Instituição) integer
type O tipo de pessoa 1 (Pessoa Física), 2 (Pessoa Jurídica), 3 (Pessoa Física - Estrangeiro), 4 (Pessoa Física (Residência no Exterior) ) integer
name Nome da pessoa (necessário nome e sobrenome) João C. Lima, Ana Maria S. Cruz, etc. text sim
social_name Nome social da pessoa João C. Lima, Ana Maria S. Cruz, etc. text
legal_name Razão social (Somente para pessoas do tipo 2) Consultoria LTDA, etc text
email Email da pessoa aluno@yahoo.com.br text
zipcode CEP 88122420 (somente números) text
street Logradouro da residência R. Floriano, R. Direita, etc. text
street_number Número de localização da residência no logradouro. 123, 44, etc text valor default S/N
city Nome da Cidade da residência São Paulo text
state Sigla da UF residencial SP varchar(2)
country Nome do País Brasil text
complement Complemento do logradouro (Número da casa, apartamento, bloco, etc). Edifício Gennera - apto 201; bloco A, apto 44; etc text
neighborhood Bairro da residência Centro text
zone Indica a zona residencial Urbana ou Rural text
birthdate Data de nascimento 31/01/1990 date
birthplace Nome da cidade de nascimento São Paulo, Santos, Niterói, Itabirito, etc. text
birth_state UF de nascimento SC, SP, RJ, MG. varchar(2)
birth_country País de nascimento Brasil, Uruguai, etc text
nationality Nacionalidade Brasileira, Chilena, Argentina, etc. text
gender Sexo da pessoa Masculino, Feminino, text
ethnicity Cor/raça do aluno conforme classificação do MEC Indígena, Amarela, Parda, Não Declarada, Preta, Branca text
rg Número da carteira de Identidade (RG) 12345678 (somente números) text
rg_issuing_agency Código do órgão expedidor da carteira de identidade SSP, MEx, CREA, OAB, DPF, etc. text
rg_issuing_state UF do órgão expedidor da carteira de identidade SC, SP, RJ, MG. varchar(2)
rg_issue_date Data de Expedição da carteira de identidade 31/01/1999 date
social_id Número de Identificação Social 123456 text
cpf Número do CPF da pessoa 20919195600 (somente números) text
cnpj Número do CNPJ da pessoa 31575212000120 (somente números) text
civil_status Estado civil Solteiro, Casado, Divorciado, Viúvo, Separado text
profession Profissão Estudante, Comerciário, etc. text
religion Religião Católica, Protestante, Espírita, etc. text
telephone_area_code Código de área do telefone 48 varchar(2)
telephone_number Número do telefone 32333020 (sem formatação e sem código de área) text
mobile_phone_area_code Código de área do telefone celular 48 varchar(2)
mobile_phone_number Número do telefone celular 8888888 text
commercial_phone_area_code Código de área do telefone comercial 48 varchar(2)
commercial_phone_number Número do telefone comercial 88888888 text
fax_area_code Código de área do fax 48 varchar(2)
fax_number Número do fax 88888888 text
foreigner_document_issue_date Data de expedição da Carteira de estrangeiro 31/01/1990 date
foreigner_document Código do Registro Nacional de Estrangeiro 123456 text
foreigner_document_expiry_date Data de validade do documento de estrangeiro 31/12/2010 date
military_status Descrição da situação militar Dispensado text
military_description Descrição do Registro Militar text
military_certificate Número do certificado Militar 12345 text
military_certificate_description Descrição do certificado Militar text
voter_document Número do Titulo de Eleitor 12341 text
voter_document_issue_date Data de expedição do Titulo de Eleitor 31/01/1990 date
voter_document_city Nome do município de emissão do Titulo de Eleitor São Paulo, Rio de Janeiro, etc. text
voter_document_state Sigla da UF de emissão do Titulo de Eleitor SP, SC, RJ char(2)
voter_document_section Descrição da seção do Titulo de Eleitor 154 char(3)
voter_document_zone Número da zona eleitoral 2 char(3)
civil_certificate_term Número do Termo da Certidão Civil 432 text
civil_certificate_page Número da folha no livro de Certidão Cívil 521 text
civil_certificate_book Descrição do Livro da Certidão Civil A-028 text
civil_certificate_issue_date Data da emissão da Certidão Cívil 01/01/1900 date
civil_certificate_agency_state Sigla da UF do cartório SC char(2)
civil_certificate_agency Nome do órgão usado para emitir a Certidão Civil. 11º Cartório do Registro Civil text
civil_certificate_father Nome do pai usado na Certidão Civil. text
civil_certificate_mother Nome da mãe usado na Certidão Civil. text
marriage_certificate_term Número do Termo da Certidão de casamento 432 text
marriage_certificate_page Número da folha no livro de Certidão de casamento 521 text
marriage_certificate_book Descrição do Livro da Certidão de casamento A-028 text
marriage_certificate_issue_date Data da emissão da Certidão de casamento 01/01/1900 date
marriage_certificate_agency_state Sigla do UF do cartório SP, RJ text
marriage_certificate_agency Nome do órgão usado para emitir a Certidão de casamento. 12º Cartório text
identity Identidade, caso estrangeiro text
commercial_name Nome da empresa de trabalho text
passport passaporte text
academic_title Tituação do professor (caso a pessoa seja um professor) text
student_code_inep Código do aluno no INEP text
academic_registration Registro Acadêmico text
conclusion_date Data de conclusão do ensino médio text
conclusion_educational_institution Instituição de ensino do ensino médio text
conclusion_educational_city Cidade de conclusão do ensino médio text
conclusion_educational_uf UF de conclusão do ensino médio text
photo_person Nome da imagem a ser integrada (processo separado de integração de fotos) Ex: perfil.jpg, gabriel.jpg, etc text
function Função 1-Docente, 2-Auxiliar/assistente educacional, 3-Profissional/monitor de atividade complementar, 4-Tradutor-intérprete de Libras, 5-Docente titular – coordenador de tutoria (de módulo ou disciplina) – EaD, 6-Docente tutor – auxiliar (de módulo ou disciplina) – EaD integer
codigo_professor_INEP Código INEP 123,12456, etc text
type_of_school Tipo de escola - Conclusão do Ensino Médio Privada/Público text
elementary_school_type_of_school Tipo de escola - Conclusão do Ensino Fundamental Privada/Público text
hiring_regime Regime de Contratação 1-Concursado/efetivo/estável, 2-Contrato temporário, 3-Contrato terceirizado, 4-Contrato CLT integer
curriculum_URL URL Currículo Lattes www.... text

Filiação

Dados dos pais, mães e responsáveis dos alunos.

Nome do Arquivo: AlunoFil.csv

Modelo de exemplo: Filiação template

Filtro: Todos os alunos existentes

Obrigatório: Sim

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_person Código da pessoa 1 integer sim Pessoa
id_student Código do aluno 1 integer sim Pessoa
relationship Grau de parentesco ou relacionamento que a pessoa tem com o aluno Um desses valores: pai, mãe, irmão, irmã, avô, avó, adotador, responsável, outros text sim
is_financial_responsible Indicar se essa pessoa é responsável financeiro do aluno true/false boolean sim


Polo

Informações sobre os polos.

Nome do Arquivo: polo.csv

Modelo de Exemplo:

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_polo Identificador do Polo Somente Números Ex: 123, 67 integer Sim
name Nome do polo O nome do polo text Sim
code Código do polo O código do polo text Não

Campus

Informações sobre os campus.

Nome do Arquivo: campus.csv

Modelo de Exemplo:

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_campus Identificador do Campus Somente Números Ex: 123, 67 integer Sim
id_polo Código único que identifica o polo 1, 123, ... integer Sim Polo
name Nome do campus O nome do campus text Sim
code Código do campus O código do campus text Não

Bloco

Informações sobre os blocos.

Nome do Arquivo: block.csv

Modelo de Exemplo:

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_block Identificador do Bloco Somente Números Ex: 123, 67 integer Sim
id_campus Código único que identifica o campus 1, 123, ... integer Sim Campus
name Nome do bloco O nome do bloco text Sim
code Código do bloco O código do bloco text Não

Sala

Informações sobre as salas.

Nome do Arquivo: room.csv

Modelo de Exemplo:

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_room Identificador da Sala Somente Números Ex: 123, 67 integer Sim
id_block Código único que identifica o bloco 1, 123, ... integer Sim Bloco
name Nome da sala O nome da sala text Sim
code Código da sala O código da sala text Não
number_occupants Número de ocupantes 10, 15, 20 ... integer Não

Dados de Ofertas

Oferta de currículo

Informações referentes a oferta de currículo.

Nome do Arquivo: curriculumOffer.csv

Modelo de exemplo: Oferta de currículo template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_curriculum_offer Código único que identifica a oferta. 1, 5, 120, ... integer sim
id_academic_calendar Código único que identifica o calendário acadêmico 1, 123, ... integer sim Calendário Acadêmico
id_curriculum Código único que identifica o currículo 1, 123, ... integer Sim Currículo

Turma

Informações referentes a turma.

Nome do Arquivo: class.csv

Modelo de exemplo: Turma template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_class Código único que identifica a turma. 1, 5, 120, ... integer sim
id_curriculum_offer Código único que identifica a oferta de currículo 1, 123, ... integer sim Oferta de Currículo
id_module Código único que identifica o módulo 1, 123, ... integer Sim Módulo
name Nome da turma A, AB, ... text Sim
start_date Data início 01/01/2021 date
end_date Data fim 01/12/2021 date
shift Turno 1 - Matutino, 2 - Vespertino, 3 - Noturno, 4 - Integral integer
inep_code Código INEP 1, 2, 1000, A1111 ... text
physical_location Local Físico 1, 2, Florianópolis, A111 ... text

Turma x Disciplina

Informações referentes a turma x disciplina.

Nome do Arquivo: classSubjectOffer.csv

Modelo de exemplo: Turma x Disciplina template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_subject_offer Código único que identifica a oferta de disciplina. 1, 5, 120, ... integer sim
id_class Código único que identifica a turma 1, 123, ... integer sim Turma
id_subject Código único que identifica a disciplina 1, 123, ... integer Sim Disciplina
complement_name Nome complementar usado na oferta Avançado, Português integral, etc text
start_date Data início 01/01/2021 date
end_date Data fim 01/12/2021 date
vacancies Número de vagas 50, 100, etc integer
disregard_attendance Desconsiderar Frequência true/false boolean
disregard_grade Desconsiderar Média true/false boolean

Turma x Disciplina x Professor

Informações referentes aos professores em disciplinas ofertadas.

Nome do Arquivo: professorSubjectOffer.csv

Modelo de exemplo: Turma x Disciplina x Professor template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_professor_subject_offer Código único que identifica o professor na oferta de disciplina. 1, 5, 120, ... integer sim
id_subject_offer Código único que identifica a oferta de disciplina 1, 123, ... integer sim Turma x Disciplina
id_person Código único que identifica a Pessoa 1, 123, ... integer Sim Pessoa
percentage_subject Percentual de aulas que o professor ira lecionar na turma ofertada 10.00,15.66,100.00,... numeric

Horário de Aula

Informações referentes aos horários de aula.

Nome do Arquivo: timetableSlot.csv

Modelo de exemplo: Horário de Aula template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_timetable_slot Código único que identifica o horário de aula 1, 5, 120, ... integer sim
id_curriculum_offer Código único que identifica a oferta de currículo 1, 123, ... integer sim Oferta de Currículo
name Descrição do horário de aula. Servirá para agrupar os horários. Horário padrão, Horário infantil, etc text sim
hour_start Hora início 12:00, 16:00, ... hour Sim
hour_end Hora fim 12:00, 16:00, ... hour Sim
is_break Intervalo true/false boolean
shift Turno 1 = Matutino, 2 - Verpertino, 2 - Noturno integer Sim
index Ordem dos horários. 1, 2, 3, ... integer Sim

Horário de Aula x Disciplina

Informações referentes ao vínculo entre disciplina e horário de aula.

Nome do Arquivo: subjectTimetableSlot.csv

Modelo de exemplo: Horário de Aula x Disciplina template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_subject_timetable_slot Código único que identifica o vínculo entre disciplina e horário de aula. 1, 5, 120, ... integer sim
id_timetable_slot Código que identifica o horário de aula 1, 123, ... integer sim Horário de Aula
id_subject Código que identifica a disciplina 1, 123, ... integer Sim Disciplina
id_class Código que identifica a turma 1, 123, ... integer Sim Turma
day_of_week Dia da semana 1 - Segunda-feira, 2 - Terça-feira, 3 - Quarta-feira, 4 - Quinta-feira, 5 - Sexta-feira, 6 - Sábado, 7 - Domingo integer Sim

Campanha

Informações referentes a campanha.

Nome do Arquivo: campaign.csv

Modelo de exemplo: Campanha template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_campaign Código único que identifica a campanha. 1, 5, 120, ... integer sim
id_academic_calendar Código que identifica o calendário acadêmico 1, 123, ... integer sim Calendário Acadêmico
name Descrição da campanha Calendário 2021, Campanha promoção, etc text Sim
integration_type Tipo de campanha 1 - Manual, 2 - Automático integer Sim
step_subject Etapa de disciplina habilitada ou não true/false boolean
step_relationship Etapa de relacionamentos habilitada ou não true/false boolean
step_additional_information Etapa de dados adicionais habilitada ou não true/false boolean
step_document Etapa de documentos habilitada ou não true/false boolean
step_financial Etapa de financeiro habilitada ou não true/false boolean
step_terms_and_conditions Etapa de termos e condições habilitada ou não true/false boolean
block_enrollment_on_overdue_invoices Bloquear matrícula se existirem faturas em atraso true/false boolean
block_enrollment_in_student_profile Bloquear matrícula no perfil de Aluno true/false boolean
consider_credit_original_subject Considerar crédito da disciplina de origem true/false boolean
signature Habilitar Assinatura true/false boolean
verify_signature Verificar assinatura true/false boolean
payment Verificar pagamento true/false boolean
code Configuração de código 1 - Sequencial de 8 caracteres por cliente, 2 - Sequencial de 8 caracteres por instituição, 3 - Código do calendário acadêmico + sequencial de 6 caracteres, 4 - Código do calendário acadêmico + código do curso + sequencial de 4 caracteres, 5 - Código do curso + sequencial de 6 caracteres, 6 - Código da instituição + código do calendário acadêmico + sequencial de 6 carateres, 7 - Código da instituição + código do calendário acadêmico + sequencial de 4 carateres integer

Campanha x Plano

Informações referentes ao plano na campanha.

Nome do Arquivo: campaignPlan.csv

Modelo de exemplo: Campanha x Plano template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_campaign_plan Código único que identifica o plano na campanha. 1, 5, 120, ... integer sim
id_campaign Código que identifica a campanha 1, 123, ... integer sim Campanha
id_curriculum_offer Código que identifica a oferta de currículo 1, 123, ... integer Oferta de Currículo
id_module Código que identifica o módulo 1, 123, ... integer Módulo
id_class Código que identifica a turma 1, 123, ... integer Turma
start_date Data início da vigência 10/01/2021 date Sim
end_date Data fim da vigência 10/01/2021 date Sim
type Identificação do tipo de plano 1 - Módulo, 2 - disciplina integer Sim
use_class_filter Disponibilizar nas disciplinas apenas a turma de referência true/false boolean

Tipo de Documento

Informações referentes ao tipo de documento.

Nome do Arquivo: documentType.csv

Modelo de exemplo: Tipo de Documento template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_document_type Código único que identifica o tipo de documento. 1, 5, 120, ... integer sim
name Descrição do documento CPF, RG, Certidão de casamento, etc text sim

Campanha x Documento

Informações referentes ao documento na campanha.

Nome do Arquivo: campaignDocument.csv

Modelo de exemplo: Campanha x Documento template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_campaign_document Código único que identifica o documento na campanha. 1, 5, 120, ... integer sim
id_campaign Código que identifica a campanha 1, 123, ... integer sim Campanha
id_curriculum_offer Código que identifica a oferta de currículo 1, 123, ... integer Oferta de Currículo
id_module Código que identifica o módulo 1, 123, ... integer Módulo
id_document_type Código que identifica a tipo de documento 1, 123, ... integer Sim Tipo de Documento
required Identificação de obrigatoriedade do documento true/false boolean Sim

Campanha x Contrato

Informações referentes ao contrato na campanha.

Nome do Arquivo: campaignContract.csv

Modelo de exemplo: Campanha x Contrato template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_campaign_contract Código único que identifica o contrato na campanha. 1, 5, 120, ... integer sim
id_campaign Código que identifica a campanha 1, 123, ... integer sim Campanha
name Descrição do contrato Contrato 1, ... text Sim
due_days Dias para vencimento 1, 5, ... integer
due_dates Datas de vencimento. Se existir mais de um valor, separar com o uso da vírgula EX: 1,5 1, 5 text

Campanha x Plano x Item

Informações referentes ao item no plano.

Nome do Arquivo: campaignPlanItem.csv

Modelo de exemplo: Campanha x Plano x Item template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_campaign_plan_item Código único que identifica o item no plano. 1, 5, 120, ... integer sim
id_campaign_contract Código único que identifica o contrato na campanha. 1, 5, 120, ... integer sim Campanha x Contrato
id_campaign_plan Código que identifica o plano na campanha 1, 123, ... integer sim Campanha x Plano
id_item Código que identifica o item no plano 1, 123, ... integer sim Item
type Tipo 1 - Módulo, 2 - Disciplina integer Sim
max_installments Número Máximo de Parcelas 1, 5, ... integer
optional Informação de item opcional ou não true/false boolean
issue_date Data de Emissão 01/01/2021, ... date
start_date Data de início 01/01/2021, ... date
end_date Data de fim 01/01/2021, ... date
first_installment_date Data de vencimento da primeira parcela 01/01/2021, ... date
first_installment_due_days Dias de vencimento para a primeira parcela 1, 5, .. integer
fixed_installments Parcelas Fixas. Se existir mais de uma separa-las por vírgula. EX: 1,5 1, 5, .. text

Matrícula

Informações referentes a matrícula do aluno.

Nome do Arquivo: Matricula.csv

Modelo de exemplo: Matrícula template

Filtro: Todas as matrículas existentes no sistema do calendário acadêmico atual (ex: se estamos em 2018, exportar somente as matrículas de 2018, ignorando as de 2017 e anteriores)

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_student Código único que identifica o aluno. 120 integer sim Pessoa
id_enrollment Código único que identifica a matrícula do aluno 123 integer sim
code Número de matricula do aluno usado no sistema legado. Somente inserir esta informação caso seja necessário cadastrar o mesmo número de matrícula. 1813023354, 2015010149, etc integer Não
academic_responsible_person_cpf CPF do responsável acadêmico 64383818021, 12578880050, etc text sim
financial_responsible_person_document CPF/CNPJ do responsável financeiro 64383818021, 12578880050, etc text Sim
academic_calendar Nome do calendário acadêmico cadastrado no sistema 20181, 2018A, 2018, Pós_2018, Graduação 2019 text sim
course Nome do Curso Ensino Fundamental text sim
curriculum Nome do Currículo Grade 1, ENF2010 text
module Nome da série 1 série, 2 série, etc text sim
class Nome da turma A, B, etc text sim
status Situação que a matrícula deve ser apresentada no sistema Aberto
Reservado
Ativo
Encerrado
Cancelado
text sim
id_campaign Código único que identifica a campanha. Se for passado deve existir nos arquivos de Campanha. 1, 120, ... integer Campanha
campaign Nome da campanha criada no sistema Acadêmico para ser possível fazer o vínculo. Será acionado caso não tenha sido passado o id_campaign acima. Matrículas 2019, Matrículas, etc text
date_enrollment Data de criação da matrícula 31/01/2018 date Não
start_date Data de ingresso da matrícula 31/01/2018, 01/01/2019, 01/2019, 02/2020 text Não
cancellation_reason Motivo do cancelamento. Se o status for cancelado este campo será necessário. Tranferido, Desistente, ... text
cancellation_date Data de cancelamento da matrícula 01/01/2021, ... date
observation Qualquer informação importante relacionada a matrícula Matrícula temporária, Analisar dados financeiros da matrícula, ... text
id_parent_enrollment Matrícula de origem 1, 45, ... integer Não Matrícula

Matrícula x Disciplina

Informações referentes às disciplinas da matrícula do aluno.

Nome do Arquivo: MatriculaDisciplina.csv

Modelo de exemplo: Matrícula x disciplina template

Filtro: Todas as disciplinas das matrículas existentes no sistema

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_enrollment Código único que identifica a matrícula do aluno 123 integer sim Matrícula
course Nome do curso Ensino Fundamental text sim
curriculum Nome do Currículo Grade 1, ENF2010 text
module Nome do módulo 2ª Série, 8ª Série, etc. text sim
subject Nome da disciplina Português, Física, etc text sim
class Nome da turma Turma A, B, etc text sim
type Tipo de disciplina Regular ou Dependência text
status Situação da disciplina. Se não for informado o valor padrão será Ativo. Ativo
Cancelado
Dispensado
text
cancellation_reason Motivo de cancelamento. Transferido, Desistente, ... text

Histórico Escolar

Informações do histórico escolar dos alunos.

Nome do Arquivo: Historico.csv

Filtro: Todos os históricos dos alunos matriculados

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_enrollment_record Identificador chave (único) do registro acadêmico 1 integer Sim
id_student Identificador do aluno 1 integer Sim Pessoa
id_enrollment Identificador da matrícula, encontrado no arquivo de matrículas. Cria o vínculo na matrícula integrada. 1, 2, ... integer Matrícula
institution_name Nome do colégio Escola Planeta, Curso Aprimorar, etc. text sim
index Ordem cronológica. Importante para relacionar os registros no sistema 1, 2, 3, 4, etc integer
institution_city Nome da cidade onde está localizado o colégio São Paulo, Curitiba, etc. text
institution_state UF onde está localizado o colégio SP, SC, PR, etc. char(2)
course Nome do curso Ensino Fundamental, Ensino Infantil. text Sim
module Nome da série/ano 2ª Série, 8º Ano, etc. text Sim
academic_calendar Calendário acadêmico 2003, 20031, 20032, 2004, 20041, 20042 text Sim
class Nome da turma A, B, ... text
status Resultado que o aluno obteve na série Aprovado, Reprovado, Cursando, Cancelado, Outro text Sim
working_days Dias letivos 100, etc text
complementary_status Resultado que o aluno obteve na série que não seja o resultado padrão do campo status * se este campo for preenchido deixar status como Outro Reprovado por recuperação, etc text
attendance Frequência que o aluno obteve na série 2, 3, 8, 0, etc. (percentual) text
workload Carga horária 40, 50, 45, 25, etc. text
shift Nome do turno Matutino, Vespertino, Integral etc. text
law Lei que regulamentou o curso 12345 text
instructional_days Quantidade de dias letivos 198 text
obs Observações do histórico Aluno transferido, etc text
finish_date Data de conclusão 01/01/2019 date
curriculum_name Nome do currículo grade 1, 2019-curriculo text
id_course_level Nível do Curso 1 (Educação Básica), 2 (Educação Superior) integer
id_course_type Tipo do Curso 1 (Educação Infantil), 2 (Ensino Fundamental de 8 anos), 3 (Ensino Fundamental de 9 anos), 4 (Multi 8 e 9 anos e Multietapa), 5 (Ensino Médio), 6 (Educação Profissional Técnica de Nível Médio - Integrada), 7 (Ensino Médio - Normal/ Magistério), 8 (Educação Profissional Técnica de Nível Médio), 9 (EJA - Ensino Fundamental), 10 (EJA - Médio), 11 (Formação Continuada ou Qualificação Profissional (FIC)), 12 (Cursos Sequenciais), 13 (Graduação), 14 (Pós Graduação), 15 (Extensão) integer
mec_course_code Código do MEC 1111,2222 integer
academic_grade Titulação acadêmica Bacharel, Especialista, etc text
coordinator Nome do Coordenador Paulo Silva text
coordinator_grade Titulação do Coordenador Licenciatura text
recognition Reconhecimento text
secretary Nome do secretário(a) João Silva text
secretary_subscription Incrição da secretário(a) 1111111111 text
modality Modalidade Semipresencial, Presencial, A distância text
authorization Autorização text
course_name_equivalence Nome do curso equivalente ao curso existente do sistema Ensino fundamental, ... text
curriculum_name_equivalence Nome do currículo equivalente ao currículo existente do sistema EF1, Ensino Fundamental 1 ... text
start_date Data de Ingresso 31/01/2018, 01/01/2019, 01/2019, 02/2020 text
certification_dispatch_date Data de expedição do diploma 31/01/2018, 01/01/2019, 01/2019, 02/2020 text
graduation_date Data de colação de grau 31/01/2018, 01/01/2019, 01/2019, 02/2020 text
admission Forma de Ingresso Enem
PEC-G
Vestibular
Egresso BI/LI
Decisão judicial
Avaliação seriada
Seleção simplificada
Transferência ex officio
Seleção para vagas remanescentes
Seleção para vagas de programas especiais
text
writing_score Nota de redação text
average_educational_history Média do Histórico Escolar text
score_educational_history Pontuação text
ranking_educational_history Classificação text
number_of_vacancies Número de Vagas text
admission_execution_date Data de Realização text
reserveof_vacancies Programa de Reserva de Vagas Étnico
Pessoa com deficiência
Outros
Social/renda familiar
Estudante procedente de escola pública
text
entrant_status Situação Ingressante Não participante do ENADE
Participante no ENADE
Não participante do ENADE, por ato da instituição de ensino
Dispensado por ocorrência de ordem pessoal
Dispensado em razão da natureza do curso
Dispensado em razão do calendário trienal
Dispensado nos termos da Lei nº 10.861, de 14 de abril de 2004
Dispensado de acordo com a Portaria Normativa n.3, de 06 de março de 2015, art 6°, § 2°, I
Não participante do ENADE, regularizado por ato do INEP/MEC
Não habilitado em razão do calendário do ciclo avaliativo
Não habilitado em razão da natureza do PPC
Dispensado por ato de responsabilidade da IES (Polo EaD não indicado ou alterado; ou mobilidade acadêmica de média e longa duração não indicada ou alterada)
Dispensado por ato de responsabilidade da IES (habilitado e não inscrito, não habilitado e não inscrito, ou outros)
Dispensado por compromisso profissional
Dispensado por compromisso acadêmico (atividade curricular curta duração vinculada ao curso)
text
exam_date Data da Prova text
conclusion_date Data Conclusão para ensino superior text
certification_delivery_date Data Entrega do Diploma text
certification_dispatch_number_identification Data Entrega do Diploma text
certification_dispatch_institution_name Nome da Instituição Expedidora do Diploma text
certification_dispatch_institution_emecCode Código e-MEC da Instituição Expedidora do Diploma text
record_date Data do Registro text
record_number_identification Identificação do Número do Registro text
record_number_identification Identificação do Número do Registro text
record_book Livro Registro text
certification_register_institution_name Nome da Instituição Registradora do Diploma text
certification_register_institution_emecCode Código e-MEC da Instituição Registradora do Diploma text
dou_info_publishing_date Data de Publicação das Informações do Registro no DOU text
final_project_name Título da Monografia ou do Trabalho de Conclusão de Curso text
final_project_grade Nota ou Conceito da Monografia ou do Trabalho de Conclusão de Curso text
final_project_presentation_date Data da Defesa da Monografia ou do Trabalho de Conclusão de Curso text
final_project_assessment Parecer da Monografia ou do Trabalho de Conclusão de Curso text
social_support Apoio social text
student_parfor Aluno Parfor text
academic_mobility Mobilidade Acadêmica text
financial_student Financiamento Estudantil text
activity_extracurricular Atividade Extracurricular text
monograph_advisor Professor Orientador da Monografia ou do Trabalho de Conclusão de Curso Faz referência a coluna id_person do layout de pessoa (1, 37, 45...) integer Pessoa

Histórico x Disciplina

Informações das notas e frequências obtidas pelos alunos nas disciplinas, referentes aos históricos escolares.

Nome do Arquivo: HistoricoDisciplina.csv

Filtro: Todas as disciplinas dos históricos dos alunos matriculados

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_enrollment_subject_record Identificador chave (único) do registro de histórico de disciplina 1 integer sim
id_enrollment_record Identificador do histórico escolar 1 integer sim Histórico Escolar
subject Nome da disciplina Português, Química, Língua Estrangeira, etc. text sim
academic_calendar Descrição do ano referência 2010, 20101, etx text
subject_group Nome da disciplina agrupada Língua Estrangeira, Comum, Diversificada, etc text
subject_type Tipo de disciplina Regular, Dependência text
subject_area Área de conhecimento da disciplina Ciências da natureza, etc text
average_grade Média obtida pelo aluno na disciplina 8.6, 9.0, 7.2, etc. text
attendance Frequência que o aluno obteve na disciplina 2, 3, 8, 0, etc. (percentual) text
workload Carga horária da disciplina 45, 55, 48, etc. text
waiver Tipo de dispensa que o aluno teve para não cumprir a disciplina Médica, Já cursou, etc. text
achievement_test_grade Valor da prova de aproveitamento 6.5, 7.3, 8.3, etc. text
status Resultado que o aluno obteve na disciplina Aprovado, Reprovado, Cursando, Cancelado, Outro text sim
complementary_status Outro status da disciplina * se este campo for preenchido deixar status como Outro Ativo, Cancelado ou Dispensado text
letter_grade Nota conceito A, B, C, D, E, F... text
cancellation_reason Motivo de cancelamento problemas de saúde, financeiro text
obs Observações de histórico disciplina Disciplina transferida text
dismissed Dispensado true / false boolean
dismissal_reason Motivo da dispensa Doença, etc text
failure_reason Motivo de reprovação Média, Frequência text
course_name_equivalence Nome do curso equivalente ao curso existente no sistema Ensino fundamental, ... text
curriculum_name_equivalence Nome do currículo equivalente ao currículo existente no sistema EF1, Ensino fundamental 1, ... text
module_name_equivalence Nome do módulo equivalente ao módulo existente no sistema 1 Ano, Módulo 1, ... text
subject_name_equivalence Nome da disciplina equivalente a disciplina existente no sistema Artes, Português, ... text

Histórico x Disciplina x Professor

Informações dos professores referentes às disciplinas no histórico escolar.

Nome do Arquivo: HistoricoDisciplinaProfessor.csv

Filtro: Todas os professores de uma disciplina no histórico acadêmico

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_enrollment_subject_record_professor Identificador chave (único) do registro de professor 1 integer sim
id_enrollment_subject_record Identificador do registro de disciplina do histórico 1 integer sim Histórico x Disciplina
professor_name Nome do professor João Paulo text
academic_title Titulação do professor Graduação em Engenharia de Software text

Histórico x Atividade Complementar

Informações das atividades complementares dos alunos referentes aos históricos escolares.

Nome do Arquivo: HistoricoAtividadeComplementar.csv

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_enrollment_complementary_activity_record Identificador chave (único) da atividade complementar do histórico 1 integer sim
id_enrollment_record Identificador do histórico escolar 1 integer sim Histórico Escolar
category A descrição da categoria Atividade Complementar 1 text Sim
name Nome da categoria Atividade livre, etc text Sim
description Descrição da categoria Atividade livre sobre fisioterapia text
start_date Data de início 11/12/2019 text
end_date Data final 12/12/2019 text
workload Carga horária 10, 40.4, 90.1, etc numeric

Matrícula x Documento

Informações dos documentos entregues referentes à matrícula do aluno.

Nome do Arquivo: MatriculaDocumento.csv

Filtro: Todos os documentos marcados como entregue das matrículas existentes no sistema

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_enrollment Código que identifica a matrícula do aluno 123 integer sim Matrícula
id_document_type Identificador de tipo de documento 1, 2, ... integer sim Tipo de Documento

Matrícula - Dados Adicionais

Informações dos dados adicionais referentes à matrícula do aluno.

Este layout se baseia no formulário gerado na tela Matrícula / Formulário / Gerar Planilha de Integração.

OBSERVAÇÃO: Caso a coluna em questão seja de multipla escolha é necessário separar os valores entre ponto e vírgula (;) conforme o exemplo abaixo:

- Valor 1;Valor 2;Valor 3

Nome do Arquivo: MatriculaDadosAdicionais.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
student_name Nome do aluno text sim

Avaliação

Informações referentes às avaliaçòes das disciplinas.

Nome do Arquivo: avaliacoes_template.csv

Modelo de exemplo: Avaliação template

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_exam Identificador da avaliação Somente Números Ex: 123, 67 integer Sim
id_subject Identificador da disciplina Somente Números Ex: 123, 67 integer Sim Disciplina
id_period Identificador do período Somente Números Ex: 123, 67 integer Sim Período
id_class Identificador da Turma Somente Números Ex: 123, 67 integer Sim Turma
name Nome da Avaliação O nome da avaliação na disciplina ofertada text Sim
weight O peso da avaliação nos cáculos Somente Números Ex: 1, 2, 2.5, etc numeric Sim
index Ordem da avaliação 1, 2, 3, 4, etc integer Sim
code Código da avaliação AV1, AV2, REC, etc text Sim
max_grade Valor máximo da nota Somente Números Ex: 10, 7.5, 100, etc numeric

Nota

Informações referentes às notas dos alunos.

Nome do Arquivo: Nota.csv

Filtro: Todos as notas dos alunos matriculados

Versão 1
Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_student Identificador do aluno Deve existir no arquivo de migração de alunos integer Sim Pessoa
course Nome do curso Ensino Fundamental text sim
module Nome do módulo 1 Série, etc text sim
curriculum Nome do currículo Currículo 2018, 2019A, etc. text sim
class Nome da turma Turma A, B, etc text sim
student_name Nome do aluno João Souza text não
period Nome do período ao qual pertence a nota 1ª Bimestre, 2º Fase, Recuperação (se for média deixar como anual, semestral, trimestral, etc) text sim
exam Nome do exame ao qual pertence a prova Prova de Recuperação, Nota 1, Trabalho text sim
academic_calendar Nome do Calendário acadêmico 2018, 20181, 2018-2019 text sim
subject Nome da disciplina Português, Matemática text sim
grade O valor da nota 9.5, 10, 2.5 numeric sim
Versão 2 - Novo
Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_student Identificador do aluno Deve existir no arquivo de migração de alunos integer Sim Pessoa
id_subject Identificador de disciplina Deve existir no arquivo de disciplinas integer sim Disciplina
id_class Identificador de turma Deve existir no arquivo de turmas integer sim Turma
id_period Identificador de período Deve existir no arquivo de período integer sim Período
id_exam Identificador da avaliação ao qual pertence a prova 1, 2, 4, ... integer sim Avaliação
grade O valor da nota 9.5, 10, 2.5 numeric sim

Média do período

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_student Identificador do aluno Deve existir no arquivo de migração de alunos integer Sim Pessoa
id_subject Identificador de disciplina Deve existir no arquivo de disciplinas integer sim Disciplina
id_class Identificador de turma Deve existir no arquivo de turmas integer sim Turma
id_period Identificador de período Deve existir no arquivo de período integer sim Período
average O valor da média 9.5, 10, 2.5 numeric sim

Frequência

Informações referentes às faltas e frequências totais dos alunos.

Nome do Arquivo: Frequencia.csv

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_student Identificador do aluno Deve existir no arquivo de migração de alunos integer Sim Pessoa
course Nome do curso Ensino Fundamental text sim
module Nome do módulo 1 Série, etc text sim
curriculum Nome do currículo Currículo 2018, 2019A, etc. text sim
class Nome da turma Turma A, B, etc text sim
period Nome do período ao qual pertence a nota 1ª Bimestre, 2º Fase, Recuperação (se for média deixar como anual, semestral, trimestral, etc) text sim
academic_calendar Nome do Calendário acadêmico 2018, 20181, 2018-2019 text sim
subject Nome da disciplina Português, Matemática text sim
total_absences Valor total de faltas 0, 10, 20, 50 integer Sim
total_presences Valor total de presenças 0, 10, 20 50 integer Sim

Parecer Descritivo

Informações referentes aos pareceres descritivos dos alunos.

Nome do Arquivo: ParecerDescritivo.csv

Filtro: Todos os pareceres descritivos dos alunos matriculados

Obrigatório: Não

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_student Identificador do aluno Deve existir no arquivo de migração de alunos integer Sim Pessoa
course Nome do curso Ensino Fundamental text sim
curriculum Nome do currículo Currículo 2018, 2019A, etc. text sim
module Nome do módulo 2ª Série, 8ª Série, etc. text sim
class Nome da turma Turma A, B, etc text sim
period Nome do período ao qual pertence a nota 1ª Bimestre, 2º Fase, Recuperação (se for média deixar como anual, semestral, trimestral, etc) text sim
academic_calendar Nome do Calendário acadêmico 2018, 20181, 2018-2019 text sim
subject Nome da disciplina Português, Matemática text sim
assessment A descrição do parecer descritivo do aluno O aluno foi muito bem nas atividades
Muito bom aluno
text sim

Dados de Financeiro

Item

Informações referentes ao produto ou serviço que esta sendo comprado.

Nome do Arquivo: Item.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_item ID ou código interno do item no sistema 123,1456,178 integer Sim
description Descrição do item (título, nome) Mensalidade, Atividade text Sim
type Tipo de item service, product text Sim
period Período do Item 1,.., 12 (Obrigatório informar se for do tipo serviço) integer
price Preço do item 215.55, 200 numeric sim
status Situação do item active, inactive text Sim
cost_center Informação de centro de custo 123456, A12456 text
category Descrição da categoria Mensalidade, ... (Cria uma categoria nova caso não exista) text Sim
search Se igual a true, o importador irá procurar um item já existente com o mesmo nome. Se for encontrado o sistema fará o vínculo com o mesmo. Caso contrário o processo segue normalmente e irá criar um novo item. false/true boolean

Tipo Desconto

Informações dos tipos de descontos.

Nome do Arquivo: TipoDesconto.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_type_discount ID ou código interno do tipo de desconto no sistema 123,1456,178 integer Sim
category Descrição da categoria Pontualidade, Bolsa integral, ... text Sim
description Descrição do desconto Bolsa 50%, Integral, ... text Sim
type O tipo de desconto conditional ou unconditional text Sim
condition Regra de aplicação do desconto (Deve ser informado somente se tipo for condicional) days_before_due_date, until_due_date ou number_of_installments text
value Valor referente a condição selecionada (Se condition for informado é necessário informar este valor) 4 (número de vezes), 3 (dias antes da data de vencimento), 5 (até o quinto dia), ..., integer
method Método do desconto (se o método indicado for manual, o valor deverá ser passado no layout de desconto) absolute, relative ou manual text Sim
percentage Valor relativo do desconto (Ele valor só será informado caso o método indicado seja relative) absolute, relative ou manual numeric
amount Valor absoluto do desconto (Ele valor só será informado caso o método indicado seja absolute) absolute, relative ou manual numeric
calculation_base Regra de cálculo do desconto gross ou net text
search Se igual a true, o importador irá procurar um tipo desconto já existente com o mesmo nome. Se for encontrado o sistema fará o vínculo com o mesmo. Caso contrário o processo segue normalmente e irá criar um novo tipo de desconto. false/true boolean

Categoria de Títulos a Pagar

Informações das categorias de títulos a pagar.

Nome do Arquivo: categoriaTitulosPagar.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_payable_category ID ou código interno da categoria 123,1456,178 integer Sim
name Descrição da categoria Água, Luz, ... text Sim
code Código descritivo para a categoria AG, Água, ... text
search Se igual a true, o importador irá procurar uma categoria já existente com o mesmo nome no sistema. Se for encontrado o sistema fará o vínculo com o mesmo. Caso contrário o processo segue normalmente e irá criar uma nova categoria. false/true boolean

Contrato

Informações referentes ao contrato.

Nome do Arquivo: Contrato.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_contract ID ou código interno do contrato no sistema 123,1456,178 integer Sim
financial_responsible_person_document Número do CPF ou CNPJ do responsável financeiro 49530612095, 62927132000110 (somente números) text Sim
id_enrollment ID ou código interno da matrícula 1123,123456,78945 integer Matrícula
status Identificador da situação do contrato Ativo ou Encerrado text Sim
due_date Dia de vencimento 1, 2, 5, 10, etc integer sim
details Informações de detalhes do contrato text
observation Observações sobre o contrato Criado via importação text
Compra

Informações de compras.

Nome do Arquivo: Compra.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_contract ID ou código interno do contrato no sistema 123,1456,178 integer Sim Contrato
id_purchase ID ou código interno da compra no sistema 123,1456,178 integer Sim
id_person ID ou código interno da pessoa (Aluno) 1123,123456,78945 integer Sim Pessoa
id_item ID ou código interno do item 1123,123456,78945 integer Sim Item
installments Número de prestações 1,2,3,...,12 integer Sim
quantity Quantidade 1,2,3,...,6 integer Sim
unit_price Valor da compra por unidade 15, 15.50 numeric Sim
date_start Data inicial de compra DD/MM/YYYY date Sim
date_end Data final de compra DD/MM/YYYY date Sim
date Data da compra DD/MM/YYYY date
Fundo

Informações de fundo.

Nome do Arquivo: Fundo.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_contract ID ou código interno do contrato no sistema 123,1456,178 integer Sim Contrato
id_fund ID ou código interno do fundo no sistema 123,1456,178 integer Sim
id_person ID ou código interno da pessoa (Aluno) 1123,123456,78945 integer Sim Pessoa
description Descrição do fundo 1123,123456,78945 text Sim
installments Número de prestações 1,2,3,...,12 integer Sim
amount Valor do fundo 500, 500.55 numeric Sim
date Data inicial de compra DD/MM/YYYY date Sim
Financiamento

Informações de financiamento.

Nome do Arquivo: Financiamento.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_loan ID ou código interno do financiamento no sistema 123,1456,178 integer Sim
id_purchase ID ou código interno da compra no sistema 123,1456,178 integer Sim Compra
id_fund ID ou código interno do fundo no sistema 1123,123456,78945 integer Sim Fundo
amount Valor do financiamento 500, 500.55 numeric Sim
date Data do financiamento DD/MM/YYYY date Sim
Renegociação

Informações de renegociação.

Nome do Arquivo: Renegociacao.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_renegotiation ID ou código interno da renegociação no sistema 123,1456,178 integer Sim
id_contract ID ou código interno do contrato no sistema 123,1456,178 integer Sim Contrato
installments Número de prestações que serão geradas 1,2,3 ... integer Sim
Fatura

Informações das faturas.

Nome do Arquivo: Fatura.csv

OBS: A fatura é sempre vínculo de uma compra, fundo ou renegociação.

Deve ser informado apenas um dos três campos (id_purchase, id_fund, id_renegotiation)

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_purchase ID ou código interno da compra no sistema 123,1456,178 integer Compra
id_fund ID ou código interno do fundo no sistema 123,1456,178 integer Fundo
id_renegotiation ID ou código interno da renegociação no sistema 1123,123456,78945 integer Renegociação
id_invoice ID ou código interno da fatura 1123,123456,78945 integer Sim
month_cycle Mês de competência 1,2,3,...,12 integer Sim
year_cycle Ano de competência 2018, 2019, 2020 integer Sim
due_date Data de vencimento DD/MM/YYYY date Sim
amount Valor total da fatura 150, 150.55 numeric Sim


Desconto

Informações dos descontos.

Nome do Arquivo: Desconto.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_discount ID ou código interno do desconto no sistema 123,1456,178 integer Sim
id_invoice ID ou código interno da fatura 1123,123456,78945 integer Sim Fatura
id_type_discount ID ou código interno do desconto 1123,123456,78945 integer Sim Tipo Desconto
type Tipo de desconto invoice text Sim
fiscal_type Tipo Fiscal commercial, financial text Sim
event Tipo de evento do desconto purchase text Sim
base Tipo de valor considerado no cálculo do desconto gross text Sim
amount Valor do desconto (Este valor só é informado quando o tipo de desconto é manual) 150, 150.55 numeric Sim
Multa

Informações das multas.

Nome do Arquivo: Multa.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_penalty ID ou código interno da multa no sistema 123,1456,178 integer Sim
id_invoice ID ou código interno da fatura 1123,123456,78945 integer Sim Fatura
amount O valor da multa que será aplicado na fatura 155, 200.55 numeric Sim
percentage Regra de porcentagem aplicado no valor da multa (Não será aplicado, apenas informal) 10, 80 numeric Sim
base_amount Regra do valor base aplicado no valor da multa (Não será aplicado, apenas informal) 10, 55.54 numeric Sim
Juros

Informações dos juros.

Nome do Arquivo: Juros.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_interest ID ou código interno do juro no sistema 123,1456,178 integer Sim
id_invoice ID ou código interno da fatura 1123,123456,78945 integer Sim Fatura
amount O valor do juro que será aplicado na fatura 155, 200.55 numeric Sim
percentage Regra de porcentagem aplicado no valor do juro (Não será aplicado, apenas informal) 10, 80 numeric Sim
base_amount Regra do valor base aplicado no valor do juro (Não será aplicado, apenas informal) 10, 55.54 numeric Sim
days Regra de dias de vencimento aplicado no valor do juro (Não será aplicado, apenas informal) 10, 55.54 numeric Sim
Cancelamento

Informações dos cancelamentos.

Nome do Arquivo: Cancelamento.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_cancellation ID ou código interno do cancelamento no sistema 123,1456,178 integer Sim
id_invoice ID ou código interno da fatura 1123,123456,78945 integer Sim Fatura
type Tipo de desconto invoice text Sim
event Tipo de evento do cancelamento purchase text Sim
reason Descrição do motivo do cancelamento Cancelamento de matrícula, Erro no pagamento, ... text Sim
amount Valor do cancelamento 150, 150.55 numeric Sim
Faturas Renegociadas

Informações das faturas renegociadas.

Nome do Arquivo: FaturasAtrasadasRenegociadas.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_invoice_renegotiation ID ou código interno 123,1456,178 integer Sim
id_renegotiation ID ou código interno da renegociação no sistema 1123,123456,78945 integer Sim Renegociação
id_delayed_invoice ID ou código interno da fatura 1123,123456,78945 integer Sim Fatura
Fatura x Observação

Informações das observações das faturas.

Nome do Arquivo: FaturaObservacao.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_invoice_observation ID ou código interno da fatura x observação 123,1456,178 integer Sim
id_invoice ID ou código interno da fatura 1123,123456,78945 integer Sim Fatura
description Descrição da observação Fatura paga antecipada, ... text Sim


Fatura (Correção)*

Disponibilidade de atualizar algumas informações das faturas depois de já integrada.

Nome do Arquivo: FaturaCorrecao.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_update_invoice ID ou código interno único da correção da fatura 123,1456,178 integer Sim
id_invoice ID ou código interno da fatura 1123,123456,78945 integer Sim Fatura
month_cycle Mês de competência 1,2,3,...,12 integer
year_cycle Ano de competência 2018, 2019, 2020 integer
due_date Data de vencimento DD/MM/YYYY date
amount Valor total da fatura 150, 150.55 numeric
Títulos a Pagar

Informações dos títulos a pagar.

Nome do Arquivo: titulosPagar.csv

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_payable ID ou código interno 123,1456,178 integer Sim
id_person ID ou código interno da pessoa 1123,123456,78945 integer Sim Pessoa
id_payable_category ID ou código interno da categoria de títulos a pagar 1123,123456,78945 integer Sim Categoria de Títulos a Pagar
name Descrição do título Pagamento de água, ... text Sim
amount Valor do título 100, 105.50 numeric Sim
due_date Data de vencimento 08/20/2022, ... date Sim
observation Descrição da observação Pagar água no prazo, ... text
Pagamento

Informações dos pagamentos.

Nome do Arquivo: Pagamento.csv

O pagamento deverá ser associado a uma parcela (id_invoice) ou a um título a pagar (id_payable)

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_payment ID ou código interno do pagamento no sistema 123,1456,178 integer Sim
id_invoice ID ou código interno da fatura 1123,123456,78945 integer Fatura
id_payable ID ou código interno do título a pagar 1123,123456,78945 integer Títulos a Pagar
id_person ID ou código interno da pessoa (Aluno) 1123,123456,78945 integer Sim Pessoa
payment_method Método de pagamento debitCard, pagseguro, creditCard, check, boleto, cash, bankTransfer text Sim
type Tipo de pagamento in, out text Sim
status Situação final do pagamento pending, refused, paid, cancelled text Sim
amount Valor total da fatura 150, 150.55 numeric Sim
payment_date Data de pagamento DD/MM/YYYY date Sim

Dados de Biblioteca

Diferentemente das demais, a importação de dados de biblioteca não é realizada via importador, mas sim, diretamente no módulo de biblioteca.

Existem dois processos distintos: Um para adicionar obras ao catálogo, e outro para adicionar cópias/exemplares às bibliotecas.

Para importar obras para o catálogo, acesse o módulo Biblioteca. Em seguida navegue para Configurações > Catálogos > Selecione o catálogo > Importações (botão superior direito).

Crie uma nova importação do tipo CSV. A seguir informe os 4 arquivos necessários:

  • Obras
  • Obras x Autor
  • Obras x Assunto (opcional)
  • Obras x Palavras-Chave (opcional)
Obras

Este arquivo contém informações das obras (livros, e outros materiais) a serem lançadas no acervo.

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_obra ID ou código interno da obra no sistema 123,1456,178 integer Sim
titulo Título da Obra Memórias Póstumas de Brás Cubas text Sim
subtitulo Subtítulo da Obra text Não
tipo_acervo Tipo de Obra Livro, Guias, TCC, Mapa text Sim
classificacao_decimal Classificação Decimal 342.4 text Não
tipo_suporte Tipo de Suporte/Material Papel text Não
colecao Nome da coleção a que esta obra pertence Coleção Vagalume text Não
genero Gênero da Obra Gastronomia text Não
qt_paginas Quantidade de páginas 190 integer Não
isbn ISBN 8525413240 text Não
nr_volume Número do Volume/Designação sequencial 3, Volume 1, text Não
cutter Número Cutter L783a text Não
periodicidade Periodicidade atual da publicação (jornais, revistas, periódicos) Mensal text Não
data_veiculacao Data da veiculação da publicação (jornais, revistas, periódicos) 31/01/2020 text Não
issn ISSN 1039989 text Não
ano_volume Ano/Volume da publicação 2012, Volume 2 text Não
fasciculo Fascículo 3 text Não
tradutor Nome do tradutor Marcos Oliveira text Não
titulo_original Título da obra no idioma original The Hitchhiker's Guide to the Galaxy text Não
idioma_original Idioma original da obra Inglês text Não
obs_geral Observações gerais text Não
obs_especifica Observações específicas text Não
obs_resumida Observação resumida text Não
ano_publicacao Ano de publicação text Não
nr_edicao Número da edição 3 text Não
cidade_publicacao Local de publicação Brasília-DF, Berlim, São Paulo-SP text Não
editora Nome da Editora Editora Sextante text Não
Obra x Autores

Este arquivo contém informações de Autor e uma referência ao arquivo de Obras.

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_obra ID ou código interno da obra no sistema 123,1456,178 integer Sim Obra
tipo_autor Tipo de Autor (Principal ou Secundário) Principal, Secundário text Sim
nome Nome do autor Machado text Sim
sobrenome Sobrenome do autor (opcionalmente pode-se deixar este campo em branco e informar o nome completo na coluna "nome") De Assis text Não
cutter Número de Cutter L783a text Não
Obra x Assuntos

Este arquivo relaciona uma obra a diversos assuntos. No processo de importação, este arquivo é opcional e pode ser omitido.

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_obra ID ou código interno da obra no sistema 123,1456,178 integer Sim Obra
assunto Assunto da Obra Gastronomia, Economia, Política, Ciência text Sim
Obra x Palavras-Chave

Este arquivo relaciona uma obra a diversas palavras-chave. No processo de importação, este arquivo é opcional e pode ser omitido.

Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_obra ID ou código interno da obra no sistema 123,1456,178 integer Sim Obra
palavra_chave Palavra-Chave da Obra Turismo, Hotéis, Praias text Sim

Cópias/Exemplares

Para importar cópias para a biblioteca, acesse o módulo Biblioteca. Em seguida navegue para Configurações > Bibliotecas > Selecione a biblioteca > Importações de Cópias (botão superior direito).

Crie uma nova importação do tipo CSV. A seguir faça upload de um arquivo no formato a seguir.

Cópias
Coluna Descrição Exemplo Tamanho e Formato Obrigatório Referência
id_obra ID ou código interno da obra no sistema 123,1456,178 integer Sim Obra
id_copia ID ou código interno da cópia/exemplar no sistema. Este campo é opcional, porém recomendado. Se informado o importador checará por duplicidade nas importações evitará lançamentos duplicados de exemplares. 123, 1456, ABC1 text Não
nr_exemplar Número identificador do exemplar 1, 2, 125, Exemplar 1, EX2, etc text Sim
nr_tombo Número do tombo patrimonial 1, 2, 125, Tombo45673, TM2123, etc text Não
sequencial_exemplar Número sequencial do exemplar text Não
parte Parte do exemplar text Não
tipo_aquisicao Tipo de Aquisição Compra, doação text Não
valor_aquisicao Valor da Aquisição R$ 50, 123, 80.12 BRL text Não
andar Andar 1 text Não
corredor Corredor 1 text Não
estante Estante 1 text Não
prateleira Prateleira 1 text Não
observacao Observação text Não


Importação de Fotos

Este processo importa as fotos das pessoas através do produto importador.

Abaixo detalhes a serem seguidos:

Habilitar Locker

No produto importador deverá estar habilitar o Locker.

  • Menu Locker
  • Habilitar

Coluna foto no layout de pessoa

No layout de pessoa existe uma coluna denominada photo_person.

Nesta coluna deverá ser informado o nome da foto que posteriormente será integrada.

Ex: alunoJoao.jpg

Upload das imagens

No menu Fotos do produto importador será possível fazer o upload das fotos no sistema.

O botão Novo ficará disponível quando o Locker estiver habilitado.

Informações importantes:

  • O arquivo a ser integrado deverá ser no formato .zip.
  • O tamanho máximo deste arquivo será de 100mb.
  • As imagens dentro do arquivo não poderão ultrapassar o tamanho de 512kb.
  • O nome da imagem deverá existir nos arquivos de pessoas (alunoJoao.jpg)

Passos para integração:

  • Na tela de Fotos clicar em Novo.
  • Selecionar o arquivo de referência (Pessoa) e escolher o arquivo.
  • Ao clicar em salvar o processo de integração será executado.
  • Os erros serão listados na tela