[16.0][IMP] sign_oca: connect sign requests with survey answers

Author: kobros-tech

sign_oca/README.rst

@@ -111,6 +111,19 @@ Sign from template
 - Some extra modules (e.g. maintenance_sign_oca) will automatically set
   the signers for each request.
 
+Sign answered survey questions
+------------------------------
+
+- Create a survey and ask the partner to answer it.
+- Create a sign template and select Survey model for model field.
+- Select the specific answered survey for survey field.
+- Open configuration form and create field elements and choose Survey
+  ones.
+- Make placeholder for each survey field the same answered questions of
+  the survey itself.
+- When the partners open the sign request they find default values are
+  the answered survey questions.
+
 Known issues / Roadmap
 ======================
 

sign_oca/__manifest__.py

@@ -9,7 +9,7 @@
     "license": "AGPL-3",
     "author": "Dixmit,Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/sign",
-    "depends": ["web_editor", "portal", "base_sparse_field"],
+    "depends": ["web_editor", "portal", "base_sparse_field", "survey"],
     "data": [
         "security/security.xml",
         "views/menu.xml",

sign_oca/data/data.xml

@@ -27,6 +27,11 @@
         <field name="name">Check</field>
         <field name="field_type">check</field>
     </record>
+    <record id="sign_field_survey" model="sign.oca.field">
+        <field name="name">Survey</field>
+        <field name="field_type">text</field>
+        <field name="default_value">survey</field>
+    </record>
     <record id="sign_role_customer" model="sign.oca.role">
         <field name="name">Customer</field>
         <field name="domain">[]</field>

sign_oca/models/sign_oca_request.py

@@ -443,6 +443,25 @@ def get_info(self, access_token=False):
                 )
             }
         )
+        # for survey related sign requests
+        survey_id = self.request_id.template_id.survey_id
+        model_id = self.request_id.template_id.model_id
+        if survey_id and model_id and model_id.model == "survey.survey":
+            survey_participation = self.env["survey.user_input"].search(
+                [
+                    ("survey_id", "=", survey_id.id),
+                    ("partner_id", "=", self.partner_id.id),
+                ]
+            )[:1]
+            survey = {}
+            for line in survey_participation.user_input_line_ids:
+                if line.question_id.question_type == "matrix":
+                    survey.update(
+                        {line.matrix_row_id.value: line.suggested_answer_id.value}
+                    )
+                else:
+                    survey.update({line.question_id.display_name: line.display_name})
+            partner_fields_dict.update({"survey": survey})
         return {
             "role_id": self.role_id.id if not self.signed_on else False,
             "name": self.request_id.template_id.name,

sign_oca/models/sign_oca_template.py

@@ -22,6 +22,9 @@ class SignOcaTemplate(models.Model):
         domain=[("transient", "=", False), ("model", "not like", "sign.oca")],
     )
     model = fields.Char(compute="_compute_model", compute_sudo=True, store=True)
+    survey_id = fields.Many2one(
+        "survey.survey",
+    )
     active = fields.Boolean(default=True)
     request_ids = fields.One2many("sign.oca.request", inverse_name="template_id")
 

sign_oca/readme/USAGE.md

@@ -55,3 +55,12 @@
   no signer will be set.
 - Some extra modules (e.g. maintenance_sign_oca) will automatically set
   the signers for each request.
+
+## Sign answered survey questions
+
+- Create a survey and ask the partner to answer it.
+- Create a sign template and select Survey model for model field.
+- Select the specific answered survey for survey field.
+- Open configuration form and create field elements and choose Survey ones.
+- Make placeholder for each survey field the same answered questions of the survey itself.
+- When the partners open the sign request they find default values are the answered survey questions.

sign_oca/static/description/index.html

@@ -382,17 +382,18 @@ <h1 class="title">Sign Oca</h1>
 <li><a class="reference internal" href="#sign-a-document-from-template" id="toc-entry-5">Sign a document from template</a></li>
 <li><a class="reference internal" href="#sign-a-pending-document" id="toc-entry-6">Sign a pending document</a></li>
 <li><a class="reference internal" href="#sign-from-template" id="toc-entry-7">Sign from template</a></li>
+<li><a class="reference internal" href="#sign-answered-survey-questions" id="toc-entry-8">Sign answered survey questions</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-8">Known issues / Roadmap</a><ul>
-<li><a class="reference internal" href="#tasks" id="toc-entry-9">Tasks</a></li>
+<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-9">Known issues / Roadmap</a><ul>
+<li><a class="reference internal" href="#tasks" id="toc-entry-10">Tasks</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-10">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-11">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-12">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-13">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-14">Maintainers</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-11">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-12">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-13">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-14">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-15">Maintainers</a></li>
 </ul>
 </li>
 </ul>
@@ -475,11 +476,25 @@ <h2><a class="toc-backref" href="#toc-entry-7">Sign from template</a></h2>
 the signers for each request.</li>
 </ul>
 </div>
+<div class="section" id="sign-answered-survey-questions">
+<h2><a class="toc-backref" href="#toc-entry-8">Sign answered survey questions</a></h2>
+<ul class="simple">
+<li>Create a survey and ask the partner to answer it.</li>
+<li>Create a sign template and select Survey model for model field.</li>
+<li>Select the specific answered survey for survey field.</li>
+<li>Open configuration form and create field elements and choose Survey
+ones.</li>
+<li>Make placeholder for each survey field the same answered questions of
+the survey itself.</li>
+<li>When the partners open the sign request they find default values are
+the answered survey questions.</li>
+</ul>
+</div>
 </div>
 <div class="section" id="known-issues-roadmap">
-<h1><a class="toc-backref" href="#toc-entry-8">Known issues / Roadmap</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-9">Known issues / Roadmap</a></h1>
 <div class="section" id="tasks">
-<h2><a class="toc-backref" href="#toc-entry-9">Tasks</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-10">Tasks</a></h2>
 <ul class="simple">
 <li>Ensure that the signature is inalterable. Maybe we might need to use
 some tools like endevise or pyHanko with a certificate. Signer can be
@@ -488,23 +503,23 @@ <h2><a class="toc-backref" href="#toc-entry-9">Tasks</a></h2>
 </div>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-10">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-11">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/sign/issues">GitHub Issues</a>.
 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
 <a class="reference external" href="https://github.com/OCA/sign/issues/new?body=module:%20sign_oca%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h1><a class="toc-backref" href="#toc-entry-11">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-12">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-12">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-13">Authors</a></h2>
 <ul class="simple">
 <li>Dixmit</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-13">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-14">Contributors</a></h2>
 <ul class="simple">
 <li>Enric Tobella (<a class="reference external" href="http://www.dixmit.com">www.dixmit.com</a>)</li>
 <li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
@@ -514,7 +529,7 @@ <h2><a class="toc-backref" href="#toc-entry-13">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-14">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-15">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org">
 <img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />

sign_oca/static/src/elements/text.esm.js

@@ -23,13 +23,28 @@ const textSignOca = {
                 !item.value &&
                 parent.info.partner[item.default_value]
             ) {
-                this.change(
-                    parent.info.partner[item.default_value],
-                    parent,
-                    item,
-                    signatureItem
-                );
-                ev.target.value = parent.info.partner[item.default_value];
+                // Add survey values if present
+                if (
+                    parent.info.partner.survey &&
+                    item.default_value === "survey" &&
+                    parent.info.partner.survey[item.placeholder]
+                ) {
+                    this.change(
+                        parent.info.partner.survey[item.placeholder],
+                        parent,
+                        item,
+                        signatureItem
+                    );
+                    ev.target.value = parent.info.partner.survey[item.placeholder];
+                } else {
+                    this.change(
+                        parent.info.partner[item.default_value],
+                        parent,
+                        item,
+                        signatureItem
+                    );
+                    ev.target.value = parent.info.partner[item.default_value];
+                }
             }
         });
         input.addEventListener("change", (ev) => {

sign_oca/views/sign_oca_template.xml

@@ -43,6 +43,11 @@
                         <field name="data" filename="filename" />
                         <field name="filename" invisible="1" />
                         <field name="model_id" groups="sign_oca.sign_oca_group_admin" />
+                        <field name="model" invisible="1" />
+                        <field
+                            name="survey_id"
+                            attrs="{'invisible': [('model', '!=', 'survey.survey')]}"
+                        />
                         <field name="ask_location" />
                     </group>
                     <notebook>