Configuration glossary

In this section you'll find more information about common configuration presets found in the various destination creation forms.

Activated parameters#

Activated parameters allow you to select which Velocidi CDP attributes and segments to use in your destinations.

activated parameters

In order to use any attribute or segment in any of your destinations you must first list relevant attributes/segments for that destination.

To add a Attribute to the activated parameters:#

  1. Click Add parameter;
  2. Input the name to which you will refer to that attribute in the Templated Fields of your Destination in the Parameter Name column;
  3. Select Attribute from the Attribute/Segment dropdown;
  4. Select the relevant Velocidi CDP attribute in the Attribute or Segment column. The dropdown auto-complete is updated periodically with all attributes that exist in user profiles of the CDP. You can see the list at User Profile Attributes.

To add a Segment to the activated parameters:#

  1. Click Add parameter;

  2. Input the name to which you will refer to that segment in the Templated Fields of your Destination in the Parameter Name column;

  3. Select Segment from the Attribute/Segment dropdown;

  4. Select the relevant Velocidi CDP segment in the Attribute or Segment column.

  5. The segment will evaluate to either true or false so you need to chose which value you want to use in your destination for each case.

    activated parameters

What if the User profile does not include all of defined activated parameters?#

By default, if the user profile is missing all of the defined activated parameters, it won't be activated. However, you can change this behavior with the Require activation parameters config.

activated parameters

note

When selecting "No, always activate the user", have that in consideration when filling the templated fields because you may not have access to any activated attribute.

Once you've selected all relevant Activated Parameters, you can now start using them in the Templated Fields.

Templated fields#

In Destination forms, a Templated Field is a field which can be interpolated using Liquid templating language and is marked with a "icon".

Exposed fields#

There are two objects exposed to the templated fields:

  • parameters: defined by the Activated Parameters

    • If parameter_name refers to an attribute, {{ parameters["parameter_name"] }} will be replaced by the parameter value;
    • If parameter_name refers to a segment, {{ parameters["parameter_name"] }} will be replaced with the valueIfTrue and valueIfFalse values if the segment is true or false, accordingly.
  • meta: meta attribuets used in the activation

    • Namely: USER_ID and USER_ID_TYPE;
    • These can be accessed with {{ meta["USER_ID"] }}.

Using the parameters object safely#

However, the recommended way to use the parameters object is using it as an opaque structure (which will only contain attributes/segments mapped in the activated parameters that exist in the user profile).

Given the parameters object: {a: 1, b:2}:

For URL use the query_params filter#

The templated field http://example.org?{{ parameters | query_params }} will render http://example.org?a=1&b=2.

For JSON use the json filter.#

The templated field {{parameters | json}} will render {"a": 1, "b": 2}.

Using properties of the parameters directly#

Given the parameters object: {a: 1, b:2}:

The templated field http://example.org?gender={{ parameters["a"] }} will render http://example.org?gender=1.

Last updated on