Creating or editing custom attributes

You can define custom attributes for use on campaigns, offers, or cells on a Target Cell Spreadsheet. When you create the attribute, you specify whether it can be used in campaigns, offers, or cells. You cannot change this selection after you save the attribute.

You must have permissions to add or modify campaign, offer, and cell attributes.

Select Settings > Campaign Settings.

In the Templates and Customization section, click Custom Attribute Definitions.

Click the Add a Custom Attribute icon

or click the name of the attribute that you want to modify.

Define the attribute.

For this option:

Take this action:

Attribute Display Name

Specify the label to identify the attribute for users. For example, "Interest Rate".

You cannot change the name of the standard offer attributes that are supplied with Campaign.

Internal Name

Specify a name to identify this attribute when you write an IBM® EMM expression, such as a query or custom macro. Use the same name as the Attribute Display Name, but without any spaces (for example, "InterestRate").

The internal name must be globally unique, must start with an alphabetic character, cannot include spaces, and are not case-sensitive.

To avoid errors, do not change the internal name of attributes that are used in flowcharts.

Attribute Of

Indicate where the attribute can be used. You cannot change this option after you save the attribute.

A Campaign attribute is included on every campaign, even campaigns that already exist.

An Offer attribute is available for use on new offer templates. If the attribute is included on an offer template, then any offers that are based on that template include the attribute.

A Cell attribute is included in the Target Cell Spreadsheet for every campaign, even campaigns that already exist.

Description

Optional.

Mandatory

If you want to require a value for this attribute, select Mandatory. This setting has the following result.

For campaigns, users are required to specify a value for the attribute (the field cannot be left blank).

For cells, users are required to specify a value in the Target Cell Spreadsheet (the cell cannot be left blank).

For offers, administrators are required to specify a value when the attribute is added to an offer template. The specified value is used for any offers that are based on that template, unless the user specifies a different value when creating or editing the offer.

If you add an offer attribute to an offer template as "Hidden static" or "Parameterized", a value is always required, even if the attribute is defined as non-mandatory. If you add an offer attribute to an offer template as "Static", the Mandatory setting determines whether a value is required.

If you change this option after an attribute is in use:

If you change from Mandatory to non-mandatory, a value is no longer required when the attribute is used.

If you change from non-mandatory to Mandatory, a value is required whenever this attribute is used in the future. This change has no effect on existing objects unless you edit them. For example, if you open a campaign, Target Cell Spreadsheet, or offer in Edit mode, you are required to specify a value before saving.

Form Element Type

Specify the type of data to be stored in the attribute field for offers or cells.

After you add the custom attribute, you cannot change its data type.

Specify more information, depending on the Form Element Type that you selected.

If you selected this Form Element Type:

Take this action:

Text Field - Numeric

Specify the number of decimal places to display to the right of the decimal point.

If you decrease the value for an existing attribute, the display is truncated in the user interface. However, the original value is retained in the database.

Text Field - Currency

Specify the number of decimal places (see above).

The currency value reflects the number of decimal places that are customarily used in the local currency. If you specify a number of decimal places less than the number commonly used, the currency value is truncated.

Text Field - String

Specify a Maximum String Length to indicate the maximum number of bytes to store for any value of this attribute. For example, if you enter 32, single-byte languages such as English store 32 characters but double-byte languages store only 16 characters.

Decreasing the length of an existing attribute truncates existing values, which, if the field is used for matching purposes, can adversely affect response tracking.

Select Box - String

Specify a Maximum String Length (see above).

Optionally, check Allow addition of list items from within edit forms to allow any user to add new unique values to the list of available values when creating or editing a campaign, offer template, or offer that includes this attribute. (This option does not apply to cells.) For example, if a Select Box on an offer template contains the values Small, Medium, Large, a user could add the value Extra Large when creating an offer or editing the offer template.

After the campaign, offer template, or offer is saved, the user cannot remove the new list item. The value is saved in the custom attribute definition and is then available to all users. Only administrators can remove items from lists, by modifying the custom attribute.

Populate the Source list of available values to specify which items are available in the Select Box. Enter values in the New or Selected Item field and click Accept. To delete a value, select it in the Source list of available values and click Remove.

Optionally, specify a Default Value for the Select Box. The default value is used on the campaign, offer, or TCS®, unless the user specifies a different value when creating or editing the campaign, offer, or cell.

Specify the Sort Order to determine how values appear in the list.

Click Save Changes.