[IMP] sign: additional features/info

task-5462047

closes odoo/documentation#16381

Signed-off-by: Anne-Françoise Marcq (afma) <afma@odoo.com>
This commit is contained in:
Audrey (auva)
2026-01-27 13:55:13 +01:00
parent e9ddd5a968
commit 66c23246b1
7 changed files with 222 additions and 149 deletions

View File

@@ -24,21 +24,21 @@ meet the requirements for electronic signatures in most countries.
With Sign, you can:
- :ref:`prepare documents for signing <sign/prepare-document>` by one or more signers using
- :ref:`prepare documents for signing <sign/request-signatures/prepare-document>` by one or more signers using
drag-and-drop fields
- send :ref:`one-off documents for signing <sign/request-signatures/one-off>` from the Sign app
or from an Odoo record
- create and use :ref:`templates <sign/request-signatures/templates>` to
send frequently used documents for signing from the Sign app or from an Odoo record
- create :ref:`document envelopes <sign/prepare-document/create-envelope>` to send multiple
- create :ref:`document envelopes <sign/request-signatures/create-envelope>` to send multiple
documents in a single signature request or sign multiple documents at the same time
- :ref:`sign documents that have been prepared using Odoo Sign
<sign/sign-document/signature-request>`
- :ref:`sign non-prepared documents <sign/sign-document/pdf-document>` from the Sign app, from
the chatter of an Odoo record, or from the :doc:`Documents <documents>` app
- configure :ref:`auto-complete fields <sign/fields/auto-fill>` that populate with data from your
- configure :ref:`auto-complete fields <sign/configuration/auto-fill>` that populate with data from your
database during signing
- define :ref:`advanced configuration for signers <sign/prepare-document/signer-settings>` to
- define :ref:`advanced configuration for signers <sign/request-signatures/signer-settings>` to
require authentication (via SMS, Aadhaar eSign, or itsme®), allow delegation, or, for templates,
assign a fixed signer

View File

@@ -58,8 +58,8 @@ To add default terms and conditions to signature requests:
.. note::
It is also possible to manually attach files, such as terms and conditions, when
:ref:`configuring a signature request <sign/configure-signature-request>`. For :ref:`templates
<sign/request-signatures/templates>`, files can be attached by default in the
:ref:`configuring a signature request <sign/request-signatures/configure-request>`. For
:ref:`templates <sign/request-signatures/templates>`, files can be attached by default in the
:guilabel:`Communication` section of the template :guilabel:`Configuration` when creating or
editing the template.
@@ -68,11 +68,12 @@ To add default terms and conditions to signature requests:
Fields
======
Fields are :ref:`added to documents <sign/prepare-document/add-fields>` to indicate what information
must be completed by the signers. Various fields are available by default. These fields can be
:ref:`edited and additional fields can be created <sign/fields/create-edit-fields>` if needed.
Fields are :ref:`added to documents <sign/request-signatures/add-fields>` to indicate what
information must be completed by the signers. Various fields are available by default. These fields
can be :ref:`edited and additional fields can be created <sign/configuration/create-edit-fields>`
if needed.
.. _sign/fields/create-edit-fields:
.. _sign/configuration/create-edit-fields:
Create and edit fields
----------------------
@@ -84,9 +85,10 @@ To create or edit a field:
#. Complete or edit the following fields:
- :guilabel:`Field Name`: Enter or edit the field name. This is visible in the list of fields in
the left panel when a document is being :ref:`prepared for signature <sign/prepare-document>`.
- :guilabel:`Type`: Choose the relevant :ref:`field type <sign/fields/field-types>` from the
dropdown; there are nine possible field types.
the left panel when a document is being :ref:`prepared for signature
<sign/request-signatures/prepare-document>`.
- :guilabel:`Type`: Choose the relevant :ref:`field type <sign/configuration/field-types>` from
the dropdown; there are nine possible field types.
- :guilabel:`Placeholder`: Optionally, specify a placeholder text that provides the signer with a
hint or example :ref:`during the signing process <sign/sign-document/signature-request>`. If
this field is left blank, the :guilabel:`Field Name` is used as placeholder text.
@@ -98,13 +100,13 @@ To create or edit a field:
.. note::
The size of any field can be modified manually when :ref:`adding the field to a document
<sign/prepare-document/add-fields>`.
<sign/request-signatures/add-fields>`.
- For :guilabel:`Text` and :guilabel:`Multiline Text` fields only, optionally use the
:guilabel:`Linked to` field to :ref:`configure auto-completion <sign/fields/auto-fill>` so the
field can be auto-completed during the signing process.
:guilabel:`Linked to` field to :ref:`configure auto-completion <sign/configuration/auto-fill>`
so the field can be auto-completed during the signing process.
.. _sign/fields/field-types:
.. _sign/configuration/field-types:
Field types
~~~~~~~~~~~
@@ -117,21 +119,21 @@ Field types
field.
- :guilabel:`Text` and :guilabel:`Multiline Text`: Signers can enter text on a single line or on
multiple lines, respectively. These field types can be :ref:`configured to be auto-completed
<sign/fields/auto-fill>` during the signing process.
<sign/configuration/auto-fill>` during the signing process.
- :guilabel:`Checkbox`: Signers can tick a box (e.g., to confirm they accept the terms and
conditions).
- :guilabel:`Radio`: Signers can select a single option from a series of options (defined when the
field is :ref:`added to the document <sign/prepare-document/add-fields>`) by clicking the radio
field is :ref:`added to the document <sign/request-signatures/add-fields>`) by clicking the radio
button beside the desired option.
- :guilabel:`Selection`: Signers can select a single option from a series of options (defined when
the field is :ref:`added to the document <sign/prepare-document/add-fields>`) via a dropdown
the field is :ref:`added to the document <sign/request-signatures/add-fields>`) via a dropdown
menu.
- :guilabel:`Strikethrough`: Signers can reject certain phrases by clicking the strikethrough field,
which adds a visible line through the text.
- :guilabel:`Stamp`: Signers can add a company stamp (defined when the
field is :ref:`added to the document <sign/prepare-document/add-fields>`).
field is :ref:`added to the document <sign/request-signatures/add-fields>`).
.. _sign/fields/auto-fill:
.. _sign/configuration/auto-fill:
Configure auto-complete fields
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -9,11 +9,11 @@ Via the Odoo Sign app or directly from an Odoo record, you can:
- :ref:`use templates <sign/request-signatures/templates>` to request the signature of one or more
signers on frequently used documents
Once a document or :ref:`document envelope <sign/prepare-document/create-envelope>` has been fully
Once a document or :ref:`document envelope <sign/request-signatures/create-envelope>` has been fully
signed, i.e., completed and signed by all signers, the signed document(s) and the :ref:`certificate
of completion <sign/security/certificate-of-completion>` are sent via email to the requestor, and to
any contacts added in :guilabel:`CC` when the signature request was :ref:`configured
<sign/configure-signature-request>`.
<sign/request-signatures/configure-request>`.
.. _sign/request-signatures/one-off:
@@ -26,7 +26,7 @@ From the Sign app
-----------------
To request the signature of a one-off document or :ref:`document envelope
<sign/prepare-document/create-envelope>` from the Sign app:
<sign/request-signatures/create-envelope>` from the Sign app:
#. Go to :menuselection:`Sign --> Documents --> My Documents` or :menuselection:`--> All Documents`,
click :guilabel:`Upload PDF`, then select and open the relevant `.pdf` document(s).
@@ -37,13 +37,13 @@ To request the signature of a one-off document or :ref:`document envelope
.. tip::
If you are creating a document envelope that includes one document saved in the Documents app,
import that document *before* :ref:`adding subsequent documents
<sign/prepare-document/create-envelope>`.
<sign/request-signatures/create-envelope>`.
#. :ref:`Prepare the document(s) for signing <sign/prepare-document>` by adding the relevant
fields; add additional signers and/or documents, if relevant.
#. :ref:`Prepare the document(s) for signing <sign/request-signatures/prepare-document>` by
adding the relevant fields; add additional signers and/or documents, if relevant.
#. Click :guilabel:`Send`.
#. Complete the relevant fields of the :ref:`New Signature Request
<sign/configure-signature-request>` window.
<sign/request-signatures/configure-request>` window.
#. If you are:
- one of the signers and you are ready to sign the document directly, click :guilabel:`Sign Now`,
@@ -57,17 +57,17 @@ From an Odoo record
-------------------
To request the signature of a one-off document or :ref:`document envelope
<sign/prepare-document/create-envelope>` from an Odoo record:
<sign/request-signatures/create-envelope>` from an Odoo record:
#. With the relevant record open, click the :icon:`fa-cog` :guilabel:`(Actions)` icon in the
upper-left corner, then :icon:`fa-file-text` :guilabel:`Request Signature`.
#. In the :guilabel:`New Signature Request` window, click :guilabel:`Upload PDF`, select the
relevant `.pdf` document(s), then click :guilabel:`Open`.
#. :ref:`Prepare the document(s) for signing <sign/prepare-document>` by adding the relevant
fields; add additional signers and/or documents, if relevant.
#. :ref:`Prepare the document(s) for signing <sign/request-signatures/prepare-document>` by adding
the relevant fields; add additional signers and/or documents, if relevant.
#. Click :guilabel:`Send`.
#. Complete the relevant fields of the :ref:`New Signature Request
<sign/configure-signature-request>` window.
<sign/request-signatures/configure-request>` window.
.. note::
When sending a signature request from an Odoo record, the related customer (or the relevant
@@ -81,7 +81,7 @@ To request the signature of a one-off document or :ref:`document envelope
*after* other signers, click :guilabel:`Send`.
.. note::
Once a document or :ref:`document envelope <sign/prepare-document/create-envelope>` has been
Once a document or :ref:`document envelope <sign/request-signatures/create-envelope>` has been
fully signed, the signed document(s) and the certificate of completion are also added to the
record's chatter.
@@ -91,11 +91,11 @@ Templates
=========
When the same single document or :ref:`envelope of multiple documents
<sign/prepare-document/create-envelope>` needs to be used regularly, creating and using a template
<sign/request-signatures/create-envelope>` needs to be used regularly, creating and using a template
can save time and streamline the workflow. Templates are prepared for signing in the same way as
one-off documents, by adding the necessary fields, signers, documents, and tags, as relevant.
.. _sign/templates/create:
.. _sign/request-signatures/create-template:
Create a template
-----------------
@@ -110,13 +110,14 @@ To create a template:
.. tip::
If you need to upload multiple documents, i.e., create a :ref:`document envelope
<sign/prepare-document/create-envelope>`, and one of the documents is saved in the Documents
<sign/request-signatures/create-envelope>`, and one of the documents is saved in the Documents
app, import that document *before* :ref:`adding subsequent documents
<sign/prepare-document/create-envelope>`.
<sign/request-signatures/create-envelope>`.
Once you have created the template, you can start :ref:`editing it <sign/templates/edit>`.
Once you have created the template, you can start :ref:`editing it
<sign/request-signatures/edit-template>`.
.. _sign/templates/edit:
.. _sign/request-signatures/edit-template:
Edit a template
---------------
@@ -139,24 +140,24 @@ open it. Alternatively, hover over the template, click the :icon:`fa-ellipsis-v`
Edit the template:
- :ref:`Prepare the document(s) for signing <sign/prepare-document>` by adding or editing fields,
and, if relevant, adding or removing signers and/or documents.
- :ref:`Prepare the document(s) for signing <sign/request-signatures/prepare-document>` by adding
or editing fields, and, if relevant, adding or removing signers and/or documents.
- Optionally, :ref:`define or edit settings for specific signers
<sign/prepare-document/signer-settings>`, such as requiring additional authentication, allowing a
signer to delegate signing, or assigning a fixed signer.
<sign/request-signatures/signer-settings>`, such as requiring additional authentication, allowing a
signer to be replaced, or assigning a fixed signer.
- Optionally, define or edit general settings for the template by clicking the :icon:`fa-cog`
:guilabel:`(cog)` icon beside the template name, then clicking :icon:`fa-cog`
:menuselection:`Configuration`:
- By default, the **name of the template** is the name of the document that was uploaded, or, in
the case of a :ref:`document envelope <sign/prepare-document/create-envelope>`, the name of the
first document uploaded. If desired, edit the name of the template.
the case of a :ref:`document envelope <sign/request-signatures/create-envelope>`, the name of
the first document uploaded. If desired, edit the name of the template.
- :guilabel:`Tags`: Add :ref:`tags <sign/configuration/tags>` to categorize the
template.
- :guilabel:`Model`: Select the :doc:`Odoo model <../../studio/models_modules_apps>` to which the
template is linked to restrict the template to :ref:`signatures requests made from records of
that model <sign/templates/use-odoo-record>`. Leave the field empty to make the template
available from any model.
that model <sign/request-signatures/template-odoo-record>`. Leave the field empty to make the
template available from any model.
- :guilabel:`Redirect Link`: Add a url to which the user is redirected after signing the document,
e.g., to a *Thank you* page, or to your company's homepage.
- :guilabel:`Documents folder`: Define in which :ref:`folder in the Documents app
@@ -170,7 +171,7 @@ Edit the template:
.. note::
The validity date of a signature request can always be modified when :ref:`configuring the
signature request <sign/configure-signature-request>`.
signature request <sign/request-signatures/configure-request>`.
- In the :guilabel:`Communication` tab, type a default text that will be added when a signature
request using this template is sent via email; the text can still be edited before sending.
@@ -187,16 +188,16 @@ Edit the template:
- :guilabel:`Responsible` user: By default, this is set to the user who created the template,
but a different user can be selected.
.. _sign/templates/use:
.. _sign/request-signatures/use-template:
Use templates
-------------
Templates can be used when initiating a signature request :ref:`from the Sign app
<sign/templates/use-sign-app>` or directly :ref:`from an Odoo record
<sign/templates/use-odoo-record>`.
<sign/request-signatures/template-sign-app>` or directly :ref:`from an Odoo record
<sign/request-signatures/template-odoo-record>`.
.. _sign/templates/use-sign-app:
.. _sign/request-signatures/template-sign-app:
From the Sign app
~~~~~~~~~~~~~~~~~
@@ -219,7 +220,7 @@ To send a signature request using a template to one or more specific signers fro
#. From the Kanban or list view, click :guilabel:`Send` on the line of the relevant template.
Alternatively, from the Kanban view, click on a template to open it, then click :guilabel:`Send`.
#. Complete the relevant fields of the :ref:`New Signature Request
<sign/configure-signature-request>` window.
<sign/request-signatures/configure-request>` window.
#. If you are:
- one of the signers and you are ready to sign the document directly, click :guilabel:`Sign Now`,
@@ -246,7 +247,7 @@ To copy a link to a templated document or document envelope:
:guilabel:`(vertical ellipsis)` icon in the top-right corner of the card, then click
:guilabel:`Stop sharing`.
.. _sign/templates/use-odoo-record:
.. _sign/request-signatures/template-odoo-record:
From an Odoo record
~~~~~~~~~~~~~~~~~~~
@@ -258,7 +259,7 @@ To send a signature request using a template from an Odoo record:
#. In the :guilabel:`New Signature Request` window, select the relevant :guilabel:`Template` from
the dropdown.
#. Complete the relevant fields of the :ref:`New Signature Request
<sign/configure-signature-request>` window.
<sign/request-signatures/configure-request>` window.
#. If you are:
- one of the signers and you are ready to sign the document directly, click :guilabel:`Sign Now`,
@@ -271,11 +272,11 @@ To send a signature request using a template from an Odoo record:
selected, as well as templates that are not linked to any model.
- When sending a signature request from an Odoo record, the related customer (or the relevant
party) is automatically added as a signer.
- Once a document or :ref:`document envelope <sign/prepare-document/create-envelope>` has been
- Once a document or :ref:`document envelope <sign/request-signatures/create-envelope>` has been
fully signed, the signed document(s) and the certificate of completion are also added to the
record's chatter.
.. _sign/templates/manage:
.. _sign/request-signatures/manage-templates:
Manage templates
----------------
@@ -311,29 +312,29 @@ For each template, the following information is shown:
Hovering over the template's card reveals a :icon:`fa-ellipsis-v` :guilabel:`(vertical ellipsis)`
icon in the top-right corner. Click the icon to:
- :ref:`Edit a template <sign/templates/edit>` that has *not yet been used* to send a signature
- :ref:`Edit a template <sign/request-signatures/edit-template>` that has *not yet been used* to send a signature
request. Alternatively, click on a template to open it for editing.
- :guilabel:`Duplicate` a template. The duplicated template can then be
:ref:`edited <sign/templates/edit>` as needed.
:ref:`edited <sign/request-signatures/edit-template>` as needed.
- :guilabel:`Archive` a template that is not currently needed.
- Select a :guilabel:`Color` to add a colored bar to the left side of a card to visually
differentiate it.
.. _sign/prepare-document:
.. _sign/request-signatures/prepare-document:
Prepare a document for signing
==============================
To prepare any document for signing, :ref:`add the relevant fields
<sign/prepare-document/add-fields>` for each signer.
<sign/request-signatures/add-fields>` for each signer.
It is also possible to:
- :ref:`add additional documents <sign/prepare-document/create-envelope>`
- :ref:`configure and add signers <sign/prepare-document/signers>`
- :ref:`add tags <sign/prepare-document/add-tags>`
- :ref:`add additional documents <sign/request-signatures/create-envelope>`
- :ref:`configure and add signers <sign/request-signatures/signers>`
- :ref:`add tags <sign/request-signatures/add-tags>`
.. _sign/prepare-document/add-fields:
.. _sign/request-signatures/add-fields:
Add fields to a document
------------------------
@@ -343,9 +344,9 @@ the document.
.. note::
Various fields are available by default. These fields can be :ref:`edited and additional fields
can be created <sign/fields/create-edit-fields>` if needed.
can be created <sign/configuration/create-edit-fields>` if needed.
Fields of the following :ref:`field types <sign/fields/field-types>` require some additional
Fields of the following :ref:`field types <sign/configuration/field-types>` require some additional
configuration when they are added to a document:
- :guilabel:`Initial`: When this field is added to a multi-page document, a pop-up message asks if
@@ -375,20 +376,20 @@ Once a field has been added, it is possible to:
- **Modify certain attributes of the field**: Click on the field to open it, make the necessary
changes, then click :guilabel:`Save`.
Depending on the :ref:`field type <sign/fields/field-types>`, attributes that can be modified
include:
Depending on the :ref:`field type <sign/configuration/field-types>`, attributes that can be
modified include:
- the :guilabel:`Placeholder` text, i.e., the temporary text the signer sees before starting to
complete the field
- whether or not a field is a :guilabel:`Mandatory field`
- whether or not a field that is :ref:`configured to be auto-completed
<sign/fields/auto-fill>` is :guilabel:`Read-only`
<sign/configuration/auto-fill>` is :guilabel:`Read-only`
- the horizontal alignment of the text within the field
.. note::
Any changes made to the attributes of a field after adding the field to a document apply *to
the current document only*. To make permanent changes to the field, :ref:`edit the field
<sign/fields/create-edit-fields>`.
<sign/configuration/create-edit-fields>`.
- **Remove a field**: Click on the field to open it, then click :icon:`fa-trash` :guilabel:`(remove)`
to remove the field from the document.
@@ -408,7 +409,7 @@ Once a field has been added, it is possible to:
your cursor where you want to paste the fields, then use your regular keyboard shortcut to
paste them.
.. _sign/prepare-document/create-envelope:
.. _sign/request-signatures/create-envelope:
Document envelopes
------------------
@@ -442,16 +443,16 @@ To add one or more documents *after* the initial file upload:
.. image:: request_signatures/multiple-documents.png
:alt: Document envelope with two documents
.. _sign/prepare-document/signers:
.. _sign/request-signatures/signers:
Add and configure signers
-------------------------
By default, a document or document envelope has one signer. Additional :ref:`signers can be added
<sign/prepare-document/add-signers>` and :ref:`advanced configuration can be defined
<sign/prepare-document/signer-settings>` for one or more signers.
<sign/request-signatures/add-signers>` and :ref:`advanced configuration can be defined
<sign/request-signatures/signer-settings>` for one or more signers.
.. _sign/prepare-document/add-signers:
.. _sign/request-signatures/add-signers:
Add signers
~~~~~~~~~~~
@@ -471,25 +472,23 @@ To add additional signers to a document or document envelope:
the same background color.
- When a document or document envelope has multiple signers, it is possible to define the
order in which signers receive and sign when :ref:`configuring the signature request
<sign/configure-signature-request>`.
<sign/request-signatures/configure-request>`.
.. _sign/prepare-document/signer-settings:
.. _sign/request-signatures/signer-settings:
Signer settings
~~~~~~~~~~~~~~~
To define additional configuration for signers, click the :icon:`fa-ellipsis-v` :guilabel:`(vertical
ellipsis)` icon on the row of the signer.
For each signer, the following options are available:
ellipsis)` icon on the row of the signer. For each signer, the following options are available:
- :guilabel:`Authentication`: Require the signer to :ref:`authenticate using a specific
authentication method <sign/security/authentication>`.
- :guilabel:`Can delegate`: Enable this option to allow the signer to delegate signing to another
person. The person to whom signing is delegated then signs the document in their own name.
- :guilabel:`Can delegate`: Allow :ref:`the signer to be replaced
<sign/request-signatures/change-signers>` after the signature request has been sent.
- :guilabel:`Assign to`: Assign a specific contact as signer by selecting them from the dropdown.
.. _sign/prepare-document/add-tags:
.. _sign/request-signatures/add-tags:
Add tags
--------
@@ -499,26 +498,30 @@ signature request*, select the relevant tags from the :guilabel:`Tags` dropdown
corner above the document.
Tags can also be added to, or removed from, a document :ref:`after a signature request has been sent
<sign/request-signatures/manage-update-tags>`.
<sign/request-signatures/manage-form>`.
.. _sign/configure-signature-request:
.. _sign/request-signatures/configure-request:
Configure the signature request
===============================
After :ref:`preparing a one-off document or document envelope for signing <sign/prepare-document>`
or selecting a template, click :guilabel:`Send`, then configure the signature request in the
:guilabel:`New Signature Request` window.
After :ref:`preparing a one-off document or document envelope for signing
<sign/request-signatures/prepare-document>` or selecting a template, click :guilabel:`Send`, then
configure the signature request in the :guilabel:`New Signature Request` window.
For each signer, select a contact or type an email address. Optionally, enable :ref:`Signing Order
<sign/configure-request/signing-order>` to control the order in which the document or document
<sign/request-signatures/signing-order>` to control the order in which the document or document
envelope is signed.
.. tip::
A signer's email address can be :ref:`modified after the signature request has been sent
<sign/request-signatures/change-signers>` if needed.
It is also possible to:
- :ref:`set a Valid Until date <sign/configure-request/validity>` after which the signature request
- :ref:`set a Valid Until date <sign/request-signatures/validity>` after which the signature request
expires
- :ref:`set Reminders <sign/configure-request/validity>` to be sent at fixed intervals
- :ref:`set Reminders <sign/request-signatures/validity>` to be sent at fixed intervals
- enable :guilabel:`Add certificate on each page` to add the reference of the :ref:`certificate of
completion <sign/security/certificate-of-completion>` to each page of the document(s)
- have one or more parties notified when the document is fully signed by adding the relevant
@@ -536,7 +539,7 @@ It is also possible to:
Documents app icon
- schedule the sending of the signature request via the :icon:`fa-clock-o` :guilabel:`(clock)` icon
.. _sign/configure-request/signing-order:
.. _sign/request-signatures/signing-order:
Signing order
-------------
@@ -563,7 +566,7 @@ receives the request only once the previous recipient has signed the document.
:alt: Configuring signing order by editing the signer number
:scale: 80%
.. _sign/configure-request/validity:
.. _sign/request-signatures/validity:
Validity dates and reminders
----------------------------
@@ -591,55 +594,101 @@ Manage signature requests and signed documents
==============================================
All signature requests that have been sent are visible in :menuselection:`Sign --> Documents --> All
Documents`. The list view and Kanban view offer different possiblities:
Documents`. The list view and Kanban view offer different possibilities:
In the list view:
- see the overall :guilabel:`Status` of the signature request, e.g., :guilabel:`To Sign`,
:guilabel:`Signed`, :guilabel:`Cancelled`
- :icon:`fa-refresh` :guilabel:`Resend` a signature request manually
- :icon:`fa-pencil-square-o` :guilabel:`Sign` a document or document envelope
- :icon:`fa-download` :guilabel:`Download` the fully signed document(s)
- for a cancelled signature request, click :icon:`fa-info` :guilabel:`Details` to see the details of
the cancelled request
- See the overall :guilabel:`Status` of the signature request, e.g., :guilabel:`To Sign`,
:guilabel:`Signed`, :guilabel:`Cancelled`.
- :icon:`fa-refresh` :guilabel:`Resend` a signature request manually.
- :icon:`fa-pencil-square-o` :guilabel:`Sign` a document or document envelope.
- :icon:`fa-download` :guilabel:`Download` the fully signed document(s).
- For a cancelled signature request, click :icon:`fa-info` :guilabel:`Details` to see the
:ref:`details <sign/request-signatures/manage-form>` of the request.
.. tip::
Click the :icon:`oi-settings-adjust` :guilabel:`(slider)` icon in the upper-right corner to see
more information for each request, such as each document included, tags, and, in the case of
documents sent using a template, the :doc:`Odoo model <../../studio/models_modules_apps>` the
template is linked to.
requests sent from an :ref:`Odoo record <sign/request-signatures/one-off-record>`, the linked
record.
.. _sign/request-signatures/manage-kanban:
In the Kanban view:
- see the status of individual signers, per signature request:
- See the status of individual signers, per signature request:
- when a signer has fully signed the document(s), the checkbox is ticked, the signer's name
appears in green, and the date of the signature is added after the name
- when a signature request is cancelled, the signers name appears in red with a :icon:`fa-times`
:guilabel:`(cross)` beside it, followed by the date on which the signature request was cancelled
- see any tags added to the document(s)
- click the :icon:`fa-clock-o` :guilabel:`(clock)` icon to schedule an activity related to the
signature request
- click the :icon:`fa-ellipsis-v` :guilabel:`(vertical ellipsis)` icon in the top-right of the card
- When a signer has fully signed the document(s), the checkbox is ticked, the signer's name
appears in green, and the date of the signature is added after the name.
- When a signature request is cancelled, the signers name appears in red with a :icon:`fa-times`
:guilabel:`(cross)` beside it, followed by the date on which the signature request was
cancelled.
- See any tags added to the document(s).
- Click the :icon:`fa-clock-o` :guilabel:`(clock)` icon to schedule an activity related to the
signature request.
- Click the :icon:`fa-ellipsis-v` :guilabel:`(vertical ellipsis)` icon in the top-right of the card
to reveal more options:
- see the :guilabel:`Details` of the signature request, including the expiry date, if relevant,
whether or not reminders have been set, activity logs, and more
- :guilabel:`Cancel` a signature request that *has not been* fully signed
- :guilabel:`Archive` a signature request
- select a color dot to add a a colored bar to the left side of a card to visually differentiate
it
- See the signature request's :ref:`Details <sign/request-signatures/manage-form>`.
- :guilabel:`Cancel` a signature request that *has not been* fully signed.
- :guilabel:`Archive` a signature request.
- Select a color dot to add a colored bar to the left side of a card to visually differentiate
it.
.. _sign/request-signatures/manage-update-tags:
.. _sign/request-signatures/manage-form:
Update the tags of a sent or signed document
--------------------------------------------
Signature request details
-------------------------
To add tags to, or remove tags from, a document or document envelope for which a signature request
has already been sent:
To view the details of a signature request, go to :menuselection:`Sign --> Documents --> All
Documents`, switch to the Kanban view, click the :icon:`fa-ellipsis-v` :guilabel:`(vertical
ellipsis)` icon on the relevant signature request's card, and select :guilabel:`Details`.
#. Go to :menuselection:`Sign --> Documents --> All Documents`, then switch to the Kanban view.
#. Hover over the relevant card, click the :icon:`fa-ellipsis-v` :guilabel:`(vertical ellipsis)` in
the top-right corner of the card, then click :guilabel:`Details`.
#. Beside the :guilabel:`Tags` field, add new tags by selecting them from the dropdown or delete
tags by clicking the :icon:`fa-times` :guilabel:`(cross)` on the tag.
Using the buttons at the top of the form, you can:
- :guilabel:`Preview` the document.
- :guilabel:`Download` the document and, if available, its :ref:`certificate of completion
<sign/security/certificate-of-completion>`.
- :guilabel:`Cancel` the signature request if it has not been fully signed.
The following information is available on the form:
.. note::
Fully signed signature requests cannot be edited, except for their tags and the linked Odoo
model and record, if applicable.
- The overall :guilabel:`Status` of the signature request, i.e., :guilabel:`To Sign`,
:guilabel:`Signed`, or :guilabel:`Cancelled`
- :guilabel:`Tags`: any :ref:`tags <sign/configuration/tags>` added to the signature request
- :guilabel:`Valid until`: the :ref:`expiration date <sign/request-signatures/validity>` of the
signature request
- :guilabel:`Reminder`: the :ref:`reminder settings <sign/request-signatures/validity>` of
the signature request
- :guilabel:`Linked to`: the Odoo model and :ref:`record <sign/request-signatures/one-off-record>`
linked to the signature request, if applicable.
- :guilabel:`Signers`: the list of signers, including their :guilabel:`Role` (i.e., the name given
to the signer when the document was being :ref:`prepared for signing
<sign/request-signatures/add-signers>`; by default, `Signer 1`, `Signer 2`, etc.), email
address, and signature status. Click :guilabel:`Resend` to manually resend the request to a signer.
- :guilabel:`Contacts in copy`: contacts added in the :guilabel:`CC` field when the signature
request was created
- :guilabel:`Activity Logs`: a complete log of actions performed on the signature request, such as
its creation, views, downloads, signatures, or :ref:`refusals <sign/sign-document/decline>`.
.. _sign/request-signatures/change-signers:
Replace a signer or update a signer's email address
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A signer can be replaced if the :guilabel:`Can delegate` option was :ref:`enabled for that signer
<sign/request-signatures/signer-settings>` when the document was being prepared for signing. To
replace a signer, click their name in the :guilabel:`Signers` tab, then click the name again
and select the new signer.
To update a signer's email address, click the signer's name twice or, if the
:guilabel:`Can delegate` option was enabled for the signer, click the name, then click the
:icon:`fa-arrow-right` :guilabel:`(Internal Link)` icon next to it and update the email address in
the contact form.
The signature request is automatically sent to the new signer or email address upon saving or
navigating away from the signature request or contact form.

View File

@@ -6,7 +6,7 @@ Various security features are integrated into Odoo Sign by default, such as:
- :ref:`email verification <sign/security/authentication>`, whereby the signer receives a unique
link to the document or :ref:`envelope of multiple documents
<sign/prepare-document/create-envelope>` via an email sent directly to their email address
<sign/request-signatures/create-envelope>` via an email sent directly to their email address
- a :ref:`signatory hash <sign/security/hash>` that links the signer's identity to the exact content
of the document at the moment of signing
- a :ref:`certificate of completion <sign/security/certificate-of-completion>` that provides
@@ -56,8 +56,8 @@ fully signed document(s).
When documents are :doc:`signed via an Odoo record's chatter <sign_document>`, or when a
signature request initiated from an Odoo record is fully completed (whether a :ref:`one-off
document <sign/request-signatures/one-off-record>` or :ref:`using a template
<sign/templates/use-odoo-record>`), the certificate of completion is also added to the chatter,
along with the fully signed document(s).
<sign/request-signatures/template-odoo-record>`), the certificate of completion is also added to
the chatter, along with the fully signed document(s).
This certificate contains details of the signing process that support the validity of the signatures
and provide proof that the document has not been altered after signing.

View File

@@ -5,7 +5,7 @@ Sign a document
Depending on the situation, you may need to sign:
- a single document or :ref:`envelope of multiple documents
<sign/prepare-document/create-envelope>` that you or another person :ref:`prepared for electronic
<sign/request-signatures/create-envelope>` that you or another person :ref:`prepared for electronic
signature using Odoo Sign <sign/sign-document/signature-request>`; or
- one or more `.pdf` documents that have :ref:`not been prepared for electronic signature
<sign/sign-document/pdf-document>` by the sender
@@ -49,7 +49,7 @@ To sign a document prepared using Odoo Sign:
#. When all required fields have been completed, click :guilabel:`Validate & Send Completed
Document` at the bottom of the document.
If there are :ref:`multiple documents <sign/prepare-document/create-envelope>` to sign, click
If there are :ref:`multiple documents <sign/request-signatures/create-envelope>` to sign, click
:guilabel:`Next` at the bottom of the document, enter the requested information for the next and
any subsequent documents. Once all documents have been signed, click :guilabel:`Validate & Send
Completed Document`.
@@ -72,16 +72,16 @@ Auto-completed fields
---------------------
In Odoo Sign, certain field types can be :ref:`configured to be auto-completed
<sign/fields/auto-fill>` using data about the signer, e.g., name or email address, that is stored in
the sender's Odoo database.
<sign/configuration/auto-fill>` using data about the signer, e.g., name or email address, that is
stored in the sender's Odoo database.
Depending on the configuration, these fields can be read-only or can still be edited after
auto-completion.
.. _sign/sign-document/initials-signature:
Define initials and signature
-----------------------------
Define a signature and initials
-------------------------------
If you are an:
@@ -118,6 +118,27 @@ To define how your initials/signature should appear after clicking the relevant
If there are multiple documents to sign within the same document envelope, the defined
initials/signature can thereafter be added directly by clicking the relevant field.
.. _sign/sign-document/decline:
Decline a signature request
---------------------------
.. note::
It is only possible to decline a signature request when accessing it through the link sent by
email. Declining is not available when the document is accessed directly from Odoo.
To decline a signature request, click the :icon:`fa-caret-down` (:guilabel:`dropdown`) button in
the top-right corner next to the name(s) of the signer(s), then select :guilabel:`Decline to sign`.
Enter the reason for the refusal, then click :guilabel:`Decline`.
The signature request is then marked as :guilabel:`Cancelled` and the refusal is recorded in the
:ref:`signature request's activity logs and chatter <sign/request-signatures/manage-form>`.
Any other signers are notified and any remaining signers can no longer sign the document.
.. note::
It is not possible to decline the signature of an individual document within a document envelope.
Declining to sign cancels the entire signature request.
.. _sign/sign-document/pdf-document:
Sign an unprepared .pdf document
@@ -145,7 +166,7 @@ To sign a document in Odoo:
document(s), then click :guilabel:`Open`.
- From a record's chatter or from the Documents app: Click on the `.pdf` document to open it,
then click :guilabel:`Sign` in the upper-right corner.
#. :ref:`Add the relevant fields <sign/prepare-document/add-fields>` to the document, then click
#. :ref:`Add the relevant fields <sign/request-signatures/add-fields>` to the document, then click
:guilabel:`Sign Now`.
#. In the :guilabel:`New Signature Request` window, ensure you are selected as the signer.
Optionally:
@@ -160,8 +181,8 @@ To sign a document in Odoo:
.. tip::
When signing a document that contains only :ref:`auto-completed fields
<sign/fields/auto-fill>`, e.g., name, email, etc., click :guilabel:`Download` to immediately
download a fully signed version, without having to complete the fields manually.
<sign/configuration/auto-fill>`, e.g., name, email, etc., click :guilabel:`Download` to
immediately download a fully signed version, without having to complete the fields manually.
#. :ref:`Complete and sign the document(s) <sign/sign-document/signature-request>`.
@@ -191,7 +212,7 @@ the Documents app.
To enable the :guilabel:`Sign` option:
#. In the Documents app, with the relevant folder or sub-folder open, click the :icon:`fa-cog`
:guilabel:`(Actions)` icon beside the name of the folder.
#. Click :icon:`fa-cog` :menuselection:`Actions on Select -->` :icon:`fa-caret-right`
:menuselection:`Sign`.
#. In the Documents app, with the relevant folder or sub-folder open, click the :icon:`fa-cog`
:guilabel:`(Actions)` icon beside the name of the folder.
#. Click :icon:`fa-cog` :menuselection:`Actions on Select -->` :icon:`fa-caret-right`
:menuselection:`Sign`.

View File

@@ -189,7 +189,7 @@ click :guilabel:`Request Signature`.
:alt: The Request Signature option in the Odoo Rental application.
In the *Sign Documents* pop-up window, either :ref:`select an existing document
template <sign/templates/use-odoo-record>` or :ref:`create a new one
template <sign/request-signatures/template-odoo-record>` or :ref:`create a new one
<sign/request-signatures/one-off-record>`.
After sending the request, a link to the signature request appears in the record's chatter. The

View File

@@ -72,7 +72,8 @@ Create a new service product
.. important::
The **Project** and the **Sales** apps must be installed for following options to be available:
The **Project** and the **Sales** apps must be installed for the following options to be
available:
- :guilabel:`Create on Order`
- :guilabel:`Project Template`
@@ -207,7 +208,7 @@ click :guilabel:`Request Signature`.
:alt: The Request Signature option in the Odoo Rental application.
A *Sign Documents* pop-up window displays. Either :ref:`select an existing document
template <sign/templates/use-odoo-record>` or :ref:`create a new one
template <sign/request-signatures/template-odoo-record>` or :ref:`create a new one
<sign/request-signatures/one-off-record>`.
After sending the request, a link to the signature request appears in the record's chatter. The