Defining Recipient Information

The uPlan recipient information includes two categories of information: schema and Filters.

The schema contains a list of the relevant recipient information fields required to produce the campaign.

The Filters allow you to generate proof sets for specific recipients, based on your filter criteria and logic. Later, when you use uProduce to create an actual production set, you can use the filters you defined to generate document instances for the required set of recipients.

Define Filters

You can define filters that enable you to generate proof sets for a specific set of recipients. You define these filters in an Expression window, using SQL.

The uPlan Wizard creates a default filter that includes all recipients defined in the specified data source.

Important

• To enforce consistent order and avoid unexpected results, it is mandatory that the plan filter query includes the ORDER BY clause. Without it, in certain cases (e.g. automatic or manual split production), some recipients may receive multiple outputs, while others receive none.

• You must define filter expressions using SQL constructs. You cannot use the QLingo templates to create filter expressions.

Various options are available when you right-click the Filters icon, or a specific filter in the tree.

Right-clicking the Filters icon provides the following options:

Option	Description
New Filter	Create a new untitled recipient filter.
New Group	Create a new group of filters.
Expand/Collapse All Groups	Expand or collapse all groups so you can see or hide their contents.
Paste	Paste a previously cut or copied filter into the list of recipient filters.
Order Filters	Sort the filters by name.

 

Right-clicking a specific group of filters provides the following options:

Option	Description
New Filter	Create a new untitled recipient filter in the current group.
Rename	Rename the current filter group.
Paste	Paste a previously copied filter into the current group.
Delete	Delete the currently selected group, provided it is empty.
Order Filters	Sort the filters inside the group, by name.

 

Right-clicking a specific filter provides the following options:

Option	Description
Edit Expression	Edit the filter’s expression in an Expression window.
Rename	Rename the currently selected filter.
Move to Group	Move the filter into the selected group.
Cut, Copy, Delete, Duplicate	Cut, copy, delete, or duplicate the currently selected filter.

Define the Schema

The schema fields are the collection of all recipient information required to produce the campaign. These fields must all come from a single data source, but not necessarily a single table in a database.

This information may, or may not, be in the data sources specified in the plan. For example, if you are creating a campaign for personalized HTML pages, the recipient information may be available only after a customer has filled in a Web page form.

If data for the schema fields is not available directly from a single table of the data source, you can use a filter to create the appropriate fields using an SQL SELECT query to retrieve the needed information from numerous tables.

When you right-click the schema icon, a menu is displayed with the following options:

Option	Description
New Field	Create a new untitled field.
Database Link	Associate the currently selected schema with a specific database, in order to enable validation and creation of a proof set.
Copy	Copy the selected schema into a buffer.
Paste	Paste a field into the selected schema.
Order Fields	Sort the schema fields by either name or type.

 

When you right-click a specific schema field, a menu is displayed with the following options:

Option	Description
Insert	Insert the currently selected schema field into the active Expression window.
Rename	Rename the currently selected schema field.
Type	Specify the type for the currently selected schema field. Available options are Bool, Date, Number, and String.
Internal Use	In interactive campaigns, you may wish to store customer interaction data for later usage in other campaign touchpoints. However, you do not wish to change your database to accommodate this data as it is related to the specific campaign only. For such cases, use the campaign field feature, which allows you to add a recipient field that will be in the campaign level only, and not in your database. Another case of campaign field usage is when you wish to hide a recipient field from the shopper in uStore. To mark a schema field as a campaign field, right-click it and select the Internal Use checkbox. When a schema field is marked for internal use, its’ icon changes from  to .
Primary	Set the selected schema field as the Primary field. The Primary field serves as a unique identifier of the recipient (for example, social security number, email address, customer ID).
Cut, Copy, Delete, Duplicate	Cut, copy, delete, or duplicate the currently selected field.

Use the Primary Field

The Recipient List’s Primary field defines a unique ID for each recipient record. This unique ID is known as the Recipient ID or XMPie Recipient Key. It is used in personalized web Campaigns for the following purposes:

• In the personalized Response URL (RURL) address, to differentiate between websites of different recipients. The standard RURL structure is:

  http://<Domain>/<Domain Folder>/<Recipient ID>

  For example:

  http://www.lioncomm.com/SummerSale/Diana.Prince

• In the personalized website, the website code uses the recipient ID to read and write recipient data to the database.

To set the primary field:

1. From the Plan Objects pane, select Recipient Information > Schema.

   All Recipient List fields are listed.

2. Right click the relevant field and check Primary.

   The field is set as the primary field, indicated by a key icon.

   

3. If you want to use the Primary key (XMPieRecipientKey), use the character "?" to reference it.

   Example:

   “http://www.MyDomain.com/MyFolder/Landing.html?rid=” & ?

More topics

Recipient Information Field Reference

Watch a video

Learn how to create Recipient filters