Data Dictionary
  • 13 Jul 2022
  • 3 Minutes to read
  • Dark
    Light

Data Dictionary

  • Dark
    Light

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 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

Override Labels and Button Text

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.

  1. Create a Data Dictionary Group related to an Event Settings record.
    Override Labels 1

    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.
    Override Labels 2

  2. From the Data Dictionary Group add a new Data Dictionary.
    Override Labels 3

  3. Select the Language / Locale you'd like to change; for this example we will select "English".
    Override Labels 4

Language Support

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.

  1. 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/"
    Override Labels 5

    "https://events.blackthorn.io/debug/"
    Override Labels 6 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.

Override Labels 7

USE CAPITAL LETTERS

In the Key definition, use capital letters.

Override Labels 8

  • Now that we've selected that, we should see this as 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

Removing 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 in 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 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

When overriding the AttendeeLink Personal Welcome Message (Key = MSG_ATTLINK_PERSONAL) include {name} in the Value field which will dynamically pull in the Attendee's first Name.

Example: Welcome {name}. Thank you for your interest in the upcoming event.

Use Case 2

When overriding the 'Starting from price' on the Event page (Key = LBL_STARTING_FROM_PRICE), include {price} in the Value field which will dynamically pull in price.

Example: Price starts at {price}!

Use Case 3

When overriding the 'Registration Canceled' message on the AttendeeLink (Key = MSG_REGISTRATION_CANCELED), include {name} and {date} in the Value field which will dynamically pull in Event Name and Date.

Example: Your registration to {name} on {date} is canceled.