I have a Zivver account
User manuals and reference documentation
Text tags
NoteIntroduction
With the Text Tags feature, users can add predefined tags to a document to specify the type and placement of various fields, such as signatures, dates, and text fields. These tags act as placeholders and can be positioned anywhere in the document. During the Prepare flow, our platform will automatically recognize and convert them into the appropriate input fields.
Supported file formats: .docx and .pdf
Text tags
A text tag can be created by adding curly brackets with the indicator zvr to a word or pdf document. Within the text tag it must be specified, whether it is a signature, text or date field.
| Text Tag | Description |
|---|---|
{{zvr type=signature}} | A text tag for signature |
{{zvr type=text}} | A text tag for text |
{{zvr type=date}} | A text tag for a date |
{{zvr type=signature; signer=sender}} | A text tag assigned to the sender of the document |
{{zvr type=signature; x=10; y=10; height=50; width=150}} | A text tag with custom placement |
{{zvr type=signature; page=all}} | A text tag for a field, which should appear on all pages |
{{zvr type=signature; page=3,5}} | A text tag for a field, which should appear on two pages |
Available parameters for text tags
| Parameter | Required? | Possible values | Description |
|---|---|---|---|
| type | yes | signature, date, text | Defines whether the field should be used for a signature, date or text |
| signer | no | sender, recipient | Defines who should be assigned to the field by default |
| height | no | number (at least 24) | The height of the field in points |
| width | no | number (at least 125) | The width of the field in points |
| x | no | number | The x coordinate (vertical position) of the field |
| y | no | number | The y coordinate (horizontal position) of the field |
| page | no | list of numbers or “all” | The page(s) of the field. If multiple pages are specified (e.g. page=1,2 or page=all) multiple fields will be created. |
Using text tags
InfoThere are 3 main steps for sending a document using text tags:
- Add text tags to a document
- Upload a document and add recipients to the Zivver message
- Prepare a document and make sure all fields are placed properly
1. Add text tag to document
Add a text tag to a document before uploading via Secure eSignatures.
2. Upload document, add recipients, define the signers
Similarly to a regular flow, the document with text tags should be uploaded through Secure eSignature side pane.
Recipient(s) should be added to the Zivver message prior to clicking Prepare document.
Signers should be specified prior to preparing document, this ensures the fields are assigned to the correct recipient.
Example
In this example there are 3 participants, the sender and 2 recipients, it is specified that only one recipient is required to sign the document.The text tag will pick up the sender and the recipient emails and place them in the document accordingly.
Zivver Office Plugin view
Document view
3. Prepare a document
When clicking on Prepare document, the text tags should be converted to regular pre-assigned fields with appropriate assignees. The placement and assignees of the fields can still be adjusted similar to the regular prepare flow.
Text tags before and after the prepare flow
Before
After
Placements
By default, the fields will be placed with the same position and the same size as the corresponding text tag. For most use cases, this should be the easiest way to specify the placement. To adjust the general size of a field, the font size of the text tag can be increased or decreased. The width of the field can be increased by adding more whitespaces to the text tag e.g. {{zvr type=text }}.
If more precise or custom placement is necessary, the x, y, width and height parameters can be used. The x(horizontal) and y(vertical) coordinates specify the position of the bottom left corner of the field. The coordinate system starts at the bottom left corder, so specifying x=0 and y=0 would place the field in the bottom left corner. A standard A4 document has the size of 595 x 842 pts, but this can largely vary for other document formats. The width and the height parameters can be used to specify the size of the field itself. The minimum size is 125 x 24 points.
Recommendations
Recommendations for the best output:
Using some fonts can cause the failure of proper placement of the fields. There, recommendation is to use one of these fonts: Arial, Courier New, Georgia, Impact, Times New Roman
In case the horisontal alignment of the fields is important it’s recommended not to use more than 9pt in font size:
In case the vertical alignment of the fields is important and fields should have the same width, it’s recommended to align the endings of the curly brackets by adding spaces to the tags and using a monospaced font (e.g. Courier New) in which all characters have the exact same width:
To avoid field overlap try to have some space between the tags
Limitations
The text tags are defined for a sender and a recipient. It is not possible to assign tags to more than 1 recipient. Example: If there are three signature tags 1 for a sender and 2 for the recipients, after starting the prepare flow only one recipient will be added to the both recipient fields in the document. However, it will be possible to make adjustments and update fields manually.
In case of a mistake or incomplete text tag there won’t be an error shown. The proper conversion and placement of tags needs to be reviewed by the user during the document prepare flow.
The entire span of the text tag, from the beginning curly brace to the closing curly brace, must fit within a single line. If a text tag covers multiple lines, either in the document that is uploaded or in the final PDF, the field will not be correctly recognized by Zivver and may cause the underlying text to be visible to the signer when signing the document.