From 8cbb82e5ee2921372705a0e33044972bc74f5e63 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Wed, 1 Sep 2021 15:24:45 -0700
Subject: [PATCH] WorkflowMessage - Track 'support' level for each message

---
 CRM/Case/WorkflowMessage/CaseActivity.php       |  1 +
 Civi/Api4/WorkflowMessage.php                   | 10 ++++++++++
 Civi/WorkflowMessage/GenericWorkflowMessage.php |  4 ++++
 Civi/WorkflowMessage/WorkflowMessage.php        |  2 +-
 4 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/CRM/Case/WorkflowMessage/CaseActivity.php b/CRM/Case/WorkflowMessage/CaseActivity.php
index 59380ba3c1..166f2a57f2 100644
--- a/CRM/Case/WorkflowMessage/CaseActivity.php
+++ b/CRM/Case/WorkflowMessage/CaseActivity.php
@@ -15,6 +15,7 @@
  * the configuration/add-ons) additional copies may be sent.
  *
  * @see CRM_Case_BAO_Case::sendActivityCopy
+ * @support template-only
  */
 class CRM_Case_WorkflowMessage_CaseActivity extends Civi\WorkflowMessage\GenericWorkflowMessage {
 
diff --git a/Civi/Api4/WorkflowMessage.php b/Civi/Api4/WorkflowMessage.php
index a206214bb0..5369e84df1 100644
--- a/Civi/Api4/WorkflowMessage.php
+++ b/Civi/Api4/WorkflowMessage.php
@@ -97,6 +97,16 @@ class WorkflowMessage extends Generic\AbstractEntity {
           'title' => 'Description',
           'data_type' => 'String',
         ],
+        [
+          'name' => 'support',
+          'title' => 'Support Level',
+          'options'  => [
+            'experimental' => ts('Experimental: Message may change substantively with no special communication or facilitation.'),
+            'template-only' => ts('Template Support: Changes affecting the content of the message-template will get active support/facilitation.'),
+            'full' => ts('Full Support: All changes affecting message-templates or message-senders will get active support/facilitation.'),
+          ],
+          'data_type' => 'String',
+        ],
       ];
     }))->setCheckPermissions($checkPermissions);
   }
diff --git a/Civi/WorkflowMessage/GenericWorkflowMessage.php b/Civi/WorkflowMessage/GenericWorkflowMessage.php
index 862c3a8d42..0c072a485e 100644
--- a/Civi/WorkflowMessage/GenericWorkflowMessage.php
+++ b/Civi/WorkflowMessage/GenericWorkflowMessage.php
@@ -24,6 +24,10 @@ use Civi\WorkflowMessage\Traits\ReflectiveWorkflowTrait;
  * @method int|null getContactId()
  * @method $this setContact(array|null $contact)
  * @method array|null getContact()
+ *
+ * @support template-only
+ * GenericWorkflowMessage should aim for "full" support, but it's prudent to keep
+ * it flexible for the first few months. Consider updating to "full" after Dec 2021.
  */
 class GenericWorkflowMessage implements WorkflowMessageInterface {
 
diff --git a/Civi/WorkflowMessage/WorkflowMessage.php b/Civi/WorkflowMessage/WorkflowMessage.php
index 5ad47eaed4..32593418bb 100644
--- a/Civi/WorkflowMessage/WorkflowMessage.php
+++ b/Civi/WorkflowMessage/WorkflowMessage.php
@@ -181,7 +181,7 @@ class WorkflowMessage {
    */
   public static function getWorkflowSpecs() {
     $compute = function() {
-      $keys = ['name', 'group', 'class', 'description', 'comment'];
+      $keys = ['name', 'group', 'class', 'description', 'comment', 'support'];
       $list = [];
       foreach (self::getWorkflowNameClassMap() as $name => $class) {
         $specs = [
-- 
2.25.1