Customised workflow templates need manual updating on upgrade

[Eileen]

Most of our customers have customised contribution, membership & event receipts (for many this might not be necessary if there were a {domain.header} token available in all of these.

After upgrading to 3.4.6 (although annecdotally maybe it was earlier) there customised templates require modification to re-incorporate changes to the underlying template. I suppose with a bit of effort an sql method may be possible, It seems on the event tpl, at least

     {if $customPre}
      <tr>
       <th {$headerStyle}>
        {$customPre_grouptitle}
       </th>
      </tr>
      {foreach from=$customPre item=value key=customName}
       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}
        <tr>
         <td {$labelStyle}>
          {$customName}
         </td>
         <td {$valueStyle}>
          {$value}
         </td>
        </tr>
       {/if}
      {/foreach}
     {/if}

Needs to be replaced with

{if $customPre}
{foreach from=$customPre item=customPr key=i}
   <tr> <th {$headerStyle}>{$customPre_grouptitle.$i}</th></tr>
   {foreach from=$customPr item=customValue key=customName}
   {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}
     <tr>
         <td {$labelStyle}>{$customName}</td>
         <td {$valueStyle}>{$customValue}</td>
     </tr>
   {/if}
   {/foreach}
{/foreach}
{/if}

& ditto on the post
     {if $customPost}
      <tr>
       <th {$headerStyle}>
        {$customPost_grouptitle}
       </th>
      </tr>
      {foreach from=$customPost item=value key=customName}
       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}
        <tr>
         <td {$labelStyle}>
          {$customName}
         </td>
         <td {$valueStyle}>
          {$value}
         </td>
        </tr>
       {/if}
      {/foreach}
     {/if}

With

{if $customPost}
{foreach from=$customPost item=customPos key=j}
   <tr> <th {$headerStyle}>{$customPost_grouptitle.$j}</th></tr>
   {foreach from=$customPos item=customValue key=customName}
   {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}
     <tr>
         <td {$labelStyle}>{$customName}</td>
         <td {$valueStyle}>{$customValue}</td>
     </tr>
{/if}
{/foreach}
{/foreach}
{/if}


AND

     {if $customProfile}
      {foreach from=$customProfile item=value key=customName}
       <tr>
        <th {$headerStyle}>
         {ts 1=$customName+1}Participant Information - Participant %1{/ts}
        </th>
       <tr>
       {foreach from=$value item=val key=field}
        {if $field eq 'additionalCustomPre' or $field eq 'additionalCustomPost'}
         <tr>
          <td colspan="2" {$labelStyle}>
           {if $field eq 'additionalCustomPre'}
            {$additionalCustomPre_grouptitle}
           {else}
            {$additionalCustomPost_grouptitle}
           {/if}
          </td>
         </tr>
         {foreach from=$val item=v key=f}
          <tr>
           <td {$labelStyle}>
            {$f}
           </td>
           <td {$valueStyle}>
            {$v}
           </td>
          </tr>
         {/foreach}
        {/if}
       {/foreach}
      {/foreach}
     {/if}

With


{if $customProfile}
{foreach from=$customProfile.profile item=eachParticipant key=participantID}
     <tr><th {$headerStyle}>{ts 1=$participantID+2}Participant Information - Participant %1{/ts} </th></tr>
     {foreach from=$eachParticipant item=eachProfile key=pid}
     <tr><th {$headerStyle}>{$customProfile.title.$pid}</th></tr>
     {foreach from=$eachProfile item=val key=field}
     <tr>{foreach from=$val item=v key=f}
         <td {$labelStyle}>{$field}</td>
         <td {$valueStyle}>{$v}</td>
         {/foreach}
     </tr>
     {/foreach}
{/foreach}
{/foreach}
{/if}

[petednz]

FYI the issue clients were having was that the Event Confirmation and Donation/Membership Receipts were going out with ARRAY in the table of fields
Just adding this so people searching for array and system template messages and receipts etc might find this

[Eileen]

OK we fixed up a bunch of customised templates with the following rather drawn out sql - it includes quite a bit of context as it is intended only to replace unedited bits of strings.

This doesn't bring across all the changes - just the ones that were causing broken emails

Code: [Select]

UPDATE
 `civicrm_msg_template`
 SET msg_html = REPLACE(msg_html,'<td {$valueStyle}>\r\n         {$amount|crmMoney}\r\n        </td>\r\n       </tr>\r\n\r\n      {else}\r\n\r\n       <tr>\r\n\r\n','<td {$valueStyle}>\r\n         {$amount|crmMoney}\r\n        </td>\r\n       </tr>\r\n\r\n      {else}\r\n       {if $useForMember && $lineItem}\r\n       {foreach from=$lineItem item=value key=priceset}\r\n        <tr>\r\n         <td colspan="2" {$valueStyle}>\r\n          <table> {* FIXME: style this table so that it looks like the text version (justification, etc.) *}\r\n           <tr>\r\n            <th>{ts}Item{/ts}</th>\r\n            <th>{ts}Qty{/ts}</th>\r\n            <th>{ts}Each{/ts}</th>\r\n            <th>{ts}Total{/ts}</th>\r\n      <th>{ts}Membership Start Date{/ts}</th>\r\n      <th>{ts}Membership End Date{/ts}</th>\r\n           </tr>\r\n           {foreach from=$value item=line}\r\n            <tr>\r\n             <td>\r\n             {if $line.html_type eq \'Text\'}{$line.label}{else}{$line.field_title} - {$line.label}{/if} {if $line.description}<div>{$line.description|truncate:30:"..."}</div>{/if}\r\n             </td>\r\n             <td>\r\n              {$line.qty}\r\n             </td>\r\n             <td>\r\n              {$line.unit_price|crmMoney}\r\n             </td>\r\n             <td>\r\n              {$line.line_total|crmMoney}\r\n             </td>\r\n             <td>\r\n              {$line.start_date}\r\n             </td>\r\n       <td>\r\n              {$line.end_date}\r\n             </td>\r\n            </tr>\r\n           {/foreach}\r\n          </table>\r\n         </td>\r\n        </tr>\r\n       {/foreach}\r\n       {/if}' )
WHERE `msg_html` LIKE '%<td {$valueStyle}>\r\n         {$amount|crmMoney}\r\n        </td>\r\n       </tr>\r\n\r\n      {else}\r\n\r\n       <tr>\r\n\r\n%';

UPDATE
 `civicrm_msg_template`
 SET msg_html = REPLACE(msg_html,'     {if $customPre}\n      <tr>\n       <th {$headerStyle}>\n        {$customPre_grouptitle}\n       </th>\n      </tr>\n      {foreach from=$customPre item=value key=customName}\n       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\n        <tr>\n         <td {$labelStyle}>\n          {$customName}\n         </td>\n         <td {$valueStyle}>\n          {$value}\n         </td>\n        </tr>\n       {/if}\n      {/foreach}\n     {/if}\n','{if $customPre}\n{foreach from=$customPre item=customPr key=i}\n   <tr> <th {$headerStyle}>{$customPre_grouptitle.$i}</th></tr>\n   {foreach from=$customPr item=customValue key=customName}\n   {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\n     <tr>\n         <td {$labelStyle}>{$customName}</td>\n         <td {$valueStyle}>{$customValue}</td>\n     </tr>\n   {/if}\n   {/foreach}\n{/foreach}\n{/if}\n' )
WHERE `msg_html` LIKE '%     {if $customPre}\n      <tr>\n       <th {$headerStyle}>\n        {$customPre_grouptitle}\n       </th>\n      </tr>\n      {foreach from=$customPre item=value key=customName}\n       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\n        <tr>\n         <td {$labelStyle}>\n          {$customName}\n         </td>\n         <td {$valueStyle}>\n          {$value}\n         </td>\n        </tr>\n       {/if}\n      {/foreach}\n     {/if}\n%';

UPDATE
 `civicrm_msg_template`
 SET msg_html = REPLACE(msg_html,'     {if $customPost}\n      <tr>\n       <th {$headerStyle}>\n        {$customPost_grouptitle}\n       </th>\n      </tr>\n      {foreach from=$customPost item=value key=customName}\n       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\n        <tr>\n         <td {$labelStyle}>\n          {$customName}\n         </td>\n         <td {$valueStyle}>\n          {$value}\n         </td>\n        </tr>\n       {/if}\n      {/foreach}\n     {/if}','{if $customPost}\n{foreach from=$customPost item=customPos key=j}\n   <tr> <th {$headerStyle}>{$customPost_grouptitle.$j}</th></tr>\n   {foreach from=$customPos item=customValue key=customName}\n   {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\n     <tr>\n         <td {$labelStyle}>{$customName}</td>\n         <td {$valueStyle}>{$customValue}</td>\n     </tr>\n{/if}\n{/foreach}\n{/foreach}\n{/if}' )
WHERE `msg_html` LIKE '%     {if $customPost}\n      <tr>\n       <th {$headerStyle}>\n        {$customPost_grouptitle}\n       </th>\n      </tr>\n      {foreach from=$customPost item=value key=customName}\n       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\n        <tr>\n         <td {$labelStyle}>\n          {$customName}\n         </td>\n         <td {$valueStyle}>\n          {$value}\n         </td>\n        </tr>\n       {/if}\n      {/foreach}\n     {/if}%';

UPDATE
 `civicrm_msg_template`
 SET msg_html = REPLACE(msg_html,'     {if $customPost}\r\n      <tr>\r\n       <th {$headerStyle}>\r\n        {$customPost_grouptitle}\r\n       </th>\r\n      </tr>\r\n      {foreach from=$customPost item=value key=customName}\r\n       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\r\n        <tr>\r\n         <td {$labelStyle}>\r\n          {$customName}\r\n         </td>\r\n         <td {$valueStyle}>\r\n          {$value}\r\n         </td>\r\n        </tr>\r\n       {/if}\r\n      {/foreach}\r\n     {/if}','{if $customPost}\r\n{foreach from=$customPost item=customPos key=j}\r\n   <tr> <th {$headerStyle}>{$customPost_grouptitle.$j}</th></tr>\r\n   {foreach from=$customPos item=customValue key=customName}\r\n   {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\r\n     <tr>\r\n         <td {$labelStyle}>{$customName}</td>\r\n         <td {$valueStyle}>{$customValue}</td>\r\n     </tr>\r\n{/if}\r\n{/foreach}\r\n{/foreach}\r\n{/if}' )
WHERE `msg_html` LIKE '%     {if $customPost}\r\n      <tr>\r\n       <th {$headerStyle}>\r\n        {$customPost_grouptitle}\r\n       </th>\r\n      </tr>\r\n      {foreach from=$customPost item=value key=customName}\r\n       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\r\n        <tr>\r\n         <td {$labelStyle}>\r\n          {$customName}\r\n         </td>\r\n         <td {$valueStyle}>\r\n          {$value}\r\n         </td>\r\n        </tr>\r\n       {/if}\r\n      {/foreach}\r\n     {/if}%';

UPDATE
 `civicrm_msg_template`
 SET msg_html = REPLACE(msg_html,'{if $customProfile}\n      {foreach from=$customProfile item=value key=customName}\n       <tr>\n        <th {$headerStyle}>\n         {ts 1=$customName+1}Participant Information - Participant %1{/ts}\n        </th>\n       </tr>\n       {foreach from=$value item=val key=field}\n        {if $field eq \'additionalCustomPre\' or $field eq \'additionalCustomPost\'}\n         <tr>\n          <td colspan="2" {$labelStyle}>\n           {if $field eq \'additionalCustomPre\'}\n            {$additionalCustomPre_grouptitle}\n           {else}\n            {$additionalCustomPost_grouptitle}\n           {/if}\n          </td>\n         </tr>\n         {foreach from=$val item=v key=f}\n          <tr>\n           <td {$labelStyle}>\n            {$f}\n           </td>\n           <td {$valueStyle}>\n            {$v}\n           </td>\n          </tr>\n         {/foreach}\n        {/if}\n       {/foreach}\n      {/foreach}\n     {/if}','{if $customProfile}\n      {foreach from=$customProfile item=value key=customName}\n       <tr>\n        <th {$headerStyle}>\n         {ts 1=$customName+1}Participant Information - Participant %1{/ts}\n        </th>\n       </tr>\n       {foreach from=$value item=val key=field}\n        {if $field eq \'additionalCustomPre\' or $field eq \'additionalCustomPost\'}\n         <tr>\n          <td colspan="2" {$labelStyle}>\n           {if $field eq \'additionalCustomPre\'}\n            {$additionalCustomPre_grouptitle}\n           {else}\n            {$additionalCustomPost_grouptitle}\n           {/if}\n          </td>\n         </tr>\n         {foreach from=$val item=v key=f}\n          <tr>\n           <td {$labelStyle}>\n            {$f}\n           </td>\n           <td {$valueStyle}>\n            {$v}\n           </td>\n          </tr>\n         {/foreach}\n        {/if}\n       {/foreach}\n      {/foreach}\n     {/if}' )
WHERE `msg_html` LIKE '%{if $customProfile}\n      {foreach from=$customProfile item=value key=customName}\n       <tr>\n        <th {$headerStyle}>\n         {ts 1=$customName+1}Participant Information - Participant %1{/ts}\n        </th>\n       </tr>\n       {foreach from=$value item=val key=field}\n        {if $field eq \'additionalCustomPre\' or $field eq \'additionalCustomPost\'}\n         <tr>\n          <td colspan="2" {$labelStyle}>\n           {if $field eq \'additionalCustomPre\'}\n            {$additionalCustomPre_grouptitle}\n           {else}\n            {$additionalCustomPost_grouptitle}\n           {/if}\n          </td>\n         </tr>\n         {foreach from=$val item=v key=f}\n          <tr>\n           <td {$labelStyle}>\n            {$f}\n           </td>\n           <td {$valueStyle}>\n            {$v}\n           </td>\n          </tr>\n         {/foreach}\n        {/if}\n       {/foreach}\n      {/foreach}\n     {/if}%';

UPDATE
 `civicrm_msg_template`
 SET msg_html = REPLACE(msg_html,'{if $customProfile}\r\n      {foreach from=$customProfile item=value key=customName}\r\n       <tr>\r\n        <th {$headerStyle}>\r\n         {ts 1=$customName+1}Participant Information - Participant %1{/ts}\r\n        </th>\r\n       </tr>\r\n       {foreach from=$value item=val key=field}\r\n        {if $field eq \'additionalCustomPre\' or $field eq \'additionalCustomPost\'}\r\n         <tr>\r\n          <td colspan="2" {$labelStyle}>\r\n           {if $field eq \'additionalCustomPre\'}\r\n            {$additionalCustomPre_grouptitle}\r\n           {else}\r\n            {$additionalCustomPost_grouptitle}\r\n           {/if}\r\n          </td>\r\n         </tr>\r\n         {foreach from=$val item=v key=f}\r\n          <tr>\r\n           <td {$labelStyle}>\r\n            {$f}\r\n           </td>\r\n           <td {$valueStyle}>\r\n            {$v}\r\n           </td>\r\n          </tr>\r\n         {/foreach}\r\n        {/if}\r\n       {/foreach}\r\n      {/foreach}\r\n     {/if}','{if $customProfile}\r\n      {foreach from=$customProfile item=value key=customName}\r\n       <tr>\r\n        <th {$headerStyle}>\r\n         {ts 1=$customName+1}Participant Information - Participant %1{/ts}\r\n        </th>\r\n       </tr>\r\n       {foreach from=$value item=val key=field}\r\n        {if $field eq \'additionalCustomPre\' or $field eq \'additionalCustomPost\'}\r\n         <tr>\r\n          <td colspan="2" {$labelStyle}>\r\n           {if $field eq \'additionalCustomPre\'}\r\n            {$additionalCustomPre_grouptitle}\r\n           {else}\r\n            {$additionalCustomPost_grouptitle}\r\n           {/if}\r\n          </td>\r\n         </tr>\r\n         {foreach from=$val item=v key=f}\r\n          <tr>\r\n           <td {$labelStyle}>\r\n            {$f}\r\n           </td>\r\n           <td {$valueStyle}>\r\n            {$v}\r\n           </td>\r\n          </tr>\r\n         {/foreach}\r\n        {/if}\r\n       {/foreach}\r\n      {/foreach}\r\n     {/if}' )
WHERE `msg_html` LIKE '%{if $customProfile}\r\n      {foreach from=$customProfile item=value key=customName}\r\n       <tr>\r\n        <th {$headerStyle}>\r\n         {ts 1=$customName+1}Participant Information - Participant %1{/ts}\r\n        </th>\r\n       </tr>\r\n       {foreach from=$value item=val key=field}\r\n        {if $field eq \'additionalCustomPre\' or $field eq \'additionalCustomPost\'}\r\n         <tr>\r\n          <td colspan="2" {$labelStyle}>\r\n           {if $field eq \'additionalCustomPre\'}\r\n            {$additionalCustomPre_grouptitle}\r\n           {else}\r\n            {$additionalCustomPost_grouptitle}\r\n           {/if}\r\n          </td>\r\n         </tr>\r\n         {foreach from=$val item=v key=f}\r\n          <tr>\r\n           <td {$labelStyle}>\r\n            {$f}\r\n           </td>\r\n           <td {$valueStyle}>\r\n            {$v}\r\n           </td>\r\n          </tr>\r\n         {/foreach}\r\n        {/if}\r\n       {/foreach}\r\n      {/foreach}\r\n     {/if}%';

UPDATE
 `civicrm_msg_template`
 SET msg_html = REPLACE(msg_html,'     {if $customPre}\r\n      <tr>\r\n       <th {$headerStyle}>\r\n        {$customPre_grouptitle}\r\n       </th>\r\n      </tr>\r\n      {foreach from=$customPre item=value key=customName}\r\n       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\r\n        <tr>\r\n         <td {$labelStyle}>\r\n          {$customName}\r\n         </td>\r\n         <td {$valueStyle}>\r\n          {$value}\r\n         </td>\r\n        </tr>\r\n       {/if}\r\n      {/foreach}\r\n     {/if}\r\n','{if $customPre}\r\n{foreach from=$customPre item=customPr key=i}\r\n   <tr> <th {$headerStyle}>{$customPre_grouptitle.$i}</th></tr>\r\n   {foreach from=$customPr item=customValue key=customName}\r\n   {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\r\n     <tr>\r\n         <td {$labelStyle}>{$customName}</td>\r\n         <td {$valueStyle}>{$customValue}</td>\r\n     </tr>\r\n   {/if}\r\n   {/foreach}\r\n{/foreach}\r\n{/if}\r\n' )
WHERE `msg_html` LIKE '%     {if $customPre}\r\n      <tr>\r\n       <th {$headerStyle}>\r\n        {$customPre_grouptitle}\r\n       </th>\r\n      </tr>\r\n      {foreach from=$customPre item=value key=customName}\r\n       {if ( $trackingFields and ! in_array( $customName, $trackingFields ) ) or ! $trackingFields}\r\n        <tr>\r\n         <td {$labelStyle}>\r\n          {$customName}\r\n         </td>\r\n         <td {$valueStyle}>\r\n          {$value}\r\n         </td>\r\n        </tr>\r\n       {/if}\r\n      {/foreach}\r\n     {/if}\r\n%';

[Yashodha Chaku]

eileen :

We intend on including the following link explaining how to deal with system workflow msg template changes in the upgrades.
http://wiki.civicrm.org/confluence/display/CRMDOC40/Message+Templates#MessageTemplates-UpgradesandCustomizedSystemWorkflowTemplates

HTH
-Yashodha

[Eileen]

Hi, Will you list templates that have changed in the upgrade they are doing - it would be really useful if they got a list of templates that differ from the defaults AND are subject to changes

[Yashodha Chaku]

eileen :
yes, we will list all the templates that have been modified by user AND modified in upgrade as well

-Yashodha

[Marty]

I'm experiencing the template problem in my email receipts after upgrading from 3.3.5 to 3.4.7.  I'm using the default templates and verified that they don't contain the updates described by Eileen.  I tried running the SQL but no changes were made (not sure why), so I guess I'll need to make the changes manually.

Is there an issue open for this?  I see in Subversion that the change has been made for the event registration online receipt template, but not for the contribution or membership online receipt templates.


UPDATE: I made the modifications to my online contribution and membership receipt templates, and now they're worse.  I get custom name fields like 'groupHelpPre', 'groupHelpPost', 'title', 'where', 'attributes', 'is_required', 'is_view', etc, etc, and these repeat for each custom field.  I've since removed the updates, but now back to the original problem. 

[Marty]

PROBLEM SOLVED - I realized that the template changes described in this thread are only required to support the ability for unlimited profiles for event registration forms, and do not apply to the contribution/membership templates.

It turns out that the changes to support unlimited profiles in event registration forms broke email receipts for online contributions when the contribution form contains a bottom-of-page profile.  I opened a new issue and described the fix in CRM-9226.