Projeto: FS008375(AAAKH4) – Integração com TOTVS Assinatura Eletrônica (TAE)

Nome do Cliente: Confederação Nacional da Indústria - SENAI

__________________________________________________________________________________________________________________________________________________________________

Objetivo

Orientar o usuário sobre as implementações realizadas para sua empresa. Todas as funcionalidades descritas neste manual têm como base do que está descrito nos documentos:

Detalhamento Funcional - FS008375(AAAKH4)


Pré-requisitos

  1. Customização instalada e todos os scripts gerados com sucesso;

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

Parâmetros para integraçã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 coligada.

  • 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. 
  • 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.
  • 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.
  • 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 (cadastro de Pessoa), 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.

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

O relatório que não possuir filtro ou parâmetro SCERTIFICADO, 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;


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.


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

O processo Enviar Diário de Classe para Assinatura está disponível em:

TOTVS Educacional | Currículo e Oferta | Turmas/disciplinas | Anexos | Etapas | Processos | Enviar Diário de Classe para assinatura.


Inicia a execução do processo: 

    

Processo finalizado


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. 


  1. O usuário poderá selecionar qualquer etapa, independentemente de estar marcada como Etapa final (resultado).
  2. 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.
  3. Para que o processo funcione corretamente é necessário que o relatório possua os parâmetros CODCOLIGADA, IDTURMADISC, CODETAPA e TIPOETAPA.

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.


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.


Inicia a execução do processo: 


Processo finalizado



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



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


Inicia a execução do processo: 

    

Processo finalizado


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 relatório que não possuir filtro ou parâmetro SCONTRATO, não será enviado.

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

Ao realizar a matrícula de um aluno no Processo Seletivo, será gerado o contrato do mesmo. A customização buscará o relatório de contrato parametrizado e realizará a integração com o TAE seguindo os mesmos modelos da Integração de Relatórios de Contrato de Matrícula - Manual.

O relatório que não possuir filtro ou parâmetro SCONTRATO, não será enviado.

Através da interface customizada "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.

Ao acessar o Monitor de Relatórios será retornado uma tela de visão, onde serão listados os respectivos processos de integração de relatórios. Nessa visão estarão dispostos os relatórios gerados e as informações sobre o processo de integração.

  • Tipo de relatório: Nesta coluna será exibido o tipo de relatório enviado para assinatura.
  • Status: Exibirá o status do documento/relatório. Um relatório pode ter os seguintes status:


image2021-4-6_14-52-31.png

  • Job relatório: Número do Job de execução do relatório.
  • Arquivo assinatura: Identificador do arquivo na Api de assinatura.
  • Remetente: Usuário responsável pelo processo principal.
  • Destinatários: E-mails dos usuários que devem assinar o relatório.
  • Mensagem: Mensagem de erro ou informação retornada pelo processo ou Api.
  • Nome do arquivo: Nesta coluna será exibido o nome do arquivo gerado.
  • Campos chave: Campos que compõem a chave para geração do relatório.
  • Valores chave: Valores que compõem o campo chave.
  • Job Principal: Identificador do Job responsável por disparar a geração dos relatórios (Diário de Classe ou Certificado).
  • Criado por: Usuário de criação do processo.
  • Criado em: Data de criação do processo.
  • Modificado por: Usuário de modificação (alteração de status) do registro.
  • Modificado em: Data de modificação (alteração de status) do registro.


Será possível realizar a edição de um registo para visualizar os dados detalhados. 


Atualização de status de documentos integrados

Para uma gestão mais eficaz dos relatórios, sempre que necessário, o usuário possui a capacidade de atualizar o status dos documentos já integrados utilizando o processo Atualização de status de documentos integrados. Isso permite manter um controle mais preciso e atualizado sobre o estado de cada documento.


Ao ser executado esse processo o sistema verificará se o documento Pendente de assinatura ou Assinado parcialmente teve alguma alteração de status no portal TOTVS Assinatura Eletrônica e atualizará a informação no registro de monitoramento.


Status e-mail

As informações da situação de envio do Documento para o aluno, também serão gravadas no Monitor de Relatórios, na coluna STATUS E-MAIL do Monitor. 


E-mail enviado com sucesso: Caso o processo tenha sido executado sem ressalvas e o documento
assinado tenha sido enviado para o e-mail do aluno;
Falha no envio de e-mail: Caso o processo tenha sido executado com ressalvas e o documento
assinado não tenha sido enviado para o e-mail do aluno.


Mensagem

Em complemento à essas informações, temos a coluna e Mensagem, onde estará descrito a mensagem de retorno do processamento.

É necessário que os responsáveis pela assinatura e validação dos relatórios/certificados integrados ao TAE acessem o Portal de assinatura para validar e assinar. 

Para mais informações sobre como acessar e utilizar o portal TAE acesso o link abaixo:
Manual Operacional - TAE