Data Dictionary
  • 16 Apr 2024
  • 4 Minutes to read
  • Dark
    Light

Data Dictionary

  • Dark
    Light

Article Summary

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!

Permission Sets and Licensing for the Data Dictionary

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

Supported Languages

We do not currently support all languages. The following is a list of the languages we support. 

  • Arabic    
  • Chinese (Simplified)    
  • Chinese (Traditional)
  • Czech    
  • Danish    
  • Dutch    
  • Finnish    
  • French
  • German    
  • Haitian Creole    
  • Hindi    
  • Hmong    
  • Hungarian    
  • Indonesian    
  • Italian    
  • Japanese    
  • Korean    
  • Norwegian    
  • Polish    
  • Portuguese    
  • Romanian    
  • Russian    
  • Somali
  • Spanish    
  • Swedish    
  • Thai    
  • Turkish    
  • Vietnamese 

Create a Data Dictionary Group

One-to-One Relationship for Keys and Values

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.

If you want to override out-of-the-box values, the first step is to create a Data Dictionary Group and populate it with Data Dictionary Entries.

  1. In the App Launcher, enter and click "Data Dictionary Group".

  2. Click New.CreateDataDictionaryGroup_Object

  3. Enter a Data Dictionary Group Name.

  4. Click Save.CreateDataDictionaryGroup_New

  5. Click New next to the Data Dictionary Entry. In a Data Dictionary Group, each Data Dictionary Entry can only support one language.CreateDataDictionaryGroup_NewEntry

  6. The Data Dictionary Values field contains the Language / Locale, Key, and Value. There can only be one Value per Key for each Language / Locale. Creating a new entry for an existing Key will replace the current Value with the new one. Click here for the full Events Data Dictionary list. And here are some of the most frequently used Data Dictionary Value and their Keys:
    • Key = "ACT_ADD_ATTENDEE" and Value = "Add Attendee"
    • Key = "ACT_DONE" and Value = "Done"
    • Key = "LBL_FREE" and Value = "Free"
    • Key = "ACT_REGISTER" and Value = "Registration"
    • Key = "MSG_REGISTRATION_CONFIRMED" and Value = "You are registered!"
  7. Select the Language / Locale you'd like to change. 

  8. Enter a Key and Value.

  9. Click Add Row to add additional entries or click Save

  10. Click Back to return to the Data Dictionary Group record.

CreateDataDictionaryGroup_EntryKeyValue

If you need to add additional keys to the Data Dictionary Entry, click the menu (upside down triangle) next to the Data Dictionary Entry. From there, click Add Row to add a new Key and Value. When you are done, click Save and Back to return to the Data Dictionary Group.

USE CAPITAL LETTERS
In the Key field, use capital letters.

Example

For this example, we will set Language / Locale = "English". Now, we can select any word or phrase to replace an action with. For this example, we set Key = “ACT_COMPLETE“ and Value = “Complete”. Make sure to use all capital letters for the Key

Override Labels 7

Here's the expected result.
Override Labels 9

However, if we were to change Value = "Complete" to Value = "Test", this would be the result.
Override Labels 10

Override Labels 11

Override a Specific Key

If you are looking for a specific Key you want to override, click the Event Page URL field, and swap the language in the domain with "debug". You will see the keys on a specific Event, or in other words, the debugged version of the Event with each field identified. 

See the images below to see how swapping "https://events.blackthorn.io/en/" with "https://events.blackthorn.io/debug/" shows the keys.

"https://events.blackthorn.io/en/"
Data Dictionary_Regular

"https://events.blackthorn.io/debug/"

Data Dictionary_Debug

Add a Data Dictionary Group to an Event Settings Record

  1. Open an Event Settings record.
  2. Click the Pencil icon next to the Data Dictionary Group field.Event%20Settings_Data%20Dictionary%20Group%20Field
  3. Select a Data Dictionary Group.
  4. Click Save

Remove the Paid/Free Verbiage

Please Note

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 an empty value.
remove free verbiage 1

And voila! Now, we can see that the text has been removed from the page.
remove free verbiage 2

With the Data Dictionary, it is completely up to you what you'd like each field to represent in your checkout process.

Use 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, give 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".