References let you personalize your messages and documents automatically. Insert a short code, and Auctria fills in the right information for each recipient, item, or donor.
For example, if you send this text message:
Hi {{ FirstName }}, thanks for joining us! Your Paddle# is {{ Number }}.
Jane Smith receives:
Hi Jane, thanks for joining us! Your Paddle# is 112.
How to add a reference
- Open the email, text message, or template you want to edit.
- Place your cursor where the information should appear.
- Type or paste the reference code, including both sets of curly braces. Check the table under Where you can use references to choose the right form.
- Send yourself a test message, or preview the template, to check the result before sending it to everyone.
Avoid typos:
Copy and paste codes straight from the reference tables to avoid typos. A missing brace or misspelled word means the code won't be filled in.
Short form and full form
Most references come in two forms:
| Short form | Full form |
|---|---|
{{ FirstName }} | {{ Bidder.FirstName }} |
The short form shows information from the one record the message or template is about. On a bid sheet, that record is the item. On a receipt footer, it's the participant.
The full form starts with the type of record, such as Bidder. or Donor.. It only works in places where Auctria makes that record available by name.
Which form works depends on where you use it. In some places, only one form works, and the other shows up blank.
Which form should I use?
In emails built with the email editor, always use the full form ({{ Bidder.FirstName }}). In bid sheets, catalogs, certificates, display pages, receipt headers and footers, and Word document templates, use the short form ({{ Title }}), because these templates are about a single record. Text messages accept either form.
Names that mean the same thing
Some record types have two names. Both work the same way, and you may see either one in examples:
| These are the same | |
|---|---|
Bidder. | Participant. |
Auction. | Event. |
For example, {{ Bidder.FirstName }} and {{ Participant.FirstName }} both show the participant's first name.
Where you can use references
| Where | Short form | Full form | Information available |
|---|---|---|---|
| Text messages to participants | Yes | Yes | The participant, the event, and your organization |
| Emails built in the email editor | No | Yes | Participants, donors, the event, and your organization |
| Basic emails (plain subject and body) | Yes | Event and organization only | The recipient's own details |
| Bid sheets | Yes | No | The item |
| PDF catalog templates (description, donor, and quantity) | Yes | No | The item |
| Certificates and display pages | Yes | No | The item |
| PDF participant receipt headers and footers | Yes | No | The participant, plus receipt totals |
| Participant statement email headers and footers | Yes | No | The participant's own details only |
| Donor receipt headers and footers | Yes | No | The donor |
| Basket description template | Yes | No | The basket item |
| Word document templates | Yes | No | One participant, donor, or item, plus lists you can loop through |
| System emails | Varies | Yes | Depends on the message. See What's included in system emails. |
Things to keep in mind
- Single-record templates use the short form only. On a bid sheet, use
{{ Title }}, not{{ Item.Title }}. The full form shows up blank there. - You can follow links to related records. When a field points to another record, add a dot to reach that record's details, even in a single-record template. For example,
{{ Donor.Name }}on a bid sheet shows the item donor's name. - Basic emails only use the full form for event and organization details. For the recipient's own details, use the short form:
{{ FirstName }}works, but{{ Bidder.FirstName }}shows up blank. - Your organization's details are available everywhere. Use the
Organization.prefix, such as{{ Organization.Name }}. In the email editor, the available organization details are the name, email, website, logo, currency, time zone, and social media links. - Some fields can't be used as references. These include hidden fields, files such as images (see Item References for how to show item images), and fields that hold more than one value. Some calculated fields aren't available either, and the email editor includes fewer calculated fields than other places.
Lists and Word document templates
Some references hold a list instead of a single value, such as a participant's items won or a donor's donated items. Lists only work in Word document templates and a few system emails. Everywhere else, they show up blank.
In a Word document template, show a list by looping through it. Start the loop with {% foreach ListName %} and end it with {% end %}. Inside the loop, the short form refers to each entry in the list.
For example, this lists the number and title of every silent auction item:
{% foreach SilentItems %}{{ Number }} {{ Title }}{% end %}
Each reference page includes a Word document templates only section for the codes that only work there.
What's included in system emails
System emails are the messages Auctria sends automatically. Each one includes a fixed set of information.
| Message | What you can use |
|---|---|
| Purchase and registration receipts | Bidder./Participant., Auction./Event., Organization., plus {{ Purchases }} (the purchased items), {{ Payment }} (the amount paid), {{ PaidBy }}, {{ Balance }}, {{ BidTotal }}, {{ Donation }}, {{ HasPurchase }}, and {{ HasDonation }} |
| Outbid and bid confirmation emails | Bidder., Item., and Bid. |
| E-tickets | Bidder., Ticket., and Ticket.Item. |
| Donor receipt email | Donor. |
| Text message statement | Items won, purchases, donations, payments, and tickets, with their totals |
Test the text statement:
The lists in the text message statement may not display as expected. Send yourself a test statement before relying on them.
Tips for great messages
- Test first. Always send a test to yourself before sending to your full list. A reference that shows up blank usually means the wrong form for that place, a field that isn't available there, or a list outside a Word document template.
- Keep texts short. Text messages have limited space. Use short links like
{{ ShortRegisterCreditCardUrl }}instead of full links. - Plan for blank fields. If a record doesn't have the information (for example, no company name), the reference shows nothing. Write your sentence so it still reads well if a value is missing.
- Check internal fields. Some fields, like Notes, may contain information meant only for your team. Review them before including them in messages.
Reference lists
| Page | Description |
|---|---|
| Participant References | Names, contact details, Paddle#, receipt totals, and payment links |
| Item References | Item titles, prices, images, winners, and closing times |
| Donor References | Donor names, contact details, and donated items |
| Bid History References | Individual bids, amounts, and taxes |
| Payment References | Payment details, card charges, and how payments were credited |
| Catalog and Category References | Word catalog templates and item categories |
