Add workflow_name column to civicrm_msg_template, deprecate workflow_id

[eileenmcnaughton]

Overview

Alternate to #17180

Some "Message Templates" are associated with workflow steps -- e.g. if a message template is associated with "membership_online_receipt", then it will be sent as the automated email after someone signs up for a membership online. This PR makes the association easier to work with.

Before

The relationship between "Message Template" and "Workflow" is tracked by the column civicrm_msg_template.workflow_id.

The column workflow_id is encoded in an unusual/confusing way -- it references civicrm_option_value.id. A column like this should normally reference civicrm_option_value.value or perhaps civicrm_option_value.name - but the COV ID is unusual and tricky to work with.

After

The relationship is also tracked by the columncivicrm_msg_template.workflow_name. This is a symbolic value referring to civicrm_option_value.name.

The workflow_id still works but is deprecated.

Technical Details

Alternate to #17180 per feedback from @mattwire & @totten

Comments

Note that this leaves open the question of adding an option group for this field as something we can do - but don't have to

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[totten]

Did some testing of the DB content with upgrades and new-installs. Looked good for upgrade and a normal (non-demo/non-example) installation. To support new installs with demo data, I rebased and ran regen.sh.

So far, light testing in the admin UI has been good, but I'm still trying out cases for runtime usage...

[totten]

I did some testing with civivolunteer (an extension that defines a custom msgtpl with custom workflow) - and confirmed what we expected: (1) the workflow_name is filled on upgrade but (2) the workflow_name is faulty on new installs.

The extra commit 097c97a 0c5781a should keep the values in sync - I can confirm that new installations with civivolunteer end up with suitable workflow_name.

[totten]

Discussed a bit on MM - Eileen seemed OK with the extra commits. Merging.