Como criar um modelo de documento?

Crie um modelo de documento que será preenchido automaticamente a partir de um fluxo. Confira!

Modelo > Formulário > Fluxo com formulário

O modelo de documento é uma funcionalidade disponível no plano Automação e Integração. Saiba mais em Planos e Preços.

Onde utilizar o modelo de documento?

O modelo de documento é a base para os documentos que serão gerados e enviados automaticamente para assinatura, a partir do Fluxo com formulário. 

Por isso, antes de criar um Fluxo com formulário, você precisa criar um modelo. Em seguida, faz a criação do formulário, e então a criação do Fluxo, que une o modelo e o formulário.

---

 

Como criar um modelo de documento na plataforma Clicksign

Assista já o vídeo onde mostramos a criação dos modelos de documento

O modelo de documento deve conter algumas informações. Confira antes de criá-lo:

Variáveis

As "variáveis" nada mais são que palavras que você irá inserir em seu modelo de documento, dentro de chaves duplas "", como no exemplo abaixo:

Essas variáveis deverão ser iguais aos campos do formulário que será criado posteriormente por você. Isso vai permitir que, após essas informações como e  serem preenchidas pelo signatário no formulário, elas sejam inseridas automaticamente no modelo de documento.

Pronto! Agora que você tem seu modelo pronto, é hora de inseri-lo na plataforma:

1. Em "Modelos" no menu lateral, clique em "Criar Modelo";

2. Escolha o nome do modelo e selecione em seu computador o arquivo em formato .docx. Em seguida clique em "Salvar";

Você também pode baixar um modelo exemplo, clicando abaixo da seleção do modelo.⠀⠀⠀⠀⠀⠀⠀

Pronto! Modelo de documento criado com sucesso. ✔️

---

 

Como criar um modelo de documento via API

Disponível para o plano Integração. Saiba mais em Planos e Preços.

---

 

Dicas

Possíveis mensagens de erro ao tentar realizar o upload de seu modelo:

• Erro no fechamento da tag ''.:Possivelmente foi adicionado uma chave a mais em um ou mais parâmetros do documento, como por exemplo "}".
• Erro no fechamento da tag '{parâmetro}'.: Se for indicado o nome do parâmetro que contêm algum erro, possivelmente esteja faltando uma chave nele, como por exemplo "{{parâmetro}"

No JSON para geração do documento:

O formato JSON deve seguir o padrão:

{"variável": "valor da variável","variável 1": "valor da variável 1"...}

• Sempre comece com uma Chave 
• Sempre inclua aspas antes e após a variável 
• Inclua dois pontos 
• Sempre inclua aspas antes e após o valor atribuído à variável
• Todas as linhas devem ser finalizadas com vírgula, exceto a última linha
• Encerre com uma chave 

---

 

Perguntas frequentes 

O que é JSON?  JSON é um padrão de escrita para troca de dados entre sistemas, é  uma maneira de armazenar e representar informações de forma organizada e fácil de acessar. Mais informações em: https://www.devmedia.com.br/o-que-e-json/23166.

Como eu mando o documento após a geração? 

Após a geração do documento, ele é encaminhado como qualquer outro documento dentro da Clicksign. É necessário adicionar signatários, seus respectivos e-mails e qual a qualificação de suas assinaturas, decidir como será enviado o Token de autenticação e enviar o documento para assinatura.

Caso não seja passado no formato JSON corretamente, uma mensagem de erro será exibida.