Projeto: FS008375– Integração com TOTVS Assinatura Eletrônica (TAE)
FS009061- Integração TAE - Melhorias na integração de relatórios
Nome do Cliente: Confederação Nacional da Indústria - SENAI
__________________________________________________________________________________________________________________________________________________________________
Objetivo
Este documento foi elaborado para informar aos usuários chave da área Educacional do SENAI, as funcionalidades customizadas na Integração com TOTVS Assinatura Eletrônica (TAE).
Todas as funcionalidades descritas neste manual têm como base do que está descrito nos documentos:
Detalhamento Funcional - FS008375 e FS009061
As Melhorias/Alterações na Integração, estão destacadas neste documento com o ícone: Novo!
Pré-requisitos
Customização instalada e todos os scripts gerados com sucesso;
Devem ser liberadas nas permissões de perfil dos usuários, os menus do TOTVS Assinatura Eletrônica. Para mais detalhes de como liberar no perfil dos usuários acesse o Manual de Instalação de Customizações na seção Liberando Acesso aos Menus.
Para liberar o acesso aos menus do TAE acesse o módulo Serviços Globais | Perfil em perfil selecione o sistema Educacional acesse o perfil que deseja realizar a liberação, na aba Acesso a Menus expanda os seguintes itens: Sistema Industria | Mais | TAE:
Para fazer uso da Customização TAE, é necessário iniciar o processo com algumas parametrizações essenciais.
Os Parâmetros TAE podes ser acessados através do seguinte caminho:
TOTVS Educacional | Sistema Industria | TAE | Parâmetros TAE.
A interface exibirá alguns campos para serem configurados, sendo eles:
Identificação:
Consultar e criar usuário na API TAE User, caso não exista: Se esta opção não estiver marcada, ocorrerá um erro durante a integração dos documentos caso o usuário não exista no portal;
Utilizar um único usuário para a geração do Token: Define um usuário padrão responsável pela geração do token de acesso. Caso não seja especificado, será solicitado no momento da integração dos documentos;
Usuário Token: Insira o usuário para autenticação na API Token;
Senha Token: Forneça a senha do usuário para autenticação na API Token;
Atenção
A permissão de acesso ao menu será feita através de configuração de controle de perfil de usuário (nativa).
Dentro da interface personalizada de Parâmetros Educacionais, será possível efetuar a integração dos relatórios de acordo com a modalidade do curso.
Para essa finalidade, foi desenvolvida uma configuração que engloba Modalidade, Relatórios e Assinaturas, permitindo que o usuário estabeleça os valores essenciais para a realização da integração.
Você pode acessar os Parâmetros Educacionais por meio do seguinte caminho:
TOTVS Educacional | Sistema Industria | TAE | Parâmetros Educacionais
A interface exibirá seis abas para serem configurados: Modalidade, Parâmetros da Filial, Relatórios, Situação de Matrícula, Resp. Assinatura e E-mail.
Será necessário informar todas as modalidades que farão parte da integração TAE.
Além de informar a modalidade, o usuário deverá informar qual o tipo de relatório de certificado que será utilizado em cada modalidade.
Esses parâmetros serão gravados por FILIAL Novo!.
- Modalidade: Campo utilizado para informação da modalidade a ser utilizada. Apenas as modalidades informadas terão seus relatórios enviados para assinatura no TAE. Preenchimento obrigatório.
Certificados:
- Relatório de Certificado: Campo utilizado para informação do relatório de certificado da modalidade. Essa informação será buscada da tabela de relatórios do RM (RptReports).
- Tipo de Certificado Padrão: Parâmetro do tipo lookup que irá retornar a lista da tabela STIPOCERTIFICADO. Neste parâmetro, o usuário deverá informar qual o tipo de certificado será considerado como padrão para o processo de geração e assinaturas. O Tipo de Certificado deverá ser parametrizado por modalidade.
- Novo! Solicita assinatura do secretário: Esse campo determina se o relatório de certificado deve ou não ser enviado para assinatura do(s) secretário(s). Por padrão, o campo virá desmarcado.
- Relatório de Saída Intermediária: Parâmetro do tipo lookup que irá retornar a lista de relatórios existentes no RM Reports. Neste parâmetro, o usuário deverá informar qual o relatório será considerado para geração caso o tipo do mesmo seja o definido no parâmetro acima ‘Tipo de Certificado Saídas Intermediárias’. O Certificado deverá ser parametrizado por modalidade.
- Tipo de Certificado Saídas Intermediárias: Parâmetro do tipo lookup que irá retornar a lista da tabela STIPOCERTIFICADO. Neste parâmetro, o usuário deverá informar qual o tipo de certificado será considerado como Saída Intermediária para o processo de geração e assinaturas. O Tipo de Certificado deverá ser parametrizado por modalidade.
Contrato de matrícula:
- Relatório de Contrato: Campo utilizado para informação do relatório de contrato da modalidade. Essa informação será retornada da tabela de relatórios do RM (RptReports).
- Responsável pela assinatura do Contrato de Matrícula: Campo para seleção do Responsável pelo Contrato de Matrícula na Unidade Operacional (Filial), de onde serão buscados o e-mail, nome e CPF. Campo de preenchimento obrigatório e indica que o usuário correspondente será utilizado como aprovador/validador do Contrato de Matrícula.
- Novo! Utiliza envio automático: Esse campo determina se o relatório de contrato deve ou não utilizar a integração automática. Por padrão, o campo virá marcado.
Observações
A tela de Parâmetros de Modalidade necessita que pelo menos um relatório seja parametrizado, ou seja, deve ser informado o Relatório de Certificado, o Relatório de Contrato ou ambos.
Aviso
O relatório de certificado, que não possuir filtro ou parâmetro SCERTIFICADO, não será enviado.
O relatório de contrato, que não possuir filtro ou parâmetro SCONTRATO, não será enviado.
Será necessário informar o Responsável pela Unidade Operacional. Essa parametrização é por filial.
- Responsável pela Unidade Operacional: Campo para seleção do Responsável pela Unidade Operacional (cadastro de Pessoa), de onde serão buscados o e-mail, nome e CPF. Indica que o usuário correspondente será enviado como aprovador/validador do Certificado, que no TAE tem o poder de veto do documento. Ele não precisará assinar o documento;
- Integra Contrato de Rematrícula: Campo para informar se os contratos de rematrícula serão integrados ao TAE;
- Protocolo de Assinatura Simplificado: Permite usar assinatura simplificada, além do protocolo completo nativo de assinaturas. Isso permite que as informações sejam inseridas na última página do certificado e não em uma pagina a parte;
Atualizado recentemente
A aba Parâmetro da Filial, recebeu um novo parâmetro, que quando marcado, gera um protocolo de assinatura simplificado ao certificado.
Maiores informações descritas no Manual Protocolo de assinatura Certificado.
Nesta aba será necessário informar quais relatórios de Diário de Classe que serão utilizados. Os relatórios serão parametrizados por coligada.
- Relatório de Diário de Classe - Frequência: Campo utilizado para informação do relatório de diário de classe de frequência. Essa informação será buscada da tabela de relatórios do RM (RptReports).
- Relatório de Diário de Classe - Nota: Campo utilizado para informação do relatório de diário de classe de notas. Essa informação será buscada da tabela de relatórios do RM (RptReports).
Nesta aba será necessário informar quais Status de Matrícula a customização deverá considerar para realizar a integração do Relatório do Contrato de Matrícula com o TAE.
Importante!
- Não serão criados parâmetros customizados para informar os assinadores. Esses dados serão obtidos no Cadastro da Filial | Anexos | Dados Educacionais | Anexos | Instituição do MEC | Anexos | Diretores por Instituição. A customização identificará os assinadores pelas campos Diretor, Secretário 1 e Secretário 2.
- A permissão de acesso ao menu será feita através de configuração de controle de perfil de usuário (nativa).
- Para o envio do e-mail para os responsáveis, todos os dados deverão ser parametrizados corretamente.
Na Aba Responsável Assinatura, será informado o responsável pela assinatura, por Estado. Essa parametrização será utilizada no certificado que esteja vinculado ao Template digital.
A interface fará o vínculo do responsável pela assinatura daquele Estado, como o Estado informado no cadastro do Aluno.
- Estado: Neste parâmetro, o usuário deverá informar qual o estado da pessoa responsável por assinar os certificados de cursos concluídos no Template Digital. Esse parâmetro utiliza a lista de Estados;
- Nome: Neste parâmetro, o usuário deverá informar qual pessoa será responsável por assinar os certificados de cursos concluídos no Template Digital de alunos que residem no seu estado responsável. Esse parâmetro utiliza a tabela PPESSOA;
Importante
- Somente será possível informar uma pessoa responsável por estado.
- Este parâmetro será armazenado por Coligada e somente para o Template Digital.
Nessa Aba, o usuário informará os dados do E-mail que será enviado ao aluno, junto ao Certificado. 
- E-mail de Remetente: Neste parâmetro, o usuário deverá informar qual o endereço de e-mail que será utilizado como remetente no envio do certificado assinado para o aluno;
- Assunto do e-mail: Neste parâmetro, o usuário deverá informar qual o assunto do e-mail que será utilizado no envio do certificado assinado para o aluno;
- Tipo de E-mail: Parâmetro do tipo checkbox. Neste parâmetro, o usuário deverá informar qual o formato de e-mail que será utilizado no envio do certificado assinado para o aluno, sendo 'HTML' ou 'TXT';
- Tags Disponíveis: Será possível que o usuário defina o texto padrão de envio do e-mail utilizando algumas tags.
- Ao selecionar o campo, serão apresentadas as seguintes tags;
[RA]: Registro Acadêmico do aluno;
[NOMEALUNO]: Nome do aluno;
[NOMECURSO]: Nome do curso de matrícula do aluno;
[NOMEHABILITACAO]: Nome da habilitação de matrícula do aluno;
[CODPERLET]: Código do período letivo de matrícula do aluno;
- Ao selecionar o campo, serão apresentadas as seguintes tags;
- Texto do E-mail: Parâmetro do tipo texto. Neste parâmetro, o usuário deverá informar qual o texto do e-mail que será utilizado no envio do certificado assinado para o aluno. O texto será definido pelo usuário, desde que utilize as tags listadas acima.
Atualizado recentemente
A aba Parâmetro da Filial, recebeu um novo parâmetro, que quando marcado, gera um protocolo de assinatura simplificado ao certificado. Maiores informações descritas no Manual Protocolo de assinatura Certificado.
Importante
- Estes parâmetros são armazenados por Filial;
- Demais informações necessárias nestes Parâmetros, seguirão as regras, já existentes no Projeto Integração TOTVS Educacional x TOTVS Assinatura Eletrônica.
O processo Enviar Diário de Classe para Assinatura está disponível em dois Menus:
1º MENU:
TOTVS Educacional | Currículo e Oferta | Turmas/disciplinas | Anexos | Etapas | Processos | Enviar Diário de Classe para assinatura.
Novo! 2º MENU:
TOTVS Educacional | Currículo e Oferta | Oferta| Mais | Visualização de etapas | Processos Processos | Enviar Diário de Classe para assinatura.
Neste menu é possível selecionar mais de uma etapa:
Ao ser acionado a customização identificará as etapas selecionadas para geração do relatório. Para cada etapa selecionada a customização realizará a geração de um relatório, ou seja, a execução de um único processo poderá diversos relatórios. A customização realizará também uma consulta nas Parametrizações da Interface customizada "Parâmetros Educacionais | Modalidade", para identificar se a modalidade do curso do diário selecionado está parametrizada se os relatórios de Diário de Classe (Nota e Frequência) foram informados. Caso não exista essa parametrização a execução do processo não será realizada.
- Etapa de Notas: Caso a etapa selecionada seja de Notas, será gerado o relatório informado no parâmetro "Diário de Classe - Notas" definido nos Parâmetros Educacionais.
- Etapa de Faltas: Caso a etapa selecionada seja de Faltas, será gerado o relatório informado no parâmetro "Diário de Classe - Frequência" definido nos Parâmetros Educacionais.
Atenção
- O usuário poderá selecionar qualquer etapa, independentemente de estar marcada como Etapa final (resultado).
- Para que o Processo seja executado o Campo nativo "Disponível para os Alunos" no cadastro da etapa deverá está marcado. Caso não esteja, o processo não poderá ser executado.
- Para que o processo funcione corretamente é necessário que o relatório possua os parâmetros CODCOLIGADA, IDTURMADISC, CODETAPA e TIPOETAPA.
- Caso o relatório possua filtros a customização irá sobrescrever o filtro com os dados de CODCOLIGADA e IDTURMADISC da Etapa selecionada.
Os documentos integrados ficarão disponíveis no Portal TAE para assinatura e validação, quando necessário, pelos seguintes usuários:
- Professor responsável pela disciplina: A customização identificará o Professor responsável pela disciplina através do cadastro do Professor, definido em TOTVS Educacional | Currículo e Oferta | Turmas/Disciplinas | Anexos | Professores.
- Secretários: A customização identificará os Secretários através do cadastro do Diretor da Filial, definido no Cadastro da Filial | Anexos | Dados Educacionais | Anexos Instituição do MEC | Anexos | Diretores por instituição | Campos Secretário 1 e Secretário 2.
- Coordenador da matriz aplicada: A customização identificará o Coordenador da Matriz Curricular através do cadastro da comissão coordenadora, definido em: TOTVS Educacional | Currículo e Oferta | Matriz Curricular | Anexos | Matriz Aplicada | Anexos | Comissão Coordenadora.
Ao ser integrado, o TAE enviará um e-mail automático para o Professor Responsável pela disciplina, Secretários Coordenador l, avisando da necessidade de assinatura do Diário no portal.
Importante!
O nome do arquivo deve ser “DiarioDeClasse” + IdTurmaDisc + “Etapa” + Número da etapa .PDF
O processo Enviar Certificado para assinatura está disponível em:
TOTVS Educacional | Atividades Acadêmicas | Certificados/Diplomas | Processos | Enviar Certificado para assinatura.
Ao ser executado, este processo realizará uma consulta nas Parametrizações da Interface customizada "Parâmetros Educacionais | Modalidade", para identificar se a modalidade do curso do certificado selecionado está parametrizada. Caso não exista essa parametrização a execução do processo não será realizada.
Será gerado um PDF do Certificado do curso que o aluno concluiu (Iniciação, Aperfeiçoamento, Qualificação e Aprendizagem) e o documento ficará disponível para assinatura no Portal de Assinaturas TAE.
Os documentos integrados ficarão disponíveis no Portal TAE para assinatura e validação, quando necessário, pelos seguintes usuários:
- Diretor responsável pela filial: A customização identificará o Diretor através do cadastro do Diretor da Filial, definido no Cadastro da Filial | Anexos | Dados Educacionais | Anexos Instituição do MEC | Anexos | Diretores por instituição | Campo Diretor.
- Secretários*Novo!: A customização identificará os Secretários através do cadastro do Diretor da Filial, definido no Cadastro da Filial | Anexos | Dados Educacionais | Anexos Instituição do MEC | Anexos | Diretores por instituição | Campos Secretário 1 e Secretário 2.
*Novo!(O certificado será enviado ao secretário(s), caso o parâmetro 'Solicita assinatura do secretário' esteja marcado)
- Responsável pela unidade operacional: A customização identificará o responsável pela Unidade Operacional através do Parâmetro Responsável Unidade Operacional, definido em TAE | Parâmetros Educacionais.
Ao ser integrado, o TAE enviará um e-mail automático para Diretor, Secretários e Responsável, avisando da necessidade de assinatura do Certificado no portal.
Importante!
A identificação dos responsáveis e assinadores será feita de acordo com a filial do certificado/habilitação, caso não sejam localizados assinadores para a filial o processo não poderá ser executado.
- O nome do arquivo no Certificado no TAE será “Certificado” + RA+ Nome sem espaços + CodCurso + .PDF.
O processo Enviar Contrato para assinatura está disponível em:
TOTVS Educacional | Financeiro / Contábil | Contratos | Processos | Enviar Contrato para assinatura
Para execução deste processo é necessário selecionar o(s) registro(s) para geração do relatório e integração para assinatura no TAE.
Ao ser executado, este processo realizará uma consulta nas Parametrizações da Interface customizada "Parâmetros Educacionais | Modalidade", para identificar se a modalidade do curso selecionado para a matrícula está parametrizada. Caso não exista essa parametrização a execução do processo não será realizada.
Será gerado um PDF do Contrato de Matrícula e o documento ficará disponível para assinatura no Portal de Assinaturas TAE.
Ao ser integrado, o TAE enviará um e-mail automático para os responsáveis pela assinatura do contrato de matrícula, avisando da necessidade de assinatura do Contrato no portal.
- O contrato é encaminhado para assinatura, sempre que atender aos parâmetros definidos (Modalidade, situação de matrícula e responsável financeiro).
- O contrato poderá ser gerado pelos Portal do Processo Seletivo, Tela do Contrato RM.exe (Anexo do Aluno), ou Processo de Matrícula.
- O contrato é encaminhado para o responsável pela Modalidade, informado no parâmetro da integração e para o responsável financeiro do aluno.
O relatório que não possuir filtro ou parâmetro SCONTRATO, não será enviado.
Importante!
A identificação dos responsáveis e assinadores será feita observando as parametrizações da modalidade e os dados do responsável financeiro pelo contrato, caso não sejam localizados assinadores para a filial o processo não poderá ser executado.
- O nome do arquivo no TAE será “Contrato” + RA+ Nome sem espaços + CodCurso + .PDF.
Cursos Gratuitos
- Os contratos de cursos gratuitos (Contratos sem plano de pagamento ou com plano de pagamento sem parcela), não serão enviados para assinatura.
- Apenas para contratos que tenham parcelas (que são considerados na exportação) será necessário ter o responsável financeiro cadastrado.
Através do Monitor de Relatórios será possível realizar o acompanhamento dos status de assinatura dos relatórios enviados para assinatura.
A Interface Monitor de Relatórios está disponível em: TOTVS Educacional | TAE | Monitor de Relatórios.
Atenção
O Monitor de Relatórios não é um menu customizado, suas permissões e configurações seguem o definido pelo produto padrão. Para informações sobre sua utilização acesse o link abaixo:
https://tdn.totvs.com/x/xxg3J
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas