INTEGRAÇÃO TOTVS Educacional X Pergamum

Totvs Educacional

A instituição inicia seus trabalhos na secretaria acadêmica. Uma estrutura curricular é montada para serem ofertas aos alunos e professores. Cadastram-se cursos, disciplinas, matrizes curriculares para depois ofertá-las aos alunos nos períodos letivos, turmas etc.

Com tudo pronto, a faculdade ou escola, já pode matricular seus alunos e dar permissão aos seus professores para registrarem as notas e faltas.

As movimentações acadêmicas são uma série de rotinas realizadas com frequência, como realização de atividades extras, avaliações institucionais, transferência de alunos, emissão de certificados/diplomas, solicitação de recurso e instalação e alocação salas.

As movimentações financeiras são processos que acontecem na tesouraria ou financeiro de uma faculdade ou escola. No sistema são cadastrados planos de pagamentos para os alunos, contratos, gerados lançamentos etc.

Faz parte do fluxo processual do TOTVS Educacional as integrações a outros sistemas como Gestão de Relacionamento com Cliente, Folha de Pagamento, Gestão Financeira, Gestão Bibliotecária entre outros.

Pergamum

A Rede Pergamum é constituída pelas instituições usuárias do software Pergamum - Sistema Integrado de Bibliotecas, tendo por finalidade melhorar a qualidade global dos serviços dos usuários, promover a cooperação no tratamento da informação e o compartilhamento de recursos de informação.

Sistemas Envolvidos

  • TOTVS Educacional – Módulo Educacional que gerencia escolas e faculdades (ensino básico e superior), por meio de ferramentas que permitem maior agilidade nos processos que envolvem os alunos, responsáveis, professores e os funcionários.
  • Pergamum – Sistema Integrado de Bibliotecas.

Integração

O TOTVS Educacional pode ser configurado para integrar com sistema de gestão bibliotecária Pergamum. Com esta integração será possível criar usuários do TOTVS Educacional no Pergamum, gerenciar multas e pendências de empréstimos dos alunos.

 

Escopo

As entidades e os pontos de integração que farão parte do escopo dessa integração são:

EntidadePontos de Integração
  

 

Perfil de Acesso

Para definição do perfil de acesso para as funcionalidades relacionadas a integração com o Pergamum o usuário deve acessar o módulo Serviços Globais | Segurança | Perfis, selecionar o contexto Educacional.

Segue árvore de permissões relacionada ao Pergamum.

Perfil de Acesso

Na árvore Educacional | Integrações | Integrações | Pergamum,

permissões pertinentes a integração.

Na árvore Educacional | Educacional (Portal) | Biblioteca | Pergamum,

permissões pertinentes ao Meu Pergamum.

 

Parâmetros de Integração

Segue abaixo a definição de parâmetros para a utilização da integração entre TOTVS Educacional e Pergamum.

O acesso se da por meio do TOTVS Educacional | Configurações | Parâmetros | Biblioteca.

  • Seleção do Tipo de integração bibliotecária utilizada: TOTVS Gestão Bibliotecária e Pergamum.

Parâmetros que são utilizados tanto por TOTVS Gestão Bibliotecária quanto pelo PergamumParâmetros exclusivos para integração com o Pergamum
  • Bloqueio de matrícula/mudança de status no período letivo:
    • Alunos com empréstimos em atraso na biblioteca;
    • Alunos com débitos na biblioteca.
  • Parâmetros de comunicação com o webservice do Pergamum:
    • Caminho (endereço);
    • Chave de acesso - esta informação é obrigatória para todas as chamadas de webservice.
  • Parâmetros para envio das fotos via FTP para o Pergamum:
    • Caminho (endereço);
    • Usuário;
    • Senha.

A pasta para onde as fotos serão enviadas deve ser parametrizada no Pergamum para correta importação

Parâmetros para acesso ao banco de dados do Pergamum:

  • Tipo do banco de dados (SQL Server ou Oracle);
  • Servidor;
  • Base de Dados;
  • Usuário;
  • Senha.

O Pergamum não disponibiliza webservice para cobrir todos os pontos da integração, por este motivo é necessário configurar a base de dados para o funcionamento pleno da integração.

Exemplo: O envio das baixas dos lançamentos de multa é realizado via uma stored procedure.

 

Parâmetros:

  • Código da instituição do Pergamum;
  • Código da categoria para os professores;
  • Código da categoria para os alunos;
  • Código da categoria para os funcionários;
  • Código da situação normal;
  • Código da situação afastado.

Para definição dos parâmetros acima o sistema realiza uma consulta ao Pergamum, desta forma para o correto funcionamento os parâmetros de comunicação com o webservice definidos no primeiro passo já devem estar preenchidos.

 

  • Criar usuário no Pergamum automaticamente após matrícula do aluno no período letivo;
  • Atualizar código da categoria de alunos após matrícula no período letivo.

 

Se houver problemas na comunicação com o Pergamum durante a criação do usuário ou atualização da categoria o processo de matrícula não é impactado, sendo apenas inserida uma mensagem de alerta ao final da execução do processo.

 

  • Enviar o domínio com o usuário de rede quando integrado com LDAP na exportação de Usuários.

Para o funcionamento do parâmetro acima é necessário que a integração LDAP esteja habilitada e configurada nos parâmetros globais.

Parâmetros Globais para definição da integração LDAP

O acesso aos parâmetros da Integração LDAP, se da por meio do caminho Ambiente | Parâmetros | Parâmetros Globais | Aba Integração LDAP.

Parâmetros:

  • Ação para quando ocorrer erro na comunicação com o Pergamum na desativação de funcionário demitido:
    • Emitir erro impedindo a efetivação da demissão;
    • Permitir a demissão.

 

  • Atualizar dados cadastrais automaticamente no Pergamum
    • Ação para quando ocorrer erro na comunicação com o Pergamum:
      • Emitir erro impedindo a gravação da alteração;
      • Permitir a gravação da alteração.

  • Meu Pergamum
    • Endereço (informar o endereço da tela de redirecionamento para o Meu Pergamum):
      • http://<SERVIDOR + LOCAL>/biblioteca_s/php/pergamum_redireciona.php

 

Parâmetros da habilitação/serie

A definição da categoria dos alunos vinculados a habilitação/série no Pergamum se da por meio dos Parâmetros da Habilitação/Série, sendo acessado em.

Currículo e Oferta | Cursos | Habilitação | Parâmetros da habilitação, para o Ensino Superior e Currículo e Oferta | Cursos | Série | Parâmetros da série, para o Ensino Básico.

  

Na exportação dos usuários dos alunos para o Pergamum, o sistema envia a categoria relacionada a habilitação/serie do aluno. Nos casos em que esta informação não estiver preenchida é utilizada a categoria informada nos parâmetros do TOTVS Educacional.


Parâmetros de Integração Financeira da Unidade Bibliotecária

O Pergamum possui algumas possibilidades para configurar a integração financeira com um sistema de terceiros, sendo possível os seguintes valores:
ValorAçãoEfeito
0Não realiza exportação de multas. A tabela exporta_multa não é gerada.A tabela não é gerada, e todo o controle de débitos é efetuado no próprio Pergamum. É solicitado pelo Pergamum se o usuário deseja ou não efetuar o pagamento da multa no momento da devolução do material.
1A exportação pode ser efetuada diretamente para o controle financeiro. Para isso, a instituição deve disponibilizar a stored procedure a ser executada pelo Pergamum. Além da stored procedure, a instituição deverá entrar em contato com o Pergamum para maiores detalhes (database, login, senha, nome da stored procedure, etc). A tabela exporta_multa não é gerada.É solicitado se o usuário deseja lançar o débito na mensalidade ou não. Caso seja lançado na mensalidade, não existirá o débito no Pergamum, sendo que o usuário pode continuar utilizando todos os serviços da(s) biblioteca(s) normalmente. Caso o usuário opte por não lançar, o débito deverá ser quitado na própria biblioteca, sendo que o usuário ficará impossibilitado de utilizar os serviços da biblioteca.
2A exportação é realizada, ou seja, é inserido o registro na tabela exporta_multa. 
  • Não é gerado o débito no Pergamum;
  • A multa não fica constando no sistema, devendo ser verificada de modo externo e por isso, não existe a necessidade do retorno da informação para a biblioteca;
  • O Pergamum não solicita pergunta ao usuário;
  • O campo flag_transporte sempre terá o valor “B”.
3A exportação é realizada, ou seja, é inserido o registro na tabela exporta_multa. Todavia, a exportação é realizada de acordo com a permissão do operador, onde no momento da devolução irá surgir a tela de solicitação de pagamento da multa, ou seja, nessa opção de exportação o sistema pode receber a multa durante o processo de devolução caso o operador esteja habilitado para tal. Fica evidenciado que, se o operador receber a multa na devolução, a mesma não ficará pendente e portanto não será exportada.
  • É gerado o débito no Pergamum nas tabelas de histórico. A ideia nesta exportação é que no Pergamum seja informado posteriormente o pagamento dos débitos via processo interno, utilizando a tabela EXPORTA_MULTA_TEMP (ver exemplo no item 4.5.2 do documento de Integrações para sistemas terceiros do Pergamum).
  • No momento da devolução com multa, o Pergamum NÃO pergunta “Deseja exportar a multa?”. Ou seja, a exportação de multa sempre é realizada;
  • O campo flag_transporte nessa modalidade é gravado com vazio “ ”.
4A exportação é realizada, ou seja, é inserido o registro na tabela exporta_multa.
  • É gerado o débito no Pergamum;
  • No momento da devolução com multa, o Pergamum solicita ao usuário se deseja que o débito seja lançado para mensalidade ou para pagamento. De acordo com a resposta, a coluna flag_transporte é gravada com "M" (mensalidade) ou "B" (boleto). Caso o usuário opte por efetuar o lançamento na mensalidade, o débito deve ser retirado automaticamente do Pergamum, ficando portanto somente os débitos de boleto. O lançamento do débito para a mensalidade somente poderá ser efetivado caso a situação do usuário na instituição seja normal. Caso esteja afastado na instituição, aparecerá a mensagem informando da impossibilidade de lançamento na mensalidade, lançando o mesmo automaticamente para boleto.
5A exportação é realizada de acordo com pergunta solicitada ao usuário, e quando for exportada, é inserido o registro portanto na tabela exporta_multa.
  • O Pergamum solicita pergunta ao usuário de exportação ou não;
  • Caso seja exportada, não é gerado o débito no Pergamum. A multa não fica constando no sistema, devendo ser verificada de modo externo e por isso, não existe a necessidade do retorno da informação para a biblioteca.

A integração com o TOTVS Educacional permitirá a utilização dos seguintes tipos de integração: 0, 2 ou 3, sendo que quando o Pergamum estiver parametrizado com os valores 2 ou 3 passa a ser necessária a configuração das informações para a integração financeira. Para tanto basta acessar Integrações | Pergamum | Unidade bibliotecária do Pergamum | Parâmetros financeiros.

 

O cadastro permite a definição das informações importantes para que o lançamento de multa possa ser criado na coligada e filial da unidade bibliotecária.

Pré-requisitos instalação/implantação/utilização

Não é escopo desse documento descrever as instalação do ERP RM e nem sua configuração.

Versão RM

Utilizar a versão RM 12.1.16 ou superior.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos TOTVS Educacional estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

Cadastros

Cadastro de Situação de Matrícula

Com a integração do Pergamum ativa o usuário pode configurar no cadastro de Situação de Matrícula na aba Status no período letivo se deve ou não desativar o usuário do Pergamum, pelo parâmetro: Desativa usuário no Pergamum.

 

Cadastro de Unidade Bibliotecária

O cadastro da unidade bibliotecária permite a associação entre a informação de unidade bibliotecária registrada no TOTVS Educacional e a cadastrada no Pergamum. Tal vinculo é primordial para o envio de informações de acesso as unidades bibliotecárias. Atualmente não existe nenhum tipo de sincronização dessa informação entre TOTVS Educacional e Pergamum, sendo necessário o cadastro manual para o correto funcionamento. Uma unidade bibliotecária do Pergamum só pode estar vinculada a uma coligada e filial do TOTVS Educacional.

O acesso ao cadastro está localizado em Integrações | Pergamum | Unidade bibliotecária do Pergamum.

 

  • Código: busca as unidades bibliotecárias cadastradas no Pergamum para realização do vínculo.
  • Descrição: permite a definição de uma descrição para unidade bibliotecária

A unidade bibliotecária fica associada a coligada e filial na qual o usuário está autenticado no momento do cadastro.

 

Cadastro de Restrição de Acesso a uma Unidade Bibliotecária

Em algumas instituições de ensino o acesso a determinadas unidades bibliotecárias pode ser restrito a alunos de cursos e habilitações/series específicos, tendo em vista este aspecto o usuário do TOTVS Educacional pode para cada unidade bibliotecária definir, se necessário, restrições de acesso que deverão ser respeitadas no envio dos usuários para o Pergamum. A definição desta restrição de acesso pode ser feita em Integrações | Pergamum | Unidade bibliotecária do Pergamum | Restrição de acesso.

Para o cadastro da restrição de acesso é necessário informar o código do curso e o código da habilitação/serie. As unidades bibliotecárias sem restrição de acesso, estarão liberadas para acesso para todos os alunos.

Já aquelas que possuem restrição de acesso só podem ser acessadas por alunos matriculados nos cursos e habilitações/series cadastradas neste cadastro.

 

Cadastro de Permissão de Acesso Para Outras Filiais

Uma unidade bibliotecária é associada a uma coligada e filial, no entanto, pode ser compartilhada com outras filiais desde que ambas estejam parametrizadas para utilizar o mesmo Pergamum. A realização deste compartilhamento é feito acessando Integrações | Pergamum | Unidade bibliotecária do Pergamum | Permissão de acesso para outras filiais.

Cadastrar as filiais que podem ter acesso a unidade bibliotecária.

Uma filial estará configurada para utilizar o mesmo Pergamum quando os parâmetros de integração Tipo de Integração Bibliotecária utilizada é igual a Pergamum e os campos relacionados aos Parâmetros de comunicação com o webservice do Pergamum estejam iguais:

  • Caminho (endereço);
  • Chave de Acesso.

 

Cadastro de Relacionamento Entre as Tabelas TOTVS Educacional e Pergamum

A exportação de usuários requer que alguns relacionamentos sejam realizados entre TOTVS Educacional e Pergamum para garantir o envio correto da informação. As seguintes informações devem possuir o relacionamento criado:

  • Escolaridade;
  • Estado civil;
  • Nacionalidade;
  • Profissões.

Para tanto deve-se acessar Integrações | Pergamum | Cadastro de relacionamento entre tabelas básicas.

Cadastro dos de/para relacionado a informação da origem TOTVS Educacional com a informação do destino Pergamum.

Para que a informação do destino seja exibida corretamente os parâmetros de comunicação com os webservices do Pergamum já devem ter sido preenchidos.


Processos

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

 

Como fazer (opcional)

Descreva os passos que viabilizem a integração.

Exemplo:

Os passos para viabilizar a integração são:

 

Checklist de suporte da aplicação

Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

Instalação/Configuração

Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

 

Checklist de Verificações:

Relacione itens de verificações para que o atendente possa:

  • Identificar o funcionamento da integração;
  • Identificar a ocorrências de problemas;
  • Coletar evidências do mau funcionamento relatado pelo cliente;
  • Realizar possíveis ajustes na integração quanto à configuração ou negócio.

Anexos

Anexo 1 - De/Para das informações enviadas na integração dos usuários

WS_PESSOA_TEMP
ParâmetroDescriçãoTipoNuloTOTVS EducacionalObservação
cod_pessoa

Este código deve ser único perante a instituição. A preferência é a utilização de códigos numéricos com no máximo 8 dígitos. Caso sejam códigos numéricos com mais de 8 dígitos ou a utilização de códigos alfanuméricos, a parametrização do sistema deverá ser alterada para permitir este controle, e neste caso, o suporte do Pergamum deverá ser contatado.

String 20NãoPPESSOA.CODIGONo entanto, em alguns cenários este valor poderá variar caso o código já esteja sendo utilizado no Pergamum por outra pessoa.
nome_pessoa String 50SimPPESSOA.NOMESerá truncado de 120 para 50 caracteres
rua_pessoa String 50SimPPESSOA.RUASerá truncado de 140 para 50 caracteres
num_end_pessoa String 6SimPPESSOA.NUMEROSerá truncado de 8 para 6 caracteres
apto_pessoa String 15SimPPESSOA.COMPLEMENTOSerá truncado de 60 para 15 caracteres
bairro_pessoa String 30SimPPESSOA.BAIRROSerá truncado de 80 para 30 caracteres
telefone_pessoa String 150SimPPESSOA.TELEFONE1 
cep_pessoa Int 10SimPPESSOA.CEP 
cidade_pessoa String 30SimGMUNICIPIO.NOMEMUNICIPIOSerá truncado de 32 para 30 caracteres
cod_uf String 02SimPPESSOA.ESTADO 
cod_estado_civil Int 03NãoBusca a informação do relacionamento de tabelas entre os dois sistemas (SRELACAOCADBASICOEXTERNO) 
sexo_pessoa String 01SimPPESSOA.SEXOM/F
data_nascimento_pessoa String 10SimPPESSOA.DTNASCIMENTOdd/mm/aaaa
cod_nacionalidade Int 03NãoBusca a informação do relacionamento de tabelas entre os dois sistemas (SRELACAOCADBASICOEXTERNO) 
rg_pessoa String 40SimPPESSOA.CARTUDEBTUDADE 
cpf_pessoa String 11SimPPESSOA.CPF 
situacao_pessoaSituação da pessoa na instituiçãoInt 01SimParâmetro da Integração com o Pergamum "Código da situação normal" 
num_via_carteiraNúmero da via da carteira da pessoa, caso a instituição utilize este tipo de informação no crachá / carteiraInt 03SimFIXO = "" 
senha_pessoaCaso a instituição utilize a modalidade de autenticação via LDAP / AD, este campo não deve ser informado.String 255SimFIXO = "" 
senha_criptCaso a instituição utilize a modalidade de autenticação via LDAP / AD, este campo deve ser informado 'N'.String 01NãoUtilizando LDAP enviar Fixo = N, caso contrário S.
  • S - Senha Já criptografada;
  • N - Senha sem criptografia.
cod_categ_usuarioCategoria na qual a pessoa se enquadra para efetuar o empréstimoInt 03NãoEste campo dependerá da entidade a ser enviada.
  • Professor: parâmetro da integração com o Pergamum "Código da categoria para os professores";
  • Funcionário: parâmetro da integração com o Pergamum "Código da categoria para os funcionários";
  • Pessoa: o código da categoria é definido no processo de exportação;
  • Aluno: código parametrizado no cadastro da habilitação/série cursada pelo aluno, e nos casos em que esta informação não estiver definida buscar do parâmetro da integração com o Pergamum "Código da categoria para os alunos".
e_mail String 60SimPPESSOA.EMAIL 
recebe_emailSe a pessoa deseja receber e-mail com aviso de devolução, reserva, etc ou não.String 01NãoFIXO = N 
cod_profissaoUtilizado geralmente para Instituições PúblicasInt 10SimBusca a informação do relacionamento de tabelas entre os dois sistemas (SRELACAOCADBASICOEXTERNO) 
cod_escolaridadeUtilizado geralmente para Instituições PúblicasInt 10SimBusca a informação do relacionamento de tabelas entre os dois sistemas (SRELACAOCADBASICOEXTERNO) 
arq_fotoNome do arquivo que contém a foto do usuário, sem informar o caminhoString 100SimFIXO = "" 
demais_informacoesQuaisquer outras informações que sejam pertinentes a pessoaString 255SimFIXO = "" 
data_validadeValidade do usuário na instituição.String 10SimFIXO = ""dd/mm/aaaa
cod_tipo_emprestimoTipo de Empréstimo que a pessoa será autorizadaInt 03NãoFIXO = 11 - Normal
login_ldapNome do login ldap. Existem casos dependendo da configuração do servidor LDAP na instituição, que o nome do domínio deve estar presente juntamente ao nome do login, separados por barra. Verifique com o suporte do Pergamum como este campo deverá estar preenchido.String 50SimSe integração LDAP estiver desativada 
chaveChave de validação do WSString 255NãoParâmetro da Integração com o Pergamum "Chave de acesso" 


Anexo 2 - De/Para das informações enviadas na integração do programa de ensino

WS_DISCIPLINAS
ParâmetroDescriçãoTipoNuloValor
cod_disciplinaUtilizar o mesmo código do sistema acadêmico, caso utilize. Caso não possua, pode ser utilizado qualquer outro código, desde que o mesmo seja mantido em próximas atualizações.String 30NãoSDISCIPLINA.CODDISC
desc_disciplinaDescrição do nome da disciplina.String 200NãoSDISCIPLINA.NOME
chaveChave de validação do WSString 255NãoParâmetro da Integração com o Pergamum "Chave de acesso"


WS_DEPARTAMENTO
ParâmetroDescriçãoTipoNuloValor - CursoValor - HabilitaçãoValor - Matriz Aplicada
cod_departamentoCódigo do departamento/unidade organizacionalString 20Não"C|" + SCURSO.CODCURSO"H|" + SHABILITACAO.CODHABILITACAO"M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL
nome_departamentoNome do departamento/unidade organizacionalString 100NãoSCURSO.NOMESHABILITACAO.NOME (será truncado de 150 para 100)SGRADE.DESCRICAO (será truncado de 255 para 100)
sigla_departamentoSigla do departamento/unidade organizacionalString 20SimFIXO = ""FIXO = ""FIXO = ""
cod_pessoa_respCódigo da pessoa responsável pelo departamentoString 20SimFIXO = ""FIXO = ""FIXO = ""
cod_dep_paiRelação hierárquica se existir, caso não exista, cadastrar igual ao cod_departamentoString 20Não"C|" + SCURSO.CODCURSO"C|" + SCURSO.CODCURSO"H|" + SHABILITACAOFILIALCODHABILITACAO
ramalRamal telefônico para localização do setor dentro da instituiçãoString 10SimFIXO = ""FIXO = ""FIXO = ""
email_departE-mail do departamentoString 100SimFIXO = ""FIXO = ""FIXO = ""
chaveChave de validação do WSString 255NãoParâmetro da Integração com o Pergamum "Chave de acesso"



WS_DEPARTAMENTO_BIB
ParâmetroDescriçãoTipoNuloValor
cod_departo_bibCódigo do departamento (curso, setor, ...)String 20Não"M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL
cod_biblioteca_depCódigo da bibliotecaInt 5Não

SUNIDADEBIBLIPERGAMUM.CODUNIDBIBLIOTECARIA

chaveChave de validação do WSString 255NãoParâmetro da Integração com o Pergamum "Chave de acesso"


WS_IMPORTA_PERG_PROGRAMA
ParâmetroDescriçãoTipoNuloValor
cod_departo_progCódigo do departamento (curso, setor, ...)String 20Não"M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL
ano_progAno de início do currículoInt 4NãoSPLETIVO.DTINICIO (Formato: aaaa)
semestre_progForma de identificação do início do currículo dentro do anoInt 5NãoSPLETIVO.DTINICIO (Formato: aaaa)
periodo_progPeríodo que está sendo cursado, por exemplo 1º período, 2ºperíodo, 1 ano, etc.Int 5Não

Existe duas formas para buscar a informação, que dependerá da escolha do usuário:

  • Períodos da Matriz curricular: neste cenário deve-se exportar uma linha para cada período cadastrado na matriz curricular vinculada a matriz aplicada selecionada;
  • Períodos relacionados a oferta cadastrada: neste cenário deve-se exportar uma linha para cada período que possuir pelo menos uma disciplina ofertada relacionada a matriz curricular vinculada a matriz aplicada selecionada. (A turma/disciplina deverá estar ativa).

Os períodos cadastrados com código "0" não devem ser encaminhados.

cod_aux_progCódigo a ser utilizado caso necessário pela instituição para vínculo com sistemas terceirosString 20NãoFIXO = ""
chaveChave de validação do WSString 255NãoParâmetro da Integração com o Pergamum "Chave de acesso"


WS_TURMA
ParâmetroDescriçãoTipoNuloValor
cod_dep_turmaCódigo do departamento conforme descrito no WS_DEPARTAMENTOString 20Não"M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL
ano_turmaDeverão ser informados todos os anos que existiu a oferta de turma para o referido cursoInt 4SimSPLETIVO.DTINICIO (Formato: aaaa)
periodo_turmaDeverão ser informados todos os períodos que existiu a oferta de turma para o referido curso / anoInt 5SimFIXO = ""
serie_turmaDeverão ser informados todas as séries que existiu a oferta de turma para o referido curso / ano / períodoString 04SimFIXO = ""
turma_dep_turmaCaso exista algum código que identifique a turma perante o sistema acadêmico, essa informação pode ser informada.String 20SimSTURMA.CODTURMA
chaveChave de validação do WSString 255NãoParâmetro da Integração com o Pergamum "Chave de acesso"


WS_PERG_PROGRAMA_DISC
ParâmetroDescriçãoTipoNuloValor
cod_departo_discCódigo do departamento (curso, setor, ...)String 20Não"M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL
ano_progAno de início do currículoInt 4NãoSPLETIVO.DTINICIO (Formato: aaaa)
semestre_progForma de identificação do início do currículo dentro do anoInt 5Não

Se o mês da data inicial do período letivo for menor que 6 enviar 1, caso contrário 2.

periodo_progPeríodo que está sendo cursado, por exemplo 1º período, 2ºperíodo, 1 ano, etc. Int 5NãoSDISCGRADE.PERIODO 
cod_disciplinaCódigo identificador da disciplina.String 30 NãoSTURMADISC.CODDISC 
num_alunos_discNúmero de alunos na disciplina da turma do cursoInt 5Sim

Verificar controle de vaga definido na matriz curricular vinculada a matriz aplicada:

  • Turma/Disciplina: STURMADISC.MAXALUNOS;
  • Turma: STURMA.MAXALUNOS.
chaveChave de validação do WSString 255NãoBuscar da parametrização da integração entre Pergamum e o TOTVS Educacional


WS_PESSOA_DEP
ParâmetroDescriçãoTipoNuloValor
cod_pessoa_depCódigo da pessoa no depto (Ex.: aluno por curso, funcionário por setor, etc)String 20 Não

SPESSOAPERGAMUM. CODUSUARIOPERGAMUM
Buscar a informação vinculada ao mesmo contexto do departamento (matriz aplicada) informado.

cod_departamento_depCódigo do departamento (curso, setor, etc)String 20Não"M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL
cod_afast_depSituação da pessoa no departamentoInt 1NãoDefine a situação do usuário de acordo com a situação de matricula do aluno.
ano_vigencia_depAno atual ou o último ano que a pessoa esteve vinculada ao departamentoInt 4SimSPLETIVO.DTINICIO (Formato: aaaa)
periodo_depPeríodo que está cursandoInt 5SimSMATRICPL.CODPERIODO
serie_depSérie que está cursandoString 04SimFIXO = ""
turma_depTurma atual da pessoaString 20SimSMATRICPL.CODTURMA
ChaveChave de validação do WSString 255 NãoBuscar da parametrização da integração entre Pergamum e o TOTVS Educacional