Metadata-Version: 2.1
Name: odoo-addon-fieldservice_sign
Version: 19.0.1.0.0.2
Requires-Dist: odoo-addon-fieldservice==19.0.*
Requires-Dist: odoo-addon-sign_oca==19.0.*
Requires-Dist: odoo==19.0.*
Summary: Customer signature capture and document signing on FSM orders
Home-page: https://github.com/OCA/field-service
License: AGPL-3
Author: Gray Matter Logic, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 19.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 4 - Beta
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

====================
Field Service - Sign
====================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:359331c23aa7fe230c288d9fad14819b567d0d06c658649eb5dea206afdc5ebf
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Ffield--service-lightgray.png?logo=github
    :target: https://github.com/OCA/field-service/tree/19.0/fieldservice_sign
    :alt: OCA/field-service
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/field-service-19-0/field-service-19-0-fieldservice_sign
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/field-service&target_branch=19.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module adds configurable customer signing features on Field Service
orders:

- **On-site signature capture** — uses the native signature widget and
  the signature fields already provided by ``fieldservice``
  (``signature``, ``signed_by``, ``signed_on``). Capture can be enabled
  or disabled per company, and optionally required before an order can
  be completed.
- **Document signing** — integrates with ``sign_oca`` to launch a
  signature request for a document linked to the order, expose its
  status on the order, and optionally require a signed document before
  completion.

Both features are independent. An administrator can enable none, either
one, or both from Field Service settings.

**Table of contents**

.. contents::
   :local:

Configuration
=============

Go to *Field Service > Configuration > Settings* and open the
**Signatures** section:

1. Enable **On-site Signature Capture** to surface customer signature
   capture on orders. Optionally enable **Require Signature to
   Complete**.
2. Enable **Document Signing** to allow launching ``sign_oca`` requests
   from orders. Optionally enable **Require Document Signed to
   Complete**.
3. Select the **FSM Order Sign Template** used when requesting a
   document signature. The template model must be ``fsm.order``.

Usage
=====

On-site signature capture
-------------------------

1. Open a Field Service order.
2. When the order stage requires a signature, use **Sign** to capture
   the customer signature.
3. Complete the order. If the company requires a signature, completion
   is blocked until one is captured.

The signature is also printed on the Service Order report when capture
is enabled.

Document signing
----------------

1. Open a Field Service order.
2. Click **Request Signature** to create and send a ``sign_oca`` request
   from the company template.
3. Follow the linked signature requests from the smart button or the
   **Document Signing** tab.
4. Complete the order. If the company requires a signed document,
   completion is blocked until at least one request is signed.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/field-service/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/field-service/issues/new?body=module:%20fieldservice_sign%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Gray Matter Logic

Contributors
------------

- `Gray Matter Logic <https://www.graymatterlogic.com>`__:

  - Maxime Chambreuil <maxime.chambreuil@graymatterlogic.com>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-max3903| image:: https://github.com/max3903.png?size=40px
    :target: https://github.com/max3903
    :alt: max3903

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-max3903| 

This module is part of the `OCA/field-service <https://github.com/OCA/field-service/tree/19.0/fieldservice_sign>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
