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 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.

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	Cadastro do Aluno; Matrícula no período letivo
Professor	Cadastro do Professor
Funcionário	Cadastro de Funcionário
Pessoa	Cadastro de Pessoa
Disciplinas	Cadastro de Disciplinas
Curso	Cadastro de Curso; Unidades Bibliotecárias.
Parametrização por Curso	Cadastro da Parametrização por Curso
Turma	Cadastro de Turma; Cadastro de Turma/Disciplina.

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.

Informações

icon	false

Deck of Cards

id	ParametrosIntegracaoEduxPergamum

Card

id	PrimeiroPasso
label	Primeiro Passo

Informações

icon	false

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 Pergamum

Parâ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.

Aviso

title	Importante

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

Card

id	SegundoPasso
label	Segundo Passo

Informações

icon	false

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.

Aviso

title	Importante

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.

Card

id	TerceiroPasso
label	Terceiro Passo

Informações

icon	false

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.

Aviso

title	Importante

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;

Aviso

title	Importante

Se houver problemas na comunicação com o Pergamum durante a criação do usuário 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.

Aviso

title	Importante

Para o funcionamento do parâmetro acima é necessário que a integração LDAP esteja habilitada e configurada nos parâmetros globais. O domínio somente será enviado caso o mesmo esteja preenchido no cadastro do Usuário e vinculado à entidade, caso o mesmo não esteja preenchido o domínio não será enviado.

Além disso, caso o usuário de rede não estiver preenchido, será enviado o usuário RM da entidade.

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.

Enviar o nome social, quando preenchido, na exportação de usuários - a finalidade deste parâmetro é a de possibilitar o envio do Nome Social, quando o mesmo estiver preenchido no cadastro da Pessoa (Aluno/Professor/Funcionário/Pessoa).

Utilizar estado civil padrão para exportar usuários com estado civil vazio - a finalidade deste parâmetro habilitar a definição de qual será o estado civil padrão das entidades ao exportar/atualizar para o Pergamum caso o mesmo esteja vazio em seu respectivo cadastro.

Card

label	Quarto Passo

Informações

icon	false

Parâmetros:

Atualizar código da categoria do aluno (modo que será atualizado a categoria do aluno no pergamum):
- Nunca
  - Não será realizado nenhum tipo de atualização.
- Após a matrícula no período letivo
  - A atualização somente ocorrerá ao matricular o aluno no período letivo em uma situação de matrícula com o item "Desativa usuário no Pergamum" desmarcado.
- Após o encerramento do período letivo
  - Será disparada automaticamente a atualização das categorias dos usuários do Pergamum relacionados aos alunos. O sistema irá busca todos os alunos matriculados no período letivo, cujo período encerrado esteja parametrizado com o "Período letivo anterior".
  - Exemplo: ao encerrar o período letivo 2018/2 o sistema irá pesquisar o período letivo (ex. 2019/1) que tenha como período letivo anterior 2018/2. Ao localizar, todos os alunos do período letivo encontrado (ex. 2019/1) terão sua categoria alterada no Pergamum.

Aviso

title	Importante

A categoria utilizada para alterar os alunos no Pergamum é parametrizada no Passo Anterior ou no anexo da Habilitação/Série do curso onde o aluno está matriculado, sendo primeiro é buscada a categoria na Habilitação, caso não tenha sido parametrizada será buscada a categoria nos parâmetros da integração, se ainda não existir, não será feita a atualização.

Para um aluno que possua duas matrículas e dois usuários vinculados ao Pergamum, o envio somente será possível se a categoria da Habilitação/Série dos cursos forem iguais, caso não sejam, não será possível atualizar a categoria no pergamum.

Card

label	Quinto Passo

Informações

icon	false

No passo atual temos a possibilidade de informarmos qual a chave de integração de Usuários e Alunos e o que fazer no momento de criação de usuário quando o aluno possuir mais de um RA.

Card

label	Sexto Passo

Informações

icon	false

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.

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.	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”.
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.	É 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 “ ”.
4	A 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.
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.	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.

Aviso

title	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:

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.

Informações

title	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.

Aviso

title	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.

Informações

title	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).

Aviso

title	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.

Aviso

title	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.

É possivel 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

Atualiza o cadastro do TOTVS Educacional com o código do usuário disponível no Pergamum.
Desta forma clientes que já dispõe do Pergamum implantado sem integração com o TOTVS Educacional poderão sincronizar de forma fácil os usuários existentes no Pergamum e no TOTVS Educacional;
Atualiza os dados do usuário do Pergamum a partir do cadastro do TOTVS Educacional;
Insere o vínculo entre os usuários do Pergamum e TOTVS Educacional;
Se o parâmetro do TOTVS Educacional Atualizar categoria estiver marcado a categoria do usuário também será atualizada.

O sistema cria o usuário no Pergamum e insere o vínculo entre os usuários do Pergamum e TOTVS Educacional.

Informações

title	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

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.

Informações

icon	false
title	Passos da execução

Deck of Cards

id	ExportarUsuarios

Card

id	EU_PrimeiroPasso
label	Primeiro Passo

Informações

icon	false

Definição das entidades para quais serão gerados os usuários no Pergamum (Aluno, Professor, Funcionário ou Pessoa).

Card

id	EU_SegundoPasso
label	Segundo Passo

Informações

icon	false

Seleção dos registros com base na entidade selecionada no primeiro passo. Apenas serão listados registros que não possuam usuário já gerado no Pergamum.

Seleção dos registros:
- Alunos: são listados apenas alunos matriculados no período letivo selecionado pelo lookup e cuja situação de matricula identifique que o usuário deve estar ativo no Pergamum;
- Professores: são listados apenas os professores com permissão na filial em que o usuário está autenticado;
- Funcionários: são listados apenas os funcionários com permissão na filial em que o usuário está autenticado;
- Pessoas: são listadas as pessoas que não estejam vinculadas a alunos, professores e funcionários.

Definição de Unidades Bibliotecárias

Professor, Funcionário ou Pessoa

Aluno

Serão listadas as unidades bibliotecárias e o usuário do sistema deverá selecionar as com acesso permitido na execução do processo.

Em caso de professores, funcionários ou pessoa que também são alunos, será possível gerar o usuário do Pergamum com o RA do aluno.

A definição da unidade bibliotecária será feita a partir da seleção das matrículas dos alunos no período letivo.

O sistema verifica em quais unidades bibliotecárias o aluno terá permissão de acesso, validando inclusive as restrições de acesso por curso e habilitação/serie.

Definição da categoria do usuário

Alunos: a categoria a ser enviada é a vinculada ao cadastro da habilitação/serie que o aluno estiver cursando, caso não esteja preenchida, busca a informação dos parâmetros do TOTVS Educacional na integração com o Pergamum;
Professores e Funcionários: quando o usuário estiver sendo criado a categoria do Pergamum a ser associada a ele será a definida nos parâmetros do TOTVS Educacional na integração com o Pergamum;
Pessoas: o usuário deverá informar a categoria a ser associada as pessoas selecionadas.

Card

id	EU_TerceiroPasso
label	Terceiro Passo

Informações

icon	false

Após a seleção das entidades (Alunos, Professores, Pessoas e/ou Funcionários) a serem exportados se executa o processo.

Card

id	EU_QuartoPasso
label	Quarto Passo

Informações

icon	false

Ao final da execução é exibido o log do processo informando os registros vinculados e os não vinculados;

Após a execução do processo os usuários são criados no Pergamum e o vínculo dos usuários é inserido no TOTVS Educacional.

Dica

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

title	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.

Aviso

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.

Informações

title	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.
Endereço:
- Rua (Logradouro);
- Número;
- Bairro;
- Complemento;
- CEP;
- Cidade;
- Estado.
Documentos:
- CPF;
- Carteira de Identidade.

Informações

icon	false
title	Passos da execução

Deck of Cards

id	AtualizarUsuarios

Card

id	AU_PrimeiroPasso
label	Primeiro Passo

Informações

icon	false

Definição das entidades a partir das quais os dados cadastrais dos usuários no Pergamum serão atualizados (Aluno, Professor, Funcionário ou Pessoa).

Card

id	AU_SegundoPasso
label	Segundo Passo

Informações

icon	false

Seleção dos registros com base na entidade selecionada no primeiro passo.

Alunos: são listados apenas alunos que possuam usuário gerado no Pergamum;
Professores: são listados apenas os professores que possuam usuário gerado no Pergamum;
Funcionários: são listados apenas os funcionários que possuam usuário gerado no Pergamum;
Pessoas: são listadas as pessoas que não estejam vinculadas a alunos, professores e funcionários e que possuam usuário gerado no Pergamum.

Card

id	EU_TerceiroPasso
label	Terceiro Passo

Informações

icon	false

Após a seleção das entidades (Alunos, Professores, Pessoas e/ou Funcionários) a serem atualizadas se executa o processo.

Card

id	EU_QuartoPasso
label	Quarto Passo

Informações

icon	false

Ao final da execução é exibido o log do processo informando os registros atualizados e os que não puderam ser atualizados.

Após a execução do processo os usuários terão suas informações atualizadas no Pergamum.

Dica

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.

Aviso

title	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.

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

Aviso

title	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.

.

Aviso

title	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.

Informações

title	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.

Informações

icon	false

Deck of Cards

id	atzcatalunoperletenc

Card

label	Atualização da categoria dos alunos pelo cadastro do Período Letivo

Informações

icon	false

Ao clicarmos em "Período letivo encerrado" e posteriormente clicar no botão salvar para gravar o cadastro, o sistema irá ter uma das ações abaixo:

Exibirá uma mensagem de confirmação, caso a integração com Pergamum estiver ativa e o período letivo em questão for encontrado em outro período letivo como "Período letivo anterior".

Sim: será disparado um Job em segundo plano para executar a atualização da categoria dos alunos;
Não: o formulário não será salvo.

Exibirá uma mensagem de confirmação, caso a integração com Pergamum estiver ativa e o período letivo em questão não for encontrado em outro período letivo como "Período letivo anterior".

Sim: o período letivo será encerrado e nenhum aluno terá a sua categoria alterada no Pergamum;
Não: o formulário não será salvo.

Aviso

title	Importante

Se a integração com o Pergamum estiver desativada, o comportamento do sistema permanece inalterado.

Caso o job seja executado o mesmo poderá ser consultado pelo Gerenciamento de Jobs do RM.

Aviso

title	Importante

Caso seja necessário executar o processo de atualização de categoria dos alunos novamente, será possível por meio de um botão, chamado Atualizar a categoria dos alunos no Pergamum, no cadastro do período letivo.

O botão somente ficará disponível nos seguintes casos:

O período letivo já estiver encerrado;
A integração com o Pergamum estiver ativada;
O período letivo estiver parametrizado como "Período letivo anterior" em outro período letivo;
O usuário com permissão especial (no perfil | anexos | Parâmetros Educacionais | Aba Biblioteca | Item Permitir executar a atualização da categoria no Pergamum dos alunos no período letivo encerrado) para executar a atualização.

Caso o usuário clique no botão "Atualizar a categoria dos alunos no Pergamum", será disparado um Job também em segundo plano, para executar a atualização da categoria dos alunos no Pergamum novamente.

Card

label	Atualização da categoria dos alunos pela Apuração de Resultados

Informações

icon	false

No processo de apuração de resultados ao clicar para encerrar o período letivo é exibido uma opção, já marcada, para Atualizar a categoria dos alunos no Pergamum, tal item somente irá aparecer se a integração com Pergamum estiver ativa e o período letivo em questão for encontrado em outro período letivo como "Período letivo anterior". Ao executar o processo de apuração para encerrar o período letivo e atualizar a categoria dos alunos será exibido um log no final do mesmo com as informações pertinentes ao encerramento e a atualização.

Caso o usuário desmarque para não atualizar a categoria dos alunos no pergamum, uma mensagem de notificação será exibida para ele conforme abaixo.

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.

Aviso

title	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.

Aviso

title	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.

Informações

icon	false
title	Passo Único

Atualizar status - definir se o processo será executado para funcionário e/ou aluno.

Utilizar data do último processamento realizado com sucesso para:
Alunos	Funcionários
Marcado - a data inicial será a data da última atualização executada com sucesso.
Desmarcado - o usuário poderá definir a data desde que esta seja igual ou inferior a data da última atualização executada com sucesso.

Este processo pode ser agendado e verificará todas as alterações realizadas desde a última atualização. Com base nos registros alterados o sistema dispara mensagens para o Pergamum, solicitando a ativação ou desativação do usuário.
Quando o processo é executado com sucesso a data de última atualização (disponível nos parâmetros do TOTVS Educacional para a integração com o Pergamum) será alterada para a data da execução do processo.

Aluno

Funcionário

A ativação ou desativação depende da parametrização da situação de matricula do aluno no período letivo. É verificado o parâmetro da situação de matrícula Cancela usuário no Pergamum que fica localizado na aba Status no Período Letivo.
No momento do cancelamento deve ser verificado se o aluno está ativo em outro curso no período letivo corrente, definido nos parâmetros do TOTVS Educacional, ou se desempenha um outro papel (exemplo: o aluno também é funcionário da instituição), nestes casos não é disparada a mensagem solicitando o cancelamento.

Usuários demitidos no TOTVS são desativados por este processo.

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.

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.

Informações

icon	false
title	Passos da execução

Deck of Cards

id	ProgramaEnsino

Card

id	PE_PrimeiroPasso
label	Primeiro Passo

Informações

icon	false

O usuário define o período letivo base da exportação e quais as entidades devem ser exportadas. As entidades disponíveis são:

Disciplinas;
Cursos;
Cursos X Unidades Bibliotecárias;
Parametrização por Curso;
Turmas X Curso;
Disciplinas X Curso;
Alunos X Curso.

O período letivo definido pelo usuário nesta etapa irá filtrar os dados das consultas as entidades Parametrização por Curso, Turmas X Curso, Disciplinas X Curso e Alunos X Curso.

Os próximos passos do processo dependem de quais entidades o usuário marcou para exportação.

Card

id	PE_SegundoPasso
label	Segundo Passo - Seleção de Disciplinas

Informações

icon	false

A aba de seleção de Disciplinas que serão enviadas para o Pergamum será disponibilizada somente se o usuário tiver selecionado no primeiro passo do processo a opção Disciplinas.

A tabela de disciplinas, no Pergamum, é utilizada para armazenar todas as disciplinas existentes na instituição, independente de curso, série/período ou turma.

Ao final do processo é exibido um log contendo a relação das disciplinas criadas no Pergamum bem como a listagem das que por algum motivo não puderam ser criadas.

Aviso

title	Importante

Eventos de alterações ou exclusões de disciplinas no TOTVS Educacional não disparam nenhum tipo de integração com o Pergamum. Para estas situações deve-se entrar no Pergamum e realizar a alteração ou exclusão.

Card

id	PE_TerceiroPasso
label	Terceiro Passo - Seleção de Cursos

Informações

icon	false

A aba de seleção de Matrizes Aplicadas que serão enviadas para o Pergamum será disponibilizada somente se o usuário tiver selecionado no primeiro passo do processo a opção Cursos. Tais matrizes aplicadas são agrupadas pelo curso e habilitação (série) para que durante o envio já sejam criados os departamentos pai com seus respectivos filhos no Pergamum.

Os Cursos, Habilitações e Matrizes Aplicadas do TOTVS Educacional serão entendidos como sendo os Departamentos ou Unidades Organizacionais do Pergamum. As informações do TOTVS Educacional serão exportadas formando hierarquias através do preenchimento do campo código de departamento pai. Ou seja, cada curso do TOTVS Educacional será um departamento pai no Pergamum, seguido das habilitações e como último nodo da hierarquia as suas matrizes aplicadas. Sendo assim após o envio das informações teremos no Pergamum a seguinte estrutura de cursos:

Primeiro Nível: Curso;
- Segundo Nível: Habilitação (Série);
  - Terceiro Nível: Matrizes Aplicadas.

Ao final do processo é exibido um log contendo a relação dos cursos criados no Pergamum bem como a listagem dos que por algum motivo não puderam ser criados.

Aviso

title	Importante

Eventos de alterações ou exclusões de cursos no TOTVS Educacional não disparam nenhum tipo de integração com o Pergamum. Para estas situações deve-se entrar no Pergamum e realizar a alteração ou exclusão.

Card

id	PE_QuartoPasso
label	Quarto Passo - Seleção de Cursos X Unidades Bibliotecárias

Informações

icon	false

Na primeira etapa do processo se o usuário tiver marcado a opção Curso X Unidades Bibliotecárias o sistema disponibiliza a mesma seleção utilizada para a entidade Cursos, onde o usuário seleciona as matrizes aplicadas. A partir desta seleção o sistema envia as unidades bibliotecárias de acesso liberado para o Pergamum para cada matriz aplicada selecionada.

A definição das restrições de uso das unidades bibliotecárias está disponível como um anexo do cadastro de unidades bibliotecárias. Desta forma é possível a partir da matriz aplicada definir o conjunto de unidades bibliotecárias com acesso liberado.

Ao final do processo é exibido um log contendo a relação dos Cursos X Unidades Bibliotecárias que foram criados no Pergamum bem como a listagem dos que por algum motivo não puderam ser criados.

Card

id	PE_QuintoPasso
label	Quinto Passo - Seleção das Parametrizações por Curso

Informações

icon	false

A aba de seleção de Parametrização por curso que serão enviadas para o Pergamum será disponibilizada somente se o usuário tiver selecionado no primeiro passo do processo a opção Parametrização por curso.

As Parametrizações por Curso do TOTVS Educacional será vinculado ao que o Pergamum define como Plano de Ensino. O plano de ensino, tabela PERG_PROGRAMA, no Pergamum, tem a finalidade de criação dos currículos (esta terminologia de currículo pode variar de acordo com cada instituição, o importante é o significado do mesmo). Um currículo é a união entre um Departamento (Curso), Ano e Semestre. Portanto, é finalidade do plano de ensino determinar o vínculo dos departamentos com os currículos, os quais são originados no início de cada período. A cada início de novos períodos na instituição dentro do departamento, serão gerados cadastros nesta tabela variando o campo período.

Cada registro do cadastro de parametrização por curso o sistema poderá gerar de 1 a N planos de ensino de acordo com a configuração do campo Como definir os períodos. Este campo permitirá as seguintes definições:

Períodos da Matriz Curricular: para cada período vinculado ao curso será gerado um registro de plano de ensino;
Períodos relacionadas a oferta cadastrada: apenas períodos que possuem pelo menos uma disciplina ofertada dentro do período letivo vinculado a parametrização por curso.

Ao final do processo é exibido um log contendo a relação das parametrizações por curso que foram criadas no Pergamum bem como a listagem das que por algum motivo não puderam ser criadas.

Card

id	PE_SextoPasso
label	Sexto Passo - Seleção das Turmas x Curso

Informações

icon	false

A aba de seleção de Turmas que serão enviadas para o Pergamum será disponibilizada somente se o usuário tiver selecionado no primeiro passo do processo a opção Turmas x Curso.

A tabela DEPARTAMENTO_TURMA, no Pergamum, é utilizada para armazenar todas as turmas, de determinados "currículos" de determinados períodos.

Ao final do processo é exibido um log contendo a relação das Turmas X Curso que foram criadas no Pergamum bem como a listagem das que por algum motivo não puderam ser criadas.

Card

id	PE_SetimoPasso
label	Sétimo Passo - Seleção das Disciplinas x Curso

Informações

icon	false

A aba de seleção de Turmas/Disciplinas que serão enviadas para o Pergamum será disponibilizada somente se o usuário tiver selecionado no primeiro passo do processo a opção Disciplinas X Curso.

A tabela PERG_PROGRAMA_DISC_TEMP, no Pergamum, é utilizada para vincular a disciplina ao departamento e sua respectiva turma.

Ao final do processo é exibido um log contendo a relação das Disciplinas X Curso que foram criadas no Pergamum bem como a listagem das que por algum motivo não puderam ser criadas.

Card

id	PE_OitavoPasso
label	Oitavo Passo - Seleção das Alunos x Curso

Informações

icon	false

A aba de seleção de matrículas no período letivo dos alunos que serão enviadas para o Pergamum será disponibilizada somente se o usuário tiver selecionado no primeiro passo do processo a opção Alunos X Curso.

A tabela PESSOA_DEPARTAMENTO, no Pergamum, é utilizada para criar o vínculo entre as pessoas e seus respectivos departamentos. Uma pessoa pode estar vinculada a um ou mais departamentos. A maior finalidade dessa é a possibilidade de geração de estatísticas relativas a circulação de materiais e utilização da biblioteca por departamento (curso).

De acordo com a situação de matrícula do aluno este terá o status definido como normal ou afastado.

Ao final do processo é exibido um log contendo a relação dos alunos que foram criados no Pergamum bem como a listagem dos que por algum motivo não puderam ser criados.

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.

Informações

icon	false
title	Processo

Definir o tipo da importação:

Importar novas multas diretamente do Pergamum - as multas são importadas do Pergamum para uma tabela temporária do TOTVS Educacional;
Carregar multas já importadas que estejam sem lançamento gerado para processamento - o sistema busca as multas que ainda não geraram lançamento financeiro na tabela temporária do TOTVS Educacional e não busca novas informações do Pergamum;
Carregar multas já importadas com erro na geração de lançamentos para reprocessamento - o sistema busca as multas na tabela temporária do TOTVS Educacional que geraram erro durante o processo de geração de lançamento financeiro e não busca novas informações do Pergamum.
Não realizar carregamento de multas - neste cenário não é realizada a carga de multas para geração de lançamento financeiro.

Gerar lançamentos das multas - com esta opção marcada o sistema irá gerar os lançamentos financeiros para a multas da biblioteca. Esta opção não faz sentido quando na definição do tipo da importação a opção marcada é Não realizar carregamento de multas;

Enviar para o Pergamum informações de baixas de lançamentos - com esta opção marcada o TOTVS envia para o Pergamum o pagamento das multas cujos lançamentos financeiros se encontram baixados.

Este processo poderá ser agendado para ser executado automaticamente em horários mais adequados para a instituição de ensino ou poderá ser executado a qualquer momento pelo usuário do sistema.

Aviso

title	Importante

O envio do pagamento da multa para o Pergamum é realizado executando uma stored procedure e por isso é importante que a base de dados esteja parametrizada corretamente.

Para que o sistema gere corretamente um lançamento financeiro para o ALUNO, o seu Responsável financeiro deverá estar configurado na Aba Responsáveis dentro do cadastro do Aluno.

Para geração de lançamentos para o tipo de usuário PROFESSOR é necessário fazermos o Vínculo entre Cli/For e Pessoa no Totvs Gestão de Pessoas.

Localize o cadastro da pessoa em seguida acesse Anexo Vínculo entre Cli/For e Pessoa posteriormente execute o Processo de Vincular/Desvincular Cli/For (defina entre as opções qual o cliente fornecedor que será usado). Para desativar um cliente fornecedor execute o Processo de Vincular/Desvincular Cli/For selecione a opção de Desvincular Cli/For e execute o processo.

Informações

title	Observações

A importação de multas é feita pela chamada do webservice (Pergamum) ws_exporta_multa, o vínculo da pessoa com a multa com o TOTVS Educacional é feito pela coluna cod_pessoa_sistema, o campo cod_pessoa retornado pelo webservice é um código interno do Pergamum e neste serviço não é utilizado.

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.	S - Senha Já criptografada; N - Senha sem criptografia.
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.	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 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: 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_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: Turma/Disciplina: STURMADISC.MAXALUNOS; Turma: STURMA.MAXALUNOS.
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 Buscar a informação vinculada ao mesmo contexto do departamento (matriz aplicada) informado.
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

Páginas filhas

Versões comparadas

Versão antiga 87

Nova versão 88

Chave

INTEGRAÇÃO TOTVS Educacional X Pergamum

Totvs Educacional

Pergamum

Sistemas Envolvidos

Integração

Escopo

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

Versão RM

Controle de Versão

Suporte

Cadastros

Processos

Checklist de suporte da aplicação

Anexos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 87

Nova versão 88

Chave

INTEGRAÇÃO TOTVS Educacional X Pergamum

Totvs Educacional

Pergamum

Sistemas Envolvidos

Integração

Escopo

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

Versão RM

Controle de Versão

Suporte

Cadastros

Processos

Checklist de suporte da aplicação

Anexos