Projeto: FS008375(AAAKH4) – Integração com TOTVS Sign

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

__________________________________________________________________________________________________________________________________________________________________


Prezados Senhores,

O documento a seguir tem por 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


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


Detalhamento do Processo


Para a utilização da Customização "Integração com TOTVS Sign" será necessário primeiramente realizar algumas parametrizações.

A interface de Parâmetros está disponível em: TOTVS Educacional | TOTVS Sign | Parâmetros TOTVS Sign.



A interface exibirá duas abas para serem configurados, sendo eles:


Aba Identificação:

  • URL API Assinatura: Campo para informação do endereço da API para onde os documentos serão enviados para serem assinados. 
  • Endpoint para envio de dados: Identificação do endpoint responsável pelo recebimento dos dados dos arquivos a serem assinados. 
  • Endpoint para consulta de dados: Identificação do endpoint responsável pela consulta dos dados dos arquivos enviados e retorno dos status das assinaturas. 
  • Consultar documentos pendentes e atualizar status dos documentos ao abrir visão de monitoramento: Após o documento ser enviado para o portal de assinaturas será possível acompanhar se o mesmo já foi assinado ou não através de uma visão de monitoramento. Ao marcar esse campo quando a visão for aberta, a customização identificará os documentos que estiverem como pendentes de assinatura e realizará uma consulta na API de assinatura para identificar se os mesmos foram assinados e atualizar o status apresentado na tela caso tenham sofrido alterações de status (se foram assinados ou rejeitados).      
  • Ao abrir visão mostrar apenas dados solicitados pelo usuário logado: Caso seja marcado esse parâmetro apenas documentos enviados por processos solicitados pelo usuário logado, serão exibidos na tela, não sendo possível consultar o status de documentos solicitados por outros usuários. 
  • Assinar documento ao enviá-lo: Caso marcado, indica que o documento será assinado pelo usuário da inclusão dos documentos assim que os documentos forem incluídos para assinatura. 
  • Testar conexão API: Funcionalidade utilizada pra testar a conexão com os serviços do portal de assinaturas.



Aba API Totvs Sing User:


  • Utilizar token (API Totvs Sing User) para execução de assinatura: Identificador para utilização de um token fixo ou utilização de API para obtenção do Token de autenticação.
  • Token Fixo: Caso o campo “Utiliza API Token para execução de assinatura” esteja desmarcado, esse campo ficará habilitado para ser preenchido com o token de autenticação.
  • Url API Token: Informe a Url da API responsável pela autenticação do usuário e geração do Token para envio dos documentos.
  • Endpoint para obtenção do Token: Identificação do endpoint responsável pela geração do token. 
  • Utilizar único usuário para geração do Token: define um usuário padrão para geração do token de acesso. Caso não seja definido, será solicitado no momento da integração dos documentos.
  • Usuário Token: Informe o usuário para autenticação na Api Token. 
  • Senha Token: Informe a senha do usuário na Api Token. 
  • Consultar e criar usuário na API TOTVS Sign User caso não exista: Se desmarcado, caso o usuário não exista no portal, ocorrerá erro no momento da integração dos documentos.
  • Endpoint para criação de usuário: Texto com a identificação do Endpoint responsável pelo recebimento dos dados dos usuários a serem criados no TOTVS Sign. 
  • Endpointo para consulta de usuário: Texto com a identificação do endpoint responsável pela consulta de usuário no TOTVS Sign a fim de identificar a existência do mesmo.
  • Testar conexão Sign: Funcionalidade utilizada pra testar a conexão com o portal de assinaturas.



A permissão de acesso ao menu será feita através de configuração de controle de perfil de usuário (nativa).

Pré-requisitos


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


Detalhamento do Processo


Na interface customizada de "Parâmetros Educacionais" realizará a integração dos relatórios de acordo com a modalidade do curso. 

Para isso foi criado uma parametrização de Modalidade, Relatórios e Assinaturas onde o usuário definirá os valores utilizados pela integração. 


A interface de Parâmetros está disponível em: TOTVS Educacional | TOTVS Sign | Parâmetros Educacionais.


A interface exibirá três abas para serem configurados: Modalidade, Parâmetros da Filial e Relatórios. 


Aba Modalidade: Será necessário informar todas as modalidades que estarão farão parte da integração TOTVS Sign. 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 TOTVS Sign. Preenchimento obrigatório. 
  • 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). Preenchimento obrigatório.



Aba Parâmetros da Filial: 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. Campo de preenchimento opcional e indica que o usuário correspondente será enviado como aprovador/validador do Certificado, que no TOTVS SIGN tem o poder de veto do documento. Ele não precisará assinar o documento.



Aba Relatórios: 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).



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


Pré-requisitos

  • Customização instalada e todos os scripts gerados com sucesso. 
  • Parametrizações realizadas com sucesso.


Detalhamento do Processo


Foi desenvolvido a funcionalidade Integração do Relatórios de Diário de Classe de Notas e Diário de Classe de Frequência com o TOTVS Sign. 

A funcionalidade de Integração dos relatórios com o TOTVS Sign está disponível em: TOTVS Educacional | Currículo e Oferta | Turmas/disciplinas | Anexos | Etapas | Processos | Enviar Diário de Classe para assinatura.



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.

Os documentos integrados ficarão disponíveis no Portal TOTVS SIGN 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 | Professor | Anexos | Disciplinas Autorizadas.
  • 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 TOTVS Sign enviará um e-mail automático para o Professor Responsável pela disciplina, Secretários Coordenadorl, avisando da necessidade de assinatura do Diário no portal.



  • O nome do arquivo deve ser “DiarioDeClasse” + IdTurmaDisc + “Etapa” + Número da etapa .PDF


Pré-requisitos

  • Customização instalada e todos os scripts gerados com sucesso. 
  • Parametrizações realizadas com sucesso.


Detalhamento do Processo


Foi desenvolvido a funcionalidade Integração do Relatórios de Certificado com o TOTVS Sign. 

A funcionalidade de Integração do Certificado com o TOTVS Sign  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 TOTVS SIGN.

Os documentos integrados ficarão disponíveis no Portal TOTVS SIGN 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 TOTVS Sign | Parâmetros Educacionais. 


Ao ser integrado, o TOTVS Sign 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 TOTVS Sifgn será “Certificado” + RA+ Nome sem espaços + CodCurso + .PDF.


Pré-requisitos

  • Customização instalada e todos os scripts gerados com sucesso. 
  • Parametrizações realizadas com sucesso.


Detalhamento do Processo


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 | TOTVS Sign | 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:


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



Pré-requisitos

  • Customização instalada e todos os scripts gerados com sucesso. 
  • Parametrizações realizadas com sucesso.


Detalhamento do Processo


Através da interface customizada "Monitor de Relatórios" será possível consultar o status de arquivos/relatórios enviados para o TOTVS Sign.


O processo para consultar o status de arquivos/relatórios enviados para o TOTVS Sign poderá ser executado automaticamente ao abrir a tela de visão. O processo será executado automaticamente caso o parâmetro "Consultar e atualizar status do documento ao abrir tela de monitoramento" disponível nos Parâmetros TOTVS Sign esteja marcado. 

Isso pode fazer com que a exibição dos dados seja demorada dependendo da quantidade de registros a serem consultados.

A segunda opção para consulta será através do Processo "Consultar Status de Assinatura" que está disponível em: TOTVS Educacional | TOTVS Sign | Monitor de Relatórios | Processos | Consultar status de assinatura.

 


Pré-requisitos

  • Customização instalada e todos os scripts gerados com sucesso. 
  • Parametrizações realizadas com sucesso.


Detalhamento do Processo


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


Ao acessar o Portal de assinatura o usuário deverá clicar na opção Externo.


O usuário deverá informar os dados de e-mail (login) e senha de acesso:


No Portal de Assinatura através do  menu documentos será possível visualizar três pastas com todos documentos: Pendentes, Finalizados e Rejeitado e os documentos pendentes de validação/assinatura do usuário logado. 



Para visualizar o documento para assinatura e assinatura o responsável deverá dar um duplo clique no documento.


Será disponibilizado na aba ao lado direito do documento três menus: Informações, Destinatários e Anexo.


O usuário Responsável pela Unidade Operacional, após validar o documento deverá clicar em “Próxima etapa” e realizar a liberação para os demais destinatários assinar.



Clique na opção concordo em usar assinaturas e registros eletrônicos e no botão assinar eletronicamente:



Caso o responsável queira Rejeitar o documento, será necessário clicar na opção Rejeitar e deverá informar o motivo da rejeição.