Lets Get Visual – Fields, Actions and Tests

Fields, Actions and Tests make up the appearance of a UTM-Builder UI. Fields describe the rows where values can come from. And Actions and Tests decide what is visible when.

Fields

Fields represent a possible input. They make up a row of the final UI and can be either a list of buttons or a free text input.

Each fields has

  • A number of possible values (eg. the list of buttons)
  • But at any time a field has Only One active value.

This active value is used by UTM Datapoint “Recipes”. Eg the active value of a Field with id “source” would be checked by a recipe using the syntax ${source}

 

Create a Field

You can create a field by clicking the plus to the right of an existing field or by the Add new Field button at the top of the Fields area.

There are 5 elements to describe the Field

  • Id
    • this is used to identify the Field for Recipes eg. ${field}
    • Can only contain letters.
  • Title
    • The displayed name for a user of the Profile
  • Is Top Right
    • If this field is ticked the field will be moved to the top right corner of chrome extension
    • The field type is set to buttons
    • We advise to use this feature for rarely changed global fields and to have only a few options
  • Field Type
    • Buttons or Free Text
  • Other Button Type
    • If the field contains buttons this allows the option for the user to add a value not contained in the list
    • This can be free text or a calendar

Adding Buttons

If a Field Type of Buttons is chosen then we need to create our possible values.

Just click on the large plus button and a pop-up will instruct you to create a Text and Value pair. The “value” will be what is passed to any Tests, UTMs or Recipes.

Editing A Button

This is a simple a clicking on the button.

More on Fields

Fields maybe hidden but their active values can still be accessed. Take care when hiding a field that its values dont slip through if not intended.

Actions

Actions provide a way to change the visual of the UI for a user. Such as hiding elements. Actions can be caused to run by one or more triggers (Test), which you can read about in the Tests section. Actions only become available once UTMs and Fields have been created.

Create An Action

There are only three elements to an action

An Id which to reference in the Tests section

An action type

  • Hide Fields
    • Hides one or more Fields from view in the UI
  • Set Values
    • Changes the active value of a Field
  • Disable Buttons
    • Prevents One or more buttons in  a Field from being clicked
    • Shifts the value of a field if the current value is disabled

Actionables

  • These are the elements on which the action acts.
  • Eg Hide the Field “source” and  the Field “medium” – here “source” and “medium” are actionables
  • Each actionable must be added via the “Add Actionable” button
  • Actionables appear as a blue row
  • NB. if an actionable is red it contains an error or reference an element that has been deleted

Tests

Tests trigger Actions. Tests behave the same way as recipes, please reference above. Each Test activates one Action.

N.B.s

  • The order of tests can matter depending on what kind of Actions are being triggered
  • A Test with no elements in its If will always be true, and so always fire
  • Inside of an If each part behaves as a logical AND. The Test will only pass if all of them are true
  • If you wish to produce a logical OR. Simply add another Test

 

 

2018-07-03T15:31:34+00:00