CiviCRM Community Forums (archive)

I am trying to customize one of the system workflow messages
(Home > CiviCRM > Administer CiviCRM > Message Templates > System Workflow Messages). 

From the errors my attempts have generated, it appears that the tokens which may be used in this type of message are not the same as the tokens described in the token documentation in the link which appears on the System Workflow Messages edit screen. 

For example {contact.first_name} returns an error. 

Most of the tokens in the default System Workflow Messages message I am trying to edit relate to $formValues but I can't seem to find a list of the available $formValues tokens.

Where can I find documentation for the tokens which are available in this context?

Thanks!  Somehow I hadn't noticed the "Insert Tokens" link, believe it or not! 

The error message says "user error: Smarty error: [etc... duplicating many lines of the template here]
syntax error: unidentified token '.first_name' (Smarty_Compiler.class.php, line 1410) in /home1/.../sites/all/modules/civicrm/packages/Smarty/Smarty.class.php on line 1093."

Thanks for your help.  I made the same changes to the off-line contributions message on the demo site, and the same error appears, so hopefully that will make it easier to solve.

The changes to the system template are below (I only provided the text template below, but corresponding changes were made to the HTML template).

Is the problem that these tokens are not supported in the context of an if/else block?  That is my thought at this point.  If so, is there any way to accomplish such logic?

{if contact.email_greeting}
{contact.email_greeting},
{else}
{if contact.first_name}
Dear {contact.first_name},
{/if}
{/if}
{if $formValues.receipt_text}
{$formValues.receipt_text}
{else}
Thank you for your generous financial support. 
We will mail you a printed receipt soon, but in the meantime, you may print this message for your records if you need an immediate record.
{/if}


===========================================================
{ts}Contribution Information{/ts}

===========================================================
{ts}Contribution Type{/ts}: {$formValues.contributionType_name}
{if $lineItem}
{foreach from=$lineItem item=value key=priceset}
---------------------------------------------------------
{capture assign=ts_item}{ts}Item{/ts}{/capture}
{capture assign=ts_qty}{ts}Qty{/ts}{/capture}
{capture assign=ts_each}{ts}Each{/ts}{/capture}
{capture assign=ts_total}{ts}Total{/ts}{/capture}
{$ts_item|string_format:"%-30s"} {$ts_qty|string_format:"%5s"} {$ts_each|string_format:"%10s"} {$ts_total|string_format:"%10s"}
----------------------------------------------------------
{foreach from=$value item=line}
{$line.description|truncate:30:"..."|string_format:"%-30s"} {$line.qty|string_format:"%5s"} {$line.unit_price|crmMoney|string_format:"%10s"} {$line.line_total|crmMoney|string_format:"%10s"}
{/foreach}
{/foreach}
{/if}

{ts}Total Amount{/ts}: {$formValues.total_amount|crmMoney}
{if $receive_date}
{ts}Received Date{/ts}: {$receive_date|truncate:10:''|crmDate}
{/if}
{if $receipt_date}
{ts}Receipt Date{/ts}: {$receipt_date|truncate:10:''|crmDate}
{/if}
{if $formValues.paidBy and !$formValues.hidden_CreditCard}
{ts}Paid By{/ts}: {$formValues.paidBy}
{if $formValues.check_number}
{ts}Check Number{/ts}: {$formValues.check_number}
{/if}
{/if}
{if $formValues.trxn_id}
{ts}Transaction ID{/ts}: {$formValues.trxn_id}
{/if}

{if $ccContribution}
===========================================================
{ts}Billing Name and Address{/ts}

===========================================================
{$billingName}
{$address}

===========================================================
{ts}Credit Card Information{/ts}

===========================================================
{$credit_card_type}
{$credit_card_number}
{ts}Expires{/ts}: {$credit_card_exp_date|truncate:7:''|crmDate}
{/if}
{if $customGroup}
{foreach from=$customGroup item=value key=customName}
===========================================================
{$customName}
===========================================================
{foreach from=$value item=v key=n}
{$n}: {$v}
{/foreach}
{/foreach}
{/if}
{if $formValues.honor_first_name}

===========================================================
{$formValues.honor_type}
===========================================================
{$formValues.honor_prefix} {$formValues.honor_first_name} {$formValues.honor_last_name}
{if $formValues.honor_email}
{ts}Honoree Email{/ts}: {$formValues.honor_email}
{/if}
{/if}

{if $formValues.product_name}
===========================================================
{ts}Premium Information{/ts}

===========================================================
{$formValues.product_name}
{if $formValues.product_option}
{ts}Option{/ts}: {$formValues.product_option}
{/if}
{if $formValues.product_sku}
{ts}SKU{/ts}: {$formValues.product_sku}
{/if}
{if $fulfilled_date}
{ts}Sent{/ts}: {$fulfilled_date|crmDate}
{/if}
{/if}

In the course of answering another post today and working with Lobo, I learned that you CAN use the CiviCRM contact tokens in smarty expressions. The trick is that you have to surround them with curly-brackets within the smarty expression (so brackets are nested).

For example, this will work in a system message template:
{if {contact.preferred_language} eq 'fr'}I see you speak french!{else}I see you speak some other language{/if}

CAVEAT: You'll need 3.2.1 for the above example since we also discovered that some contact tokens were not being populated for System Message Templates. Patch available from: http://issues.civicrm.org/jira/browse/CRM-6600

3.2.1 out soon?

Hopefully next week, maybe the week after – depending on how the 3.2.1 issue queue looks like.

can u reproduce this on our demo server. the error message seems wierd

lobo

Lobo: On the Demo server(V. 3.4) I get this error:
  Sorry. A non-recoverable error has occurred.
  PDF Format Option Group not found in database.

Dave: Thanks for checking, but I do have Smarty Templates enabled the define( 'CIVICRM_MAIL_SMARTY', 1 ); in the civicrm.settings.php file. The error does seem weird. The folder sites/default/files/civicrm/templates_c/en_US/ is full of folders with names like %%OB, %%OC, %%0F, and so on, 120 all in all. And then also the da_DK folder, with 250 folders in the same style. But perhaps that's how it is supposed to be?

I am using Danish as default language, might that be causing the error?

That sounds great Lobo!

Forgive me if I haven't understood the purpose of the demo server, but is it a good idea to use it for testing new code live? I would think the best practice was to have a stable demo version on-line, also so that new users have a good first time experience, when trying the demo version. I also wouldn't like to use a beta version for production, which I might need to, if the Smarty code above does work in the current 3.4.2 version, and not the recommended stable version, 3.4.1.

But perhaps that is the purpose of the demo server, part presentation, part sandbox?

About the error, might it have something to do with php version 5.2 versus 5.3? I have stumbled over other places in the Drupal world where the added ampersand-sign("&") in variables messes up in 5.3 or in 5.2 I forget...
For example &$variable_name versus $variable_name, without the ampersand-sign.