- 29 Jan 2024
- 4 Minutes to read
- Print
- DarkLight
Data Dictionary
- Updated on 29 Jan 2024
- 4 Minutes to read
- Print
- DarkLight
The Data Dictionary feature provides the flexibility to override button labels and other static text on your hosted Event pages. This gives you the ability to further customize the experience for your Attendees, and even better, it supports multi-language Events and merge fields as well!
To use the Data Dictionary feature, you must have a Blackthorn Payments license, as well as access to the following fields:
- Create/Read/Update - Data Dictionary Group
- Create/Read/Update - Data Dictionary Entry
Override Labels and Button Text
For each Language/Locale, there can only be one Value per Key. Creating a new entry for an existing Key will replace the current Value with the new one.
If a label or button isn't translating correctly (we use Google Translate), or if you want to override a value with your own label, you can manually define the label for your Event.
Create a Data Dictionary Group related to an Event Settings record.
Alternatively, you can create a Data Dictionary Group on an Event Group record. This will add the Data Dictionary Group to all Events within the Event Group. The Data Dictionary Group on the Event Settings record will take priority over the Data Dictionary Group on the Event Group.
From the Data Dictionary Group add a new Data Dictionary.
Select the Language / Locale you'd like to change; for this example we will select "English".
In the Language / Locale picklist, we do not support all languages available to pick from at this time. At the bottom of this page, you will find a list of all languages that we do support.
- Now, we're prompted with a Key and Value. This is where it gets fun!
First, click on this Google Document - this will give you all the information of what the translations are.
Second, If you are looking for a specific key you want to override, click on the Event Page URL, and swap the language in the domain with "debug" to see all the keys on a specific Event. This will show you a debug version of the Event, with each field identified. Essentially swap "https://events.blackthorn.io/en/" with "https://events.blackthorn.io/debug/".
"https://events.blackthorn.io/en/"
"https://events.blackthorn.io/debug/"
Here are some of the most frequently used Data Dictionary values and their keys:
- Add Attendee - ACT_ADD_ATTENDEE
- Done button - ACT_DONE
- Free - LBL_FREE
- Registration button - ACT_REGISTER
- You are registered! - MSG_REGISTRATION_CONFIRMED
Since we selected English as the primary language, we will use that for our source translation. Now, we can select any word or phrase to replace an action with. For this example, we will use the "Complete" field.
In the Key definition, use capital letters.
Now that we've selected that, we should see this as the expected result:
However, if we were to change Value = "Complete" to Value = "Test", this would be the result.
Removing the Paid/Free Verbiage
This currently only applies to the Event Group URL.
There are currently two ways to remove the "Free" and "$XX.XX" pricing.
- Reach out to Blackthorn Support to disable this throughout the entire org.
- If you would like to only remove the "Free" verbiage from the Event registration, you can do so by setting the Value field to a "Space bar" entry.
Going back to this Google Document, we can find the key we're looking for. In this case, let's remove the "Free" from the Subtotal column. The key we will be using is LBL_SUBTOTAL. Next, for the Value field, simply click the space bar to enter in an empty value.
And voila! Now, we can see that the text has been removed from the page.
With the Data Dictionary, it is completely up to you on what you'd like each field to represent in your checkout process.
Using Merge Fields with Data Dictionary
While we do not support merge fields in the Data Dictionary out of the box, we do have ICU formatted messages that by default gives you the ability to insert dynamic text within the message. Syntax is {variable}.
Click here for more information on Salesforce Supported ICU Formats.
Use Cases
Use Case 1 - Change the Welcome Message
To update the text in the “Personal Welcome Message” message that appears in the AttendeeLink, set Key = “MSG_ATTLINK_PERSONAL” and Value = text that includes the Attendee’s "{name}". The Attendee’s First Name will automatically be added.
Example: Welcome {name}. Thank you for your interest in the upcoming event.
Use Case 2 - Update the Starting From Price
To override the “Starting from {price}” on the Event’s webpage, set Key = “LBL_STARTING_FROM_PRICE” and Value = text that includes “{price}”. The cost of the lowest priced Event Item will automatically be added.
Example: Price starts at {price}!
Use Case 3 - Change the Registration Canceled Message
To override the text in the “Registration Canceled” message that appears in the AttendeeLink, set Key = “MSG_REGISTRATION_CANCELED” and Value = text that includes "{name}" and "{date}". The Event Name and Event Start Date will automatically be added.
Example: Your registration to {name} on {date} is canceled.
Use Case 4 – Modify the Get Tickets Button
To change the text on the Get Tickets button to “Join or Renew Membership”, set Key = “ACT_GET_TICKETS” and Value = “Join or Renew Membership".