Histórico da Página
AçTempo Tempo aproximado para leitura: 00 20 min
ÍNDICE| Índice |
|---|
- Visão Geral
- Exemplo de utilização
- Configuração
- Criar Oauth Provider
- Criar Oauth App
- Dataset Parâmeros
- Assinatura de Contratos
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
|
01. VISÃO GERAL
No processo Workflow de Solicitação de Contratos (Workflow - Fluig), após a etapa "Gera Minuta Final", é possível mover o Workflow para a etapa "Encaminhar para Assinatura", onde será possível autenticar digitalmente o contrato produto da solicitação. A autenticação da assinatura digital será garantida pela parceira Soluti, que fornecerá uma chave eletrônica (token) via aplicativo para que o usuário realize a assinatura.Esta funcionalidade elimina a , foi implementada a funcionalidade de Assinatura Digital de Contratos. Esta funcionalidade possibilita realizar a assinatura digital dos contratos através do Fluig, eliminando a necessidade de ter uma versão em papel do documento que necessita a ser assinado, otimizando assim o processo de aprovação de contratos. dos mesmos.
A assinatura do documento é feita através do o plug-in Vertsign e poderá ocorrer de duas formas: com ou sem certificado digital.
Nota: Funcionalidade disponível a partir da versão 12.1.24.
02.
EXEMPLO DE UTILIZAÇÃO03. Configuração
a. Criar Oauth Provider - Painel de Controle / aba WCM / Oauth Provider
No Fluig, acesse o Painel de Controle, vá até a aba WCM / Oauth Provider
Preencha os campos obrigatórios, considerando:
- O campo oAuth Provider deve ser preenchido como "WCM";
- Os campos Acess Token URL, Request Token URL, User Authorization URL, deverão ser preenchidos com as URLs padrões da aPI Fluig, sendo elas:
Acess Token URL: http://<computername>/portal/api/rest/oauth/access_token
Request Token URL: http://<computername>/portal/api/rest/oauth/request_token
- User Authorization URL: http://<computername>/portal/api/rest/oauth/authorize
b. Criar Oauth App - Painel de Controle / aba WCM / Oauth App
No Fluig, acesse o Painel de Controle, vá até a aba WCM / Oauth App
Preencha os campos obrigatórios, considerando:
- O campo oAuthProvider deve ser preenchido com o oAuthProvider criado anterioriormente (item a).
Após adicionar o Oauth Application, selecione o mesmo e clique em Usuário Aplicativo, em seguida clique no botão Gerar Token para que o usuário seja criado.
c. Dataset Parâmetros
Atualize o dataset dsParamsSIGAJURI com as informações do ambiente do cliente, considerando:
- A coluna sOathAppPublic deve ser preenchida com o conteúdo do campo Consumer Key do Oauth App criado anteriormente;
- A coluna sOathAppPrivate deve ser preenchida com o conteúdo do campo Consumer Secret do Oauth App criado anteriormente;
- A coluna OathTokenPublic deve ser preenchida com o conteúdo do campo Access Token gerado para o usuário do Oauth App criado anteriormente;
- A coluna OathTokenPrivate deve ser preenchida com o conteúdo do campo Token Secret gerado para o usuário do Oauth App criado anteriormente;
- A coluna sFluigHostName deve ser preenchida com o endereço IP do cliente.
DOWNLOAD E ATIVAÇÃO
2.1 Realizar o download do componente
Ação | Descrição |
|---|---|
Acesse a TOTVS Store - https://totvs.store/br/vertsign.html - e faça o download do componente. |
|
2.2 Ativação do componente
Ação | Descrição |
|---|---|
No fluig, com um usuário admin, acesse: Painel de Controle / Aplicativos / Central de Componentes; | Escolha o arquivo baixado e clique em “Enviar”
|
Buscar o componente e ativar | Ainda na Central de Componentes, após o deploy do componente, busque por “Vert_Component”.
Selecione o componente e clique em "Ativar"
|
Verifique se o componente foi ativado corretamente | Após a ativação, recarregue a página e veja se a opção de menu “Vertsign” foi criada.
|
03. INSTALAÇÃO
3.1 Formulários
Nesta etapa os formulários serão instalados para realizar o cadastro de assinantes, cadastro de parâmetros gerais do app e formulário para auxiliar no envio e retorno de documentos enviados para assinatura.
Cadastro de Assinantes: Formulário responsável por armazenar os dados dos assinantes inseridos através da widget. O Fluig irá armazenar o Nome, E-mail e CPF.
Parâmetros Gerais: Formulário responsável por armazenar os parâmetros do App. Ele será atualizado conforme a instalação é realizada.
Formulário Auxiliar: Formulário responsável por registrar cada documento enviado para assinatura, trazendo em cada registro informações relevantes sobre o documento enviado. Este formulário não será acessado de forma direta pelo usuário.
Ação | Descrição |
|---|---|
Instalar os Formulários Acessar o Menu: Vertsign
Instalação e Configuração
| Na sessão 1. Formulários clique no botão Instalar.
|
3.2 Datasets
Esta etapa é responsável por realizar a instalação dos datasets que farão a integração entre o fluig e a Vertsign.
Abaixo estão os datasets que serão instalados:
ds_upload_vertsign: Lista todos os documentos do formulário auxiliar que estão pendentes de envio e envia para a Vertsign.
ds_package_vertsign: Verifica se os documentos foram assinados no portal de assinaturas da Vertsign e retorna o manifesto para o ECM do fluig.
ds_documents_vertsign: Lista todos os documentos que foram enviados para a Vertsign. Posteriormente será utilizado para realizar o cancelamento de um documento enviado.
ds_upload_vertsign_manual: Dataset responsável por enviar os documentos para assinatura. É executado após cada envio.
ds_auxiliar_vertsign: Dataset responsável por auxiliar a widget executando os webservices do fluig.
ds_delete_vertsign: Deleta um arquivo do Portal de Assinaturas da Vertsign.
ds_documents_autocomplete_vertsign: Dataset responsável por listar todos os arquivos disponíveis para envio.
ds_admin_vertsign: Dataset responsável por listar todos os usuários administradores da plataforma.
ds_signers_vertsign: Dataset responsável por listar todos os assinantes cadastrados.
Ação | Descrição |
|---|---|
Instalar os Datasets Acessar o Menu: Vertsign
Instalação e Configuração
| Na sessão 2. Datasets clique no botão Instalar.
|
3.2.1 Agendador de tarefas
Após a instalação, os datasets marcados como Sincronizado = Sim serão criados no Agendador de tarefas do fluig. Por padrão serão executados uma vez por dia, mas pode ser editado.
Ação | Descrição |
|---|---|
Para visualizar os datasets no Agendador de tarefas basta acessar: Painel de Controle > Parâmetros Técnicos > Agendador de tarefas |
|
3.3 Serviços
Nesta etapa será realizada a instalação dos serviços utilizados pelo app:
ECMCardService_Vertsign: Webservice responsável por realizar operações referentes a formulários no fluig.
ECMCustomFieldsService_Vertsign: Webservice responsável por interagir com os campos customizados do fluig.
ECMDocumentService_Vertsign: Webservice responsável por realizar operações referentes a documentos do fluig.
ECMFolderService_Vertsign: Webservice responsável por realizar operações referentes a pastas no fluig.
ECMTokenService_Vertsign: Webservice responsável por interagir com os token’s do fluig. Pode ser utilizado para pesquisar e validar os token’s existentes.
Ação | Descrição |
|---|---|
Instalar os Serviços Acessar o Menu: Vertsign
Instalação e Configuração
| Na sessão 3. Serviços clique no botão Instalar.
|
3.4 Campo Customizado
Nesta etapa da instalação será instalado o campo customizado que será atualizado a cada alteração de status do documento enviado para assinatura.
Ação | Descrição |
|---|---|
Instalar os Serviços Acessar o Menu: Vertsign
Instalação e Configuração
| Na sessão 4. Campo Customizado clique no botão Instalar.
|
04. CONFIGURAÇÃO
4.1 Parâmetros
Os parâmetros são obrigatórios na instalação a fim de definir todas as configurações iniciais necessárias para começar a utilizar o app. Abaixo encontra-se a descrição de cada campo:
Ação | Descrição |
|---|---|
Instalar os Serviços Acessar o Menu: Vertsign
Instalação e Configuração
| Na sessão 5. Parâmetros preencha os campos conforme orientações abaixo:
O Token é uma informação de controle de acesso no Portal de Assinaturas Vertsign. Na contratação do app Vertsign dois ambientes do Portal de Assinaturas Vertsign são liberados: um ambiente de homologação e um ambiente de produção. Cada ambiente possui o seu respectivo token. O Token será enviado por email pela Vertsign para o administrador do sistema cadastrado na TOTVS. Caso a empresa não tenha recebido o token, favor encaminhar um email para [email protected].
Usuário admin do fluig responsável pelas integrações.
Senha do usuário de integração.
Definir se a integração será feita no ambiente de homologação ou no ambiente de produção da Certisign.
|
4.2 Serviço externo
Após preencher todos os campos e clicar em “Salvar”, o formulário de parâmetros gerais será atualizado com as novas informações e o serviço VertsignServiceRest será criado no Fluig.
O campo Token é utilizado para realizar as integrações entre o Fluig e a Vertisign. O serviço VertsignServiceRest é o responsável por fazer esta integração. Caso o token seja alterado, este serviço será removido e criado novamente com o novo token.
Os endereços abaixo devem ser liberados para que as integrações sejam realizadas:
https://api-sbx.portaldeassinaturas.com.br
https://api.portaldeassinaturas.com.br
4.3 Usuário de integração
Na última etapa da instalação deve ser definido nos Parâmetros um usuário administrador para realizar as integrações internas do Fluig.
Caso o Fluig esteja configurado com o Identity, o campo “Senha de integração (Fluig)” deve ser preenchido com a senha do Identity do usuário de integração.
| Informações | ||
|---|---|---|
| ||
Caso a senha do usuário de integração seja alterada, deve-se lembrar de alterar também nos parâmetros. Outro cuidado que deve ser tomado é caso o usuário de integração seja desativado da plataforma. Nesse caso, deve-se acessar os parâmetros do app e definir outro usuário |
4.4 Rotinas de integração
A integração entre Fluig e Vertisign ocorrem através de Datasets sincronizados que verificam o status da assinatura dos documentos e realizam as integrações. Por padrão esses scripts são executados uma vez por dia, mas também podem ser executados manualmente acessado o Agendador de Tarefas no Painel de Controle. O Fluig permite também alterar esse tempo de agendamento.
Os Datasets responsáveis por realizar o envio/download dos documentos são:
- ds_upload_vertsign: Envia os documentos para assinatura.
- ds_package_vertsign: Baixa os documentos assinados.
4.4 Configurações do Agendamento
Após a instalação dos Datasets, as rotinas de integração serão configuradas para executar uma vez por dia. Essas rotinas são responsáveis por enviar e baixar os documentos do Portal de Assinaturas da Vertisign.
- Mas existe a possibilidade de alterar a frequência de execução. Abaixo será explicado como o usuário administrador da plataforma pode realizar essa alteração:
- Acesse o Painel de Controle do Fluig
- Acesse o Agendador de tarefas
- Localize as duas rotinas de integração (ds_package_vertsign e ds_upload_package)
- Selecione a rotina que deseja alterar
- Clique em Deletar
- Clique em Adicionar
- Insira uma descrição e selecione a opção "Sincronização de Dataset"
- Selecione o dataset ds_package_vertsign
- Feito isso, selecione a frequência de execução e clique em Confirmar. Mais detalhes em fluig help.
Agora a rotina que baixa os documentos assinados do Portal de Assinaturas da Certisign será executada com a frequência determinada.
A data da próxima sincronização é exibida do lado superior direito do Quadro de Status como na imagem abaixo:
05. CADASTRO DE ASSINANTES
Ação | Descrição |
|---|---|
Cadastrar Assinante Acessar o Menu: Vertsign
Cadastros
| Antes de tudo é necessário cadastrar assinantes para que sejam adicionados no momento de envio de um documento para assinatura. Acesse a página “Cadastros”, insira o nome, e-mail, CPF e o tipo de assinatura (digital/eletrônica) e clique em salvar. Assinatura Digital A assinatura digital utiliza um Certificado Digital ICP Brasil para comprovar a autoria da assinatura. A assinatura digital garante autenticidade, integridade e não repúdio (signatário não tem como negar sua autoria). O Certificado Digital é a identidade digital da pessoa física e jurídica no meio eletrônico. É validado presencialmente, não permitindo fraudes. Se você necessita mandar documentos para fora de sua rede, é fundamental que haja confiança pública para que a assinatura seja automaticamente aceita pelos diferentes órgãos e empresas. Nesse caso, a assinatura digital é mais conveniente, pois possui a mesma validade jurídica de um documento com firma reconhecida em cartório. Assinatura Eletrônica Assinatura eletrônica coleta evidências para comprovar a autoria da assinatura em um documento e não utiliza um Certificado Digital. Estas evidências são coletadas no momento da assinatura. O Portal coleta três principais: a grafia do signatário (com uma caneta touch, dedo, mouse ou a imagem digitalizada), IP da máquina e geolocalização. A assinatura eletrônica viabiliza a migração de ações do dia a dia da empresa do meio físico para o digital, reduzindo custos operacionais e poupando tempo. Se você necessita apenas deixar de usar papel e agilizar os processos, então conformidade e confiança não devem ser um problema, e a assinatura eletrônica pode ser considerada.
|
06. QUADRO DE STATUS
Ação | Descrição |
|---|---|
Cadastrar Assinante Acessar o Menu: Vertsign
Quadro de Status
| Também é possível consultar o quadro de status para acompanhar o andamento do processo de assinatura do documento enviado. Acesse a página “Monitoramento”.
Cada aba corresponde um status diferente. Clique na aba desejada para visualizar os documentos. A atualização dos documentos enviados para assinatura são atualizados no quadro de status de duas formas:
Os usuários administradores do Fluig podem visualizar todos os documentos no quadro de status, enquanto os outros usuários comuns podem apenas visualizar seus documentos enviados. Nas imagens abaixo, é possível visualizar a diferença entre os dois Quadros de Status: para usuários administradores e para usuários comuns. Quadro de Status de usuários comuns (não administradores)
Quadro de Status de usuários administradores
No exemplo acima é possível ver que o usuário administrador visualiza o documento enviado pelo usuário "João da Silva". |
07. ASSINATURA DE CONTRATO
[Fluig] Solicitação de Contratos - Encaminhar para Assinatura
Ação | Descrição | |||||
|---|---|---|---|---|---|---|
Encaminhar para assinatura | Quando a Solicitação estiver no passo de "Gerar Minuta Final", o usuário terá a opção de "Encaminhar para Assinatura Digital"
Observação: Se a API não estiver instalada, ao tentar enviar para assinatura, o usuário não conseguirá entrar na próxima etapa e receberá o seguinte aviso:
Observação: Se não houver arquivos anexados na Solicitação o sistema irá mostrar a mensagem abaixo:
| |||||
| Selecionar documento | Na fase de "Encaminhar para Assinatura" será apresentado uma Área de "Assinatura Digital".
| |||||
| Selecionar assinadores | Ao clicar em Assinadores, serão apresentados os Assinadores cadastrados na Widget da Vertsign
Ao selecionar um assinador, o e-mail do usuário será apresentado na área de texto abaixo. Se forem selecionados mais Assinadores, ele serão concatenados, separados por ";"
| |||||
| Validar assinatura | Ao enviar para etapa "Valida Assinatura" a solicitação será enviada para a Vertsign. Os assinadores receberão um e-mail com o link para assinatura do documento.
| |||||
| Realizar a assinatura | Os assinadores receberão um e-mail para realizar a assinatura do documento
Ao clicar no link, o assinador será direcionado para a Vertsign, onde poderá visualizar o arquivo se for um .pdf. Caso seja um .doc ou .docx, será necessário realizar o download do arquivo para visualizar. A assinatura do arquivo é feita através do botão "Estou pronto para assinar".
Ao clicar em "Estou pronto para assinar" irá abrir uma área para fazer a rubrica.
| |||||
| Finalizar validação de assinatura | Após a assinatura de todos os Assinadores, o Responsável do Fluxo poderá clicar em "Enviar" no Fluig para movimentar o fluxo da solicitação.
Quando o sistema identificar o documento assinado, irá automaticamente movimentar o fluxo para "Finaliza contrato"
O documento original terá um "Manifesto" anexado que será baixado junto com o documento ao realizar o download.
|
| Card documentos | ||||
|---|---|---|---|---|
|
04. Assinatura de Contratos
(Fluig) Solicitação de Contratos - Encaminhar para Assinatura
Após a etapa Gerar Minuta Final, ao enviar o formulário, selecione a etapa Encaminhar para Assinatura como próxima atividade.
Será apresentada no inicio do formulário o grupo de campos Assinatura Digital. No campo Documento, selecione um documento em formato PDF a ser autenticado. Os usuários selecionados no campo Assinadores serão adicionados e separados por ";" no campo disposto logo abaixo.
Nota: Somente documentos em formato PFD serão listados para seleção.
| Card documentos | ||||
|---|---|---|---|---|
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas