Templates

Templates save you from building the same document over and over. A service agreement, an equipment loan agreement or a direct debit authorization can become templates, and each envelope only fills in the details of that person. Operators, administrators and owners create and edit templates; the Read only role can only view them.

Template types#

Create a text template#

1. In Templates, click New template.
2. Give it a name and choose the Text with variables type.
3. Write the text. Where a variable piece of data goes, use the key between double braces, for example {{nome}}, {{cpf_cnpj}}, {{plano}} or {{valor}}.
4. For each variable, enter a label (the name that appears on the envelope form, for example "Subscriber's CPF or CNPJ") and mark whether it is required.
5. Save.

Rules for variable keys: lowercase letters without accents, numbers and underscore (_). The template text can be up to 2 MB.

CONTRATO DE PRESTAÇÃO DE SERVIÇOS DE INTERNET

Contratante: {{nome}}, CPF/CNPJ {{cpf_cnpj}}, residente em {{endereco}}.
Plano contratado: {{plano}}, pelo valor mensal de {{valor}}.
Vigência: {{vigencia}}.

Tip use Test to see the result with sample values before using the template in an envelope. The test saves nothing and does not create an envelope.

Create a fixed PDF template#

1. Click New template, give it a name and choose Fixed PDF.
2. Upload the file (up to 20 MB, without a password).
3. Save.

Versions#

Each time you save a change, Ravisign creates a new version of the template. Envelopes already created remain linked to the version they used, so changing a template never alters a document that is already out for signature or signed. The version used is recorded in the envelope.

Archive and restore#

A template that should no longer be used can be archived: it leaves the list of choices when creating envelopes, but its history remains intact. To use it again, show the archived templates and click Restore.

Use a template in an envelope#

When creating the envelope, under Document, choose Use a template and select the template. The variable fields appear with the labels you defined; the required ones must be filled in. With a text template, the PDF is generated right after creation; the envelope stays as a draft with the indication Document being prepared until the file is ready, and then proceeds to sending normally.

Through the API, the same applies with modelo_id and variaveis: see Documents and templates.