Metadata Settings

Overview

Engage+ offers the ability to tag Campaigns with custom Metadata fields and values. These Metadata fields allow you to create Filters that look for specific Metadata tags in them, for use in reports, future Campaigns, or other tasks.

Once the Metadata fields are defined, you can assign tags to a specific Campaign. These tags can either be a free-form text entry field, or, you can pre-define a set of valid values from which to pick in a drop-down menu.

Metadata fields can also be marked as "Required," meaning a marketing Campaign won't launch until these Metadata values have been entered or selected.

Access

The Metadata Settings screen is accessible by the following method:

Features

 Define a New Metadata Field

Click hereClick here

Note: Metadata settings are shared across all parent-child systems. Any changes made to Metadata in a child account, such as adding new fields, removing or renaming fields, setting the "required field" flag, and setting up predefined values, will be applied to all child accounts.

To  define a new Metadata field:

  1. In the blank row at the top of the Metadata Settings screen, enter the "Display Name" for your new Metadata field.

  2. The system automatically populates the "Symbol" field based on the Display Name. Optionally, you can override this default value, and enter a custom value.  The Symbol is used for the formatting of the merge symbol when using Metadata for personalization; the Symbol can't be edited after initial creation.

  3. From the "Data Type" drop-down menu, select a data type for your new field -- String, Integer, Date / Time, or Money / Decimal. The Data Type can't be edited after initial creation.

  4. If you want to require that this Metadata field be populated before a Campaign can launch, place a check mark in the "Required" check box.

  5. If you want to define a set of valid values that can be selected for this field, place a check mark in the "Predefined Selection" check box (see below for details on how to define these valid values). This feature helps prevent data entry errors, and enforces consistency across Campaigns. You must establish at initial creation whether a field uses predefined selections; you can't later change this setting for a Metadata field.

  6. Click the Add button (plus-sign icon). The new Metadata field is added to table of existing fields.

  7. By default, your new field is added at the very bottom of the screen, meaning it will also appear at the very bottom of the Metadata screen when the user is entering or selecting Metadata values for a Campaign. Optionally, if you want to move your new field to a new position on the screen, click-and-drag the gray box above the Metadata field name, and drop it into its new location.

  8. When finished, click save.

If you checked the "Predefined Selection" check box, you next need to define the set of valid values that can be used in your new field. To define these values:

  1. Find your Metadata field in the table of existing fields. Click the down-arrow icon next to the field name.

  2. In the blank text field, enter a valid value for this field, then click the Add button (plus-sign icon). Repeat this step as needed to add any additional valid values.

  3. The order in which the valid values appears on the screen controls the order in which these values will appear in the drop-down menu when the user is selecting Metadata values for a Campaign. Optionally, if you want to move a value to a new position within the drop-down menu, click-and-drag the gray box above the value, and drop it into its new location.

  4. When finished, click save.  

 

 Edit Metadata Settings

Click hereClick here

Note: Metadata settings are shared across all parent-child systems. Any changes made to Metadata in a child account, such as adding new fields, removing or renaming fields, setting the "required field" flag, and setting up predefined values, will be applied to all child accounts.

To modify a Metadata field:

  1. Find the desired field on the Metadata Settings screen, and make any necessary changes:

  • Change the Display Name.

  • Change whether or not the field is required.

  • For a field that uses predefined selections, click the down arrow icon to view the list of valid values. You can change an existing value, or add a new value.

  1. Optionally, if you want to move your new field to a new position on the screen, click-and-drag the gray box above the Metadata field name, and drop it into its new location.

  2. When finished, click save.

 

 Delete a Metadata Field

Click hereClick here

To delete a Metadata field:

  1. Find the desired field on the Metadata Settings screen.  

  2. Click the delete button ("X" icon) to the right of the field. The system deletes the selected field.

Note: Deleted Metadata Fields are NOT moved to the Recycle Bin, and can't be restored.

 

 Assign Metadata Values to a Campaign

Click hereClick here

From the Campaigns screen, you can assign Metadata values to one or more Campaigns:

  1. Navigate to the Campaigns screen. 

  2. Browse to the folder where the desired Campaign is stored. 

  3. Place a check mark next to one or more Campaigns.

  4. In the Tool Ribbon, click metadata editor. A dialog box is displayed listing all Metadata fields defined within your account.

  5. Click the toggle button next to the desired Metadata field to enable it, then enter or select the desired Metadata value. Repeat this step as needed for other Metadata fields. 

  6. Click save.   

To assign Metadata values to a single Campaign from within the Campaign Details screen:

  1. Navigate to the Campaign Details screen for the desired Campaign.

  2. In the Tool Bar, select Settings > Set Metadata. The Metadata pop-up window is displayed, listing every Metadata field defined for this account.  A red asterisk is displayed next to the fields that are required for Campaign launch.

  3. Enter or select the desired Metadata values.

  4. Click ok.