mirror of
https://github.com/documenso/documenso.git
synced 2025-11-10 04:22:32 +10:00
447 lines
19 KiB
Plaintext
447 lines
19 KiB
Plaintext
---
|
|
title: Document Fields
|
|
description: Learn about the different fields you can add to your documents in Documenso.
|
|
---
|
|
|
|
# Document Fields
|
|
|
|
Learn about the different fields you can add to your documents in Documenso and how to make the most of them.
|
|
|
|
## Signature Field
|
|
|
|
The signature field collects the signer's signature. It's required for each recipient with the "Signer" role.
|
|
|
|
### Document Editor View
|
|
|
|
The field doesn't have any additional settings. You just need to place it on the document where you want the signer to sign.
|
|
|
|
|
|
|
|
### Document Signing View
|
|
|
|
The recipient will see the signature field when they open the document to sign.
|
|
|
|
The recipient must click on the signature field to open the signing view, where they can sign using their mouse, touchpad, or touchscreen.
|
|
|
|
|
|
|
|
The image below shows the signature field signed by the recipient.
|
|
|
|
|
|
|
|
After signing, the recipient can click the "Complete" button to complete the signing process.
|
|
|
|
## Email Field
|
|
|
|
The email field is used to collect the signer's email address.
|
|
|
|
### Document Editor View
|
|
|
|
The field doesn't have any additional settings. You just need to place it on the document where you want the signer to sign.
|
|
|
|
|
|
|
|
### Document Signing View
|
|
|
|
When the recipient opens the document to sign, they will see the email field.
|
|
|
|
The recipient must click on the email field to automatically sign the field with the email associated with their account.
|
|
|
|
|
|
|
|
The image below shows the email field signed by the recipient.
|
|
|
|
|
|
|
|
After entering their email address, the recipient can click the "Complete" button to complete the signing process.
|
|
|
|
## Name Field
|
|
|
|
The name field is used to collect the signer's name.
|
|
|
|
### Document Editor View
|
|
|
|
The field doesn't have any additional settings. You just need to place it on the document where you want the signer to sign.
|
|
|
|
|
|
|
|
### Document Signing View
|
|
|
|
When the recipient opens the document to sign, they will see the name field.
|
|
|
|
The recipient must click on the name field, which will automatically sign the field with the name associated with their account.
|
|
|
|
|
|
|
|
The image below shows the name field signed by the recipient.
|
|
|
|
|
|
|
|
After entering their name, the recipient can click the "Complete" button to complete the signing process.
|
|
|
|
## Date Field
|
|
|
|
The date field is used to collect the date of the signature.
|
|
|
|
### Document Editor View
|
|
|
|
The field doesn't have any additional settings. You just need to place it on the document where you want the signer to sign.
|
|
|
|
|
|
|
|
### Document Signing View
|
|
|
|
When the recipient opens the document to sign, they will see the date field.
|
|
|
|
The recipient must click on the date field to automatically sign the field with the current date and time.
|
|
|
|
|
|
|
|
The image below shows the date field signed by the recipient.
|
|
|
|
|
|
|
|
After entering the date, the recipient can click the "Complete" button to complete the signing process.
|
|
|
|
## Text Field
|
|
|
|
The text field is used to collect text input from the signer.
|
|
|
|
### Document Editor View
|
|
|
|
Place the text field on the document where you want the signer to enter text. The text field comes with additional settings that can be configured.
|
|
|
|
|
|
|
|
To open the settings, click on the text field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
|
|
|
|
|
|
|
The text field settings include:
|
|
|
|
- **Label** - The label displayed in the field.
|
|
- **Placeholder** - The placeholder text displayed in the field.
|
|
- **Text** - The default text displayed in the field.
|
|
- **Character limit** - The maximum number of characters allowed in the field.
|
|
- **Required** - Whether the field is required or not.
|
|
- **Read only** - Whether the field is read-only or not.
|
|
|
|
It also comes with a couple of rules:
|
|
|
|
- The field can't be required and read-only at the same time.
|
|
- A read-only field can't have an empty text field. It must have a default text value.
|
|
- The signer must fill out a required field.
|
|
- The text field characters count can't exceed the character limit.
|
|
- The signer can't modify a read-only field.
|
|
- The field auto-signs if there is a default text value.
|
|
|
|
Let's look at the following example.
|
|
|
|
|
|
|
|
The field is configured as follows:
|
|
|
|
- Label: "Address"
|
|
- Placeholder: "Your office address"
|
|
- Default Text: "Signing Street 1, 241245"
|
|
- Character Limit: 35
|
|
- Required: False
|
|
- Read Only: False
|
|
|
|
Since the field has a label set, the label is displayed instead of the default text field value - "Add text".
|
|
|
|
### Document Signing View
|
|
|
|
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
|
|
|
In this case, the recipient sees the text field signed with the default value.
|
|
|
|
|
|
|
|
The recipient can modify the text field value since the field is not read-only. To change the value, the recipient must click the field to un-sign it.
|
|
|
|
Once it's unsigned, the field uses the label set by the sender.
|
|
|
|
|
|
|
|
To sign the field with a different value, the recipient needs to click on the field and enter the new value.
|
|
|
|
|
|
|
|
Since the text field has a character limit, the recipient must enter a value that doesn't exceed the limit. Otherwise, an error message will appear, and the field will not be signed.
|
|
|
|
The image below illustrates the text field signed with a new value.
|
|
|
|
|
|
|
|
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
|
|
|
## Number Field
|
|
|
|
The number field is used for collecting a number input from the signer.
|
|
|
|
### Document Editor View
|
|
|
|
Place the number field on the document where you want the signer to enter a number. The number field comes with additional settings that can be configured.
|
|
|
|
|
|
|
|
To open the settings, click on the number field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
|
|
|
|
|
|
|
The number field settings include:
|
|
|
|
- **Label** - The label displayed is the field.
|
|
- **Placeholder** - The placeholder text displayed in the field.
|
|
- **Value** - The default number displayed in the field.
|
|
- **Number format** - The format of the number.
|
|
- **Required** - Whether the field is required or not.
|
|
- **Read only** - Whether the field is read-only or not.
|
|
- **Validation** - The validation rules for the field.
|
|
|
|
It also comes with a couple of rules:
|
|
|
|
- The value must be a number.
|
|
- The field can't be required and read-only at the same time.
|
|
- A read-only field can't have an empty number field. It must have a default number value.
|
|
- The signer must fill out a required field.
|
|
- If the default number and a max value are set, the default number must be less than the max value.
|
|
- If the default number and a min value are set, the default number must be greater than the min value.
|
|
- The value must match the number format if a number format is set.
|
|
|
|
In this example, the number field is configured as follows:
|
|
|
|
- Label: "Quantity"
|
|
- Placeholder: "Enter the preferred quantity"
|
|
- Default Value: 12
|
|
- Number Format: "123,456,789.00"
|
|
- Required: False
|
|
- Read Only: False
|
|
- Validation:
|
|
- Min value: 5, Max value: 50
|
|
|
|
|
|
|
|
Since the field has a label set, the label is displayed instead of the default number field value - "Add number".
|
|
|
|
### Document Signing View
|
|
|
|
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
|
|
|
The recipient sees the number field signed with the default value in this case.
|
|
|
|
|
|
|
|
Since the number field is not read-only, the recipient can modify its value. To change the value, the recipient must click the field to un-sign it.
|
|
|
|
Once it's unsigned, the field uses the label set by the sender.
|
|
|
|
|
|
|
|
To sign the field with a different value, the recipient needs to click on the field and enter the new value.
|
|
|
|
|
|
|
|
Since the number field has a validation rule set, the recipient must enter a value that meets the rules. In this example, the value needs to be between 5 and 50. Otherwise, an error message will appear, and the field will not be signed.
|
|
|
|
The image below illustrates the text field signed with a new value.
|
|
|
|
|
|
|
|
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
|
|
|
## Radio Field
|
|
|
|
The radio field is used to collect a single choice from the signer.
|
|
|
|
### Document Editor View
|
|
|
|
Place the radio field on the document where you want the signer to select a choice. The radio field comes with additional settings that can be configured.
|
|
|
|
|
|
|
|
To open the settings, click on the radio field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
|
|
|
|
|
|
|
The radio field settings include:
|
|
|
|
- **Required** - Whether the field is required or not.
|
|
- **Read only** - Whether the field is read-only or not.
|
|
- **Values** - The list of choices for the field.
|
|
|
|
It also comes with a couple of rules:
|
|
|
|
- The field can't be required and read-only at the same time.
|
|
- A read-only field can't have an empty radio field. It must have at least one option.
|
|
- The signer must fill out a required field.
|
|
- The field auto-signs if there is a default value.
|
|
- The signer can't sign with a value not in the options list.
|
|
- The signer can't modify the field if it's read-only.
|
|
- It should contain at least one option.
|
|
- The field can't have more than one option selected.
|
|
|
|
In this example, the radio field is configured as follows:
|
|
|
|
- Required: False
|
|
- Read Only: False
|
|
- Options:
|
|
- Option 1
|
|
- Option 2
|
|
- Empty value
|
|
- Empty value
|
|
- Option 3
|
|
|
|
|
|
|
|
Since the field contains radio options, it displays them instead of the default radio field value, "Radio".
|
|
|
|
### Document Signing View
|
|
|
|
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
|
|
|
In this case, the recipient sees the radio field unsigned because the sender didn't select a value.
|
|
|
|
|
|
|
|
The recipient can select one of the options by clicking on the radio button next to the option.
|
|
|
|
|
|
|
|
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
|
|
|
## Checkbox Field
|
|
|
|
The checkbox field is used to collect multiple choices from the signer.
|
|
|
|
### Document Editor View
|
|
|
|
Place the checkbox field on the document where you want the signer to select choices. The checkbox field comes with additional settings that can be configured.
|
|
|
|
|
|
|
|
To open the settings, click on the checkbox field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
|
|
|
|
|
|
|
The checkbox field settings include the following:
|
|
|
|
- **Validation** - The validation rules for the field.
|
|
- **Rule** - The rule specifies "At least", "At most", and "Exactly".
|
|
- **Number** - The number of choices that must be selected.
|
|
- **Required** - Whether the field is required or not.
|
|
- **Read only** - Whether the field is read-only or not.
|
|
- **Options** - The list of choices for the field.
|
|
|
|
It also comes with a couple of rules:
|
|
|
|
- The field can't be required and read-only at the same time.
|
|
- A read-only field can't have an empty checkbox field. It must have at least one checked option.
|
|
- The signer must fill out a required field.
|
|
- The field auto-signs if there is a default value.
|
|
- The signer can't sign with a value not in the options list.
|
|
- The signer can't modify the field if it's read-only.
|
|
- It should contain at least one option.
|
|
|
|
In this example, the checkbox field is configured as follows:
|
|
|
|
- No validation rules
|
|
- Required: True
|
|
- Read Only: False
|
|
- Options:
|
|
- Option 1
|
|
- Empty value (checked)
|
|
- Option 2
|
|
- Option 3 (checked)
|
|
- Empty value
|
|
|
|
|
|
|
|
Since the field contains checkbox options, it displays them instead of the default checkbox field value, "Checkbox".
|
|
|
|
### Document Signing View
|
|
|
|
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
|
|
|
In this case, the recipient sees the checkbox field signed with the values selected by the sender.
|
|
|
|
|
|
|
|
Since the field is required, the recipient can either sign with the values selected by the sender or modify the values.
|
|
|
|
The values can be modified in 2 ways:
|
|
|
|
- Click on the options you want to select or deselect.
|
|
- Hover over the field and click the "X" button to clear all the selected values.
|
|
|
|
The image below illustrates the checkbox field with the values cleared by the recipient. Since the field is required, it has a red border instead of the yellow one (non-required fields).
|
|
|
|
|
|
|
|
Then, the recipient can select values other than the ones chosen by the sender.
|
|
|
|
|
|
|
|
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
|
|
|
## Dropdown/Select Field
|
|
|
|
The dropdown/select field collects a single choice from a list of options.
|
|
|
|
### Document Editor View
|
|
|
|
Place the dropdown/select field on the document where you want the signer to select a choice. The dropdown/select field comes with additional settings that can be configured.
|
|
|
|
|
|
|
|
To open the settings, click on the dropdown/select field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
|
|
|
|
|
|
|
The dropdown/select field settings include:
|
|
|
|
- **Required** - Whether the field is required or not.
|
|
- **Read only** - Whether the field is read-only or not.
|
|
- **Options** - The list of choices for the field.
|
|
- **Default** value - The default value selected in the field.
|
|
|
|
It also comes with a couple of rules:
|
|
|
|
- The field can't be required and read-only at the same time.
|
|
- A read-only field can't have an empty select field. It must have a default value.
|
|
- The signer must fill out a required field.
|
|
- The default value must be one of the options.
|
|
- The field auto-signs if there is a default value.
|
|
- The field can't be signed with a value not in the options list.
|
|
- The signer can't modify the field if it's read-only.
|
|
- It should contain at least one option.
|
|
|
|
In this example, the dropdown/select field is configured as follows:
|
|
|
|
- Required: False
|
|
- Read Only: False
|
|
- Default Value: None
|
|
- Options:
|
|
- Document
|
|
- Template
|
|
- Other
|
|
|
|
### Document Signing View
|
|
|
|
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
|
|
|
In this case, the recipient sees the dropdown/select field with the default label, "-- Select ---" since the sender has not set a default value.
|
|
|
|
|
|
|
|
The recipient can modify the dropdown/select field value since the field is not read-only. To change the value, the recipient must click on the field for the dropdown list to appear.
|
|
|
|
|
|
|
|
The recipient can select one of the options from the list. The image below illustrates the dropdown/select field signed with a new value.
|
|
|
|
|
|
|
|
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|