Skip to content

Commit 984f971

Browse files
Donapixpl-odoo
authored andcommitted
[IMP] sign: update for 16.0
task-3433578 closes #6660 X-original-commit: 71446b0 Signed-off-by: Xavier Platteau (xpl) <[email protected]>
1 parent 03e756d commit 984f971

File tree

8 files changed

+143
-64
lines changed

8 files changed

+143
-64
lines changed

content/applications/finance/sign.rst

Lines changed: 143 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
Sign
33
====
44

5-
**Odoo Sign** allows you to send, sign and approve documents online, using electronic signatures.
5+
**Odoo Sign** allows you to send, sign, and approve documents online, using electronic signatures.
66

77
An **electronic signature** shows a person's agreement to the content of a document. Just like a
88
handwritten signature, the electronic one represents a legal bounding by the terms of the signed
99
document.
1010

11-
With Sign, you can upload any PDF file and add fields to it. These fields are automatically filled
12-
in with the user's details present in your database.
11+
With Sign, you can upload any PDF file and add fields to it. These fields can be automatically
12+
filled in with the user's details present in your database.
1313

1414
.. seealso::
1515
- `Odoo Sign: product page <https://www.odoo.com/app/sign>`_
16-
- `Odoo Tutorials: Sign <https://www.odoo.com/slides/sign-61>`_
16+
- `Odoo Tutorials: Sign [video] <https://www.odoo.com/slides/sign-61>`_
1717

1818
Validity of electronic signatures
1919
=================================
@@ -82,16 +82,60 @@ Overall, to be recognized as valid, electronic signatures have to meet five crit
8282
is up-to-date. We advise contacting a local attorney for legal advice regarding electronic
8383
signature compliance and validity.
8484

85+
Send a document to sign
86+
=======================
87+
88+
One-time signature
89+
------------------
90+
91+
You can click :guilabel:`Upload a PDF to sign` from your dashboard for a one-time signature. Select
92+
your document, open it, and drag and drop the required :ref:`fields <sign/fields>` in your document.
93+
You can modify the :ref:`role <sign/role>` assigned to a field by clicking on it and selecting the
94+
one you want.
95+
96+
When ready, click :guilabel:`Send`, and fill in the required fields. Once sent, your document
97+
remains available. Go to :menuselection:`Documents --> All Documents` to see your document
98+
and the status of the signatures.
99+
100+
.. image:: sign/signature-status.png
101+
:alt: Signature status
102+
103+
Templates
104+
---------
105+
106+
You can create document templates when you have to send the same document several times. From your
107+
dashboard, click :guilabel:`Upload a PDF template`. Select the document and add the required
108+
:ref:`fields <sign/fields>`. You can modify the :ref:`role <sign/role>` of a field by clicking on it
109+
and selecting the one you want.
110+
111+
Click :guilabel:`Template Properties` to add :guilabel:`Tags` to your template, define a
112+
:guilabel:`Signed Document Workspace`, add :guilabel:`Signed Document Tags`, set a
113+
:guilabel:`Redirect Link` that will be available in the signature confirmation message received
114+
after the signature, or define :guilabel:`Authorized Users` if you want to restrict the use of your
115+
template to specific authorized users or groups.
116+
117+
Your templates are visible by default on your dashboard. You can click :guilabel:`Send` to quickly
118+
send a document template to a signer or :guilabel:`Sign Now` if you are ready to sign your document
119+
immediately.
120+
121+
.. tip::
122+
You can **create a template from a document that was previously sent**. To do so, go to
123+
:menuselection:`Documents --> All Documents`. On the document you want to retrieve, click on
124+
⋮, then :guilabel:`Template`. Click on ⋮ again, then :guilabel:`Restore`. Your document now
125+
appears on your dashboard next to your other templates.
126+
127+
.. _sign/role:
128+
85129
Roles
86130
=====
87131

88-
Each field in a Sign document is related to a role that corresponds to a specific person. When a
89-
document is being signed, the person assigned to the role needs to fill in their assigned fields and
132+
Each field in a Sign document is related to a role corresponding to a specific person. When a
133+
document is being signed, the person assigned to the role must fill in their assigned fields and
90134
sign it.
91135

92136
Roles are available by going to :menuselection:`Sign --> Configuration --> Roles`.
93137

94-
It is possible to update existing roles or to create new roles by clicking on :guilabel:`Create`.
138+
It is possible to update existing roles or to create new roles by clicking on :guilabel:`New`.
95139
Choose a :guilabel:`Role Name`, add an :guilabel:`Extra Authentication Step` to confirm the
96140
identity of the signing person, and if the document can be reassigned to another contact, select
97141
:guilabel:`Change Authorized` for the role. A :guilabel:`Color` can also be chosen for the role.
@@ -101,79 +145,133 @@ template.
101145
Secured identification
102146
----------------------
103147

104-
As the owner of a document, you may request an :guilabel:`Extra Authentication Step` through an SMS
105-
verification or via Itsme® (available in Belgium and the Netherlands). Both authentication options
106-
require :ref:`credits <iap/buying_credits>`. If you do not have any credits left, the authentication
107-
steps will be skipped.
148+
As the owner of a document, you may request an :guilabel:`Extra Authentication Step` through
149+
:ref:`SMS verification <sign/sms>` or via :ref:`Itsme® <sign/itsme>` (available in Belgium and the
150+
Netherlands). Both authentication options require :ref:`credits <iap/buying_credits>`. If you do not
151+
have any credits left, the authentication steps will be skipped.
108152

109153
.. seealso::
110154
- :doc:`In-App Purchase (IAP) <../general/in_app_purchase>`
111155
- :doc:`SMS pricing and FAQ <../marketing/sms_marketing/pricing/pricing_and_faq>`
112156

157+
.. _sign/sms:
158+
113159
SMS verification
114160
~~~~~~~~~~~~~~~~
115161

116162
Go to :menuselection:`Sign --> Configuration --> Roles`. Click in the :guilabel:`Extra
117163
Authentication Step` column for the role, and select :guilabel:`Unique Code Via SMS`.
118164

119-
.. image:: sign/sms-verification.png
120-
:align: center
121-
:alt: Add a hash to your document
165+
.. note::
166+
Before being able to send SMS Text Messages, you need to register your phone number. To do so, go
167+
to :menuselection:`Sign --> Configuration --> Settings` and click :guilabel:`Buy credits` under
168+
:guilabel:`Authenticate by SMS`.
122169

123-
Go to the document to sign, add the field for which the SMS verification is required, for example
124-
the :guilabel:`Signature` field, and click :guilabel:`Send`. A page pops up, select the customer,
125-
and click :guilabel:`Send`.
170+
Go to the document to sign, add the field for which the SMS verification is required, for example,
171+
the :guilabel:`Signature` field, and click :guilabel:`Send`. On the new page, select the
172+
:guilabel:`customer` and click :guilabel:`Send`.
126173

127-
The person signing the document fills in the :guilabel:`Signature` field and clicks
128-
:guilabel:`Validate & Send Completed Document`. A :guilabel:`Final Validation` page pops up where to
129-
add their phone number. One-time codes are sent by SMS.
174+
The person signing the document fills in the :guilabel:`Signature` field, then :guilabel:`Sign`, and
175+
clicks :guilabel:`Validate & Send Completed Document`. A :guilabel:`Final Validation` page pops up
176+
where to add their phone number. One-time codes are sent by SMS.
130177

131-
.. image:: sign/final-validation.png
132-
:align: center
133-
:alt: fill in your phone number for final validation
178+
.. image:: sign/sms-verification.png
179+
:alt: Add a hash to your document
134180

135181
.. note::
136182
- This feature is enabled by default.
137183
- As soon as the :guilabel:`Extra Authentication Step` applies to a role, this validation step is
138184
requested for any field assigned to this role.
139185

186+
.. _sign/itsme:
187+
140188
Itsme®
141189
~~~~~~
142190

143-
Go to :menuselection:`Sign --> Configuration --> Settings` and enable :guilabel:`Identify with
144-
itsme®`.
191+
Itsme® authentication can be used to allow signatories to provide their identity using itsme®. This
192+
feature is only available in **Belgium** and the **Netherlands**.
145193

146-
Then, go to :menuselection:`Sign --> Configuration --> Roles`. Click in the :guilabel:`Extra
147-
Authentication Step` column for the role, and select :guilabel:`Via itsme®`.
194+
The feature can be enabled in :guilabel:`Sign Settings` and applies automatically to the
195+
:guilabel:`Customer (identified with itsme®)` role. To enable it for other roles, go to
196+
:menuselection:`Sign --> Configuration --> Roles`. Click in the :guilabel:`Extra Authentication
197+
Step` column for the role, and select :guilabel:`Via itsme®`.
148198

149-
Go to the document that needs to be signed and add the :guilabel:`Signature` field. Switch the role
150-
to :guilabel:`customer (identified with itsme®)`, and click :guilabel:`Validate`, and
151-
:guilabel:`Send`.
199+
Go to the document that needs to be signed and add the :guilabel:`Signature` field. Switch to any
200+
role configured to use the feature, and click :guilabel:`Validate` and :guilabel:`Send`.
152201

153202
.. image:: sign/itsme-identification.png
154-
:align: center
155203
:alt: select customer identified with itsme®
156204

157-
The person signing the document fills in the :guilabel:`Signature` field and clicks
158-
:guilabel:`Validate & Send Completed Document`. A :guilabel:`Final Validation` page pops up, and the
159-
person must authenticate with itsme®.
205+
Upon signing the document, the signer completes the :guilabel:`Signature` field and proceeds by
206+
clicking on :guilabel:`Validate & Send Completed Document`, triggering a
207+
:guilabel:`Final verification` page where authentication via itsme® is required.
160208

161-
.. note::
162-
This feature is only available in Belgium and the Netherlands.
209+
Signatory hash
210+
==============
211+
212+
Each time someone signs a document, a **hash** - a unique digital signature of the operation - is
213+
generated to ensure traceability, integrity, and inalterability. This process guarantees that any
214+
changes made after a signature is affixed can be easily detected, maintaining the document's
215+
authenticity and security throughout its lifecycle.
216+
217+
A visual security frame displaying the beginning of the hash is added to the signatures. Internal
218+
users can hide or show it by turning the :guilabel:`Frame` option on or off when signing the
219+
document.
220+
221+
.. image:: sign/sign-hash.png
222+
:alt: Adding the visual security frame to a signature.
163223

164224
.. _sign/field-types:
165225

166-
Field Types
226+
Tags
227+
====
228+
229+
Tags can be used to categorize and organize documents, allowing users to search for and filter
230+
documents based on specific criteria quickly.
231+
232+
You can manage tags by going to :menuselection:`Configuration --> Tags`. To create a tag, click
233+
:guilabel:`New`. On the new line, add the :guilabel:`Tag Name` and select a :guilabel:`Color Index`
234+
for your tag.
235+
236+
To apply a tag to a document, use the dropdown list available in your document.
237+
238+
Sign order
239+
==========
240+
241+
When a document needs to be signed by different parties, the signing order lets you control the
242+
order in which your recipients receive it for signature.
243+
244+
By going to :menuselection:`Configuration --> Settings`, you can :guilabel:`Enable Signing Order`.
245+
Each recipient receives the signature request notification only once the previous recipient has
246+
completed their action.
247+
248+
Add at least two :guilabel:`Signature` fields with different roles to your document. Click
249+
:guilabel:`Send`, go to the :guilabel:`Options` tab, and tick the :guilabel:`Specify signing order`
250+
box.
251+
252+
Add the signer's :guilabel:`Name or email` information. You can decide on the :guilabel:`Sign Order`
253+
by typing :guilabel:`1` or :guilabel:`2` in the :guilabel:`Sign Order` column.
254+
255+
.. seealso::
256+
`Odoo Quick Tips: Sign order [video] <https://www.youtube.com/watch?v=2KUq7RPt1cU/>`_
257+
258+
.. _sign/fields:
259+
260+
Field types
167261
===========
168262

169-
Various field types can be used to sign documents (placeholder, autocompletion, ...). By configuring
170-
your own field types, also known as signature item types, the signing process can be even faster for
171-
your customers, partners, and employees.
263+
Fields are used in a document to indicate what information must be completed by the signers. You can
264+
add fields to your document simply by dragging and dropping them for the left column into your
265+
document.
266+
267+
Various field types can be used to sign documents (placeholder, autocompletion, etc.). By
268+
configuring your own field types, also known as signature item types, the signing process can be
269+
even faster for your customers, partners, and employees.
172270

173271
To create and edit field types, go to :menuselection:`Sign --> Configuration --> Settings -->
174272
Edit field types`.
175273

176-
You can select an existing field by clicking on it or you can :guilabel:`Create` a new one. First,
274+
You can select an existing field by clicking on it, or you can :guilabel:`Create` a new one. First,
177275
edit the :guilabel:`Field Name`. Then, select a :guilabel:`Field Type`:
178276

179277
- :guilabel:`Signature`: users are asked to enter their signature either by drawing it, generating
@@ -199,34 +297,15 @@ the person signing the document. To do so, enter the contact model field's techn
199297
document.
200298

201299
The size of the fields can also be changed by editing the :guilabel:`Default Width` and
202-
:guilabel:`Default Height`. Both sizes are defined as a percentage of the full-page expressed as a
203-
decimal, with 1 equalling the full-page's width or height. By default, the width of new fields you
204-
create is set to 15% (0.150) of a full-page's width, while their height is set to 1.5% (0.015) of a
205-
full-page's height.
300+
:guilabel:`Default Height`. Both sizes are defined as a percentage of the full page expressed as a
301+
decimal, with 1 equalling the full page's width or height. By default, the width of new fields you
302+
create is set to 15% (0.150) of a full page's width, while their height is set to 1.5% (0.015) of a
303+
full page's height.
206304

207305
Next, write a :guilabel:`Tip`. Tips are displayed inside arrows on the left-hand side of the user's
208306
screen during the signing process to help them understand what the step entails (e.g., "Sign here"
209307
or “Fill in your birthdate”). You can also use a :guilabel:`Placeholder` text to be displayed inside
210308
the field before it is completed.
211309

212310
.. image:: sign/tip-placeholder.png
213-
:align: center
214311
:alt: Tip and placeholder example in Odoo Sign
215-
216-
Signatory hash
217-
==============
218-
219-
A :guilabel:`hash` can be added to a document that is shared (attached to an email or printed, for
220-
example) to indicate that the signature is electronic and that there is some traceability behind
221-
it. The :guilabel:`hash` corresponds to a unique ID number related to the signed document.
222-
223-
If you are an :doc:`internal user <../general/users/manage_users>`,
224-
you can choose to tick or untick the frame option when signing the document. Tick the box to have
225-
the frame and hash visible.
226-
227-
.. image:: sign/sign-hash.png
228-
:align: center
229-
:alt: Add a hash to your document
230-
231-
.. note::
232-
The :guilabel:`hash` is only applicable to the signature field.
0 Bytes
Loading
-85 Bytes
Loading
-19.8 KB
Loading
12.5 KB
Loading
6.23 KB
Loading
-3.93 KB
Loading
1 Byte
Loading

0 commit comments

Comments
 (0)