[#1829] Make call-to-action action button configurable

src/open_inwoner/cms/cases/views/status.py

@@ -171,6 +171,16 @@ def get_context_data(self, **kwargs):
                         "status_indicator_text",
                         None,
                     ),
+                    "call_to_action_url": getattr(
+                        statustype_config_mapping.get(end_statustype.url),
+                        "call_to_action_url",
+                        None,
+                    ),
+                    "call_to_action_text": getattr(
+                        statustype_config_mapping.get(end_statustype.url),
+                        "call_to_action_text",
+                        None,
+                    ),
                 }
 
             context["case"] = {
@@ -203,6 +213,7 @@ def get_context_data(self, **kwargs):
             )
         else:
             context["case"] = None
+
         return context
 
     def add_second_status_preview(self, statuses: list, statustypen: list) -> None:
@@ -295,21 +306,23 @@ def get_upload_info_context(self, case: Zaak):
             ),
         }
 
-    def get_result_display(self, case: Zaak) -> str:
+    @staticmethod
+    def get_result_display(case: Zaak) -> str:
         if case.resultaat:
             result = fetch_single_result(case.resultaat)
             if result:
                 return result.toelichting
         return None
 
-    def get_initiator_display(self, case: Zaak) -> str:
+    @staticmethod
+    def get_initiator_display(case: Zaak) -> str:
         roles = fetch_case_roles(case.url, RolOmschrijving.initiator)
         if not roles:
             return ""
         return ", ".join([get_role_name_display(r) for r in roles])
 
+    @staticmethod
     def get_statuses_data(
-        self,
         statuses: List[Status],
         lookup: TranslationLookup,
         statustype_config_mapping: Optional[dict] = None,
@@ -330,11 +343,22 @@ def get_statuses_data(
                     "status_indicator_text",
                     None,
                 ),
+                "call_to_action_url": getattr(
+                    statustype_config_mapping.get(s.statustype.url),
+                    "call_to_action_url",
+                    None,
+                ),
+                "call_to_action_text": getattr(
+                    statustype_config_mapping.get(s.statustype.url),
+                    "call_to_action_text",
+                    None,
+                ),
             }
             for s in statuses
         ]
 
-    def get_case_document_files(self, case: Zaak) -> List[SimpleFile]:
+    @staticmethod
+    def get_case_document_files(case: Zaak) -> List[SimpleFile]:
         case_info_objects = fetch_case_information_objects(case.url)
 
         # get the information objects for the case objects

src/open_inwoner/openzaak/admin.py

@@ -184,8 +184,11 @@ class ZaakTypeStatusTypeConfigInline(admin.StackedInline):
         "zaaktype_uuids",
         "status_indicator",
         "status_indicator_text",
+        "show_document_uploads",
         "document_upload_description",
         "description",
+        "call_to_action_url",
+        "call_to_action_text",
     ]
     readonly_fields = [
         "statustekst",

src/open_inwoner/openzaak/migrations/0028_zaaktype_statustype_button.py

@@ -0,0 +1,43 @@
+# Generated by Django 3.2.20 on 2023-10-31 11:37
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("openzaak", "0027_zaaktype_resultaattype_config"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="zaaktypestatustypeconfig",
+            name="call_to_action_text",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="The text displayed on the call-to-action button",
+                max_length=48,
+                verbose_name="Call to action text",
+            ),
+        ),
+        migrations.AddField(
+            model_name="zaaktypestatustypeconfig",
+            name="call_to_action_url",
+            field=models.URLField(
+                blank=True,
+                default="",
+                help_text="The url the user will be sent to by clicking on the call-to-action button",
+                verbose_name="Call to action url",
+            ),
+        ),
+        migrations.AddField(
+            model_name="zaaktypestatustypeconfig",
+            name="show_document_uploads",
+            field=models.BooleanField(
+                default=True,
+                help_text="Wheter document uploads are to be shown",
+                verbose_name="Show document uploads",
+            ),
+        ),
+    ]

src/open_inwoner/openzaak/migrations/0029_merge_20231107_1355.py

@@ -0,0 +1,13 @@
+# Generated by Django 3.2.20 on 2023-11-07 12:55
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("openzaak", "0028_merge_20231101_1705"),
+        ("openzaak", "0028_zaaktype_statustype_button"),
+    ]
+
+    operations = []

src/open_inwoner/openzaak/migrations/0031_merge_20231114_1400.py

@@ -0,0 +1,13 @@
+# Generated by Django 3.2.20 on 2023-11-14 13:00
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("openzaak", "0029_merge_20231107_1355"),
+        ("openzaak", "0030_merge_20231113_1518"),
+    ]
+
+    operations = []

src/open_inwoner/openzaak/migrations/0032_alter_zaaktypestatustypeconfig_show_document_uploads.py

@@ -0,0 +1,22 @@
+# Generated by Django 3.2.20 on 2023-11-15 13:42
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("openzaak", "0031_merge_20231114_1400"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="zaaktypestatustypeconfig",
+            name="show_document_uploads",
+            field=models.BooleanField(
+                default=True,
+                help_text="Whether document uploads are to be shown",
+                verbose_name="Show document uploads",
+            ),
+        ),
+    ]

src/open_inwoner/openzaak/models.py

@@ -383,6 +383,26 @@ class ZaakTypeStatusTypeConfig(models.Model):
             "Whether the user should be notfied if a case is set to this type of status"
         ),
     )
+    show_document_uploads = models.BooleanField(
+        default=True,
+        verbose_name=_("Show document uploads"),
+        help_text=_("Whether document uploads are to be shown"),
+    )
+    call_to_action_url = models.URLField(
+        blank=True,
+        default="",
+        verbose_name=_("Call to action url"),
+        help_text=_(
+            "The url the user will be sent to by clicking on the call-to-action button"
+        ),
+    )
+    call_to_action_text = models.CharField(
+        max_length=48,
+        blank=True,
+        default="",
+        verbose_name=_("Call to action text"),
+        help_text=_("The text displayed on the call-to-action button"),
+    )
 
     class Meta:
         verbose_name = _("Zaaktype Statustype Configuration")

src/open_inwoner/openzaak/tests/test_case_detail.py

@@ -408,6 +408,8 @@ def test_status_is_retrieved_when_user_logged_in_via_digid(self, m):
             statustype_url=self.status_type_finish["url"],
             status_indicator=StatusIndicators.success,
             status_indicator_text="bar",
+            call_to_action_url="https://www.example.com",
+            call_to_action_text="Click me",
         )
 
         self._setUpMocks(m)
@@ -436,12 +438,16 @@ def test_status_is_retrieved_when_user_logged_in_via_digid(self, m):
                         "label": "Initial request",
                         "status_indicator": "warning",
                         "status_indicator_text": "foo",
+                        "call_to_action_url": "",
+                        "call_to_action_text": "",
                     },
                     {
                         "date": datetime.datetime(2021, 3, 12),
                         "label": "Finish",
                         "status_indicator": "success",
                         "status_indicator_text": "bar",
+                        "call_to_action_url": "https://www.example.com",
+                        "call_to_action_text": "Click me",
                     },
                 ],
                 # only one visible information object
@@ -475,6 +481,8 @@ def test_pass_endstatus_type_data_if_endstatus_not_reached(self, m):
             statustype_url=self.status_type_finish["url"],
             status_indicator=StatusIndicators.success,
             status_indicator_text="bar",
+            call_to_action_url="https://www.example.com",
+            call_to_action_text="Click me",
         )
 
         self._setUpMocks(m, use_eindstatus=False)
@@ -499,6 +507,8 @@ def test_pass_endstatus_type_data_if_endstatus_not_reached(self, m):
                     "label": "Finish",
                     "status_indicator": "success",
                     "status_indicator_text": "bar",
+                    "call_to_action_url": "https://www.example.com",
+                    "call_to_action_text": "Click me",
                 },
                 "description": "Coffee zaaktype",
                 "statuses": [
@@ -507,13 +517,17 @@ def test_pass_endstatus_type_data_if_endstatus_not_reached(self, m):
                         "label": "Initial request",
                         "status_indicator": "warning",
                         "status_indicator_text": "foo",
+                        "call_to_action_url": "",
+                        "call_to_action_text": "",
                     },
                     # preview of second (upcoming) status
                     {
                         "date": None,
                         "label": "In behandeling",
                         "status_indicator": "success",
                         "status_indicator_text": "zap",
+                        "call_to_action_url": "",
+                        "call_to_action_text": "",
                     },
                 ],
                 # only one visible information object

src/open_inwoner/openzaak/tests/test_cases.py

@@ -195,6 +195,8 @@ def setUpTestData(cls):
             status_indicator=StatusIndicators.warning,
             status_indicator_text="U moet documenten toevoegen",
             description="Lorem ipsum dolor sit amet",
+            call_to_action_url="https://example.com",
+            call_to_action_text="Click me",
         )
         # open
         cls.zaak1 = generate_oas_component(

src/open_inwoner/templates/pages/cases/status_inner.html

@@ -21,6 +21,65 @@ <h1 class="h1" id="title">{{ case.description }}</h1>
             <section id="statuses_component" class="statuses__section">
                 {% include 'pages/cases/statuses.html' %}
             </section>
+            {% if case.statuses %}
+                <h2 class="h2" id="statuses">{% trans 'Status' %}</h2>
+
+                <aside class="status-list" aria-label="{% trans "Status lijst" %}">
+                    <ul class="status-list__list">
+                        {% for status in case.statuses %}
+
+                            {% if forloop.last %}
+                                {# Current active status, including final status #}
+                                <li class="{% if case.end_statustype_data %}status--current{% endif %} status-list__list-item status-list__list-item--{{ status.status_indicator }} {% if not case.end_statustype_data %}item--completed status-list__list-item--info{% endif %}">
+                                    {% icon icon="circle" %}
+                                    <div class="status-list__notification status-list__notification--{{ status.status_indicator }}">
+                                        <h3 class="status-list__notification-h3"><a href="#" class="link link-toggle link--bold">{{ status.label }}</a>{% icon icon="expand_more" icon_position="after" outlined=True %}</h3>
+                                        <div class="status-list__notification-content">
+                                            <p class="p p-text p--compact">{{ status.status_indicator_text }}</p>
+                                            <p class="p p-date p--compact">{{ status.date|date }}</p>
+                                            <p>
+                                            {% if case.internal_upload_enabled or case.external_upload_enabled %}
+                                                {% button href="#form_upload" text=_("Scroll naar document uploaden") title=_("Ga direct naar document upload sectie.") primary=True icon="arrow_downward" icon_position="after" %}
+                                            {% endif %}
+                                            {# IF there is a CTA button in the final status, show this #}
+                                            {% with button_url=status.call_to_action_url %}
+                                                {% if button_url %}
+                                                    {% translate status.call_to_action_text as button_text %}
+                                                        {% button href=button_url text=button_text title=_("Open de bijlage") primary=True icon="arrow_forward" icon_position="after" %}
+                                                {% endif %}
+                                            {% endwith %}
+                                            </p>
+                                        </div>
+                                    </div>
+                                </li>
+                            {% else %}
+                                {# Completed past statuses #}
+                                <li class="status--completed status-list__list-item">
+                                    {% icon icon="task_alt" %}
+                                    <div class="status-list__notification">
+                                        <h3 class="status-list__notification-h3"><a href="#" class="link link-toggle link-success">{{ status.label }}</a>{% icon icon="expand_more" icon_position="after" outlined=True %}</h3>
+                                        <div class="status-list__notification-content">
+                                            <p class="p p-text p--compact">{{ status.status_indicator_text }}</p>
+                                            <p class="p p-date p--compact">{{ status.date|date }}</p>
+                                        </div>
+                                    </div>
+                                </li>
+
+                            {% endif %}
+                        {% endfor %}
+                        {% if case.end_statustype_data %}
+                            {# Future end status #}
+                            <li class="status--future status-list__list-item status-list__list-item--future">
+                                {% icon icon="circle_outlined" outlined=True %}
+                                <div class="status-list__notification status-list__notification--future">
+                                    <h3 class="status-list__notification-h3"><span class="link">{{ case.end_statustype_data.label }}</span></h3>
+                                </div>
+                            </li>
+
+                        {% endif %}
+                    </ul>
+                </aside>
+            {% endif %}
 
             {#  Documents. #}
             {% if case.documents %}