INTEGRAÇÃO TOTVS Educacional X Pergamum
Aviso
Para que a integração funcione corretamente o Pergamum deve estar configurado para que o conteúdo das requisições do webservice sejam retornados no formato "text/xml" e o conjunto de caracteres do tipo "ISO-8859-1".
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 o 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.
Observação Importante
O Pergamum deverá estar com a versão mais recente e quando for utilizar a funcionalidade de "Programa de ensino" o código do departamento deve ser parametrizado no Pergamum para utilizar alfanumérico.
Escopo
As entidades e os pontos de integração que farão parte do escopo dessa integração são:
Entidade | Pontos de Integração |
---|---|
Aluno |
|
Professor | Cadastro do Professor |
Funcionário | Cadastro de Funcionário |
Pessoa | Cadastro de Pessoa |
Disciplinas | Cadastro de Disciplinas |
Curso |
|
Parametrização por Curso | Cadastro da Parametrização por Curso |
Turma |
|
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.
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: | ||
Valor | Ação | Efeito |
0 | Nã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. |
1 | A 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. |
2 | A exportação é realizada, ou seja, é inserido o registro na tabela exporta_multa. |
|
3 | A 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. |
|
4 | A exportação é realizada, ou seja, é inserido o registro na tabela exporta_multa. |
|
5 | A exportação é realizada de acordo com pergunta solicitada ao usuário, e quando for exportada, é inserido o registro portanto na tabela exporta_multa. |
|
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.
Observações:
- Dias para vencimento: quando uma multa é importada do Pergamum, o sistema considera a data da multa (campo data_multa) como base para cálculo da data de vencimento do lançamento que será gerado, incrementando os dias para vencimento na data retornada pelo Pergamum.
- Agrupar valores em um único lançamento: caso exista mais de uma multa para o mesmo usuário no momento da geração dos lançamentos, o sistema poderá agrupar todas as multas em um único lançamento e em um único boleto no momento da geração.
- Gerar boleto bancário: Ao gerar um lançamento, seja para multas agrupadas ou por cada item de multa, o sistema já irá gerar o boleto bancário logo após a geração do lançamento.
- Centro de Custo: caso o centro de custo seja obrigatório para geração de lançamentos, o mesmo deve ser informado e será sempre utilizado o centro de custo da unidade bibliotecária que a multa foi importada.
- Os eventos contábeis e tabelas opcionais sempre serão fixos conforme definido nos parâmetros financeiros 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.
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. Observação 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:
|
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. Importante 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. |
Central do Aluno
A central do aluno passa a contar com mais um item para consulta relacionado a Biblioteca, listando os empréstimos pendentes e as multas vencidas do aluno.
Portal Educacional x Meu Pergamum
Quando o aluno acessar o Portal Educacional é disponibilizado no menu Biblioteca o item Meu Pergamum. Este link irá direcionar o aluno para o Pergamum sem a necessidade de autenticação.
Para que o aluno possa visualizar o link do Meu Pergamum no Portal do Aluno, o perfil associado a seu usuário deverá ter habilitada a permissão Educacional | Educacional (Portal) |Biblioteca | Meu Pergamum.
Importante
É importante a definição do código da instituição e a URL do Pergamum nos parâmetros da integração entre TOTVS Educacional e Pergamum.
A partir dessas configurações, o aluno já é capaz de acessar o Meu Pegamum a partir do Portal Educacional sem a necessidade de efetuar um novo login.
Chave de integração de usuários
É possível escolher qual será a chave que de integração dos novos usuários e alunos do TOTVS Educacional com o Pergamum, o sistema permite enviar o código da pessoa, CPF ou RA(em caso de aluno).
A partir das versões 12.1.27.304, 12.1.28.214, 12.1.29.140 e 12.1.31, foi inserido dois itens informativos. O primeiro indica qual é o tipo do do campo código da pessoa parametrizado no Pergamum, numérico ou alfanumérico. O segundo item inserido foi a quantidade de caracteres que o código da pessoa do Pergamum foi parametrizado, caso o tipo do campo for alfanumérico. Muita atenção a este parâmetro que informa o tipo de campo código da pessoa no Pergamum, a alteração dele nas configurações do Pergamum poderá gerar grandes impactos na importação de multas vindas do Pergamum.
Detalhes da utilização do Código da Pessoa
A partir das versões 12.1.27.304, 12.1.28.214, 12.1.29.140 e 12.1.31 se no Pergamum estiver parametrizado como alfanumérico e a quantidade de caracteres for menor que 10, será possível utilizar o Código da Pessoa como chave de integração, porém será exibido um alerta ao usuário, pois o Código da Pessoa é um número inteiro de 32 bits que poderá ter seu valor em até 4.294.967.295, ou seja, 10 caracteres. É necessário verificar o código da pessoa no TOTVS irá ultrapassar a quantidade de caracteres parametrizado no Pergamum.
Detalhes da utilização do CPF
- Alunos, Professores, Funcionários ou Pessoas que não tiverem CPF preenchido não serão enviados e tal informação será inserida no log ao final da exportação.
- Caso no momento da geração de um novo usuário com o CPF o mesmo já tenha sido utilizado por outro usuário Pergamum, não será feita a exportação do mesmo e será informado no log.
- É recomendável que o CPF esteja parametrizado como registro único no Totvs Gestão de Pessoas, sendo assim o sistema irá garantir a integridade do registro que está sendo gerado.
A partir das versões 12.1.27.304, 12.1.28.214, 12.1.29.140 e 12.1.31 se no Pergamum estiver parametrizado como alfanumérico e a quantidade de caracteres for menor que 11, não será possível utilizar o CPF como chave de integração, pois o CPF possui 11 caracteres, com isso deve se escolher outra chave de integração.
Detalhes da utilização do RA
- Caso se utilize um padrão de geração de RA, apenas, numérico, poderão ocorrer conflitos com códigos de outros usuários.
- Para estes casos, o sistema não realizará a exportação desses alunos e os mesmos deverão ser associados manualmente.
A partir das versões 12.1.27.304, 12.1.28.214, 12.1.29.140 e 12.1.31 se no Pergamum estiver parametrizado como alfanumérico e a quantidade de caracteres for menor que 20, será possível utilizar o RA como chave de integração, porém será exibido um alerta ao usuário, pois o RA permite até 20 caracteres. É necessário verificar se a máscara que gera o RA irá ultrapassar a quantidade de caracteres parametrizado no Pergamum.
É possível também informar como o sistema realizará a inclusão de usuário caso sejam selecionados para a exportação, vários alunos da mesma pessoa.
Processos
Criação de Usuários no Pergamum
Quando parametrizamos a integração do TOTVS Educacional com o Pergamum podemos ter alguns cenários nas instituições de ensino:
- Instituição utiliza o TOTVS Educacional e está implantando o Pergamum;
- Instituição utiliza o Pergamum e está implantando o TOTVS Educacional;
- Instituição está implantando o TOTVS Educacional e o Pergamum;
- Instituição já utiliza o TOTVS Educacional e o Pergamum.
Para alguns dos cenários acima os usuários existem tanto no TOTVS Educacional quanto no Pergamum, no entanto, não possuem um vínculo que permita a exportação de multas. Tendo em vista este cenário as funcionalidades responsáveis por criar os usuários no Pergamum devem verificar se o usuário selecionado no TOTVS Educacional já possui usuário no Pergamum.
Usuário já existe no Pergamum | Usuário não existe no Pergamum |
---|---|
|
|
Critérios que serão utilizados para verificar se o usuário já existe no Pergamum
- Verificar se existe algum usuário no Pergamum com o mesmo CPF;
- Verificar se existe algum usuário no Pergamum com o mesmo Nome e Data de Nascimento.
O vínculo que é criado entre o usuário do TOTVS Educacional e Pergamum pode ser consultado nos anexos dos seguintes cadastros:
- Cadastro de aluno;
- Cadastro de professor;
- Cadastro de funcionário;
- Cadastro de pessoa.
Vínculo entre o usuário TOTVS Educacional com o Pergamum. Este vinculo pode ser inserido e alterado manualmente caso seja necessário | |
Caso esteja parametrizado para enviar todos os RA do aluno para o pergamum o campo RA vinculado irá aparecer e será preenchido caso for aluno, para as demais entidades o mesmo não será preenchido. Por outro lado, caso esteja parametrizado para enviar o primeiro RA encontrado o campo RA vinculado não irá ser exibido para nenhuma entidade. |
Para exportar os registros de Alunos, Professores, Funcionários e Pessoas para o Pergamum deve-se utilizar o processo de Exportar usuários para o Pergamum. Tal processo poderá ser acesso em Integrações | Pergamum | Exportar usuários para o Pergamum.
Importante
Caso o ambiente do Pergamum estiver configurado para que o código do usuário do pergamum seja não numérico (alfanumérico) o TOTVS Educacional irá concatenar zeros à esquerda para completar os 20 caracteres e enviar para o Pergamum. Por outro lado, se estiver configurado para que seja numérico o TOTVS Educacional não irá concatenar zeros à esquerda ao enviar o código de usuário para o Pergamum. Lembrando que o TOTVS Educacional envia o código da pessoa ou CPF ou RA para a criação do usuário no Pergamum.
Isso vale a partir das versões: 12.1.27.160, 12.1.28.172 e 12.1.29.100.
A partir das versões 12.1.27.304, 12.1.28.214, 12.1.29.140 e 12.1.31, se no Pergamum estiver parametrizado como alfanumérico a quantidade de caracteres que será complementados com zeros à esquerda não mais será fixado em 20 caracteres e sim seguirá o que foi parametrizado no Pergamum. Ou seja, se no Pergamum estiver alfanumérico e 15 caracteres, o TOTVS Educacional ao exportar o usuário irá concatenar zeros à esquerda até complentar 15 caracteres. Lembrando que isso vale apenas para parametrização alfanumérica, se for numérico não irá ocorrer nenhuma concatenação de zeros à esquerda.
Para tornar mais ágil a parte de criação de usuários para os Alunos no Pergamum, basta acessar os parâmetros da integração com o Pergamum e marcar a opção Criar usuário no Pergamum automaticamente após matrícula do aluno no período letivo. Com esta opção marcada os alunos que forem matriculados no período letivo, que ainda não tiverem usuários gerados e cuja situação de matricula determinar que é ativo no Pergamum, devem disparar a criação automática.
Aviso
A geração automática só ocorrerá se as matrículas forem executadas para o período letivo corrente definido nos parâmetros da secretaria.
Nos casos em que a comunicação com o Pergamum estiver indisponível (por alguma questão de rede ou indisponibilidade do webservice do Pergamum) a matrícula do aluno no período letivo não será interrompida e ao final do processo é exibida uma mensagem informando que a criação do usuário no Pergamum não foi realizada. Nestes casos deve-se fazer uso do processo de criação de usuário.
Importante
Alguns campos possuem tamanhos diferentes entre TOTVS Educacional e Pergamum, por este motivo os campos cujo tamanho no TOTVS Educacional forem maior que no Pergamum devem ter seu conteúdo truncado para permitir o envio. Para mais detalhes acessar o item Anexo 1 - De/Para das informações enviadas na integração dos usuários.
Atualização de Usuário no Pergamum
Para manter o cadastro dos usuários com as informações sincronizadas pode-se utilizar o processo de atualização de usuários. Tal processo está localizado em Integrações | Pergamum | Atualiza usuários no Pergamum | Atualiza usuários no Pergamum.
A atualização dos dados cadastrais da Pessoa será responsável por deixar as seguintes informações do TOTVS Educacional idênticas as do Pergamum:
- Nome;
- Sexo;
- Estado civil;
- Data de Nascimento;
- Nacionalidade;
- Profissão;
- Grau de Instrução;
- Telefone;
- E-mail;
- Foto;
- Login LDAP
- Quando a integração estiver habilitada:
- Será enviado o login de rede caso preenchido, caso vazio será enviado login do usuário RM.
- Quando a integração estiver desabilitada:
- Será enviado o login do usuário RM caso exista.
- Quando a integração estiver habilitada:
- Endereço:
- Rua (Logradouro);
- Número;
- Bairro;
- Complemento;
- CEP;
- Cidade;
- Estado.
- Documentos:
- CPF;
- Carteira de Identidade.
Para manter os cadastros dos usuários sincronizados é necessário acessar os parâmetros da integração com o Pergamum e configurar a atualização automática, da seguinte forma:
- Marcar o parâmetro Atualizar dados cadastrais automaticamente no Pergamum, desta forma as alterações realizadas nos cadastros de aluno, professor, funcionário e pessoa enviam automaticamente uma mensagem de atualização para o cadastro de usuário do Pergamum;
- Aliado ao parâmetro acima citado, tem-se a configuração do parâmetro Ação a ser executada quando ocorrer erro na comunicação com o Pergamum/ para atualização dos dados cadastrais da pessoa que estabelece a forma como o sistema se comportará se ocorrer um problema na comunicação com o Pergamum, tendo as seguintes opções:
- Emitir erro impedindo a gravação da alteração - o sistema emite uma mensagem de erro e não permite a alteração da informação no TOTVS;
- Emitir aviso e possibilitar a gravação da alteração - o sistema emite uma mensagem de aviso permitindo a alteração da informação no TOTVS. Para que a informação cadastral deste usuário seja atualizada no Pergamum o Processo de atualização dos dados cadastrais da Pessoa deverá ser executado, posteriormente.
Quando o parâmetro o Atualizar dados cadastrais automaticamente no Pergamum estiver desmarcado a atualização dos dados cadastrais dos usuários do Pergamum deverá ser realizada pela execução do Processo de atualização dos dados cadastrais da Pessoa.
É importante frisar que o disparo das atualizações cadastrais não modifica a categoria do usuário do Pergamum, mantendo desta forma a mesma categoria enviada na sua criação.
Importante
Alterações realizadas no cadastro de usuário no Pergamum não são refletidas no TOTVS Educacional, por este motivo é aconselhado que todas as alterações sejam realizadas no sistema TOTVS.
Quando o usuário não possuir foto no cadastro de pessoa, o campo "Nome do arquivo da foto" no Pergamum não será atualizado, ou seja, não será preenchido com ".".
Quando o usuário possuir foto e esta for removida do cadastro da pessoa no TOTVS Educacional, o processo não irá remover o vínculo da foto no cadastro do Pergamum, este processo deverá ser feito manualmente através do Pergamum.
Durante a matrícula/rematrícula do aluno em um período letivo se a integração com o Pergamum estiver ativa, temos alguns parâmetros que determinam ações a serem executadas.
Parâmetros que determinam o disparo de comunicação para sincronização de informações com o Pergamum | |
---|---|
Atualizar código da categoria de alunos após matrícula no período letivo | Indica que quando houver a matrícula de alunos em um novo período letivo este terá sua categoria atualizada. |
Criar usuário no Pergamum automaticamente após matrícula do aluno no período letivo | Indica que quando houver a matrícula de alunos no período letivo e este não possuir usuário cadastrado no Pergamum o sistema dispara a criação do usuário no Pergamum, ou seja, o usuário do aluno será criado no Pergamum |
Importante
Nos casos em que a comunicação com o Pergamum estiver indisponível (por alguma questão de rede ou indisponibilidade do webservice do Pergamum) a matrícula do aluno no período letivo não será interrompida e ao final do processo é exibida uma mensagem para o usuário informando que a atualização da categoria ou a criação do usuário no Pergamum não foi realizada. Neste caso deve-se utilizar os processos Atualiza usuários no Pergamum e/ou Exportar usuários para o Pergamum.
Parâmetros que podem bloquear a matricula/rematrícula do aluno no período letivo | |
---|---|
Alunos com empréstimos em atraso na biblioteca | Indica que quando o aluno possuir empréstimos atrasados junto a biblioteca sua matrícula no período letivo será bloqueada. |
Alunos com débitos na biblioteca | Indica que quando o aluno possuir débitos na biblioteca sua matrícula no período letivo será bloqueada. |
.
Importante
Quando a integração financeira estiver parametrizada para ser controlada pelo Pergamum a verificação do débito é realizado neste sistema, para todos os outros cenários a verificação é realizada no TOTVS.
Lembrete
Lembrando que os parâmetros de bloqueio podem ser sobregravados por permissões especiais associadas ao perfil do usuário, neste caso temos:
- Alterar situação de matrícula ou matricular aluno com empréstimos em atraso;
- Alterar situação de matrícula ou matricular alunos com débitos na biblioteca.
Atualização de Categoria de Alunos Após Encerramento de Período Letivo
Este processo se aplica apenas quando a tipo de atualização de categoria dos alunos esteja parametrizado para atualizar após o encerramento do período letivo.
O encerramento do período letivo se dá de duas formas, pelo cadastro do Período Letivo e pelo processo de Apuração de Resultados. Em ambos a regra para atualizar é estar parametrizado para atualizar a categoria após o encerramento do período letivo e o mesmo ser o "Período letivo anterior" em outro período letivo.
Regras de atualização da categoria ao encerrar o período letivo
Ao encerrar um período letivo, algumas regras são consideradas:
- Aluno possui duas matrículas em dois cursos diferentes
- Caso as duas habilitações/séries possuírem as categorias preenchidas, sendo diferentes, o sistema não irá atualizar a categoria do aluno no Pergamum, pois são diferentes, caso sejam iguais, o sistema irá atualizar.
- Caso as duas habilitações/séries não possuírem as categorias preenchidas e nos parâmetros da integração com o Pergamum estiver preenchido, o sistema irá atualizar a categoria do aluno no Pergamum para a categoria da parametrização geral. Caso a categoria nos parâmetros gerais não estiver preenchido, o sistema não irá atualizar a categoria, por não possuir nenhuma.
- Caso uma das habilitações/séries possuir a categoria preenchida, o sistema irá considerar a categoria da habilitação/série preenchida para atualizar a categoria do aluno no Pergamum.
Matricula Online
A matrícula online obedecerá os parâmetros definidos em RM Portal - Matrícula que passam a controlar a forma com o sistema funcionará.
Grupo de parâmetros para Biblioteca:
- Alertar alunos com débitos financeiros;
- Bloquear alunos com débitos financeiros;
- Alertar alunos com empréstimos atrasados;
- Bloquear alunos com empréstimos atrasados.
Estes parâmetros definirão como as pendências do aluno na biblioteca serão tradadas na matrícula online, podendo apenas emitir um alerta ou também bloquear a matrícula do aluno.
Alteração de Situação de Matrícula no Período Letivo
Ao alterar a situação de matrícula no período letivo para um determinado aluno o sistema valida alguns parâmetros da integração entre TOTVS Educacional e Pergamum, são eles:
- Alunos com empréstimos em atraso na biblioteca - indica que quando o aluno possuir empréstimos atrasados junto a biblioteca a alteração da situação de matrícula no período letivo será bloqueada;
- Alunos com débitos na biblioteca - indica que quando o aluno possuir débitos na biblioteca a alteração da situação de matrícula no período letivo será bloqueada.
Importante
Quando a integração financeira estiver parametrizada para ser controlada pelo Pergamum a verificação do débito é realizado neste sistema, para todos os outros cenários a verificação é realizada no TOTVS.
Em caso de problema na comunicação com o Pergamum para verificar os atrasos e débitos na biblioteca o sistema se comportará da seguinte forma:
- Se o usuário autenticado tiver associado ao seu perfil a permissão de Alterar situação de matrícula ou matricular aluno com empréstimos em atraso e/ou Alterar situação de matrícula ou matricular alunos com débitos na biblioteca o sistema permitirá a alteração da situação de matricula, mas adicionará um aviso no log do processo;
- Se o usuário autenticado não tiver associado ao seu perfil a permissão de Alterar situação de matrícula ou matricular aluno com empréstimos em atraso e Alterar situação de matrícula ou matricular alunos com débitos na biblioteca o sistema emitirá uma exceção e não permitirá a alteração da situação de matrícula.
Após a execução do processo, se a situação de matrícula do aluno estiver parametrizada para desativar o usuário no Pergamum, o sistema antes de disparar a mensagem verifica:
- Se este usuário não desempenha algum outro papel, por exemplo pode ser um funcionário ou professor;
- Se este usuário não está cursando outro curso na instituição de ensino que permita que o usuário continue ativo;
- Se a alteração está sendo realizada no período letivo parametrizado como corrente.
Importante
Ao enviar a mensagem para desativar o usuário no Pergamum, se houver problema de comunicação entre os dois sistemas, o processo de alteração da situação de matrícula será concluído emitindo uma mensagem de aviso ao final do processo.
Cadastro da situação de matrícula - Desativa usuário no Pergamum | Parametrizador do TOTVS Educacional - Secretária | Período letivo parâmetro - Período letivo |
---|---|
Status do Usuário no Pergamum
O processo Atualiza status dos alunos e funcionários no Pergamum é responsável por alterar o status do usuário no Pergamum, mediante alteração da situação de matrícula no período letivo corrente e demissões de funcionários. A execução deste processo poderá ser feita em Integrações | Pergamum | Atualiza status dos alunos e funcionários no Pergamum.
Demissão de Funcionários
Quando o TOTVS Educacional estiver integrado com a Folha de Pagamento da linha RM a demissão do funcionário executa os seguintes passos:
- Verifica no Pergamum se o funcionário possui pendências com a biblioteca no momento da demissão do funcionário;
- Envia a mensagem de desativação do usuário para o Pergamum.
Caso ocorra erro na comunicação entre TOTVS Educacional e Pergamum o sistema deverá verificar o parâmetro Ação a ser executada quando ocorrer erro na comunicação com o Pergamum na desativação de funcionário demitido que disponibiliza as opções:
- Emitir erro impedindo a efetivação da demissão - neste cenário o sistema emite uma mensagem de erro e não permite a demissão do funcionário no TOTVS;
- Emitir aviso e permitir a demissão - neste cenário o sistema emite uma mensagem de aviso permitindo a demissão do funcionário no TOTVS.
Caso o funcionário possua vínculo em mais de um contexto e o parâmetro Emitir erro impedindo a efetivação da demissão esteja marcado, todos os contextos do funcionário devem ter o código de situação afastado preenchido nos parâmetros de integração no TOTVS Educacional.
Programa de Ensino
A exportação de informações relacionadas ao Programa de Ensino é possível ser feito pelo processo Exporta Programa de Ensino para Pergamum, que possui várias etapas que permitem a seleção das informações que devem ser exportadas.
Integração Financeira
A integração financeira entre TOTVS Educacional e Pergamum para funcionar corretamente possui algumas premissas, que são descritas abaixo:
- Pergamum deve estar parametrização para o tipo de integração 2 ou 3;
- TOTVS Educacional deve ter as parametrizações financeiras das unidades bibliotecárias cadastras.
A partir daí é possível gerar os lançamentos financeiros a partir das multas importadas do Pergamum. Tal fato é possível acessando Integrações | Pergamum | Importar Multas Geradas no Pergamum.
Checklist de suporte da aplicação
Itens para conferência no TOTVS Educacional | Itens para conferência no Pergamum | |
---|---|---|
1 | Instalação da Biblioteca RM versão 12.1.16 ou superior. | Webservice disponibilizado do Pergamum ativo |
2 | Tipo de integração bibliotecária utilizada marcada com Pergamum | |
3 | Parâmetros de comunicação com o webservice do Pergamum preenchidos | |
4 | Parâmetros para acesso ao banco de dados do Pergamum preenchido | |
5 | Cadastro de relacionamento entre tabelas básicas entre TOTVS Educacional e Pergamum |
Anexos
Anexo 1 - De/Para das informações enviadas na integração dos usuários
WS_PESSOA_TEMP | |||||
---|---|---|---|---|---|
Parâmetro | Descrição | Tipo | Nulo | TOTVS Educacional | Observaçã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 20 | Não | PPESSOA.CODIGO | No entanto, em alguns cenários este valor poderá variar caso o código já esteja sendo utilizado no Pergamum por outra pessoa. |
nome_pessoa | Caso o Parâmetro "Enviar o nome social, quando preenchido, na exportação de usuários" esteja habilitado, será enviado o campo PPESSOA.NOMESOCIAL sempre que ele estiver preenchido. | String 50 | Sim | PPESSOA.NOME ou PPESSOA.NOMESOCIAL | Será truncado de 120 para 50 caracteres |
rua_pessoa | String 50 | Sim | PPESSOA.RUA | Será truncado de 140 para 50 caracteres | |
num_end_pessoa | String 6 | Sim | PPESSOA.NUMERO | Será truncado de 8 para 6 caracteres | |
apto_pessoa | String 15 | Sim | PPESSOA.COMPLEMENTO | Será truncado de 60 para 15 caracteres | |
bairro_pessoa | String 30 | Sim | PPESSOA.BAIRRO | Será truncado de 80 para 30 caracteres | |
telefone_pessoa | String 150 | Sim | PPESSOA.TELEFONE1 | ||
cep_pessoa | Int 10 | Sim | PPESSOA.CEP | ||
cidade_pessoa | String 30 | Sim | GMUNICIPIO.NOMEMUNICIPIO | Será truncado de 32 para 30 caracteres | |
cod_uf | String 02 | Sim | PPESSOA.ESTADO | ||
cod_estado_civil | Int 03 | Não | Busca a informação do relacionamento de tabelas entre os dois sistemas (SRELACAOCADBASICOEXTERNO) | ||
sexo_pessoa | String 01 | Sim | PPESSOA.SEXO | M/F | |
data_nascimento_pessoa | String 10 | Sim | PPESSOA.DTNASCIMENTO | dd/mm/aaaa | |
cod_nacionalidade | Int 03 | Não | Busca a informação do relacionamento de tabelas entre os dois sistemas (SRELACAOCADBASICOEXTERNO) | ||
rg_pessoa | String 40 | Sim | PPESSOA.CARTUDEBTUDADE | ||
cpf_pessoa | String 11 | Sim | PPESSOA.CPF | ||
situacao_pessoa | Situação da pessoa na instituição | Int 01 | Sim | Parâmetro da Integração com o Pergamum Código da situação normal | |
num_via_carteira | Número da via da carteira da pessoa, caso a instituição utilize este tipo de informação no crachá / carteira | Int 03 | Sim | FIXO = "" | |
senha_pessoa | Caso a instituição utilize a modalidade de autenticação via LDAP / AD, este campo não deve ser informado. | String 255 | Sim | FIXO = "" | |
senha_cript | Caso a instituição utilize a modalidade de autenticação via LDAP / AD, este campo deve ser informado 'N'. | String 01 | Não | Utilizando LDAP enviar Fixo = N, caso contrário S. |
|
cod_categ_usuario | Categoria na qual a pessoa se enquadra para efetuar o empréstimo | Int 03 | Não | Este campo dependerá da entidade a ser enviada. |
|
e_mail | String 60 | Sim | PPESSOA.EMAIL | ||
recebe_email | Se a pessoa deseja receber e-mail com aviso de devolução, reserva, etc ou não. | String 01 | Não | FIXO = N | |
cod_profissao | Utilizado geralmente para Instituições Públicas | Int 10 | Sim | Busca a informação do relacionamento de tabelas entre os dois sistemas (SRELACAOCADBASICOEXTERNO) | |
cod_escolaridade | Utilizado geralmente para Instituições Públicas | Int 10 | Sim | Busca a informação do relacionamento de tabelas entre os dois sistemas (SRELACAOCADBASICOEXTERNO) | |
arq_foto | Nome do arquivo que contém a foto do usuário, sem informar o caminho | String 100 | Sim | FIXO = "" | |
demais_informacoes | Quaisquer outras informações que sejam pertinentes a pessoa | String 255 | Sim | FIXO = "" | |
data_validade | Validade do usuário na instituição. | String 10 | Sim | FIXO = "" | dd/mm/aaaa |
cod_tipo_emprestimo | Tipo de Empréstimo que a pessoa será autorizada | Int 03 | Não | FIXO = 1 | 1 - Normal |
login_ldap | Nome 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 50 | Sim | Caso a integração com LDAP estiver habilitada será enviado o usuário de rede caso preenchido, caso vazio será enviado o usuário RM. Caso a integração estiver desabilitada será enviado o usuário RM caso exista. Estes dados serão enviados para o campo "login adicional" do Pergamum. | |
chave | Chave de validação do WS | String 255 | Não | Parâ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âmetro | Descrição | Tipo | Nulo | Valor |
cod_disciplina | Utilizar 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 30 | Não | SDISCIPLINA.CODDISC |
desc_disciplina | Descrição do nome da disciplina. | String 200 | Não | SDISCIPLINA.NOME |
chave | Chave de validação do WS | String 255 | Não | Parâmetro da Integração com o Pergamum Chave de acesso |
WS_DEPARTAMENTO | ||||||
---|---|---|---|---|---|---|
Parâmetro | Descrição | Tipo | Nulo | Valor - Curso | Valor - Habilitação | Valor - Matriz Aplicada |
cod_departamento | Código do departamento/unidade organizacional | String 20 | Não | "C|" + SCURSO.CODCURSO | "H|" + SHABILITACAO.CODHABILITACAO | "M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL |
nome_departamento | Nome do departamento/unidade organizacional | String 100 | Não | SCURSO.NOME | SHABILITACAO.NOME (será truncado de 150 para 100) | SGRADE.DESCRICAO (será truncado de 255 para 100) |
sigla_departamento | Sigla do departamento/unidade organizacional | String 20 | Sim | FIXO = "" | FIXO = "" | FIXO = "" |
cod_pessoa_resp | Código da pessoa responsável pelo departamento | String 20 | Sim | FIXO = "" | FIXO = "" | FIXO = "" |
cod_dep_pai | Relação hierárquica se existir, caso não exista, cadastrar igual ao cod_departamento | String 20 | Não | "C|" + SCURSO.CODCURSO | "C|" + SCURSO.CODCURSO | "H|" + SHABILITACAOFILIALCODHABILITACAO |
ramal | Ramal telefônico para localização do setor dentro da instituição | String 10 | Sim | FIXO = "" | FIXO = "" | FIXO = "" |
email_depart | E-mail do departamento | String 100 | Sim | FIXO = "" | FIXO = "" | FIXO = "" |
chave | Chave de validação do WS | String 255 | Não | Parâmetro da Integração com o Pergamum Chave de acesso |
WS_DEPARTAMENTO_BIB | ||||
---|---|---|---|---|
Parâmetro | Descrição | Tipo | Nulo | Valor |
cod_departo_bib | Código do departamento (curso, setor, ...) | String 20 | Não | "M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL |
cod_biblioteca_dep | Código da biblioteca | Int 5 | Não | SUNIDADEBIBLIPERGAMUM.CODUNIDBIBLIOTECARIA |
chave | Chave de validação do WS | String 255 | Não | Parâmetro da Integração com o Pergamum Chave de acesso |
WS_IMPORTA_PERG_PROGRAMA | ||||
---|---|---|---|---|
Parâmetro | Descrição | Tipo | Nulo | Valor |
cod_departo_prog | Código do departamento (curso, setor, ...) | String 20 | Não | "M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL |
ano_prog | Ano de início do currículo | Int 4 | Não | SPLETIVO.DTINICIO (Formato: aaaa) |
semestre_prog | Forma de identificação do início do currículo dentro do ano | Int 5 | Não | SPLETIVO.DTINICIO (Formato: aaaa) |
periodo_prog | Período que está sendo cursado, por exemplo 1º período, 2ºperíodo, 1 ano, etc. | Int 5 | Não | Existe duas formas para buscar a informação, que dependerá da escolha do usuário:
Os períodos cadastrados com código "0" não devem ser encaminhados. |
cod_aux_prog | Código a ser utilizado caso necessário pela instituição para vínculo com sistemas terceiros | String 20 | Não | FIXO = "" |
chave | Chave de validação do WS | String 255 | Não | Parâmetro da Integração com o Pergamum Chave de acesso |
WS_TURMA | ||||
---|---|---|---|---|
Parâmetro | Descrição | Tipo | Nulo | Valor |
cod_dep_turma | Código do departamento conforme descrito no WS_DEPARTAMENTO | String 20 | Não | "M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL |
ano_turma | Deverão ser informados todos os anos que existiu a oferta de turma para o referido curso | Int 4 | Sim | SPLETIVO.DTINICIO (Formato: aaaa) |
periodo_turma | Deverão ser informados todos os períodos que existiu a oferta de turma para o referido curso / ano | Int 5 | Sim | FIXO = "" |
serie_turma | Deverão ser informados todas as séries que existiu a oferta de turma para o referido curso / ano / período | String 04 | Sim | FIXO = "" |
turma_dep_turma | Caso exista algum código que identifique a turma perante o sistema acadêmico, essa informação pode ser informada. | String 20 | Sim | STURMA.CODTURMA |
chave | Chave de validação do WS | String 255 | Não | Parâmetro da Integração com o Pergamum Chave de acesso |
WS_PERG_PROGRAMA_DISC | ||||
---|---|---|---|---|
Parâmetro | Descrição | Tipo | Nulo | Valor |
cod_departo_disc | Código do departamento (curso, setor, ...) | String 20 | Não | "M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL |
ano_prog | Ano de início do currículo | Int 4 | Não | SPLETIVO.DTINICIO (Formato: aaaa) |
semestre_prog | Forma de identificação do início do currículo dentro do ano | Int 5 | Não | Se o mês da data inicial do período letivo for menor que 6 enviar 1, caso contrário 2. |
periodo_prog | Período que está sendo cursado, por exemplo 1º período, 2ºperíodo, 1 ano, etc. | Int 5 | Não | SDISCGRADE.PERIODO |
cod_disciplina | Código identificador da disciplina. | String 30 | Não | STURMADISC.CODDISC |
num_alunos_disc | Número de alunos na disciplina da turma do curso | Int 5 | Sim | Verificar controle de vaga definido na matriz curricular vinculada a matriz aplicada:
|
chave | Chave de validação do WS | String 255 | Não | Buscar da parametrização da integração entre Pergamum e o TOTVS Educacional |
WS_PESSOA_DEP | ||||
---|---|---|---|---|
Parâmetro | Descrição | Tipo | Nulo | Valor |
cod_pessoa_dep | Código da pessoa no depto (Ex.: aluno por curso, funcionário por setor, etc) | String 20 | Não | SPESSOAPERGAMUM. CODUSUARIOPERGAMUM |
cod_departamento_dep | Código do departamento (curso, setor, etc) | String 20 | Não | "M|" + SHABILITACAOFILIAL.IDHABILITACAOFILIAL |
cod_afast_dep | Situação da pessoa no departamento | Int 1 | Não | Define a situação do usuário de acordo com a situação de matricula do aluno. |
ano_vigencia_dep | Ano atual ou o último ano que a pessoa esteve vinculada ao departamento | Int 4 | Sim | SPLETIVO.DTINICIO (Formato: aaaa) |
periodo_dep | Período que está cursando | Int 5 | Sim | SMATRICPL.CODPERIODO |
serie_dep | Série que está cursando | String 04 | Sim | FIXO = "" |
turma_dep | Turma atual da pessoa | String 20 | Sim | SMATRICPL.CODTURMA |
Chave | Chave de validação do WS | String 255 | Não | Buscar da parametrização da integração entre Pergamum e o TOTVS Educacional |