Helpers gs-helpers

Default Fallback Value default-value

The Default Fallback Value helper is used to return a default fallback value if an attribute is empty or null. This mechanism works for Profile attributes and Journey events.

Syntax

Hello {%=profile.personalEmail.name.firstName ?: "there" %}!

In this example, the value there is displayed if the firstName attribute of this profile is empty or null.

Conditions if-function

The if helper is used to define a conditional block.
If the expression evaluation returns true, the block is rendered otherwise it is skipped.

Syntax

{%#if contains(profile.personalEmail.address, ".edu")%}
<a href="https://www.adobe.com/academia">Check out this link</a>

Following the if helper, you can enter an else statement to specify a block of code to be executed, if the same condition is false.
The elseif statement will specify a new condition to test if the first statement returns false.

Format

{
    {
        {%#if condition1%} element_1
        {%else if condition2%} element_2
        {%else%} default_element
        {%/if%}
    }
}

Examples

Unless unless

The unless helper is used to define a conditional block. By opposition to the if helper, if the expression evaluation returns false, the block is rendered.

Syntax

{%#unless unlessCondition%} element_1 {%else%} default_element {%/unless%}

Example

Render some content based on email address extension:

{%#unless endsWith(profile.personalEmail.address, ".edu")%}
Some Normal Content
{%else%}
Some edu specific content
{%/unless%}

Each each

The each helper is used to iterate over an array.
The syntax of the helper is

The syntax of the helper is We can refer to the individual array items by using the keyword this inside the block. The index of the array’s element can be rendered by using {{@index}}.

The syntax of the helper is

The syntax of the helper is Syntax

The syntax of the helper is

The syntax of the helper is

• {{this.name}}

**Example**

```sql
{{#each profile.homeAddress.city}}
  {{@index}} : {{this}}<br>
{{/each}}

Example

Render a list of products that this user has in their cart:

{{#each profile.products as |product|}}
    <li>{{product.productName}} {{product.productRating}}</li>
{{/each}}

With with

The with helper is used to change the evaluation token of template-part.

Syntax

{{#with profile.person.name}}
{{this.firstName}} {{this.lastName}}
{{/with}}

The with helper is useful to define a shortcut variable too.

Example

Use with for aliasing long variable names to shorter ones:

{{#with profile.person.name as |name|}}
 Hi {{name.firstName}} {{name.lastName}}!
 Checkout our trending products for today!
{{/with}}

Let let

The let function allows an expression to be stored as a variable to be used later in a query.

Syntax

{% let variable = expression %} {{variable}}

Example

The following example lets you calculate the total sum of prices for products in the cart with prices between 100 and 1000.

{% let sum = 0%}
    {{#each profile.productsInCart as |p|}}
        {%#if p.price>100 and p.price<1000%}
            {%let sum = sum + p.price %}
        {%/if%}
    {{/each}}
{{sum}}

Dataset lookup dataset-lookup

The datasetLookup helper retrieves data from Adobe Experience Platform record datasets during personalization so you can use field values that are not stored on the profile or in the event payload.

Syntax

{{datasetLookup datasetId="datasetId" id="key" result="store" required=false}}

Reference retrieved fields with {{result.fieldId}}, where result is the value you pass to the result parameter.

For dataset enablement, parameter details, examples, and testing, see Use Adobe Experience Platform data for personalization.

Execution Metadata execution-metadata

The executionMetadata helper allows to dynamically capture and store custom key-value pairs into the message execution context.

Syntax

{{executionMetadata key="your_key" value="your_value"}}

In this syntax, key refers to the metadata name and value is the metadata to persist.

Use case

With this function, you can append contextual information to any native action from your campaigns or journeys. This enables you to export real-time delivery contextual data to external systems for various purposes such as tracking, analytics, personalization and downstream processing.

For instance, you can use the Execution Metadata helper to append a specific ID to each delivery sent to each profile. This information is generated during runtime and the enriched execution metadata can then be exported for downstream reconciliation with an external reporting platform.

How it works

Select any element from your channel content inside a campaign or a journey and, using the personalization editor, add the executionMetadata helper to this element.

Upon runtime, the metadata value is added to the existing Message Feedback Event Dataset with the following schema addition:

"_experience": {
  "customerJourneyManagement": {
    "messageExecution": {
      "metadata": {
        "your_key": "your_value"
      }
    }
  }
}

Limitations

There is an upper limit of 2kb on the key value pairs per action. If the 2Kb limit is exceeded, the message is still delivered, but any of the key value pairs can be truncated.

Metadata is not captured for profiles excluded from the action. When a profile is excluded from receiving a message, no metadata entry is created for that profile in the dataset.

Example

{{executionMetadata key="firstName" value=profile.person.name.firstName}}

In this example, assuming profile.person.name.firstName = “Alex”, the resulting entity is:

{
  "key": "firstName",
  "value": "Alex"
}

Encrypt url-parameter-encryption-helper

The Encrypt function lets you encrypt any expression value at render time—commonly a profile attribute, a token, or even a stringified JSON structure you build in the expression—before it is written into a query parameter on tracking links or landing pages.

Values that would appear as plain text in the URL (including PII or other sensitive data) are not readable when the link is inspected or forwarded. Only the values you wrap with this helper are encrypted; the rest of the URL is unchanged.

Use case

This helper allows you to protect sensitive profile data (PII) before including it in rendered output.

Prerequisite

An administrator must create at least one active key in the sandbox-level key registry. Learn how to create and manage keys

Syntax

{{encrypt dataPath keyName="keyName" version="version" result="variableName"}}

Usage

This helper encrypts sensitive data and stores the result in a template variable.

You can apply the helper to one parameter, several, or all parameters in a link, depending on your URL design and length constraints.

Examples

Guardrails