Adding Docusign Tabs to a Contract Template
A Docusign tab is an interactive element on the contract, for example a signature line, a set of initials, a date, or a box the signer fills in. Contract template admins add a tab by inserting a Docusign token in the appropriate place in the Word template. When the contract is generated and sent, Docusign reads each token and inserts the matching interactive element in the tab location.
Who can use this feature?
- Contract Template Administrators
- Using Docusign Tokens
- Creating Input Tabs
- Using Signature and System Tabs
- Users do not require an additional license
Using Docusign Tokens as
A Docusign token performs two critical roles:
- Places the tab - The token text is an anchor. Docusign searches the PDF for that exact text and places the tab where it finds it.
- Maps the data - The token can name a Vault CRM field from the Contract Partner object. Whatever the signer enters is written back to that field in Vault CRM after signing.
Using Correct Token Syntax
Correct token syntax is essential for tokens to render correctly in the final document. The syntax is as follows:
{{DocusignTab:TabType<Object.Field>[modifier:value]}}
The following table describes each element.
|
Element |
Required? |
Description |
|---|---|---|
|
DocusignTab: |
Yes |
Marks the token as a Docusign tab and not a regular merge field |
|
TabType |
Yes |
The kind of tab, in singular form, such as textTab or signHereTab |
|
<Object.Field> |
No |
The Vault CRM field to read from and write back to. Omit it for a tab that does not map to a field. |
|
[modifier:value] |
Yes |
Used for extra settings, for example role and width. A role is required on every tab except envelopeIdTab. |
Using Modifiers
Tab modifiers define who owns a field, how it looks, and how it behaves. Modifiers are not case sensitive and can be placed in any order. Tokens work only on Event Speaker and Speaker Agreement templates, and field mapping works only with the Contract Partner object.
|
Modifier |
Location |
Description |
|---|---|---|
|
role |
All tabs except envelopeIdTab |
Assigns the tab to a signer using the Signer Role API name, for example speaker__v |
|
width |
Input tabs |
Sets the field width in pixels. Required on input tabs. Without a width modifier, the field is only a few pixels wide and the signer cannot select it. |
|
optional |
Input, signature, and initial tabs |
Set to true to allow the signer to skip the field. If not used, Signature and initial tabs are required. |
|
required |
checkboxTab |
Set to true to make selecting a check box required. Check boxes are optional by default. |
|
ehanko |
signHereTab |
Renders the signature as an eHanko stamp |
Rules for Every Token
- Tokens remain in the final PDF, however they must remain hidden from the signer and should not alter the layout. Two settings control this behavior:
- Font color - Hides the token. Set the token's font color to match the page background (usually white) so the signer cannot see it. This makes the token effectively invisible.
- Font size - Protects the layout. Set the token to a small font size so it does not wrap to a second line or stretch a table cell. It should be a size small enough to keep the whole token on one line; it does not need to be a specific value.
- Type the token as one continuous string. Do not build it from pieces and do not use spaces.
- Keep the whole token on a single line. A token that wraps to the next line is not discoverable by Docusign.
- Use one font for the entire token. If part of the token uses a different font, Word stores it in pieces and Docusign may fail to match it.
- Turn off auto-correct so that straight quotes and hyphens are not substituted for other characters
- Type tokens directly in Word. Do not paste a token from a PDF, email, or web page. The braces and other characters can be substituted for look-alike characters Docusign cannot match.
- Insert tokens in the body of the document or inside a table cell only. Do not use the header or footer as those repeat on every page. This causes the same token to display more than once and Docusign places a duplicate tab on each page.
- Each token must be unique (see following section)
Apply both settings (font color and font size) to the entire token, including the opening {{ and closing }}.
Making a Token Unique
Docusign inserts a tab at every spot that contains the token text. If two tokens are identical, both tabs are placed in the same location and stack on top of each other, stopping the signer from completing the tabs. If the same tab type for the same signer is required in two places, add an extra character to the end of one token so the two are no longer identical. The extra character does not change what the tab does.
Examples
First initials box:
{{DocusignTab:initialHereTab<contract_partner__v.signature__v>[role:speaker__v]}}
Second initials box (with an additional character added):
{{DocusignTab:initialHereTab<contract_partner__v.signature__v>[role:speaker__v]2}}
Creating Input Tabs as
Input tabs allow the signer to type a value into the contract. When signing is complete, the value is written back to the Vault CRM field named in the token.
Every input tab requires a width modifier. Without a width modifier, the field is only a few pixels wide and the signer cannot select it.
Recommended Widths
Use the following widths as starting points, in pixels:
- Names - 200
- Titles and institutions - 150
- Dates - 120
- Short codes and numbers - 100
- Anything shorter - 84
Examples
A text field for the signer's title, 150 wide, that the signer may skip:
{{DocusignTab:textTab<contract_partner__v.title__v>[role:speaker__v][width:150][optional:true]}}
A number field assigned to a second signer:
{{DocusignTab:numberTab<contract_partner__v.npi__v>[role:legal_reviewer__v][width:120]}}
A required checkbox:
{{DocusignTab:checkboxTab<contract_partner__v.agree__v>[role:speaker__v][required:true]}}
A field shown in Docusign that is not written back to Vault CRM (no field named):
{{DocusignTab:textTab[role:speaker__v][width:150]}}
Using Signature and System Tabs as
Signature and system tabs are filled by Docusign or by a signing action. Only the signature and initials write back to Vault CRM; the remaining tabs display on the contract only.
|
Tab Type |
Description |
|
|---|---|---|
|
signHereTab (See text and examples below) |
A signature line. The signer signs here. |
|
|
initialHereTab (See text and examples below) |
An initials box. The signer initials here. |
|
|
dateSignedTab |
The date and time the signer completed signing |
|
|
fullNameTab |
The signer's full name |
|
|
firstNameTab |
The signer's first name |
|
|
lastNameTab |
The signer's last name |
|
|
companyTab |
The signer's company |
|
|
titleTab |
The signer's title |
|
|
envelopeIdTab |
The Docusign envelope ID. No role required. |
|
For signHereTab and initialHereTab, the field named in the token receives the captured image. That field must be Long Text (32,000) on contract_partner__v. Do not set a width on these tabs; Docusign sizes them automatically. Docusign places the tab starting at the first character of the token. Because the token is set to a small font size, the first character takes up almost no space, and the tab displays to the right of the token. This is normal.
Examples
A speaker signature line:
{{DocusignTab:signHereTab<contract_partner__v.signature__v>[role:speaker__v]}}
An initials box:
{{DocusignTab:initialHereTab<contract_partner__v.signature__v>[role:speaker__v]}}
Troubleshooting System and Signature Tabs
|
What displays |
Check this |
|---|---|
|
The tab does not display in Docusign |
Ensure the token is a continuous string on a single line with no spaces, and the tab type is singular, for example signHereTab, not signHereTabs |
|
The tab does not display and the token looks correct |
The token probably contains a space, or part of it uses a different font. Retype the token in one font with no spaces. |
|
The token is visible on the signed contract |
The font color was not set to match the background across the whole token, including the braces. |
|
A table cell is stretched or text wraps oddly |
The token font size is too large. Make it smaller so the whole token fits on one line. |
|
The field is too narrow or too wide |
Add or adjust the width modifier. Width is not based on the length of the token. |
|
Two tabs stack in the same place |
Two tokens are identical. Add an extra character to the end of one so each token is unique. |
|
The value is not written back to Vault CRM |
The token has no <Object.Field> element, or the field is inactive or the wrong type. Tokens can only write back to fields on the contract_partner__v object. |
|
The tab went to the wrong signer |
The role is missing or does not match a Signer Role API name. |

