Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Pega Marketing
USER GUIDE
7.31
© 2017
Pegasystems Inc., Cambridge, MA
All rights reserved.
Trademarks
For Pegasystems Inc. trademarks and registered trademarks, all rights reserved. All other trademarks or service marks are property of
their respective holders.
For information about the third-party software that is delivered with the product, refer to the third-party license file on your
installation media that is specific to your release.
Notices
This publication describes and/or represents products and services of Pegasystems Inc. It may contain trade secrets and proprietary
information that are protected by various federal, state, and international laws, and distributed under licenses restricting their use,
copying, modification, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc.
This publication is current as of the date of publication only. Changes to the publication may be made from time to time at the
discretion of Pegasystems Inc. This publication remains the property of Pegasystems Inc. and must be returned to it upon request. This
publication does not imply any commitment to offer or deliver the products or services described herein.
This publication may include references to Pegasystems Inc. product features that have not been licensed by you or your company. If
you have questions about whether a particular capability is included in your installation, please consult your Pegasystems Inc. services
consultant.
Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors, as
well as technical inaccuracies. Pegasystems Inc. shall not be liable for technical or editorial errors or omissions contained herein.
Pegasystems Inc. may make improvements and/or changes to the publication at any time without notice.
Any references in this publication to non-Pegasystems websites are provided for convenience only and do not serve as an
endorsement of these websites. The materials at these websites are not part of the material for Pegasystems products, and use of
those websites is at your own risk.
Information concerning non-Pegasystems products was obtained from the suppliers of those products, their publications, or other
publicly available sources. Address questions about non-Pegasystems products to the suppliers of those products.
This publication may contain examples used in daily business operations that include the names of people, companies, products, and
other third-party publications. Such examples are fictitious and any similarity to the names or other data used by an actual business
enterprise or individual is coincidental.
Pegasystems Inc.
One Rogers Street
Cambridge, MA 02142-1209
USA
Phone: 617-374-9600
Fax: (617) 374-9620
www.pega.com
Feedback
If you have suggestions or comments for how we can improve our materials, send an email to AppDocBug@pega.com.
CONTENTS
Preface xvii
Intended Audience xviii
Guide Organization xviii
Chapter 1: Pega Marketing Overview 1
Features 2
Logging In 2
Pega Marketing Portal 3
Header 4
Reports Menu 4
Configuration Menu 5
Navigation Panel 6
RECENT pane 7
Home Page 8
Customizing the Home page 8
Transitioning from Next-Best-Action Studio 9
Chapter 2: Marketing Dashboard 11
Using the Dashboard 11
Understanding the Widget Display 12
Insight & Action 12
Display Types 12
Applying Filters 20
Customizing the Dashboard 21
Managing Widgets 21
Adding a New Widget 21
Removing a Widget 22
Re-organizing widgets 23
Configuring Widget Options 23
Customizing Insight & Action 25
Customizing the Default Dashboard 26
Chapter 3: Next-Best-Action 27
Preface
This guide is designed to provide you with an overview of Pega Marketing and its various
components. Pega Marketing is a comprehensive marketing automation solution that delivers
inbound offer management and outbound marketing campaigns on a single platform. Pega
Marketing uses a unique combination of predictive and adaptive analytics, real time decisioning, and
business process management to dynamically manage cross-channel conversations (from offer
design to fulfillment), drive revenue, and expand customer lifetime value.
l Create Seed Lists and utilize them for testing Offers and Campaigns
Intended Audience
This guide is intended for marketing analysts and managers with Pega Platform and Decision Strategy
Manager (DSM) experience. This guide also provides various insights for administrators and
implementers of Pega Marketing applications.
Guide Organization
This guide contains the following chapters:
Chapter Description
Pega Marketing Provides a business overview of Pega Marketing and explains the basics of the Pega Marketing portal.
Overview
Next-Best-Action Explains how to configure Next-Best-Action, the always-on brain that lets marketers model real-time
inbound experiences.
Marketing Explains how users can utilize and customize the Dashboard to view and monitor application
Dashboard performance.
Multi-Channel Provides an in-depth look into the Multi-Channel Campaigns. Topics covered include Campaign
Campaigns configuration, execution, and monitoring.
Outbound Provides a detailed look into Outbound Campaigns. Topics covered include Outbound Campaign
Campaigns lifecycle, configuration, and available actions.
Segments Provides an in-depth look into Segments, Samples, and Analysis Projects. Topics covered include
designing Segments, running Segments, scheduling Segments, and Intelligent Segmentation.
Control Groups Provides information on creating and populating Control Groups; and determining Control Group
memberships via Strategies.
Strategies Provides information on marketing-specific Strategy shapes and their usage.
Contact Policies Provides information on managing Contact Policies, which provide a mechanism for controlling and
restricting how many times a customer is contacted in accordance with corporate and/or regulatory
guidelines.
Volume Provides information on creating Offer and Operational Volume Constraints; and configuring constraint
Constraints reset options.
Offers Provides insights into various aspects of the Offer, such as creating and testing Offer flows, and
specifying Offer details.
Treatments Provides information on how to create and test Email, Passbook, and SMS Treatments.
Chapter Description
Templates Explains how Templates can be utilized to write content to output files and database tables.
Offer Bundles Provides information on creating Offer bundles and designing bundle Offer flows and Email Treatments.
Microsites Provides information on various aspects of creating Microsites using stage-based case management.
Geofences Provides details on creating and importing Geofences; and invoking Geofence APIs.
Real-Time Events Provides information on configuring and triggering Events.
Real-Time Provides information on configuring Real-Time Containers and the APIs available for supporting their
Containers execution.
Prospects Provides information on importing prospect lists and using Prospect-based Segments to target
prospects via Campaigns.
Seed Lists Provides information on configuring and managing Seed Lists.
Exclusion List Provides information on the exclusion list functionality.
Checklists Provides an overview of the various aspects of Checklists and Tasks.
Email and SMS Provides information on configuring Inbound SMS, Outbound SMS, and Outbound Email accounts.
Account
Configuration
Push Provides information on configuring apps for push notifications, using Offers to push notifications to
Notifications customers, and invoking push notification services.
Marketing Profile Provides details on the various elements of the Marketing Profile and guidelines on using it in custom
applications.
Revision Provides an overview of using Revision Management with marketing rules.
Management
Identity Matching Provides an overview of Identity Matching and how it is incorporated into various Pega Marketing
features.
Appendix Description
User Preferences Provides an overview of marketing-specific user preferences.
Administrative Settings Provides information for configuring various administrative facets of the application.
Passbook Settings Provides details on uploading certificates for using the Passbook functionality.
System Health Provides an overview of the System Health functionality.
The Pegasystems approach to Next-Best-Action marketing uses decision management and analytics
to determine what the right action is for every customer; and provides them with the right message,
at the right time, in the right channel.
Built for marketers (herein referred to as the user) responsible for managing inbound and outbound
customer communications and experiences, the Pega Marketing solution (herein referred to as the
system or the application) delivers on this vision through a unique combination of real-time inbound
and outbound marketing, campaign management, and marketing operations capabilities that
leverage predictive and adaptive analytics, real-time decisioning, and business process management.
Pega Marketing dynamically manages multi-channel conversations through the entire customer
lifecycle, from offer design to offer fulfillment.
The solution embraces customer focus by providing measurable business benefits to marketing
organizations by:
l Creating relevant experiences for every customer – Turn every interaction into a guided, relevant
conversation by executing the Next-Best-Action at the moment of truth. This solution continuously
learns and adapts to every customer in real time, across all channels, including social media and
mobile.
l Giving users more control – Design, change, measure, and control multi-channel customer
strategies with a single marketing portal that doesn’t require IT involvement. Pega Marketing is the
only solution to support marketing operations with a robust business process management
platform that seamlessly connects sales with customer fulfillment processes.
l Optimizing customer lifetime value - Maximize revenue with proactive cross-sell, up-sell, and
retention opportunities for customers. Coordinate the experience across inbound and outbound
channels. The solution provides the optimum balance between various customer needs and the
specific needs of the business.
Features
Pega Marketing features the following high level capabilities:
n Next-Best-Action marketing
Customer-centric approach to marketing that leverages predictive and adaptive analytics to
provide real-time and batch marketing offers and treatments to drive customer lifetime value.
Shared components include a single portal that has customizable dashboards, offer and
campaign design, treatment design, channel configuration, constraints optimization, and
response management.
n Analytics-based campaigns
Marketing campaign capabilities deliver multi-step, multi-channel marketing communications
to very targeted and segmented audiences that help increase return on investment in every
marketing initiative.
n Marketing Operations
Marketing operations capabilities include dynamic case management that can orchestrate
multiple processes, systems, and people. This allows marketing to adapt to complex business
needs. The Marketing Operations module includes checklists for marketers to monitor and
control work, as well as a number of approval templates that can be quickly leveraged in the
marketing organization to support financial business objectives.
Logging In
The following accounts are provided as out-of-the-box samples. Your administrator should provide
you with the specific account(s) with which to log in to the system.
Note: Users of previous Pega Marketing releases (version 7.12 and earlier) should review the
Transitioning from Next-Best-Action Studio section to understand the variations introduced in
the new Pega Marketing portal.
l Header
l Navigation Panel
l Home Page
Header
The portal header provides icons for easy access to various tools and menus. This includes the
following:
Reports Menu
The Reports menu provides access to the following landing pages and utilities:
l Interaction History - Launches the Interaction History (IH) landing page which provides access
to IH reports.
l Adaptive Models - Launches the Adaptive Models landing page which provides access to ADM
models and predictors.
l Report Browser - Launches the Report Browser which facilitates the management of reports in
the system.
l Report Settings - Launches the Report Settings landing page which provides access to various
reporting settings. Available to the Administrator role only.
l Simulations - Launches the Simulations landing page which provides access to Data Flow runs
and simulation runs.
Configuration Menu
The Configuration menu provides access to the following landing pages and utilities:
l Predictive Analytics - Provides links to the Adaptive Models Management and Predictive
Analytics Director Settings landing pages.
l Visual Business Director - Launches the Visual Business Director (VBD) landing page which
provides access to VBD data sources, KPIs, and views.
l Settings - Provides links to the following landing pages. Most of these pages are only available to
the Administrator role.
Application Settings - Provides ability to configure various settings for the application.
Email – Enables management of Outbound Email Accounts and handling of email delivery
errors.
l Contact Policies - Launches the Contact Policies landing page which facilitates the management
of Contact Policies in the system.
Navigation Panel
The navigation panel occupies the left side of the portal and provides direct access to salient
marketing artifacts. In addition, it also includes search and access to the user's recent items.
Users can collapse (and restore) the panel by clicking anywhere along its right edge. Dragging the
right edge allows resizing of the panel. Additionally, the system may automatically collapse the panel
for small screen sizes.
l Dashboard - Launches the Dashboard which displays widgets pertaining to the performance of
the Pega Marketing application.
l Campaigns - Launches the Campaigns landing page which enables the management of
Campaigns.
l Content - Expandable section that includes links to the following landing pages:
Offers - Enables the management of Offers.
l Intelligence - Expandable section that includes links to the following landing pages:
Strategies - Enables the management of Strategies.
Eligibilities - Enables the management of Proposition Filter and When Condition rules.
Tables and Trees - Enables the management of Decision Table and Decision Tree rules.
Analytical Models - Enables the management of Adaptive Model and Predictive Model rules.
l Audiences - Launches the Audiences landing page which enables the management of Segments
in the system.
l Revision Management - Launches the Revision Management landing page which provides role-
based access to the Revision Management functionality. Available only to users with Revision
Management role(s).
RECENT pane
The RECENT pane in the navigation panel lists the items most recently accessed by the user.
Users can click the pane header to expand (and collapse) the pane. Clicking an entry in the pane
opens the corresponding artifact.
Each entry in the pane includes the artifact's name and type (e.g. Offer, Landing Page, etc.). For work
objects, the work id is also displayed.
Tip: The number of items displayed in the RECENT pane is governed by the MaxRecentsCount
Dynamic System Setting.
Home Page
The Home page is the chief starting point for every user. It provides the user with direct access to
items and actions that are relevant to them. Users can also customize the display and content of their
Home page.
l Define your audience - Shortcut to create a new Segment rule to define the target audience.
l My Work - Displays the user's work list. Click an entry to open the corresponding work object.
Users can include any other available widgets on their Home page. Other available marketing-centric
widgets include the following:
l Checklists - Displays Checklists in the system and provides link to create new Checklists.
Requires Marketing Operations to be enabled on the system.
l Revision Management - Displays Change Requests that are assigned to the user and lists each
rule within the request. Requires user to have Revision Management role.
1. Click the gear icon (in the top right) to switch the dashboard to edit mode.
2. Use the Switch template link to select the desired template for the dashboard.
4. Configure options for applicable widgets. Hover over the widget to determine if it has available
options. If it does, the text Click to edit is displayed.
5. Use the Publish button to apply your changes and save your customized dashboard.
Refer to official Pega Platform documentation for more details on the customization process.
Tip: The default Home page configuration can be modified by users with suitable access. This access
is governed by the CanPublishToDefault Privilege, which is furnished to marketing managers and
administrators via the PegaNBAM_FW:MarketingManager role. The PegaMarketing_
FW:PortalAdministrator Access Role wraps this privilege and can be added to desired Access Groups.
Users with this requisite access can utilize the Publish to default option in the Publish button menu
to update the default Home configuration.
Existing users transitioning to the Pega Marketing portal will notice various differences from the
previous portal. This section outlines these differences and the rationale behind them.
One of the key differences between the two portals is the simplicity of the new portal. In the new
portal, marketers can quickly and directly access primary artifacts (such as Campaigns, Offers, and
Segments). Secondary artifacts are now accessed and, in most cases, created in context of their
usage.
For example, consider the case of Volume Constraints. In order to be utilized by the system, a
Volume Constraint needs to be associated with a Campaign. In the new portal, users would begin by
creating (or modifying) a Campaign. If the user wishes to utilize Volume Constraints with their
Campaign, they simply utilize the appropriate selector while configuring the Campaign to review (and
select from) existing Volume Constraints or create a new one.
Contextual creation of secondary artifacts also enabled the removal of the various explorers through
which users had to previously navigate. The end result is a simplified navigation model with direct
role-based access to all primary artifacts.
Finally, existing users will also notice a change in the verbiage used to represent certain artifacts.
These changes were added to better align the product's feature set with commonly used marketing
terminology.
l Campaigns from version 7.12 are now referred to as Outbound Campaigns to better indicate their
specialization.
The Dashboard is accessible in the Pega Marketing portal via the Dashboard link in the left
navigation pane.
Marketing widgets displayed on the Dashboard are categorized into groups. The following table lists
the available marketing widgets in each group.
l Applying filters
Clicking this icon displays the configured message for the widget. The default message indicates
whether the goal for the widget has beet met. In addition, the color of the icon also indicates this
information - the icon color is green when the goal is met and red otherwise.
Clicking anywhere outside the view switches the widget back to its default view.
Display Types
This section highlights key features of the various displays used by marketing widgets. Each display
includes the following common elements:
l Widget name
Marketing widgets can be classified into the following categories based on their data visualization:
There are multiple display types within each of the above categories. Additional information
presented on the widget varies based on the display type.
Engagement Trend
This display type is specific to engagement related widgets and includes the following additional
features:
l Right y-axis corresponds to the dual line charts (Conversion Rate, Click Through Rate)
l Clicking the metric name in the legend toggles the display of the metric's chart
Metric Bar
l Bar color indicates whether the goal is met - green if met, red otherwise
l Sentence highlights metric value change (increase vs. decrease) against configured time period
(e.g. quarter) and current performance against goal (above vs. below)
l Churn Rate
l Net Revenue
l ROMI
Engagement Funnel
This display type is specific to engagement related widgets and includes the following additional
features:
l Funnel portion for each metric with portion size corresponding to metric volume
l Hovering over a funnel portion highlights the corresponding metric and its value
l Color of the funnel portion indicates whether the corresponding metric goal is met - green if met,
red otherwise
l Email Engagement
l Web Engagement
Social Sentiment
This display type is specific to the Social Sentiment widget and includes the following additional
features:
l Major metric value (e.g. 50.00%) denotes the score for positive social sentiment
l Sentence highlights metric value change (increase vs. decrease) against configured time period
(e.g. quarter) and current performance against goal (above vs. below)
This display type is specific to the Net Promoter Score widget and includes the following additional
features:
l Major metric value (e.g. 17) denotes calculated net promoter score (NPS)
l Number and percentage of individuals in each NPS grouping (promoter, passive, detractor)
l Sentence highlights metric value change (increase vs. decrease) against configured time period
(e.g. quarter) and current performance against goal (above vs. below)
l Goal line
l Data point color indicates whether the goal is met for a time period - it is green if the goal is met,
red otherwise
l Call-out value on the final data point (e.g. 30.53M above) denotes the difference in metric value
from the previous period.
Color of the arrow (green or red) indicates whether the change in value is towards the
betterment of the metric
Direction of the arrow (up or down) indicates whether the change is an increase or decrease
from the previous value
l Goal line
l Bar color indicates whether the goal is met for a time period - it is green if the goal is met, red
otherwise
This display type is utilized by the Owned Media Spend Trend widget.
l Left y-axis corresponds to the bar chart metric (e.g. Average Spend)
l Right y-axis corresponds to the line chart metric (e.g. Save Rate)
l Major value (e.g. 70.59%) is the value of the line chart metric for the current time period (e.g. Q2)
l Hovering over a data point or bar area displays the corresponding metric value
l Clicking the metric name in the legend toggles the display of the metric's chart
This display type is utilized by the Retention Save Rate and Cost Trend widget.
This display type functions similarly to the Trend Single Bar Single Line type described above. The
only difference is that it supports multiple bar metrics in the left y-axis.
Engagement Trend
This display type is specific to engagement related widgets and includes the following additional
features:
l Right y-axis corresponds to the dual line charts (Conversion Rate, Click Through Rate)
l Clicking the metric name in the legend toggles the display of the metric's chart
Applying Filters
Marketers can use the controls at the top of the Dashboard to set filters on the data utilized by
marketing widgets.
l Timeframe - Time period into which the fetched data should be grouped
l Issue / Group - Issue and Group for which the data should be fetched. By default, the Dashboard
fetches data across all Issues and Groups.
Clicking the View button applies configured filter criteria and triggers the Dashboard to reload.
To make any changes, marketers can use the gear icon in the top right to switch the Dashboard into
edit mode. In edit mode, marketers can perform the following actions:
l Manage widgets
Managing Widgets
This section explains how marketers can add, remove, and re-organize widgets in the Dashboard.
2. In the widgets modal window, select the desired widgets to add and click Add selected. The
modal displays widgets in their groups and includes a description for each widget.
Removing a Widget
In edit mode, users can remove a widget from the dashboard by either of the following:
l Clicking the delete icon in the top right corner of the widget
l Clicking the delete icon in the row for the particular widget in the Widgets grid
Re-organizing widgets
In edit mode, users can re-organize widgets within a slot and move widgets across slots by either of
the following:
l Using the drag icon to drag and drop the widget row to the desired position in the Widgets grid
To view available configuration options, users can either select the widget directly or click the link for
the widget in the Widgets grid.
The options for the widget are displayed in the Edit dashboard panel.
Users can click Preview to view the impact of their changes on the widget. Clicking Save saves the
configuration options and applies them to the widget.
Note: Changes to configuration options are not final until the user publishes these changes via the
Publish button. Users may use the Discard button to revert to the previous configuration of the
Dashboard.
All widgets related to marketing metrics have a configurable goal option. The name and type of this
option varies based on the metric. For example, the goal for the Return on Marketing Investment
(ROMI) metric is a percentage, while the goal for the Net Revenue metric is a number. However, there
are two deviations from the single goal option.
l Multiple goals - The Email Engagement and Web Engagement widgets have three configurable
goals.
Impressions (number)
l Retention Issue - Retention related marketing widgets include an additional option to specify
the retention issue. Once specified, the widget only includes those data points associated with the
configured retention issue.
1. Switch the Dashboard into edit mode by clicking the gear icon.
3. In the Edit dashboard panel, click Edit in the Insight & Action field.
4. This will open the backing Decision Table rule for the widget. The Decision Table rule has two
outcomes - Met and Missed. These outcomes are mapped to messages using Field Value rules.
Switch to the Results tab and expand the Additional Allowed Results section to view the
name of the corresponding Field Value for each outcome.
5. To customize the message for a widget outcome, take over the corresponding Field Value rule in
your implementation layer and update it to include the desired message.
Marketers will now see the customized message when they review the insight information for this
widget.
Users with this requisite access can utilize the Publish to default option in the Publish button menu
to update the default Dashboard configuration.
Chapter 3: Next-Best-Action
In today’s digital world, marketers can no longer dictate the purchasing path and where, when, and
how customers engage with companies. Customers demand personalized and consistent experiences
across every channel be it the call center, web, retail locations, IVR, or mobile apps. Marketers need a
way to create timely and relevant actions that can be integrated into every customer interaction.
Unlike traditional Campaigns which typically target segments of customers for specific products and
services over a set time frame, Pega's Next-Best-Action (NBA) is “always-on”, serving as the brain for
every interaction with customers across all channels. This leads to increased customer value while
enhancing the customer experience with every interaction. The NBA authoring experience helps
marketers coordinate their customer journeys using customer data and derived customer insights to
provide proactive contextual actions. Key aspects include:
l Business users directly manage changing requirements, with a platform built for agility and
control.
This chapter includes the following topics that explain the various aspects of Next-Best-Action:
l Configuring the NBA hierarchy - This topic explains how to build the hierarchy of business issues
and groups that will participate in NBA.
l Configuring NBA definitions - This topic explains how to configure each stage of the NBA
hierarchy.
l Scheduled NBA execution - This topic explains how to utilize NBA configuration to perform
outbound marketing.
l Monitoring outcomes - This topic explains how to monitor the performance of NBA nodes across
configured metrics.
l Supporting decisions - This topic explains how to create and configure supporting decisions, which
are constructs used to associate Strategies with Real-Time Containers.
At the onset of NBA configuration, the Designer starts out in hierarchy management mode. Once a
hierarchy has been defined, use the gear icon in the Hierarchy panel header to switch to hierarchy
management mode. In this mode, click the Edit button to make changes to the hierarchy.
Note: The ability to modify the NBA hierarchy is controlled by the CanManageNBA privilege. This
privilege is granted (by default) to marketing managers and administrators via the PegaNBAM_
FW:MarketingManager role. Users that do not have this privilege will not see the controls referenced
in this section to configure the NBA hierarchy.
To begin configuring a new hierarchy, click the Add link in the top-level Next-Best-Action row.
The Configure Next-Best-Action modal window is displayed. This modal lists the business issues that
are part of the marketing application. Select the desired business issues to activate for NBA.
This modal window even allows for creation of new hierarchy items. Click the Create link and enter
a name for the new issue.
Note: Any newly created hierarchy item can be updated until the hierarchy changes are saved.
Click Apply after selecting the desired business issues. The selected issues are displayed under the
top-level Next-Best-Action node.
Next, use the individual Add links for each issue to select the groups to activate for NBA. As before,
use the Create link in the configuration modal window to create new groups. After selecting the
desired issues and groups, click the Save button on the landing page to submit your changes and
activate the selected hierarchy.
As part of saving the hierarchy changes, the system creates any new hierarchy items (business issues
and groups) and generates any necessary backing artifacts. After the hierarchy has been successfully
saved, the display switches back to the main Designer view.
The Delete button enables users to reset the configured NBA hierarchy.
The Close button exits the user from hierarchy management mode and returns them to the main
Designer display.
To configure the definitions for a node, select the node in the left navigation and click Edit.
The configuration options for hierarchy nodes vary based on the node type. Refer to the following
topics for more details:
At any node, the marketer can configure the outcomes to monitor and configure the node's
usage - i.e. specify where to apply the node's results.
Finally, after making the desired changes, save the updated configuration.
Configure Actions
Use the Next-Best-Actions section to configure the actions to take with customers. Click the Add
action link to define a new action. Upon clicking this link, a configurable action is added.
First, enter a Name for the action. The system generates an identifier for the action based on the
name. Users can utilize the pencil icon to edit the identifier, if needed.
Next, use the Select results from drop-down to specify the source of results for the action. Select the
source business issue or group from the active hierarchy.
Finally, use the Add criteria link to configure the conditions that make this action relevant. Users
must specify at least one relevance criteria for each action. For each criteria, use the Component field
to select an issue or group from the active hierarchy. Then, specify the attribute to inspect in the
Property field. The NBARelevance property serves as the default relevance property. The property
specified should be set by the NBA Strategy for the specified component. Use the Operator and Value
fields to specify the relevance threshold.
When specifying multiple relevance criteria, use the Logic string field to specify how to combine the
criteria. Each criteria label (A, B, etc.) must be present in the logic string. Users can combine these
labels using parentheses, AND, and OR.
Repeat the above process to create and configure more actions. The drag icon, located at the left of
the action's name, enables the re-ordering of actions. The order in which the actions are listed
represents their respective rank.
Prioritize Actions
When multiple actions are added to NBA, use the Action prioritization section to rank these
actions.
Click the Configure link in this section to launch the Configure Prioritization modal window. Usage
patterns for this modal window are described in the Using a Configuration Modal Window
appendix.
Select the desired prioritization Strategy from the list of rules and click Apply.
Note: The Configure Prioritization window only lists those Strategies that have the NBACategory
custom field set to ACTIONPRIORITIZATION. New rules created from this window automatically have
this custom field set.
Marketers can use the power of Strategies to design their desired action prioritization logic. Two
simple options for this Strategy involve prioritizing by rank and prioritizing by relevance.
Prioritizing by Rank
Prioritizing by rank is as simple as manually ordering the actions in the Next-Best-Actions section (by
using the drag control) and then using a Prioritize shape in the Strategy to order by the Rank
property. This is demonstrated in the following Strategy configuration:
Prioritizing by Relevance
Prioritizing by relevance simply involves using a Prioritize shape in the Strategy to order by the
relevance property (e.g. NBARelevance).
Configure Relevance
Use the Next Best Action relevance section to specify the relevance for the hierarchical unit - i.e.
issue or group. If this unit is the driver for an action in the top-level NBA, the relevance value of this
unit will be inspected against the configured threshold to determine if the action is relevant for the
customer.
Click the Configure link in this section to launch the configuration modal window. Usage patterns
for this modal window are described in the Using a Configuration Modal Window appendix.
Select the desired relevance Strategy from the list of rules and click Apply.
Note: The relevance configuration window only lists those Strategies that have the NBACategory
custom field set to RELEVANCE. New rules created from this window automatically have this custom
field set.
l Guided - In this mode, use the Configure links in the Eligibilities and Prioritization sub-
sections to select the desired rules. The configuration windows for these two components are
similar to the ones used in the guided Strategy creation process. Refer to the Configure Eligibilities
and Configure Prioritization topics in the Strategies chapter for more details. An example
configuration using this mode is shown below.
l Manual - Use this mode if the operations available in the guided mode are not sufficient for your
needs. In such cases, use the Alternate strategy link to switch to this mode. Then use the
Configure link in the Alternate strategy sub-section to select the Strategy rule to use to
prioritize group results. Clicking this link launches the Configure Alternate Strategy modal window.
Usage patterns for this modal window are described in the Using a Configuration Modal Window
appendix.
Select the desired alternate Strategy from the list of rules and click Apply. Upon application, the
selected Strategy is listed in the Alternate strategy section. Marketers can click the Strategy name
to open it.
1. Select a template - Use the Configure link in the Business template sub-section to choose one
of the following objectives for the group:
a. Priority ranked offers - Select this template to utilize the guided Strategy creation mechanism
to power the NBA for the group. This process is described in detail in the Strategies chapter.
Refer to the following topics for details: Configuring Targeting Options, Arbitrating over
Targeting Approaches, and Configuring Overall Prioritization.
b. Use alternate strategy - Select this template to instead use a manually created Strategy. In such
cases, use the Configure link in the Alternate strategy sub-section to select the Strategy
rule to use for the group's NBA.
2. Configure the group's relevance - This is done in a similar fashion as configuring relevance at the
issue level.
3. Configure the selected objective - Use the reference topics mentioned above to configure the
sections applicable to the selected business template.
Configuring Outcomes
At any NBA hierarchical level, use the Monitor outcomes section to specify the outcomes to track
for that level. Click the Configure link to select the metrics to track. Clicking this link launches the
Configure Metrics modal window. Usage patterns for this modal window are described in the Using
a Configuration Modal Window appendix. Use this window to select up to nine metrics to monitor
as part of NBA. Each metric is a Key Performance Indicator (KPI) configured on the Visual Business
Director landing page.
Once the NBA configuration is saved, the selected metrics are activated. The system displays the
performance results for these metrics for the selected node. Refer to the Monitoring Outcomes
topic later in this chapter for details on how to review the performance of configured metrics.
Configuring Usage
At any NBA hierarchical level, use the Usage section to specify where to apply the results for that
NBA level. The system provides support for the following:
Click the Configure link in the Real-time containers section to launch the Configure Containers
modal window. Use this modal to add the Containers that should be associated with this NBA level.
Usage patterns for this modal window are described in the Using a Configuration Modal Window
appendix.
Click Apply after adding the desired Containers to return to the main display. Upon application, the
added containers are listed in the Real-time containers section. An active status indicates that the
Container will currently respond to requests, while an inactive status indicates that it will not.
Marketers can click a Container name to open the associated Container rule.
Note: A Container can only be associated to a single NBA level, Supporting Decision, or active Multi-
Channel Campaign at a given point in time.
To review the generated Strategy, use the Open canvas menu item from the Actions landing page
menu.
Note: NBA Strategies are automatically managed behind the scenes by the system. Any manual
changes to these Strategies will be overwritten when the corresponding NBA configuration is saved.
Note: The Delete button is disabled if the NBA configuration has an active outbound schedule.
In addition to configuring a schedule, marketers can also choose to directly output Campaign results
to a database table (referenced by a Database Template rule), thereby bypassing Offer processing
altogether. Check the Write results using a database template checkbox to enable this mode. After
enabling this option, click the Add template link to see a list of available Database Template rules.
Note: The direct output feature requires the Database Template rule to utilize the Append writing
mode. The configuration window only lists those templates that utilize this mode.
After selecting a template, click the Add template button to return to the schedule configuration.
After configuring the rest of the schedule, click Apply to close the schedule configuration window.
Next, the marketer must specify the audience to target with the outbound schedule. To do so, click
the Configure link in the Audience sub-section. Clicking this link launches the Configure Audience
modal window. Usage patterns for this modal window are described in the Using a Configuration
Modal Window appendix. Use this window to select the Segment that defines the target audience for
the scheduled NBA execution.
The marketer can also choose to utilize a Volume Constraint to constrain the Offers output by the
outbound scheduled execution. To do so, click the Configure link in the Constraint sub-section.
Clicking this link launches the Configure Constraint modal window. Usage patterns for this modal
window are described in the Using a Configuration Modal Window appendix. Use this window to
select the Volume Constraint that defines the Offer and/or channel constraints to apply to the
scheduled NBA execution.
Note: The Run action is only available after all required components of the schedule have been
configured.
Upon taking this action, the system validates the configured schedule and triggers its execution. If the
schedule can be successfully applied, the status of the outbound schedule changes from Draft to
Running.
The Run schedule section lists the active and upcoming runs for the schedule. As a run is initiated,
its entry moves from the upcoming list to the active list. While a run is executing, its status displays
as Scheduled. During this phase, the marketer can utilize the Stop link to attempt to stop the
executing run.
When the run successfully completes execution, its status changes to Completed. The system also
displays the number of Offers that were sent as part of the run.
If there is an issue with the scheduled run, its status changes to Failed. In such cases, the marketer
can utilize the Skip link to ignore the failed run or the Restart link to initiate a replacement run.
Note: If the Run, Suspend, or Configure schedule action is performed while the NBA configuration is
in edit mode, the action is queued and applied when the configuration is saved. If multiple such
actions are performed, only the last action takes effect.
To deactivate an active schedule, marketers can utilize the Suspend action from the Actions menu.
Upon completion of this action, the outbound schedule reverts back to the draft state.
Marketers can also modify an active schedule. To do so, switch to edit mode and then use the
Configure link to update the schedule configuration. Save the NBA configuration to apply the changes
made to the schedule.
After all runs of the configured schedule have completed, the status of the outbound schedule
changes to Completed.
When the configured schedule has completed, marketers can configure a new schedule if desired. To
do so, switch the configuration to edit mode and re-configure the outbound schedule. Upon saving
the new configuration, the status of the outbound schedule changes to Draft. The system now
displays information about the new schedule in the active and upcoming runs lists. The marketer can
launch this updated schedule following the aforementioned guidelines.
Monitoring Outcomes
The system displays the performance of selected outcomes in the Monitor outcomes section for
each configured NBA node. The results are context-specific, i.e. they are filtered based on the
business context (top-level, issue, or group) of the corresponding node .
To switch to a drill-down view of these results, click any metric box or the line chart icon (shown in
the image above). A sample detailed view is shown below:
The detailed view includes the following information for each metric:
l A line chart spanning the selected time frame with data points for the selected frequency.
The default time frame is the past year and the default frequency is quarterly.
To change the time frame or frequency, use the controls above the charts.
Hover over a data point to see the metric name, the time period, and the metric value.
The call-out on the last data point indicates the trend of the metric, i.e. the change in the metric
between the last two time periods. The arrow icon indicates whether the metric is trending up
or down, while the call-out value denotes the actual change in the metric's value.
l An information box with the name of the metric, the latest time period, and the value of the metric
for that time period.
Supporting Decisions
Next-Best-Action Designer facilitates the association of Real-Time Containers with NBA
configurations. In certain cases, marketers may additionally want to associate Containers with other
Strategies. Pega Marketing provides support for this requirement via supporting decisions.
The Supporting Decisions landing page lists the configured supporting decisions in the system. This
landing page is accessible in the Pega Marketing portal via: Next-Best-Action > Supporting
Decisions
Marketers can use this landing page to perform the following actions:
l Search for and view supporting decisions - Use the Search input field to specify the search text.
Click View to view the matching supporting decisions.
l Open a supporting decision - Click a supporting decision's name in the grid to open it.
1. Click the Create button in the Supporting Decisions landing page header. This opens the Create a
supporting decision page.
2. Enter a name for the supporting decision in the Decision name field. The system automatically
generates an identifier based on the name. To change the identifier, click the pencil icon.
4. Use the Alternate strategy section to select the Strategy that this supporting decision will
reference. Click the Configure link in this section to launch the Configure Alternate Strategy
modal window. Usage patterns for this modal window are described in the Using a Configuration
Modal Window appendix.
5. By default, the supporting decision utilizes all results from the selected Strategy. To use a specific
component, use the Strategy results drop-down to select the desired Strategy result.
6. Next, use the Real-time containers section to select one or more Real-Time Containers to
associate with the selected Strategy. Click the Configure link in this section to launch the
Configure Containers modal window. Usage patterns for this modal window are described in the
Using a Configuration Modal Window appendix.
Upon closing the configuration window, the selected Containers are displayed along with their
current status. An active status indicates that the Container will currently respond to requests,
while an inactive status indicates that it will not.
7. After configuring the Strategy and Containers, click the Save button.
At this point, the system validates the specified configuration. If there are validation failures, the
system displays these. Some of the validations that the system performs during this phase are:
l Decision name (generated identifier) is not already used by an existing supporting decision.
l Supporting decision must have a Strategy configured if Real-Time Containers have been
configured
l Specified Containers are not currently active elsewhere - such as part of a Next-Best-Action
configuration, another supporting decision, or an active Multi-Channel Campaign.
Once the supporting decision is successfully saved, the display switches to review mode. To make
any further changes, click Edit to switch back to edit mode. Marketers can update all elements of a
created supporting decision, with the exception of the identifier.
Marketers can also use the Delete button to remove a supporting decision.
Chapter 4: Multi-Channel
Campaigns
Multi-Channel Campaigns (commonly referred to as Campaigns) enable marketers to use the power
of intelligent segmentation and analytics to deliver the right offering to the right customer at the right
time.
This chapter includes the following sections that explain various aspects of Multi-Channel Campaigns:
l Campaign Management - Describes the Campaigns landing page and how users can utilize it to
view and search for Campaigns
l Campaign Creation - Describes how users can create a new Multi-Channel Campaign
l Campaign Configuration - Provides information on how users can configure the different elements
of the Campaign
l Campaign Approval - Provides an overview of the approval process and the actions available to
the marketer and the manager
l Campaign Testing - Explains how users can test their Campaigns by running distribution and seed
tests
l Campaign Execution - Explains execution specific actions available on Campaigns and runs
l Campaign Monitoring - Describes how users can monitor the performance of their running
Campaigns
l Campaign Completion - Provides an overview of the actions available at the end of the Campaign's
execution cycle
Campaign Management
Campaigns are listed on the Campaigns landing page which is accessed in the Pega Marketing portal
via the Campaigns link in the left navigation. This landing page lists the twenty most recently
updated Multi-Channel Campaigns and Outbound Campaigns available in the system. The View
more results link (at the bottom) enables users to view the next twenty results. Users can utilize the
filters at the top of the page to filter the results by Status, Issue / Group, Name, and Created by.
Users can click anywhere on the card to open the Campaign. The card displays the following salient
information about the Campaign:
l Name
l Work id
l Enabled engagement types - available types are Outbound, Event, and Container
l Channel icon array, containing icon for each channel utilized within the Campaign - icon's tooltip
displays channel name
l Conversion goal achievement indicator - This is the color bar at the bottom of the card and
indicates performance against the Outbound Conversion Rate goal. It displays one of the following
colors:
Gray - If Outbound Conversion Rate is not a configured goal for the Campaign or when the
Campaign is in design mode.
Campaign Creation
Users can utilize either of the following mechanisms to create Multi-Channel Campaigns:
l Using the Create a new campaign shortcut widget in the Pega Marketing portal Home page
Note: The Campaign's name must be unique across the system. Unlike some of the other rules
(such as Offer), the same Campaign name can’t be used at different hierarchical levels
(Top/Issue/Group). The name must also begin with a letter and shouldn’t contain any special
characters (except spaces and underscores).
Campaign Configuration
Marketers can start configuring the Campaign right from the Create a campaign screen. Once the
Campaign has been created, they can use the Edit button to go into edit mode and make further
updates to the Campaign’s configurations.
As the user updates the Campaign's configuration, the updated values are displayed in the overview
pane on the right. This pane provides an overview of the Campaign's various configurations. The
overview pane is displayed at all times and includes links to open relevant artifacts.
The following sections provide details on the steps involved in configuring a Campaign:
l Specifying Details
l Specifying Goals
l Selecting a Strategy
l Selecting an Audience
l Selecting a Constraint
Specifying Details
Users can utilize the Plan tab to specify various details about the Campaign. These details are
organized into the following sections:
l Campaign details
l Financials
Campaign details
This section includes basic details about the Campaign and includes the following:
l Name
l Issue
l Group
l Business objective
l Campaign type
l Key code
l Priority
l Campaign image - Image associated with the Campaign. This image is displayed in the right
overview pane and in the card for the Campaign on the Campaigns landing page.
l Target audience type - Type of audience (Customer or Prospect) to target via this Campaign.
The value selected for this field determines the items presented in the Audience and Marketing
strategy sections in the Build tab.
l Ignore global exclusion list - Authorized users can enable this option to have outbound
processing of Offers for this Campaign ignore the global exclusion list. Refer to the Exclusion List
chapter for details.
Note: The Campaign's Name, Issue, and Group values cannot be changed once it is created.
Financials
This section includes fields to specify financial metrics for the Campaign. These values typically play
an important role in the approval of the Campaign.
Specifying Goals
The Goals section in the Plan tab enables the user to specify goals for their Campaign. Users can
add up to nine goals. Each available goal is a Key Performance Indicator (KPI) configured on the Visual
Business Director landing page.
The operator displayed between the goal field and the target value automatically toggles (between >=
and <=) depending on whether higher or lower performance of the goal metric is the desirable result.
For example, the Outbound Conversion Rate goal utilizes the >= operator while the Decline Rate goal
utilizes the <= operator.
Selecting a Strategy
The Marketing strategy section in the Build tab enables users to designate a Strategy rule as the
backing strategy for their Campaign.
Clicking the Configure button launches the Configure Marketing Strategy modal window which
lists available Strategies in the system. Usage patterns for this modal window are described in the
Using a Configuration Modal Window appendix.
l Rule name
Selecting this Strategy displays further information about it in the details panel.
l Description
l List of Offers output by the Strategy. Along with the Offer, icons are displayed for each channel
that the Offer utilizes. Clicking an Offer name opens the Offer rule.
After selecting a Strategy, the user must also select the desired result component to use from the
Strategy. This is done via the Strategy results field in the Marketing strategy section. Once a results
component has been selected, the system displays the Offers that are utilized by the selected
component along with their channel icons. The delete icon can be used to dissociate the selected
Strategy from the Campaign.
Selecting an Audience
The Audience section in the Build tab enables the selection of the desired audience for the
Campaign. Audience selection is optional for certain engagement types. It is required when the
Campaign has scheduled executions. It is also required if customer validation is enabled in an event-
based engagement.
Clicking the Configure button launches the Configure Audience modal window which lists
available Segments in the system. Usage patterns for this modal window are described in the Using
a Configuration Modal Window appendix.
l Rule name
Selecting this Segment displays further information about it in the details panel. This panel displays
the following information for all Segment types:
l Segment image
Criteria Segments
List Segments
Clicking the Configure button launches the Configure Engagement modal window which
presents the following three engagement types:
l Campaign schedule
l Real-Time events
l Real-Time containers
Campaign schedule
This engagement type represents scheduled Campaign execution. Users can configure desired
scheduling options and the system will automatically run the Campaign based on the configured
schedule.
To begin with, the user must select between single or recurring execution.
The following additional configuration is available for the One-time only option:
l Start on – Specify the start date and time for the Campaign execution.
The following additional configurations are available for the Recurring option:
Minutes - Specify the number of minutes in which to recur. Additionally, the user can also
choose to specify the hours of operation which are applicable to this mode of recurrence.
Hourly - Specify the number of hours in which to recur. Additionally, the user can also choose
to specify the hours of operation which are applicable to this mode of recurrence.
Daily - The user can choose between the following three options:
Every day
Recur every X weeks based off a start date – specify X in weeks field, do not select any week
days
Recur every X weeks on selected days – specify X in weeks field, select week days (as shown
below)
Monthly - Specify the day of the month and the number of months in which to recur. The
following shows a quarterly configuration:
Yearly - Specify the day of the year and the number of years in which to recur.
l Start campaign – Select the start date and time for Campaign execution.
l End campaign – Determines when scheduled Campaign execution should end. Select from the
following three options:
No end date
In addition to configuring scheduling options, the user can also determine whether to refresh the
audience for the Campaign as part of the scheduled execution. The user can further opt between
refreshing the population for each run or just for the first run.
Note: The refresh audience option is only available when the Campaign audience is a criteria
Segment.
For Multi-Channel Campaigns, Pega Marketing provides support for directly outputting the results of
a scheduled run to a configured Database Template rule. In this mode, Offer processing is bypassed.
To utilize this feature, the marketer can enable the Write Campaign results using a database
template check box and specify the desired Database Template rule in the Template field.
Note: This feature requires the Database Template rule to utilize the Append writing mode. The
smart-prompt for the Template field only lists templates that utilize this mode.
After configuring the schedule, marketers can utilize the template link in the Engagement section or
the right overview pane to open the Database Template rule.
Real-time events
This engagement type represents event triggered execution of the Campaign. Refer to the Real-Time
Events chapter for details on creating and triggering Events.
The following configuration options are available for this engagement type:
Note: If the Campaign is referencing a Strategy rule that contains Segment references within the
Strategy, the above setting is enforced even if it is not enabled. The customer must be a part of
the Campaign audience in this scenario.
l Listen for events from/to – Specify the start and, if desired, end date and time values during
which the Campaign will listen for the Events associated to it. Any Event that is received outside of
the specified time frame will be ignored.
Users should use the Add events link to associate Real-Time Events with this Campaign. Clicking this
link launches the Configure Engagement modal window which lists available Real-Time Event
rules in the system. Usage patterns for this modal window are described in the Using a
Configuration Modal Window appendix.
This view includes the following information about the Event rule:
Selecting this Event displays further information about it in the details panel.
l Friendly name - Clicking the name opens the Real-Time Event rule.
l List of Geofences that the Event triggers. Clicking the name opens the Geofence rule.
l List of Campaigns that utilize this Event. Clicking the name opens the Campaign.
Clicking Add Event in the modal adds the selected Event to the list of Events associated with the
Campaign.
Users can continue to add more Events to the Campaign following the process prescribed above.
Clicking the delete icon next to an Event removes it from the Campaign.
Note: Volume Constraints and any Contact Policy limitations specified in the Strategy are not
applicable during Event triggered Campaign execution.
Note: The Configuring a Fallback Strategy section provides details on using a fallback Strategy
with Real-Time Events.
Real-time containers
This engagement type allows marketers to expose the results of a marketing Campaign to real-time
channels such as web and mobile. Refer to the Real-Time Containers chapter for more details on
creating and triggering Containers.
The following configuration options are available for this engagement type:
l Listen for container requests from/to – Specify the start and, if desired, end date and time
values during which the Campaign will be valid for the specified Container. If a Container request
is made outside of the specified time frame, this Campaign will not be considered for execution.
Multiple Campaigns can reference a single Container as long as the active listening dates do not
overlap.
Users should use the Add containers link to associate Real-Time Containers with this Campaign.
Clicking this link launches the Configure Engagement modal window which lists available Real-
Time Container rules in the system. Usage patterns for this modal window are described in the Using
a Configuration Modal Window appendix.
This view includes the following information about the Real-Time Container rule:
Selecting this Container displays further information about it in the details panel.
l Friendly name - Clicking the name opens the Real-Time Container rule.
l List of Campaigns that utilize this Container. Clicking the name opens the Campaign.
Clicking Add Container in the modal adds the selected Container to the list of Containers associated
with the Campaign.
Users can continue to add more Containers to the Campaign following the process prescribed above.
Clicking the delete icon next to a Container removes it from the Campaign.
Note: The Configuring a Fallback Strategy section below provides details on using a fallback Strategy
with Real-Time Containers.
Selecting a Constraint
The Constraint section in the Build tab enables users to designate a Volume Constraint rule as the
backing constraint for the Campaign.
Clicking the Configure button launches the Configure Constraint modal window which lists
available Volume Constraints in the system. Usage patterns for this modal window are described in
the Using a Configuration Modal Window appendix.
In the list of entries, the following information is shown for each Volume Constraint:
l Rule identifier
Selecting this Volume Constraint displays further information about it in the details panel.
This view displays the following information about the Volume Constraint:
l Scope - Whether constraints defined in the rule are reset individually or as a group
l Grid of Offer constraints - Includes Offer name, minimum, and maximum volumes. Click the Offer
name to open the Offer rule. A check mark next to a row in the grid indicates that the
corresponding constraint is enabled.
l Grid of channel constraints - Includes channel name, minimum, and maximum volumes. A check
mark next to a row in the grid indicates that the corresponding constraint is enabled.
Campaign Approval
Pega Marketing provides supplementary support for incorporating an approval process into the
Campaign lifecycle. This functionality is included in the Marketing Operations module along with
As part of this functionality, Campaigns must be approved before they can be launched.
Implementers of marketing applications can customize the criteria for Campaigns to require
approval. Advanced implementations may even consider customizing the approval flow to better suit
their needs.
The system automatically routes approval requests to the manager of the user’s organizational unit.
In addition to adding the Campaign to the manager’s Work List, the system also notifies the manager
about the approval request via email. This email contains salient Campaign details, the marketer's
note, and a link to directly open the Campaign.
Users can enter a note explaining the reason for recalling the Campaign from the manager.
As before, the manager is notified via email when a Campaign is recalled from their Work List. This
email contains the recall note and a link to directly open the Campaign.
Once a Campaign has been successfully recalled, it can be updated and re-submitted for approval
when ready.
When approving the Campaign, the manager can also enter an approval note. A note is required if the
manager is rejecting the Campaign.
After the manager performs an approval action on the Campaign, the system notifies the user that
submitted the Campaign for approval. This email contains the approval status, manager's note, and a
link to directly open the Campaign.
The approval status and the manager's note are also displayed in the Campaign.
Note: When a Campaign is rejected, the marketer must make updates to its configurations (via the
Edit action) before other actions can be performed on the Campaign.
Campaign Validation
While the Campaign is in the design stage, the marketer can utilize the Validate action from the
Actions menu to validate their Campaign's configurations. Reported violations are categorized into
critical items and warnings. Critical items denote violations that will prevent the Campaign from
being launched. Warnings represent best practice violations and other scenarios which may
potentially impact Campaign execution.
The user can use the edit link to make any necessary updates to the Campaign.
The system automatically invokes this same validation routine when the Campaign is tested or run. If
the validation returns any critical items, the user must correct these in order to perform the desired
action. Warnings do not prevent these actions from being taken but should still be individually
heeded and addressed, where necessary.
Campaign Testing
After configuring the Campaign, marketers can utilize the Test tab on the Campaign to test their
configurations and review test results.
l Distribution Test
l Seed Test
Note: The above test modes are disabled on Campaigns that utilize the direct output to template
feature.
Distribution Test
A distribution test enables the user to test the execution of a Campaign in terms of assessing the
Offers made and the customers targeted. The result of a distribution test is a series of reports
outlining various distribution metrics. No offers are actually made to customers in this form of
Campaign testing.
The Distribution test link in the Tests section enables the user to initiate a distribution test. This
link is enabled when the following conditions are met:
l Audience is configured
Clicking this link performs Campaign validation and presents the user with validation violations and
configuration options. The user must resolve all critical violations before they can initiate the
distribution test.
Additionally, the user can enable the following options for the distribution test:
Upon clicking Submit, the system initiates a distribution test. An entry for this test is added to the
test runs grid. Users can refresh the Campaign display to view the current status of the test.
Clicking the test row displays various details about the distribution test. Refer to Viewing Run
Details for information on using this view.
The delete icon in the row enables users to remove the corresponding distribution test from the
Campaign.
Seed Test
A seed test enables the user to configure and initiate a simulation of Campaign execution. This test is
run against customers specified in a Seed List. The test will execute the referenced Strategy to
determine the Offers that should be made to the customers (seeds) and then make these Offers.
Customers will also be able to respond to these Offers. These responses, however, will not be
captured in Interaction History.
The Seed test link in the Tests section enables the user to initiate a seed test. This link is enabled
when the following conditions are met:
Clicking this link performs Campaign validation and presents the user with validation violations and
configuration options. The user must resolve all critical violations before they can initiate the seed
test.
For a seed test, the user must simply select a Seed List to represent the audience for the Campaign.
Refer to the Seed Lists chapter for information on creating and configuring Seed Lists.
Upon clicking Submit, the system initiates a seed test. An entry for this test is added to the test runs
grid. Users can refresh the Campaign display to view the current status of the test.
Clicking the test row displays various details about the seed test. Refer to Viewing Run Details for
information on using this view.
The delete icon in the row enables users to remove the corresponding seed test from the Campaign.
Campaign Execution
This section explains the following areas pertaining to Campaign execution:
l Running a Campaign
l Rescheduling a Campaign
l Suspending a Campaign
l Resuming a Campaign
l Stopping a run
l Restarting a run
l Skipping a run
Running a Campaign
After the Campaign has been configured and approved, it is ready to be launched. This readiness is
indicated by the availability of the Run action.
Clicking the Run button or selecting the Submit for Execution action from the Actions menu
performs Campaign validation and presents the user with any reported validation violations and run
configuration options. The user must resolve all critical violations before the Campaign can be
launched.
From this screen, the user can configure the desired engagement types for the Campaign. The
options available in this screen are explained in the Configuring Campaign Engagement section.
The user must select at least one engagement type in order to launch the Campaign.
After configuring the desired engagement type(s) for the Campaign, users can click Confirm to
launch the Campaign. Upon doing so, the system generates artifacts necessary for Campaign
execution and transitions the Campaign to the running stage.
Note: After submitting a Campaign for execution (and while it is still running), its referenced
components (such as Segments, Strategies, and Volume Constraints) should not be deleted. In
addition, certain structural changes should only be made after suspending the Campaign. Examples
of these changes include modifying the Strategy's result component and adding Segment usage
within Strategies. After making the desired structural change, the Campaign must be updated and
resubmitted for execution.
Rescheduling a Campaign
Marketers can utilize the Reschedule action (in the Actions menu) if they need to modify the
schedule of a running Campaign. The new schedule will apply only to upcoming runs and does not
impact any runs that are currently running. All upcoming runs for the Campaign are suspended while
this action is in progress.
The configuration options available for the Reschedule action are explained in the Configuring
Campaign Engagement section. However, during this action the user can only make updates to
schedule-related configurations. They can not enable or disable engagement types, or modify
associated Events or Containers. To make such changes, the user must first suspend the Campaign.
Once the user completes the Reschedule action, the previous set of upcoming runs is removed and a
new set of upcoming runs is generated based on the newly specified schedule.
The system also notifies the user who submitted this Campaign for execution. The notification email
contains a link to the Campaign and relevant schedule information, such as the next scheduled run
time.
Suspending a Campaign
Marketers can utilize the Suspend action (from the Actions menu) if they need to suspend a running
Campaign. An important use case for this action is when the marketer needs to make modifications
to the Campaign's configurations, such as its audience or Strategy.
Suspending a Campaign prevents any upcoming runs from executing. When performing this action,
the marketer must enter a note.
Upon completion of this action, the system transitions the Campaign back to the design stage and
notifies the user who launched the Campaign that it has been suspended. The notification email
contains the marketer's note and a link to open the Campaign.
Resuming a Campaign
Marketers can utilize the Resume action (from the Actions menu) to resume a suspended
Campaign. This action is only available if the marketer hasn't modified the Campaign after it was
suspended.
When performing this action, the marketer can determine what the system should do to scheduled
runs.
l Resume all unexecuted campaign runs - In this option, all runs that were not executed will be
resumed. This will also include all runs that are now in the past. Campaign execution will start with
the earliest run (that was not executed) and continue until it has caught up with the current time.
This implies that if there are multiple runs in the past that were not executed, they will execute
l Remove all past unexecuted campaign runs - In this option, any run that is not executed but in
the past will be removed. This option basically provides a mechanism for ignoring (skipping over)
runs that are in the past and resuming Campaign execution with the next run, i.e. one that is
scheduled to execute on or after today.
l Remove all past unexecuted campaign runs except the last - In this option, all past runs that
were not executed will be removed with the exception of the last one. This option will execute the
last run immediately on submission and then follow the rest of the upcoming Campaign schedule.
Regardless of the option selected above, the system displays the list of runs that will be resumed so
that the marketer can see the impact the various resumption options will have on Campaign
execution. The marketer can enter a note when they resume the Campaign.
Upon submission of this action, the system transitions the Campaign back to the running stage and
notifies the user who launches this Campaign for execution that it has been resumed. The notification
email contains a link to open the Campaign.
Upon initiating this action, the system presents the user with a list of all runs that will be stopped.
The user must enter a note detailing why the stop action was selected.
Upon submission of this action, the system issues stop requests for each of the listed runs. The
system will halt run processing (if possible) at the earliest possible instance. When the system
successfully stops a run, a notification email is sent to the user who submitted the Campaign for
execution.
Stopped runs can then be individually restarted or skipped by selecting the appropriate action from
the runs grid in the Campaign display.
Stopping a Run
At times, marketers may wish to stop an individual Campaign run. To do so, they can utilize the Stop
link in the row for the desired run in the Run schedule section. The marketer can also enter a note
along with the stop request.
Upon submission of this action, the system will attempt to halt run processing at the earliest possible
instance. Once the system successfully stops the run, a notification email is sent to the user who
submitted the run's Campaign for execution. The system also assigns the run to this user by adding it
to their work list. The user must act on this stopped run, i.e. perform either restart or skip, in order
for the Campaign to be eligible for wrap-up and completion.
Restarting a Run
The Restart action enables marketers to re-initiate a failed or stopped run. Marketers can utilize this
action after taking necessary steps to address the failure or stoppage of the previous run.
To perform this action, marketers can utilize the Restart link in the row for the desired run in the
Run schedule section. The marketer can also enter a note along with the restart request.
Upon submission of this action, the system automatically skips the current run. The system then
initiates a new run and starts processing it. The user will initially see the previous run in their run
schedule with a skipped status. When the user refreshes (or reopens) the Campaign, the skipped run
will be removed and the newly created run will display along with its current status.
As part of this action, the system also notifies the user via email that the run has been restarted.
Skipping a Run
The Skip action enables marketers to ignore a failed or stopped run. To perform this action,
marketers can utilize the Skip link in the row for the desired run in the Run schedule section. The
marketer can also enter a note along with the skip request.
Upon submission of this action, the run is initially displayed in the run schedule with a skipped
status. When the user refreshes (or reopens) the Campaign, the skipped run will no longer be
displayed in the run schedule.
As part of this action, the system also notifies the user via email that the run has been skipped.
Scheduled execution
The system generates the execution schedule for the Campaign and then waits for the execution time
of the first scheduled run. As a run completes, the system schedules the next run and repeats this
process until all runs are complete.
Note: For Campaigns where the end date is not specified, the system generates the upcoming
schedule for the first ten runs. It will add the next set of runs to the upcoming schedule when there
are fewer than five runs remaining. The application administrator can use the Application Settings
landing page to configure the number of runs the system generates at a time.
Once all scheduled runs of a Campaign are complete, the scheduled execution cycle is also
considered to be complete.
Event-enabled execution
The system listens for configured Events during the configured time frame. If an end time is
configured for the window, the Campaign stops listening for the Event once the end time is reached.
At this point, the event execution cycle of the Campaign is considered to be complete.
Container-enabled execution
The system responds to Container requests during the configured time frame. If an end time is
configured, the Container will no longer consider this Campaign once the end time is reached. At this
point, the container execution cycle of the Campaign is considered to be complete.
Campaign Monitoring
This section includes the following topics pertaining to Campaign monitoring:
l Campaign overview
l Performance
l Run schedule
l Goals
Campaign overview
This section provides a visual representation of how the Campaign is performing since the start of its
execution across the following salient metrics:
l Total impressions
l Click-through rate
l Conversion rate
l The x-axis represents time from the start of Campaign execution till its end, or till the current day
if the Campaign is still running.
l The left y-axis corresponds to the impressions metric, while the right y-axis corresponds to the
two rate metrics.
l Hovering over a data point in the chart displays details about the corresponding metric value.
l Clicking the metric name in the legend toggles the display of the metric's line chart.
Performance
This section lists both cumulative and individual metrics pertaining to the Campaign's overall
performance.
The metrics displayed in the boxes are cumulative across the execution cycle of the Campaign. The
following metrics are displayed:
The Details sub-section below the boxes presents a drill-down view of the above metrics for each
Offer that was utilized by the Campaign. Clicking the Offer name opens the corresponding Offer rule.
Run schedule
In the monitoring view, the Run schedule section displays two grids - one for initiated runs and the
other for upcoming runs.
Initiated runs
This grid lists each initiated Campaign run with the most recent run at the top. Each run row in the
grid contains the following:
l Status of the run - typical values are Scheduled, Running, Completed, Failed
Additionally, users can click the run's row to see a detailed view of the run. Refer to Viewing Run
Details for information on using this view.
Upcoming runs
The Upcoming grid displays the date and time of upcoming runs for the Campaign.
Goals
This section displays the performance of the Campaign against the goals configured by the marketer.
At a high level, the overall goal achievement status for the Campaign can have one of the following
values:
l Goals Met - When at least half of all configured goals have been met
l Goals Missed - When less than half of configured goals are met (as shown above)
l Goals Not Set - When no goals have been configured for the Campaign
For each configured Campaign goal, the system shows current value and the target goal value. The
current value displays in green if the corresponding goal has been met.
To begin with, the section provides an overview of the execution stages and the progress of the run
through these stages. This view contains the following three boxes:
l Audience - This box displays the number of customers that make up the run's audience.
l Marketing Strategy - This box displays the number of Offers that were identified by the
Campaign's Strategy and the number that were actually initiated by the system. These numbers
may be different if the Campaign also utilizes a Constraint, as shown in the example above.
Note: For distribution tests, this box only shows the number of Offers identified by the Strategy
since distribution tests do not initiate Offers.
l Result - This box shows the overall result of the run (or test).
Each of the above boxes also include the date and time when the corresponding stage was
completed.
Additionally, the color of a box visually indicates the status of the corresponding stage.
l Green - Run has successfully completed. Only shown on the result box.
l Yellow - Run has completed, but with Offer failures. The number of failures is also displayed. Click
the link to launch a report that shows error details. Only shown on the result box.
The stage progress colors aid in depicting that the run has failed during the strategy phase (blue). The
error message at the top provides more details on the failure and suggests steps that the marketer
can perform to rectify the situation.
The Offers grid displays the list of distinct Offers initiated as part of the run (or test) along with their
instantiated counts. Clicking an Offer name in the grid opens the corresponding Offer rule.
When the run includes Offer bundles, there are additional rows in the grid for bundled members and
the Bundle member count column displays the count of each initiated member.
Clicking the Reports link at the bottom displays the distribution reports that were generated as part
of the run (or test).
Campaign Completion
This section includes the following topics pertaining to Campaign completion:
l Wrapping up a Campaign
l Archiving a Campaign
l Restoring a Campaign
l Reopening a Campaign
Wrapping up a Campaign
When a Campaign completes its execution cycle, it moves to the wrap-up stage. In this stage, the
marketers can utilize the Wrap-up button or the Wrap-up action (in the Actions menu) to complete
the Campaign.
As part of this action, the marketer can enter any additional remarks on the Campaign and classify it
based on its outcome into one of four categories: Successful, Not successful, Neutral, or Not
specified.
Upon submission of this action, the Campaign transitions to the completed stage. Users can no
longer make any edits to this Campaign.
Archiving a Campaign
Once a Campaign is complete, the marketer can use the Archive button or the Archive action (in the
Actions menu) to archive the Campaign. Once the Campaign is archived, it will not appear (by
default) in the list of Campaigns on the Campaigns landing page.
To view archived Campaigns in the Campaigns landing page, the marketer should set the Status
filter to Archived and then click View.
Restoring a Campaign
The Restore action (in the Actions menu) enables the marketer to move an archived Campaign back
to the stage it was in before being archived, i.e. either the completed or the wrap-up stage. Once the
Campaign is restored, it will be visible in the list of Campaigns on the Campaigns landing page.
Reopening a Campaign
The Reopen action (in the Actions menu) enables the marketer to revert a completed Campaign
back to the wrap-up stage.
Outbound Campaigns have a lifecycle of their own and go through various stages. These stages are
outlined in the Outbound Campaign Lifecycle section. The remaining sections in this chapter
outline the various interactions available to the user. These interactions include the following:
graphic illustrates the stages in the Outbound Campaign lifecycle and the actions that can be
performed by the user at each stage.
l Awaiting Wrap-Up – Outbound Campaign has completed running and is available for wrap-up
l Failed – Outbound Campaign has failed. Actions in this stage are similar to those in the design
stage.
To create a new Outbound Campaign, users should select the Create Outbound Campaign item in
the Create button menu on the Campaigns landing page.
n Specifying Details
n Specifying Goals
Specifying Details
The Campaign details section contains various details about the Outbound Campaign, such as its
name, issue/group information, objectives, planned start date, and basic financial information. The
Name, Issue, and Group can’t be modified after the Outbound Campaign has been created.
Note: The Outbound Campaign’s name must be unique across the system. The name must also
begin with a letter and shouldn’t contain any special characters (except spaces and underscores).
The user can utilize the Campaign Image field to associate an image with the Outbound Campaign.
This image will be displayed in the card for the Outbound Campaign in the Campaigns landing page.
In addition to basic information, marketers can also add tags to their Outbound Campaigns. Tagging
is available once the Outbound Campaign has been created.
Currently, tagging allows the marketer to further classify the Outbound Campaign as desired. In
future iterations of the product, the tagging capabilities may be further enhanced to allow for tag-
based searching.
Authorized users can enable the Ignore global exclusion list option to have processing of Offers
for this Outbound Campaign ignore the global exclusion list. Refer to the Exclusion List chapter for
details.
The Audience card in the Outbound Campaign canvas displays the currently selected Segment and its
details. Initially, this card is empty.
Marketers can click anywhere in the card to launch the Configure Audience dialog.
This dialog presents the twenty most recently updated Segments in the system. The View more
results link at the bottom of the list enables users to load the next twenty Segments. Users can also
utilize the search box to search for Segments by name or description. The Refresh link refreshes the
list of Segments, retaining any search criteria that was previously entered.
1. Segment name. Users can click the name to open the Segment rule.
2. Segment description
If the desired audience is not represented by an existing Segment, users can also choose to create a
new Segment via the Create link. After the Segment has been created, the user can use the Refresh
link to reload the list of Segments. The user’s new Segment should now show at the top of the list
since it was most recently edited.
Clicking a Segment card selects the Segment. The right pane in the Configure Audience modal
displays further details about the selected Segment. This includes the following common information
for all Segment types:
l Segment image
l Number of Campaigns (both multi-channel and outbound) that are using this Segment as their
audience
To complete the selection process, click the Add button to denote the selected Segment as the
Outbound Campaign’s audience. The Audience card is updated to reflect the selected Segment. This
card shows pertinent details about the Segment. This provides the user with a comprehensive
summary of the selected Segment. The user can still open the referenced Segment by clicking the
name link.
The Delete link in the bottom right corner of the Audience card (in edit mode) allows the user to
remove the selected Segment. The user can then select a different Segment using the process
outlined above.
The Offer card in the Outbound Campaign canvas displays the currently selected Offer and its details.
Initially, this card is empty as shown below:
Marketers can click anywhere in the card to launch the Configure Offer dialog. This dialog presents
the twenty most recently updated Offers in the system. The View more results link at the bottom
of the list enables users to load the next twenty Offers. Users can also utilize the search box to search
for Offers by name or description. The Refresh link refreshes the list of Offers, retaining any search
criteria that was previously entered.
1. Offer name. Users can click the name to open the Offer rule.
2. Offer description
5. Volume of the Offer – number of times this Offer has been made
6. Channels utilized by this Offer. Each channel is represented by its icon. Supported channels
include Email, SMS, Passbook, Push Notification, and File/Database.
7. Availability of the Offer – duration when this Offer is available, if start and end dates are set on the
Offer
9. Draft status of the Offer – Draft icon appears if the Offer is in draft mode
Clicking an Offer card selects the Offer. The right pane in the Configure Offer modal displays further
information about the engagement content that the Offer utilizes.
This information is grouped by communication channel and includes every channel that the Offer
uses. In the example Offer above, all supported channels are being used. For each engagement,
relevant information - such as the Email Treatment name or the Push Notification message - is
displayed. Users can click the treatment name to open the associated treatment rule.
To complete the selection process, click the Add button to denote the selected Offer as the Outbound
Campaign Offer. The Offer card is updated to reflect the selected Offer. This card shows pertinent
details about the Offer. This provides the user with a comprehensive summary of the selected Offer.
The user can still open the referenced Offer by clicking the name link.
The Delete link in the bottom right corner of the Offer card (in edit mode) allows the user to remove
the selected Offer. They can then select a different Offer using the process outlined above.
Note: In the current release of Pega Marketing, the Offer and Flow cards are inter-related as the
metadata for both these cards uses the same Offer rule. As such, selecting one of these cards auto-
selects the other card as well. Similarly, removing either the selected Offer or Flow also removes the
other.
Marketers can click anywhere in the card to launch the Configure Flow dialog. This dialog presents
the twenty most recently updated Offers in the system. The View more results link at the bottom
of the list enables users to load the next twenty Offers. Users can also utilize the search box to search
for Offers by name or description. The Refresh link refreshes the list of Offers, retaining any search
criteria that was previously entered.
This card contains the following details about the Offer and its flow:
1. Offer name. Users can click the name to open the Offer rule.
2. Offer description
3. Channels utilized by this Offer. Each channel is represented by its icon. Supported channels
include Email, SMS, Passbook, Push Notification, and File/Database.
5. Offer flow
6. Draft status of the Offer – “Draft” icon appears if the Offer is in draft mode
Users can view the Offer flow in more detail by clicking on the flow. This opens the flow in a modal
window (as shown below). Clicking anywhere outside the modal closes the flow view.
Users can select a particular flow by clicking on the corresponding card. To complete the selection
process, click the Add button to denote the selected Flow as the Outbound Campaign Flow. The Flow
and Offer cards are updated to reflect the selected Offer. The Delete link in the bottom right corner
of the Flow card (in edit mode) allows the user to remove the selected Offer/Flow. They can then
select a different Offer/Flow using the process outlined above.
Specifying Goals
The Goals section of the Outbound Campaign allows marketers to define goals for their Outbound
Campaigns and to monitor the performance of these goals once the Outbound Campaign is running.
When the Outbound Campaign is in edit mode, the Manage goals link is available in this section.
Clicking this link launches a modal dialog that marketers can use to specify various goals for their
Outbound Campaign. Initially, this modal contains a single row for the Outbound Conversion Rate
metric.
Users can specify up to nine goal metrics. Each of these metrics is a Key Performance Indicator (KPI)
configured on the Visual Business Director landing page. Clicking Apply adds all goals with target
values to the Outbound Campaign.
The Goals section displays all goals that have been configured for the Outbound Campaign. Users
can continue to make changes to these goals and their target values while the Outbound Campaign is
in design mode. Once the Outbound Campaign is launched, these goals can no longer be edited.
The user can use the edit link to make any necessary updates to the Outbound Campaign.
When this action is initiated, the system automatically performs Outbound Campaign validation and
reports the validation results to the user. The user must address any validation errors before the
Outbound Campaign can be launched. Warnings do not prevent the Outbound Campaign from being
launched but should still be individually heeded and addressed, where necessary.
After addressing validation errors and warnings, the user can launch this Outbound Campaign. The
user can choose to run the Outbound Campaign right away or schedule it for a time in the future. The
system pre-populates the scheduled run time with the Outbound Campaign's Planned Start Date, if it
is set.
The user can also choose to refresh the audience for the Outbound Campaign before it is run.
Note: The refresh audience option is only available when the audience of the Outbound Campaign
is a criteria Segment.
After the user completes this action, the Outbound Campaign status switches to either Running or
Scheduled based on the run option that was selected. The Outbound Campaign Status card displays
this information along with the Outbound Campaign run duration (if running) or the scheduled
Outbound Campaign start time (if scheduled).
The Goal performance section displays relevant metrics both for the Outbound Campaign as a
whole and for each individual goal.
First, the number of goals achieved and the total number of goals are displayed.
1. Goal name
2. Goal status indicator – Up arrow when the goal has been achieved, down arrow otherwise
3. Current value for goal – Green font when achieved, red font otherwise
4. Target goal value – Set by the user as part of designing the Outbound Campaign
Goal metrics are fetched each time the Outbound Campaign is refreshed or re-opened. To get the
latest metric values, the user can simply refresh the Outbound Campaign.
l Edit – This action allows the user to update Outbound Campaign details and enter actual values
for data collected and other pertinent information about the Outbound Campaign and its
outcome.
l Wrap-Up – This action allows the user to complete the Outbound Campaign and is available in
the Actions menu. The user must select a value for the Outbound Campaign’s outcome and can
enter an outcome note as well.
Upon completion of this action, the Outbound Campaign moves to the Completed stage.
l Reschedule
l Suspend
l Withdraw
l Archive
l Restore
l Reopen
As part of suspending the Outbound Campaign, the system sends an email to the user that launched
the Outbound Campaign notifying them of the Outbound Campaign’s suspension. This email also
includes the note that was entered.
Suspending an Outbound Campaign returns it back to the In Design stage. The user can make further
modifications to the Outbound Campaign before running it.
Withdrawing an Outbound Campaign moves it to the withdrawn stage. No further actions are
available on this Outbound Campaign. The user can still utilize the Save as button to create a copy
of this Outbound Campaign. The Outbound Campaign is also no longer listed (by default) in the
Campaigns landing page. To view withdrawn Outbound Campaigns, users can set the Status filter
on this landing page to Withdrawn.
Chapter 6: Segments
Segments identify a group of customers to use as audience in Campaign and scheduled Next-Best-
Action processing. You can also use Segments on the decision strategy canvas to filter offers based on
a Segment or audience.
Historically, the assembly of criteria to describe a Segment has been an area in which the marketer
had to rely on intuition, prior complex analysis, or guess work. Pega Marketing solves this issue
through the use of intelligent segmentation. Intelligent segmentation uses statistical analysis to
discover predictors within the customer data that contribute positively towards a targeted outcome,
for example, the purchase of a product. For more information about intelligent segmentation, see
Intelligent Segmentation.
2. Click Create.
Note: If you want to create a Prospect Segment instead, see Prospect Segments. Prospect
Segments are Segments which group potential customers.
6. Optional: If you have an Analysis Project which you want to use in this Segment, select it from the
Analysis Project drop-down list. For more information, see Configuring Analysis Projects.
8. Add criteria groups to your Segment. For more information, see Designing Criteria Segments.
10. Click Run to populate the Segment with the current set of customers. You can click Stop to stop
the Segment execution, or continue with other work while the Segment populates. After Pega
Marketing finishes populating the Segment, the total number of customers in this Segment is
displayed in the Population count field.
11. Optional: To automatically refresh your Segment, configure a schedule. For more information, see
Optional: Configuring Criteria Segment Runs.
Once a Segment is created, you can view it in the Segments landing page. For more information, see
Managing Segments.
To design a Criteria Segment, add one or more criteria groups. A group is a container for multiple
criteria that can be combined together to represent a desired logical grouping of the population.
These groups are evaluated from top to bottom and can be organized into sets.
l Analysis project - Lists all the predictors available in the Analysis Project. This is only
available when you associate an Analysis Project with the Segment and run the Analysis Project
at least once.
Recommendations - Lists the best performing predictors from the modeled analysis for
the selected Analysis Project. That is, it shows the predictors which are the most effective at
predicting the required outcome.
Modeled fields - Lists all the predictors available in the Analysis Project that have been
assembled during the execution of the modeled analysis. By default, the predictors are
sorted by the Performance column. The predictors which are the most effective at
predicting the required outcome are displayed on top of the list.
Static fields - Lists the set of static attributes from the Analysis Project which have been
processed as part of static analysis execution. The Group column displays the number of
groupings for the predictor. The Count column displays the number of items across all
groupings for the predictor.
For more information about Analysis Projects, see Configuring Analysis Projects.
l Data fields - This tab allows you to select the customer data fields which you want to use as
criteria in your Segment. Use the Search box to look for specific data fields, or scroll through
the list of available fields. The following types of data fields are available in this tab:
Customer > History - data fields for customer history, for example the Outcome of an
interaction with the customer.
You can also configure other associated data entities which should be available in this tab,
for example Customer > Address. To configure additional data entities, go to
Configuration > Settings > Application Settings > Manage Data Relationships.
l History fields - This tab allows you to select the criteria related to treatment and offer
responses. For example, you can use the Received offer via channel during a time
period to look for customers who were sent an email with an offer within the last two weeks.
l Segments - This tab allows you to select other Segments as criteria within this Segment. For
example, you can select which existing customer Segment should be excluded from this
Segment by selecting the existing Segment as a criterion and then clicking Exclude. Selecting a
Segment criterion automatically includes or excludes all customers in that Segment.
4. Click any criteria to add them to the criteria group. For example, if you want the Segment to
include only customers above a specific Customer Lifetime Value, add the Customer Lifetime
Value criterion and then enter a Greater than value. Depending on the criteria type, you may
need to specify additional settings. For more information, see Criteria Types.
You can add up to 26 criteria to a criteria group. By default, the criteria are applied with an
AND logic. For example, you can look for customers with Customer Lifetime Value greater than
100 000 AND located in the United States.
5. If you want to change the relationship between some criteria to OR, edit the value in the Logic
string field. For example, you can configure the criteria group to look for customers who match
both criterion A AND criterion B, OR criterion C.
6. Optional: To remove a criterion from the logic string and the Segment, click the Delete icon .
7. Click Add group to add another criteria group, if needed. You can add multiple criteria groups
and combine them by using the following actions:
l Start with – Selects customers in the top group to be combined with the actions of the other
criteria groups.
l Intersect – Includes customers that meet the group’s criteria in the Segment population. This
action is available for groups other than the first.
l Exclude – Removes customers that meet the group’s criteria. This action is available for all
groups.
l Merge – Adds customers matching the criteria to the Segment. These customers do not have to
meet the criteria that is specified in the preceding groups. The Merge action removes the
duplicate customers that would be added to the Segment. The Merge action is available for
The WATERFALL COUNT field reflects the flow of customers through Segment criteria groups.
10. You can also organize criteria groups into separate sets for easier viewing. Click the + icon to add a
new criteria set.
Criteria Types
The configuration options for a criterion depend on the criteria type. The following criteria types are
supported:
Histograms
Categoricals
Long Categoricals
Categoricals
Long Categoricals
l Data fields
Strings
Numbers
Histograms
A histogram displays a numerical property which produced meaningful analysis information during
modeled analysis execution.
l The grouping of the analyzed data, displayed as individual columns of the histogram. Ranges for
the groupings are displayed as labels on the horizontal axis.
l The percentage of the overall population within the group, represented by the height of each
column. Percentage values are displayed as labels on the left vertical axis.
l The propensity of individual groups, represented by the red performance line. Propensity is the
ratio of the number of positive responses to the total number of responses. The propensity values
are displayed as labels on the right vertical axis.
Click on a column to select or deselect groupings. You can select multiple groupings for the criterion.
The system selects the column with the highest propensity by default.
Pega Marketing uses the range values associated with each group to compose queries against the
customer source. It treats the left edge of a range as greater than or equal to (>=) and the right
edge as less than (<) in its queries.
Categoricals
The categorical criteria editor is used for the following criteria types when they have no more than
eight groupings:
l The percentage of the population within the group, represented by the length of each bar.
Percentage values are displayed as labels on the bottom horizontal axis.
l The propensity of individual groups, represented by the red dots. Propensity is the ratio of the
number of positive responses to the total number of responses. The propensity values are
mapped to the top horizontal axis. This information is only available for modeled analysis criteria.
l Range - Symbols in this group. To see this information, move your mouse over a bar or a
propensity dot. The information is displayed as a tool tip.
l People(%) - Percentage of population (based on Sample data) in this group. To see this
information, move your mouse over a column. The information is displayed as a tool tip.
l The predictive power of this group. To see this information, move your mouse over a propensity
dot.
Click on a bar to select or deselect groupings. You can select multiple groupings, including Missing.
For modeled analysis criteria, the system selects the bar with the highest propensity by default.
Pega Marketing uses the symbols associated with each group to compose suitable queries for this
criterion. When multiple symbols exist in a group, the system will query for all present symbols. For
the Missing group, the system translates the query to search for where the criterion value is null.
Long Categoricals
If the number of elements for a categorical criterion is greater than eight, it becomes impractical to
visualize this criterion as a bar chart. Instead, the criterion is displayed as a long categorical.
Click Select items to open a pop-up window with a list of groupings for the criterion. You can select
one or more groupings.
Strings
The string criteria editor is used for text criteria available on the Data fields tab.
l Contains
l Starts with
l Ends with
l Search Exact
l Is null
l In list - For more information, see Selecting Criteria Values from a List
l Include missing values – Include results that do not have a value specified for the selected
criterion
Numbers
The number criteria editor is used for numerical criteria available on the Data fields tab.
l Between
l Greater than
l Less than
l Equal to
l Missing value
l In list - For more information, see Selecting Criteria Values from a List
l Include missing values – Include results that do not have a value specified for the selected
criterion
The date and time criteria editor is used for date and time criteria available on the Data fields tab.
Use it to configure criteria for a range of dates and times or perform standard comparison tests
against date and time values.
The following options are available for date and time criteria:
l Date & Time - Configure both dates and times for this criterion.
l Missing value- Search for instances where this criterion value is null.
l Relative date - Search for instances of this criterion value using date operators relative to the
current date. The following operators are available for relative date comparison:
More than - Use this option to search for instances where this criterion is strictly more than X
days before today (i.e. X + 1 days before or earlier).
At least - Use this option to search for instances where this criterion is at least X days before
today.
In exactly - Use this option to search for instances where this criterion is exactly X days after
today. To search for days before today, specify a negative value for Days. For example, use -X
days with this option to search for instances where this criterion is exactly X days before today.
In more than - Use this option to search for instances where this criterion is at least X days
after today.
In at least - Use this option to search for instances where this criterion is strictly more than X
days after today (i.e. X + 1 days after and later).
In last - Use this option to search for instances where this criterion is within the last X days.
In next - Use this option to search for instances where this criterion is within the next X days.
l Include missing values – Include results that do not have a value specified for the selected
criterion
Aggregating Data
For string, number, and date and time criteria fields that belong to a repeating structure (such as a list
of purchases), you can select the Occurrences search operator to aggregate the criteria values.
1. Select the Occurrences search operator to display input fields for the comparison operator and
the comparison value. The following example criteria targets all customers that have more than
thirty Interaction History records.
2. Click Add additional criteria to specify additional criteria for the aggregation. Each additional
criterion must be on the same parent entity as the original criteria being aggregated.
3. After selecting the additional criteria, fields relevant to the criteria type are displayed. Use these
fields to configure the additional criteria. The additional criteria are combined using AND logic. The
following example targets all customers that have had more than five outbound email
communications.
Note: Aggregation using the Occurrences operator is only available for first-level entities, that is,
those entities that are directly associated with the customer class and not nested under other
associated entities.
For string and number criteria available on the Data fields tab, you can select the In list search
operator to view, search for, and select filter values for the criterion from a list of possible values.
The items grid in the criteria editor lists the values that are currently selected for the criterion.
1. Select the In list search operator, and then click Select items to open the Select items dialog
box.
2. To find specific values, enter the search text in the Search field, and then click the search icon.
3. To add or remove individual items, select or clear the check box next to an item. You can select or
clear multiple items.
5. To exclude customers from the results who have any of the selected values as their value for the
criterion, select Exclude.
6. To include customers that do not have a value specified for the selected criterion, select Include
missing values.
7. Click Apply.
Note: This approach to designing Criteria Segments is deprecated. If possible, design all Segments
using the standard approach. For more information, see Designing Criteria Segments.
1. On the Design tab of a Criteria Segment, click the rule form icon .
3. In the Column source field, enter or select the property which you want to use as a criterion.
4. In the Relationship list, select the operation that evaluates the property and value.
6. Use the gear icon to add filter options, such as Ignore case and Use null if empty.
7. In the Filter conditions to apply field, define the relationship between the criteria. By default,
the criteria are applied with an AND logic. If needed, you can change the relationship between
some criteria to OR.
8. Optional: Select other Segments as criteria within this Segment. Selecting a Segment criterion
automatically includes or excludes all customers in that Segment.
c. In the IN / NOT IN list, select whether the new Segment evaluates customers who are in or
not in the existing Segment.
d. In the Filter Segments field, define the relationship between the Segments.
9. Click Save.
1. In the Data Options section, configure how data in the Segment is refreshed at run time. The
following options are available:
l Refreshable Segment - Segments which refer to this Segment as part of their criteria can
automatically refresh this Segment when they are run.
l Refresh Child Segments - The Segment can automatically refresh data in its child segments,
so long as they are marked as refreshable.
If the refreshable option is not enabled, then the Segment's contents will remain untouched and
used as is in the criteria evaluation of the parent, and any child Segment beneath the non-
refreshable Segments are also not refreshed.
Note: Top-level Segments in a dependency chain are always refreshed. Normally, Segments
lower down in a dependency chain should also be marked as refreshable, as this ensures that any
parent Segment is set up in the most accurate way. However, as a best practice, disable the
refreshable option for all Segments that are too costly (in terms of time and processing resources)
to refresh every time a parent Segment is refreshed.
2. In the Sampled Segments Options section, select a sample of criteria results. For more
information, see Control Groups.
3. In the Control Group Options section, designate Segment results as a control group. For more
information, see Control Groups.
4. In the Scheduling Options section, select the Enable Schedule check box to control when the
segment runs.
Caution: You must check in the Segment. Segment scheduling or the removal of any prior
schedule only takes place after the Segment is checked in.
5. In the Delivery Options panel, configure the Pega Marketing to send email notifications for
scheduled runs and refreshes. You can customize the email by using the provided fields. The email
recipient must be an operator in the system.
Intelligent Segmentation
Intelligent segmentation assembles recommended criteria from statistical analysis of various input
sources and ranks them according to how well they do at predicting certain outcomes. This helps the
marketer to identify groups of customers, form Segments, and use them without the need for guess
work.
Intelligent segmentation is supported by Analysis Projects, which create a set of predictors based on
samples of the main customer data. Intelligent segmentation also uses sampling strategies to
optimize the processing involved in discovering these predictors.
Configuring a Sample
You can use a Sample to define a sample of the overall customer population. An Analysis Project
takes a Sample and performs a range of statistical analysis activities to determine which data fields
have predictive power or influence when measured against a goal, for example the purchase of a
product or service.
6. On the Design tab, in the About This Sample Population section, configure the following
information according to your requirements:
l Anticipated Sample Size - Describes the required size in terms of an absolute number
(Fixed) or a percentage (for example, 10%).
l Sample Strategy - Describes various sampling strategies. For Ascending and Descending,
use the Ordered On field to identify the field in the data set on which to order.
7. In the Sample Fields section, clear any check boxes corresponding to fields which are not useful
in analysis. As a general rule, fields that are system-related (for example partition key) or unique
for individual customers (for example their customer id or their full name) typically have no value
from an analysis perspective.
8. Click Save.
b. Click Confirm to populate the Sample. The Sample size field is updated to reflect the
number of rows in the Sample.
c. Click Preview to preview the contents of the Sample and its associated customer data.
l To run the Sample automatically, schedule the sample execution in the Schedule tab. Sample
scheduling works in the same way as Segment scheduling. For more information, see Optional:
Configuring Criteria Segment Runs.
10. Optional: Click the History tab to see details of the Sample population.
2. Click Create.
5. Configure the analysis type for the Analysis Project. The following analysis types are supported:
l Configuring Static Analysis provides a convenient way to understand what the groups of data
look like for a specific property and how many occurrences exist within each group.
6. Click Save.
l To run the Analysis Project manually, click the Results tab, and then click Run .
For Static Analysis, the Run button is in the Static Results section. If the Run button is
inactive, check out the Analysis Project.
For Modeled Analysis, the Run button is in the Modeled Results section. If the Run
button is inactive, check out the Analysis Project.
l To run the Analysis Project automatically, schedule the Analysis Project execution in the
Schedule tab. Analysis Project scheduling works in the same way as Segment scheduling. For
more information, see Optional: Configuring Criteria Segment Runs.
9. Click the Results tab to review the results of manual and scheduled analysis runs.
10. Optional: Click the History tab to see the analysis execution statistics.
You can configure the Analysis Project to use static Data Distribution analysis. This provides a
convenient way to understand what the groups of data look like for a specific property and how
many occurrences exist within each group. It is useful as a first pass to describe how the data in our
data source is organized and may give some insight as to where to focus any criteria construction in
Segments.
2. Review the available properties which have been retrieved from the supporting sample.
l Distinct Count- This property will be processed during the execution phase and a distinct
count of the grouping will be performed. Apply this grouping to properties which have a limited
set of values and where knowing how many customers are in each group would be very
valuable.
l No Grouping - This property will be ignored. However, it may still be used as part of the
modeled analysis. Apply this grouping type to properties which are likely to be a continuous
value with a large number of groups and which are less useful from a grouping and distribution
analysis perspective.
4. If the Sample fields changed since this Analysis Project was created, click Refresh .
You can configure your Analysis Project to use modeled analysis. This approach uses statistical
analysis to identify properties that have a high influence on the targeted outcome, completely
removing the need for guess work or intuition when assembling criteria in a Segment.
A key aspect of this analysis approach is the use of a closed loop feedback mechanism. Sample data
is used to train or drive the creation of modeled analysis predictors. The sample data brings with it
details of previous interactions and responses to offers made. While we are creating modeled
analysis predictors that have predictive power over various outcomes, they are based on positive and
negative responses to previous offers.
2. In the Select Offer section, you can train the analysis on specific instances of responses to
previously delivered offers. You can train the analysis using responses to previous offers for the
same product or product group. Alternatively, for a new product offering, you can use similar
products or product groups to assemble likely predictors that will help illustrate the type of
customers who are likely to buy the new product.
b. Leave any of these values blank to bring through all entries for the parent category. For
example, if you select the Sales Issue and the Handsets Group, and leave the Offer field
blank, the analysis will consider the responses to all offers that belong under Sales or
Handsets.
3. In the Interaction Details section, you can train the analysis on specific interaction details, in a
similar way as with responses to offers. Select the Direction , Treatment, and Channel on
which you want to focus. Use the Offered After field to restrict the analysis only to responses to
those offers that were offered after a specified date and time.
4. In the Select Predictors section, remove or add properties from the base Sample which will be
used as predictors for the analysis. Predictors which have no predictive value in modeled analysis
should be removed from this section.
5. In the Define Behaviors section, select positive and negative outcomes for the modeled analysis
based on the set of responses received so far.
Review each response type in the Available Behaviors section and mark it as a positive,
negative, or ignored behavior for the analysis. To reload the list of available behaviors, click
Refresh . Marking as Positive or Negative moves the response type into the corresponding
response category (Positive Behavior or Negative Behavior).
You can associate a Segment with an Analysis Project so that you can reuse static and modeled
analysis predictors during criteria assembly. For more information about associating an Analysis
Project with a Segment at Segment creation, see Creating a Criteria Segment.
You can also associate Analysis Projects with existing Criteria Segments.
2. Open the Criteria Segment which you want to associate with an Analysis Project.
5. In the Analysis Project list, select an Analysis Project which is relevant to your Segment. If the
Criteria Segment was already associated with an Analysis Project, selecting a new Analysis Project
will clear any existing criteria for this Segment.
7. Optional: To view or modify the Analysis Project configuration, click the Open icon next to the
Analysis Project list.
8. Click Save.
5. Add customers to your Segment. There are two ways of adding customers to List Segments:
l Importing Customers
Pega Marketing automatically starts to populate the Segment with the current customer list. The
total number of customers in this Segment is displayed in the Population count field.
7. After you create a Segment, you can view it in the Segments landing page. For more information,
see Managing Segments.
Importing Customers
You can use a comma-separate values (CSV) file to import customer data into your application. By
adding or updating customer records in bulk, you can quickly update the Segment. You can import
customer data at any time.
Tip: The import process uses the Data Management functionality of Pega Platform. For details on
this process, click the help icon in the wizard to launch the Pega Platform help topic.
2. Click Choose file, and then upload the CSV file with your customer data.
a. Add or update - Creates customer records for entries in the import file that do not exist in
the customer table, updates existing customer records, and adds all valid customers to the List
Segment.
b. Add only - Creates customer records for entries in the import file that do not exist in the
customer table, ignores existing customers, and adds all valid customers to the List Segment.
c. Populate Segment Only- Adds existing customers from the import file to the List Segment,
but does not modify the customer table.
4. Click Next.
5. In the Match existing records by field, select the data field from your import file which will be
used to match existing customer records. For example, select CustomerID. The field used to
match records must be unique.
6. For each Source field in the import file, specify the Target field mapping. If you previously
saved a field mapping template, you can select it from the Template type list.
7. Optional: If you selected the Add or update import purpose, you can use the Update type list
to control which fields are updated for existing customers. To set different conditions for different
fields, clear the Update all fields check box and set the conditions in the Update type column.
8. Click Next.
9. Optional: To save a field mapping template, select the Save import settings as a template
check box.
Tip: If the validation reports any invalid rows, click the See more link to download a CSV file
containing the records which failed to import. The last column in this file contains a description of
the error that occurred. Resolve the errors before you proceed.
When importing large files, the import progress can take some time. You can close the import
window and continue with other activities. The system displays the status of the import at the top
of the customer grid. Once the import completes, the system displays the number of instances
that were added or updated by the import. If there were errors during the import, the number of
erroneous records is also shown.
2. Enter a part of the customer name, email, or ID into search box, and then click the search icon.
3. Select one or more customers to add to the List Segment, and then click Add.
4. Optional: Repeat the above steps to add more customer records to the Segment.
5. Click Done.
Managing Segments
You can view and manage List and Criteria Segments by using the Segments landing page.
l Description
l Segment type
Tip: The landing page lists the twenty most recently updated Segments in the system. To load the
next twenty results, click the View more results link at the end of the list.
3. To search for Segments by Issue / Group, Type, and Name, use the filters at the top of the page.
l For Criteria Segments, click the Show customers link in the Segment header panel. This
launches a pop-up grid listing the customers in the Segment.
l For List Segments, the same customer grid is available directly on the Customer list tab of the
Segment.
2. The customer grid displays the built-in Default customer view. If your implementation team
defined other views for the customer grid, you can switch to them by selecting the view in the list
and clicking View.
Tip: To define a custom data view, create a Report Definition in the Customer- class that has a
custom field named DataManagement and value Views.
l For Criteria Segments, click Export in the pop-up window which displays the customer grid.
l For List Segments, ensure that the Segment is checked in, and then click Export on the
Customer list tab of the Segment.
2. Use the columns in the grid to sort and filter for the customers you want to remove from the
Segment.
3. Click the Delete icon in the customer's row in the customer grid.
Note: For Criteria Segments, this option is not available. To change which customers are included in
a Criteria Segment, adjust the selection criteria instead. For more information, see Designing Criteria
Segments.
Repopulating a Segment
After you make changes, such as adding customers or adjusting criteria, to a Segment, repopulate it
to apply your changes.
2. Click Save.
l For Criteria Segments, click Run after checking in the Segment. Running a Criteria Segment
repopulates it.
3. For Criteria Segments, review statistics about previous Segment runs in the Segment Statistics
section.
4. For List Segments, review details about previous uploads of files with customer data records in the
Import History section.
Pega Marketing provides support for defining and populating Control Groups. In addition, the
Strategy rule also provides support for assessing whether a customer is in a Control Group. This
allows the user to treat Control Group members differently. For example, Control Groups members
might not receive a particular Offer.
Note: Pega Marketing uses Interaction History (IH) to maintain Control Group memberships. This
allows Control Groups to be used in both batch and real-time strategies.
1. Create a new Segment rule. Alternately, an existing Segment rule can also be converted to a
Control Group.
2. Configure the "Design" tab of the Segment rule as desired. Specify the criteria fields to use and
select the intersections that represent the Control Group.
3. On the "Options and Schedule" tab, enable the Control Group checkbox and, optionally, specify a
validity period for the Control Group.
4. Optionally, select whether the Control Group should be a random sampling of the selected
Segment criteria results. To do so, enable the "Select a portion..." checkbox on the "Options and
Schedule" tab. If selected, specify the maximum sample size or the percentage of the criteria
results to be use for the Control Group. If this option is not selected, the entire set returned by the
Note: The Sample option can also be used independently on a Segment (without the Control
Group option) to create a Segment with a random sampling of the selected criteria's results.
Once the Control Group has been populated, the number of customers in the Control Group is
shown in the Segment toolbar. The "Show Customers" button can be used to view the customers in
the Control Group.
At a high level, this Strategy pushes out a selected Offer to customers that are not in a selected
Control Group. The salient shapes in this Strategy are explained below.
The Interaction History shape is used to fetch the Control Group membership records for the
customer. To do so, the following conditions are specified on the shape:
In addition, the “last days” value is cleared in order to include all IH records.
To minimize the number of fields being retrieved, the "Manually select properties…” checkbox is
enabled.
2. Group By shape
The IH shape fetches all records that meet the specified criteria ordered in reverse chronological
order (latest entry first). The latest IH entry (if one exists) depicts the current membership status in the
specified Control Group. To get at this entry, the Group By shape can be used to select the first entry.
No additional grouping/aggregation criteria need to be specified.
3. Filter shape
The Filter shape specifies the criteria to output the input Offer. The filter expression must inspect the
status of the last membership record. This value is stored in the "pyOutcome" field of the record.
There are three possible values for this field:
l NonMember - Customer is currently NOT IN the specified Control Group, but has previously been
a member of this group.
l (Missing) - Customer is currently not and has never been in the specified Control Group.
The filter expression must also account for Control Group validity dates, if they have been specified.
The following represents a sample filter expression that takes the above factors into account:
@if(@equals(LatestCGStatus.ControlGroupValidityStart,""), true, @
(Pega-RULES:DateTime).CompareDates(@(Pega-
RULES:DateTime).CurrentDateTime(),
LatestCGStatus.ControlGroupValidityStart)) && @if(@equals
(LatestCGStatus.ControlGroupValidityEnd,""), true, @ (Pega-
RULES:DateTime).CompareDates (@(Pega-RULES:DateTime).CurrentDateTime
(), LatestCGStatus.ControlGroupValidityEnd))
Chapter 8: Strategies
A Marketing Strategy enables the user to match the Offers that are available for a Campaign to the
customers in the target population. Users can design Strategies to ensure that each customer is
targeted with the Offer that is most suitable for them. The Strategy rule enables the user to apply
various business goals and prioritization criteria to make this determination.
The Strategies landing page lists available Strategy rules in the system. This landing page is accessible
in the Pega Marketing portal via: Intelligence > Strategies
The Issue / Group filters and the search input field allow marketers to refine the list of Strategies
displayed on this landing page.
Pega Marketing provides support for the following Strategy creation modes:
l Guided - To create a new Strategy using this mode, directly click the Create button on the
Strategies landing page or select the Guide me through it item from the create button's menu. To
re-configure created Strategies using this mode, select the Open Strategy Builder action from the
Actions menu in the row of the Strategy on the Strategies landing page.
l Manual - To create a new Strategy using this mode, select the Start with new canvas item from the
create button's menu. To review or re-configure created Strategies using this mode, double-click
the Strategy row or select the Open Canvas action from the Actions menu. For information on
manually creating a Strategy rule and configuring its various tabs, refer to Pega Platform
documentation.
Pega Marketing includes marketing-centric Strategy shapes that aid marketers in further harnessing
the powers of Strategies. These shapes are described in the Marketing-centric Strategy Actions
section.
1. Specify a name for the new Strategy. The system automatically generates an identifier for the
Strategy based on the specified name. To change the identifier, use the pencil icon.
3. Select the objective of the Strategy. Click Configure in the Objective section to launch the
Configure Objective modal window. Usage patterns for this modal window are described in the
Using a Configuration Modal Window appendix. After selecting an objective, click Apply to close
the window.
4. Configure the various elements of the selected objective. Refer to the appropriate configuration
topic in the following list for more details:
a. Bundled offers
c. Offer prioritization
Bundled offers
This objective enables marketers to create a Strategy to create Offer bundles using various targeting
approaches. Marketers can utilize Segments, Eligibility rules, and Prioritization rules to priority rank
the Offers within each bundle.
The sequence of steps for configuring this objective and the configuration options are mostly similar
to the ones for configuring the Priority ranked offers objective.
The one additional configuration that is specific to the Bundled offers objective is the specification of
the bundle parent when configuring a targeting approach. This is applicable for both audience-driven
and analytics-driven targeting approaches.
When configuring a targeting approach under this objective, use the Configure link in the Bundle
sub-section of the approach to launch the Configure Bundle modal window. This window lists all
Offers in the selected groups that are bundle parents. Select the desired Offer to use as the bundle
parent for the targeting approach and click Apply to close the modal window.
After selecting a bundle parent, marketers can use the Name and Type fields to modify the name and
type of the bundle. Any modifications to the name and/or type are only applied in the generated
Strategy. The backing Offer is not impacted.
To configure this objective, first select the calculation method to use. Click the Configure link in the
Method section to launch the Configure Calculation Method for CLV modal window. This window
lists the available calculation methods. The details section shows the expression used by the
calculation method. Pega Marketing provides the Simple calculation method out of the box. Select a
calculation method and click Apply.
Next, configure the fields pertaining to the selected calculation method. For the default Simple
calculation method, this includes the following fields:
l Annual profit - This is the yearly profit from the customer excluding one-time acquisition costs.
l Retention rate - This is the annual rate of retention of your customer base.
For each of the above fields, marketers can use one of the following sources for the value:
l Property - Select a property from the customer class that contains this value
l Strategy - Use the Configure link to select a Strategy that returns this value. After selecting a
Strategy, select the strategy result property that contains the value.
The following example demonstrates the usage of these fields to determine the CLV for a customer
using the Simple calculation method:
l Sample values: Acquisition cost = 50, Annual profit = 1400, Retention rate = 80%
Offer prioritization
This objective enables marketers to create a reusable Strategy to define how Offers will be prioritized.
Marketers can utilize analytical models to determine the Offer priority. The generated Strategy uses
an external input. As such, this Strategy can be applied to any set of Offers.
Strategies generated for this objective have built-in propensity smoothing, thereby giving new Offers
a chance to compete with existing Offers. Marketers can additionally boost priority by assigning
weights to results.
l Analytical model - Select this option to use a predictive or adaptive model as the driver for
prioritization. Click the Configure link in the Analytical model section to launch the Configure
Analytical Model configuration window. This window lists the adaptive and predictive models in
the system. Usage patterns for this modal window are described in the Using a Configuration
Modal Window appendix. Select the desired analytical model and click Apply to close the window.
After selecting a predictive model, marketers must additionally specify a property from the model
results to use as the basis for prioritization.
l Property - Select this option to use a property as the driver for prioritization. Use the smart
prompt to select the desired property.
l Weighting - Marketers can utilize a Decision Table to assign weights to prioritization results. Use
the Configure link in the Weighting section to launch the Configure Weighting configuration
window. This window lists Decision Table rules in the strategy result (SR) class. Usage patterns for
this modal window are described in the Using a Configuration Modal Window appendix. Select the
desired Decision Table and click Apply to close the window.
l Priority - Marketers can also customize the expression used to calculate the priority. These
expressions are represented using Field Value rules stored under the Embed-PegaMKT-
NBAComponent-PriorityCalculation class with the Field Name set to PriorityCalculation. The
system provides a few basic priority calculation expressions out of the box. Use the Configure
link in the Priority section to launch the Configure Priority configuration window. Usage patterns
for this modal window are described in the Using a Configuration Modal Window appendix. The
detail pane shows the expression used by the selected priority calculation. Select the desired
priority calculation and click Apply to close the window.
To specify a threshold, select Threshold in the drop-down in the Prioritization threshold section.
Then select an operator in the Condition drop-down and specify the comparison value in the Value
field. Marketers can specify a static threshold value or reference a strategy result property as the
comparison value.
A sample configuration returning the top ten results sorted on descending priority order is shown
below:
Note: Changing the business issue clears out all configurations for the previous issue.
2. Select one or more groups within the selected issue to utilize in the generated Strategy.
1. Click the Add targeting approach link in the Targeting approach section.
2. Select the targeting type from the Add Targeting modal window. Choose between the following
options:
a. Audience driven - Choose this option to use audience configurations (i.e. Segments) to
determine how to target the audience.
b. Analytics driven - Choose this option to use (predictive and adaptive) analytical models to
determine how to target the audience.
3. After selecting the targeting type, click Apply to submit the selection and close the modal window.
4. Configure the selected targeting approach. See Configuring Audience-driven Targeting and
Configuring Analytics-driven Targeting for details.
The first step of configuring this targeting approach is to select one or more Segments to represent
the starting audience targets. Click the Configure link to launch the Configure Audience modal
window. Usage patterns for this modal window are described in the Using a Configuration Modal
Window appendix.
After adding the desired Segments, click Apply. The targeting panel now displays the audiences
added for this approach.
The two rows each represent a branch of logic execution in the generated Strategy.
l Assign offers
l Split by segment
l Remove segment
Repeat the above process to fully configure each row in the audience-driven targeting approach.
Assign offers
Use the Assign offers link to launch the Configure Offers modal window. Use this window to select
the Offers that should be included for customers that are members of the corresponding Segment.
Usage patterns for this modal window are described in the Using a Configuration Modal Window
appendix.
Note: The Configure Offers modal only shows those Offers that are in the Strategy's selected
groups.
After configuring the desired Offers, click Apply to associate them to the corresponding Segment
row.
Split by segment
Select the Split by segment item from the Actions menu to split the execution logic for the selected
row. Upon selecting this item, the Configure Audiences modal window launches. Use this window to
In the example above, the marketer has split the high value customers path into two paths. Now, the
marketer can target customers who are members of each path differently. They can select one Offer
(or set of Offers) for those customers who belong to High Value Customers and Frequent Flyers, and
a different set of Offers for customers that belong to High Value Customers and New Renters.
Remove segment
Select the Remove segment item from the Actions menu to remove the current Segment row and
its associated configurations - i.e. Offers and split Segments.
The first step of configuring an analytics-driven targeting approach is to select the business groups to
include in the approach. If the Strategy being generated is only applicable to one business group, this
group is selected by default. Otherwise, click the Configure link to launch the Add groups modal
window.
Note: Only those groups that were selected to be included in the Strategy are shown in the Add
groups modal window.
Click Apply after selecting the desired groups. The targeting panel now displays each of the selected
groups along with action links to configure them.
l Remove group
l Configure eligibilities
l Configure prioritization
By default, all Offers in the group are considered. However, marketers can choose the Select Offers
menu item to individually select the Offers to use.
Use the Configure link to launch the Configure Offers modal window and select the desired Offers.
After applying their changes, marketers can click a selected Offer to open it.
The View all offers action in the Actions menu enables marketers to view the Offers in a particular
group,
Selecting this action launches a report that displays the group's Offers.
Remove Group
The Remove group action in the Actions menu enables marketers to remove the corresponding
group from the analytics-driven targeting approach.
Configure Eligibilities
After adding the desired rules, click Apply. Upon application, the configured Proposition Filter rules
are listed in the Eligibilities section. Clicking an entry in the list opens its rule form.
Note: Refer to Pega Platform documentation for more details on Proposition Filter rules.
Configure Prioritization
Select the desired prioritization Strategy rule from the list of rules and click Apply.
Note: The Configure Prioritization window only lists those Strategies that have the NBACategory
custom field set to PRIORITIZATION. New rules created from this window automatically have this
custom field set.
Upon application, the configured prioritization Strategy is listed in the Prioritization section.
Marketers can click the name of the Strategy to open it.
l A/B Testing
l Conditional
A/B Testing
This mode of arbitration allows marketers to specify the frequency (using percentages) when each
targeting approach should be applied. A value must be specified for each approach and the values
must add up to 100%.
In the example above, approach A will be applied 60% of the time while approach B will be applied
40% of the time.
Conditional
This mode of arbitration allows marketers to use conditional expressions to arbitrate between
targeting approaches. Marketers can re-order the approaches using the drag icons. Marketers can
access both Offer data and customer data in their expressions. Offer data can be accessed directly
using the "." notation, while customer data can be accessed by using the "Primary." notation.
In the example above, approach A will be applied for customers over the age of 40 and approach B
will be applied for all other customers.
to a customer. An overall prioritization is required if the marketer has configured multiple targeting
approaches and/or if an analytics-driven approach includes more than one business group.
The process for configuring an overall prioritization is same as the one for configuring a group or
issue level prioritization.
Marketers can view the generated Strategy by selecting the Open canvas action in the Actions
menu in Strategy Builder.
Note: Any modifications made to the Strategy outside of Strategy Builder will be over-written when
the Strategy Builder configuration is re-saved. In such cases, the system displays a message to warn
the user of this situation.
Marketers can use the Delete button in Strategy Builder to remove a Strategy Builder configuration.
Note: Deleting a Strategy Builder configuration does not delete the generated Strategy. Marketers
can continue to use this Strategy and modify it using the Strategy canvas.
A Segment Filter shape can reference any Segment rule that has been created in the system. Refer to
the Segments chapter for more information about creating Segment rules.
The Segment Filter shape can be connected to other Decisioning shapes, as appropriate, to apply
Segment-based filtering at appropriate levels in Strategy execution.
A sample Strategy which uses the Segment Filter shape is shown below:
The Contact Policy shape enables the user to reference a Contact Policy rule that has been created in
the system. Refer to the Contact Policies chapter for more information about creating a Contact Policy
rule.
The Contact Policy shape can also be used to restrict the number of propositions (Offers) output from
the shape. This is governed by the “Output” field. The two options available are:
l First x – Select this option to restrict the output of the Contact Policy shape. In this option, if
multiple inputs to the shape satisfy the referenced Contact Policy rule, only the first “x” (where x is
a positive integer) of these are output. The default value for “x” is 1.
l All – Select this option to output all input propositions that satisfy the referenced Contact Policy
rule.
Note: Since the Contact Policy shape can (potentially) output a portion of the inputs, it is
recommended that propositions are prioritized before being passed to the Contact Policy shape.
Like other shapes on the Strategy canvas, multiple Contact Policy shapes can be chained together.
This is particularly useful in enforcing multiple limits on the same channel of communication. For
example, one Contact Policy rule could set daily limitations of the Email channel while another sets
weekly limitations on the Email channel. By chaining two Contact Policy shapes (which reference the
above two rules), the user can ensure that both daily and weekly channel limitations are being
satisfied. If either of these limitations is violated, the Offer will not be output. This usage is illustrated
below.
l Presence of input Offers – Since Contact Policies limit the Offers being output by the Strategy, a
Contact Policy shape must have some Offers (propositions) as input to the shape.
l Restricted channel – Contact Policies only apply to Offers (propositions) being communicated on a
channel that is restricted in the referenced Contact Policy rule. This is validated by inspecting the
“pyChannel” property on each proposition. For the Contact Policy to be applicable, this value must
be set to match (exactly) one of the channels in the referenced rule.
l Available Contact Policy – Contact Policy limitations are only applied if the referenced Contact
Policy rule is marked as being available.
l Applicable Contact Policy –If date validity criteria are specified on the referenced Contact Policy
rule, the Contact Policy limitations are only applied if the current date meets these criteria. In cases
where the applicable start date is in the future or the applicable end date is in the past, the
limitations specified in the policy rule are ignored.
If the conditions specified above are satisfied, the limitations specified in the Contact Policy rule are
applied. Otherwise, these limitations are ignored. The output specifications of the Contact Policy
shape are honored regardless of whether the channel limitations were applied.
In the above example, the Include Bundle Members Filter shape is used to add the member Offers
only if the Contact Policy shape outputs the parent Offer. This is achieved via the following filter
condition:
@String.equals(GlobalContactPolicy.BundleName,"SampleBundleName")
Filter).
The Geofence Filter shape enables the user to reference one or more Geofence rules that have been
created in the system. Refer to the Geofences chapter for more information about creating a
Geofence rule.
Selecting Geofences
Users can select one or more Geofence rules to use for filtering. At runtime, the system will evaluate
each of the referenced Geofence rules (in order) until a Geofence is satisfied, i.e. the customer
location is within the Geofence. The “Geofences” properties panel tab provides support for two
modes for selecting Geofence rules:
Use this mode to add Geofence rules one at a time via the “Add Item” link. Use the “Delete” link to
remove the selected Geofence.
Use this mode to select and add multiple Geofences using a list-to-list interaction.
The left list contains the available Geofences while the right list contains the currently selected
Geofences. Use the icons adjacent to the lists to manage Geofences between (and within) the lists.
Icon Purpose
Move all available Geofences to the applied list.
Move the selected Geofence from the available to the applied list.
Move the selected Geofence from the applied to the available list.
Move all applied Geofences back to the available list.
Select the desired behavior of the shape when customer location data is not available. The default
option is to prevent the shape from returning source component results as outputs. However, if
desired, users can choose to pass source component results through to the next shape.
Users can configure the properties to use to determine the customer location. The “Latitude” and
“Longitude” fields are initialized to the default properties but can be overridden by the user.
Note: The default location properties are configured by the application administrator. Refer to the
Administrative Settings appendix for more details.
The following sources can be used for the latitude and longitude properties:
l Calculated fields – Prefix the property with the strategy shape name
Additionally, users can opt to use customer location from real-time Event data, if it is available. This
option can be employed to use location data from a triggered Event. If location data is not present on
the Event, the customer location fields specified on the shape will be used. Refer to the Events
chapter for details on including location data (latitude and longitude) as part of the Event’s payload.
1. Create a new Strategy to stop the Offer. In this Strategy, select the Offer that needs to be stopped.
Specify the value of the Type property (via a Strategy Set) to be “StopOffer” and return this Offer.
2. Create a new Campaign. Target the Campaign to the appropriate set of Customers via a Segment
rule, such as the one that was used to originally send out the Offer. Specify the newly created
Strategy as the Marketing Strategy for the Campaign.
When this Campaign runs, the system will execute the Strategy to determine the list of in-flight Offers
that need to be stopped. Each of these Offers will be marked as completed, thereby preventing any
further actions from being taken on these Offers.
The Contact Policies landing page provides a quick overview of the various Contact Policies
configured in the application. The landing page displays the start and end date of each policy along
with its availability. Details about the limits specified for a particular policy are visible by expanding
the row for the individual policy (via the arrow on the left side), as shown below:
History Specify the Description and Usage information for this Event.
l Policy Starts - Specify the start date for the policy to be applicable. If this value is not specified,
the policy is deemed to be always applicable.
l Policy Ends - Specify the end date for the policy to be applicable. Using this value requires that a
valid policy start date is also specified.
Contact Policy restrictions are only applied when the policy is marked as being available and any date
restrictions (if specified) are currently applicable. In all other cases, the contact limits specified in the
policy are ignored. Refer to the Using Contact Policies section in the Strategies chapter for details on
how to use Contact Policies.
l Channel - Select the channel (from the list of available channels) on which to restrict outbound
communication.
l Contact(s) per customer - Specify the maximum number of contacts allowed per customer.
l Duration - Select the duration over which the channel restrictions are applicable. The following
durations are supported:
Daily
Semimonthly – Semimonthly periods are: from the 1st to the 15th of a month; and from the
16th to the end of the month
Monthly
Quarterly – New quarters start on the first day of January, April, July, and October
Yearly
Contact Policy restrictions only apply to communications with customers that are triggered by
strategies during Campaign execution. Refer to the Using Contact Policies section in the Strategies
chapter for details on how to reference Contact Policy rules in strategies and how the limits specified
in a Contact Policy rule are applied.
l Offer constraints – Offer constraints allow the user to specify the maximum and/or minimum
volume for a particular Offer. This is useful in situations where there is only a limited quantity
available for a particular product.
l Channel constraints – Channel constraints allow the user to specify a maximum and/or minimum
value for a particular delivery Channel (e.g. Email, SMS, etc.). This is useful in situations where
there are limitations on the delivery mechanism, such as SMS or Email server throughput.
To apply these constraints, the Volume Constraint rule should be associated with a Campaign. When
a Campaign runs, it first executes the Strategy to determine the potential set of Offers that should be
processed. Next, if a Volume Constraint has been associated with the Campaign, any enabled Offer
and Channel constraints are applied to the Offer set to determine the final list of Offers which needs
to be processed.
Note: If a Volume Constraint has been associated with a Campaign, it must have at least one
constraint enabled. If no constraints are enabled on this Volume Constraint, the Campaign will not
execute. At this point, the user can either enable a constraint and restart the specific run; or update
the Campaign to no longer use Volume Constraints and re-submit the Campaign for execution.
Volume Constraints are primarily accessed from and created in the context of Campaigns. The
Constraint setting of a Campaign references a Volume Constraint rule. When configuring this setting,
users can use the Configure Constraint selector to review existing Volume Constraints and create
a new one if needed.
Volume Constraints can be stored at the top level or can be categorized into Issues and Groups. A
new Volume Constraint resembles the following:
Tab Purpose
Name
General Specify the offer and channel constraints to be applied. Also configure the constraint reset
options.
History Specify the Description and Usage information for this Volume Constraint.
Note: When using Volume Constraints, in most cases, each customer will receive a maximum of
one Offer. If the marketing Strategy pushes out multiple Offers for a customer, these Offers should
be prioritized in the Strategy since the highest priority Offer (based on the pxPriority field) will be
made to the customer.
The user must decide whether to specify the reset policy for each constraint in the Volume Constraint
rule individually or globally (as shown below):
l Manage each constraint individually - In this mode, the reset option is specified individually
for each (offer and channel) constraint along with its limits.
l Reset all constraints at once - In this mode, the reset option is specified globally for all (offer
and channel) constraints. The global reset options are presented as a separate row when this
option is selected.
Whether constraint limits are reset globally or individually, the following reset frequency options are
available:
l Manually: Select this option to manually reset constraint counts via the provided reset button(s).
The Volume Constraint rule must be checked in for the reset button(s) to be enabled.
When limits are reset globally, use the Reset Now button:
When limits are reset individually, use the Reset button(s) for the appropriate (offer or channel)
constraint(s):
l Each time it is accessed: System will reset constraint limits each time the Volume Constraint
rule is applied. This setting provides the option for applying the same volume constraints during
each run of a Campaign.
l Daily: System will reset the constraint limits the first time they are applied on a particular day.
l Weekly: System will reset constraint limits the first time they are applied in a particular week (first
day of week = Sunday).
l Semi-Monthly: System will reset constraint limits the first time they are applied in a particular
semi-monthly period (semi-monthly periods begin on the first and sixteenth days of each month).
l Monthly: System will reset constraint limits the first time they are applied in a particular month.
l Quarterly: System will reset constraint limits the first time they are applied in a particular quarter
(quarters begin on the first day of January, April, July, and October of each year).
l Yearly: System will reset constraint limits the first time they are applied in a particular year.
l Enabled – Whether this constraint should be enabled. This provides an easy mechanism to switch
constraints on and off as product volumes fluctuate.
l Offer – Name of the Offer to be constrained. The smart prompt presents a list of Offers
categorized by their Issue and Group.
l Reset Interval – Reset policy for this constraint. This option is available if constraint limits are
managed individually. Select the appropriate reset option.
For the constraint volumes, the user must specify at least one of the following and can specify both.
l Minimum Volume – Desired minimum volume for this Offer. If a sufficient number of Offers is
being propagated and the optimization engine selects this Offer, then the engine will satisfy this
minimum volume requirement before selecting a different Offer.
l Remaining – Number of Offers remaining. The system displays “Unlimited” for this field in the
following scenarios:
If a maximum volume is not specified
l Reset button – Reset the remaining count to the maximum volume. This option is available for
the Manually reset interval when constraint limits are managed individually.
l Reset Interval – Reset policy for this constraint. This option is available if constraint limits are
managed individually. Select the appropriate reset option.
For the constraint volumes, the user must specify at least one of the following and can specify both.
l Reset button – Reset the remaining count to the maximum volume. This option is available for
the Manually reset interval when constraint limits are managed individually.
In order for Channel constraints to be properly applied, any Offer (Proposition) that is returned by the
Strategy must set the following property:
l pyChannel – This needs to be set to the channel being constrained (Email, SMS, etc.)
Note: Each Offer is backed by a Decisioning proposition. The system automatically manages this
relationship by creating, deploying, and deleting the proposition instance as needed. Since an Offer
is closely tied to a proposition, it must always be created in the context of an Issue and a Group.
The Offers landing page lists available Offer rules in the system. This landing page is accessible in the
Pega Marketing portal via: Content > Offers
This landing page lists the twenty most recently updated Offers in the system. Users can use the
View more results at the end of the list to load the next twenty results. Users can also use the
filters at the top of the page to search for Offers by Issue / Group and Name.
For each listed Offer, the landing page displays the following information:
l Friendly name
l Impression rate of this Offer - Ratio of total impressions (associated with this Offer) and the Offer
volume
l Offer volume - Total number of times this Offer has been initiated by Campaigns
l Conversion rate of this Offer - Ratio of total conversions (associated with this Offer) and the Offer
volume
A newly created Offer starts out with the Start and End shapes, as shown below.
Send Multiple Dynamically determine which channel (Email, SMS, or Passbook) to use for communication and
Treatments send out the appropriate treatment on that channel.
Push Configure and send a notification to an app running on a device. Refer to the “Configuring Push
Notification Notifications in Offers” section of the “Push Notifications” chapter.
Inbound Specify the Section rule to be returned for a request from an inbound application.
Update Status Update the Offer's status and record response information to History (Interaction Services).
Decision Use various PRPC decision structures to determine branch conditions in the flow.
Schedule Schedule and configure an appointment for follow-up work to be performed. This shape is
Appointment available in the “Smart Shapes” sub-menu.
Start Denote the starting point of the flow.
Send Email
The Send Email shape enables the user to configure an email message for delivery.
The following General Configuration options are available for this shape:
Name Purpose
Treatment Name of the Email Treatment to send. In the case of Online Delivery, the Treatment Name
Name specified must be backed by an existing Email Treatment rule since this is used as the content
of the email to be sent.
Key Code Marketing code used to identify the treatment. This value can be output in the sent email
and/or the output file/db, and can be used to track the performance of different treatments. If
a key code value is specified on the Email Treatment being referenced, it will be populated into
this field upon selecting the treatment.
Delivery Options
Emails can be delivered in various ways - they can be sent by the system (Online mode) or they can
be written to a data warehouse for processing by other systems (File and DB modes). Users can
The following Delivery Configuration options are available for this shape:
Name Purpose
Deliver Online Determines whether an actual email should be sent using the content in the specified
Treatment Name.
Use Subject From Denotes that this shape should directly use the Email subject specified in the
Treatment referenced Email Treatment. This subject is shown as read-only in the “Email Subject”
(Online mode) field.
Specify Subject Denotes that this shape should use the specified “Email Subject”.
(Online mode)
Email Subject Subject of the email to be sent.
(Online mode)
1. Plain text – If the subject contains plain text (with no quoted words); simply enter the text in the
input field. The system will wrap the entire text around quotes.
2. Quoted text – If the subject needs to include text in double quotes (e.g. The brand new
“ProductName” is here!), then the entire subject must be in quotes with the desired quotes being
escaped with a backslash. The example above should be entered as: “The brand new \”Product
Name\” is here!”
3. Property references – If the subject needs to contain property references (such as the customer
name), then the property reference needs to be concatenated to the remaining subject by the plus
(+) symbol. Each block of text that is not a property reference should be wrapped in double
quotes. This is exemplified below:
Desired Subject: Hi <Customer’s Name>, a new “Product” awaits you!
Entered Subject: "Hi " + .Customer.pyFullName + ", a new \"Product\"
awaits you!"
If an email subject doesn’t meet the supported formats, the following error is displayed to the user:
Invalid value specified for Email Subject. Value doesn’t adhere to the Validate:
BalancedQuotationMarks.
Users can determine whether they would like to wait after sending an email. It is typical to enable this
wait when customer response is expected for an email (such as accepting or rejecting an Offer). In
other cases, the user might simply want to send an email and move on to the next step in the Offer
Flow. In such cases, waiting should be disabled on the Send Email shape. The wait options available
are the same for all wait-based shapes and are described in the section on the Wait shape.
Email Account
Users also have the option to specify the Outbound Email account to use for sending the email
message. These accounts are typically configured by the administrator. Refer to the “Email and SMS
Account Configuration” chapter for more details.
The following options are available in the “Email Account” sub-section under the “Advanced” section
of the Send Email Properties modal:
Name Purpose
Use Default Email Determines whether the Default Email account should be used for sending this email.
Account
Specify Email Account Determines whether a user-specified Email account should be used for sending the
email.
Account Name of the Outbound Email account to use for sending the email.
From/Reply To: Denotes that the sender’s name (from) and reply-to address in the email being sent
Use Email Account should be taken from the values specified on the Email account.
Settings
From/Reply To: Denotes that the name and email address of the operator that initiates this email (e.g.
Use Operator Settings by launching a Campaign that sends it) should be used for the sender’s name and
reply-to address.
From/Reply To: Denotes that user-specified values should be used for the sender’s name (from) and
Override Settings reply-to address in the email being sent.
From Name that will be used as the sender’s name in the email being sent.
Reply To Email address that will be set as the reply-to address in the email being sent.
The Send Email shape provides an easy mechanism to test its outcome. Users can employ this test
mechanism to test the online delivery of the Email Treatment. This can be beneficial in verifying both
the content of the email being delivered and any email configurations that were applied (such as the
subject, sender’s name, and reply-to address). Finally, this also enables the user to verify any data
references (both Offer Data and Customer) in the Email Treatment that were used to personalize the
email message.
The “Test Message” section lists the options available for configuring the test email message. This
includes the following:
l To – Recipients of the test email. Select either “Test Recipients” or “Seed List”.
Test Recipients - Enter list of recipients. Each entry can either be the Operator ID of an
existing user in the system or a valid email address. If the operator ID is entered, operator
information such as the name and email is populated as the customer data and the test email is
sent to the operator’s email address.
Seed List - Select a predefined Seed List as the intended recipients of the test email. The data
for each seed is populated as the customer data and is visible (if referenced) in the test email. In
this case, the Email1 column in the Seed List (.pyEmail1 property) specifies the email address to
which the test email is sent. Refer to the “Seed Lists” chapter for information on configuring a
Seed List.
l Subject – Subject of the test email. This value is pre-populated with the subject specified in the
Treatment tab. The user can choose to specify a different subject by selecting the “Override
subject” option. Refer to the Configuring Email Subject section for options available for this field.
After the test message has been configured, it can be sent via the “Send Test Message” button.
Once configured, the test message can also be directly sent via the “Test this Email” right-click menu
item on the Send Email shape. The status of the test is displayed. Any errors in the test delivery are
displayed in case of a failure. These can be corrected and the test email can be resubmitted for
delivery.
Send SMS
The Send SMS shape enables the user to configure an SMS message for delivery.
The following General Configuration options are available for this shape:
Name Purpose
Treatment Name of the SMS Treatment to be sent.
Name
Key Code Marketing code used to identify the treatment. This value can be output in the sent SMS
message and/or the output file/db, and can be used to track the performance of different
treatments. If a key code value is specified on the SMS Treatment being referenced, it will be
populated into this field upon selecting the treatment.
Delivery Options
SMS treatments can be delivered in various ways - they can be sent by the system (Online mode) or
they can be written to a data warehouse for processing by other systems (File and DB modes). Users
can enable one or more of these modes at the same time.
The following Delivery Configuration options are available for this shape:
Name Purpose
Deliver Online Determines whether an actual SMS message should be sent using the content in the specified
Treatment Name.
Use Existing Determines whether an existing treatment, specified by the Treatment Name property, should
SMS be used to get the content of the SMS message.
(Online mode)
Quick Create Determines whether to use the text specified in the “Write Message” box as the content of the
SMS SMS message.
(Online mode)
Write Message Content of the message to be sent in “Quick Create SMS” mode.
(Online mode)
Write To File Determines whether a record should be written to an output file.
Write To DB Determines whether a record should be written to an output database table.
Select File/DB Template rule which contains the specifics of what should be output to the file/table.
Template This includes the file/table name, location, header information, and the specific data fields that
(File/DB need to be output. Refer to the Templates chapter for more information.
modes)
Users can determine whether they would like to wait after sending an SMS message or proceed
directly to the next step in the Offer Flow. The wait options available are the same for all wait-based
shapes and are described in the section on the Wait shape.
SMS Account
Users also have the option to specify the SMS account to use for sending the SMS message. These
accounts are typically configured by the system administrator. Refer to the “Email and SMS Account
Configuration” chapter for more details.
The following Account Configuration options are available in the “SMS Account” sub-section under the
“Advanced” section of the Send SMS Properties modal:
Name Purpose
Use Default SMS Determines whether the Default SMS account should be used for sending this SMS message.
Account
Specify SMS Account Determines whether a user-specified SMS account should be used for sending the SMS
message.
Account Name of the Outbound SMS account to use for sending the SMS message.
The Send SMS shape provides an easy mechanism to test its outcome. Users can employ this test
mechanism to test the online delivery of the SMS Treatment. This can be beneficial in verifying the
content of the SMS being delivered. This also enables the user to verify any data references (both
Offer Data and Customer) in the SMS Treatment that were used to personalize the SMS message.
The “Test Message” tab lists the options available for configuring the test SMS message. This includes
the following:
Seed List - Select a predefined Seed List as the intended recipients of the test SMS message.
The data for each seed is populated as the customer data and is visible (if referenced) in the test
message. In this case, the Mobile Phone column in the Seed List (.pyMobilePhone property)
specifies the phone number to which the test SMS message is sent. Refer to the “Seed Lists”
chapter for information on configuring a Seed List.
l Test SMS Account Options – These settings specify the SMS account (Default or custom) used
to send the test SMS message.
After the test message has been configured, it can be sent via the “Send Test Message” button.
Once configured, the test message can also be directly sent via the “Test this SMS” right-click menu
item on the Send SMS shape. Upon sending a test message, the status of the test is displayed. Any
errors in the test delivery are displayed in case of a failure. These can be corrected and the test SMS
can be resubmitted for delivery.
Send Generic
The Send Generic shape enables the user to configure and send a Generic treatment. This shape
provides a hook for the user to process Offers via outbound delivery mechanisms, other than the
ones currently provided by the system (such as email or SMS). The user can use this shape to output
relevant data to an output file or database table for processing by legacy systems.
The following General Configuration options are available for this shape:
Name Purpose
Treatment Name of the treatment. This can be used to track and organize the output data.
Name
Key Code Marketing code used to identify the treatment. This value can be output in the output file or
table and can be used to track the performance of different treatments.
Delivery Options
Generic treatments can be written to a data warehouse (file or database table) for processing by other
systems. Users can enable one or more of these modes at the same time.
The following Delivery Configuration options are available for this shape:
Name Purpose
Write To File Determines whether a record should be written to an output file.
Write To DB Determines whether a record should be written to an output database table.
Select File or Database Template rule which contains the specifics of what should be output to the file
Template or table. This includes the file or table name, location, header information, and the specific data
(File/DB fields that need to be output. Refer to the Templates chapter for more information.
modes)
Users can determine whether they would like to wait after sending a generic treatment or proceed
directly to the next step in the Offer Flow. The wait options available are the same for all wait-based
shapes and are described in the section on the Wait shape.
This set of options is available when the application includes Pega Field Marketing. Corporate
marketers can enable the checkbox to include this shape in the list of engagement steps that field
marketers see in Field Marketing Campaigns. Additionally, they can also provide a meaningful
description to aid the field marketer in understanding this shape’s purpose.
Content Details
The “Content Details” section allows the user to upload related content for this shape. If this shape is
configured to display in Field Marketing Campaigns, then field marketers will be able to view the
uploaded content when they review this shape in their Campaigns.
Both links and files can be uploaded using this section. The user can also enter a description for each
item. Once the file or link is added, it displays in the content grid at the bottom of this section.
Treatment Specification
The following configurations options are available for specifying the treatments and channels for this
shape:
l Treatment Origin – This setting determines how the channel for delivery is determined. The two
options are:
Strategy/Offer – In this scenario, the channel value determined by strategy execution (as part
of a run) is used as the delivery channel. The user can alternately set the channel value
(.OfferData.pyChannel property) directly in the Offer Flow prior to this shape.
Decision Rule – In this scenario, the channel value is determined by executing a decision rule.
The user must also specify the Decision Type (decision table or decision tree) and the name of
the Decision Rule.
l Treatments – This group of settings is used to specify the treatments for delivery. The user can
select the channels available for delivery by enabling the Outbound Email, Outbound SMS, and
Passbook check boxes. The configuration options available for each channel are similar to those
present on the channel-specific delivery shapes. Refer to the descriptions provided for each of
these shapes for more details:
Outbound Email – Send Email shape
l Default Treatment – This setting determines the default channel value to use in case the
channel returned by the Treatment Origin setting is either undefined or not currently supported.
The values available for this setting are predicated by the channels that are enabled in the
Treatments group.
Users can determine whether they would like to wait after the processing of this shape or proceed
directly to the next step in the Offer Flow. The wait options available are the same for all wait-based
shapes and are described in the section on the Wait shape.
Delivery Options
Emails and SMS messages can be delivered in various ways - they can be sent by the system (Online
mode) or they can be written to a data warehouse for processing by other systems (File and DB
modes). Users can enable one or more of these modes at the same time.
The configuration options available are similar to the ones available for the Send Email and Send SMS
shapes. These options are situated in the following areas of the Send Multiple Treatments shape:
Send Passbook
The Send Passbook shape enables the user to configure a Passbook Treatment for delivery.
The following general configuration options are available for this shape:
Name Purpose
Passbook Style Style of the Passbook Treatment to send. Currently available options are “Coupon” and
“Generic”.
Passbook Name of the Passbook Treatment (pass) to send. Refer to the “Passbook Treatments”
Treatment section in the Treatments chapter for details on creating and configuring Passbook
Treatments.
Key Code Marketing code used to identify the treatment. This value can be output in the sent email
and/or the generated pass, and can be used to track the performance of different
treatments. If a key code value is specified on the Passbook Treatment being referenced, it
will be auto-populated into this field upon selecting the treatment.
Email Treatment Name of the Email Treatment to use to deliver new passes and updates to existing passes.
The pass is delivered as an attachment to the email message.
Delivery Options
New passes are delivered as attachments to emails. On iOS devices, the customer can open the
attached pass and can add it to their Passbook.
The following delivery configuration options are available for this shape:
Name Purpose
Email Subject Subject of the email containing the new/updated pass. Refer to Configuring Email Subject for more details.
On Update
Users have multiple options for updating passes that have previously been sent. When the same
Passbook Treatment is used in multiple shapes in the same offer flow, the first delivery is treated as a
new pass. Subsequent deliveries (shapes) are treated as updates to the existing pass. Furthermore, if
the Passbook Treatment is configured as a global treatment (“Keep updating the pass…” option is
enabled on the treatment’s Advanced tab), even the first passbook shape will result in an update
scenario if the pass has already been sent to the customer previously (via a different Offer or
Campaign).
Name Purpose
Push Select this option to utilize the Apple Push Notification service (APNs) to signal the device that
Notification an update is available for the pass. The device will then make a web service call to get the latest
pass.
Email Select this option to send the updated pass as an attachment to the email (specified in the
Notification Email Treatment field).
Note: If neither notification option (Push or Email) is enabled, the system will generate and store the
updated pass internally. This updated pass will be available to pass holders (customers) when they
attempt to manually update the pass.
Users can determine whether they would like to wait after sending a pass. The wait options available
are the same for all wait-based shapes and are described in the section on the Wait shape.
Email Account
Users also have the option to specify the Outbound Email account to use for sending the message.
These configuration options are available in the Advanced tab of the Send Passbook shape and are
The Send Passbook shape provides an easy mechanism to test its outcome. Users can employ this
test mechanism to test the online delivery of the email with the pass attachment. Refer to Testing
the Send Email shape for details on configuration options for the test message.
The test email will be sent with the selected pass as an attachment. Refer to the “Reviewing the Test
Pass” sub-section in the Treatments chapter for details on reviewing and adding the test pass.
Inbound
The Inbound shape provides a means to specify the content that should be returned when an
inbound application, such as Next-Best-Action Advisor (NBAA), requests this Offer to display within
their application.
Name Purpose
Section Name of the Section rule to use. The content of this section is returned when an inbound
application (such as NBAA) requests Offer content from the system.
Channel Inbound channel for the Treatment (Default value for this shape is CallCenter).
Work Status of the Offer after executing this step in the Offer Flow.
Status
Note: There should be only one Inbound shape in an Offer flow. Having multiple Inbound shapes in
the same Offer flow could cause non-deterministic behavior in resolving the content that should be
returned to the inbound application.
The Inbound shape, by itself, simply serves as a determining point for the content to be returned for
external requests. However, this shape can be (and typically is) combined with the InboundTicket
ticketing mechanism to provide a branch of Offer flow execution for processing an inbound request.
Refer to Adding Inbound Channel Support for more details.
Wait
The Wait shape enables the user to pause the Offer flow execution for a specified duration. This
shape can be used when an unconditional wait is required in the Offer flow. When the specified wait
duration has lapsed, Offer flow execution automatically resumes with the next shape in the flow.
This shape supports the following modes for specifying the wait duration:
l Offset - Use this mode to set the wait time to a specified duration from when this shape is
executed. Use the Days, Hours, Minutes, and Seconds fields to specify the offset. Optionally,
enable the Business Days check box to apply the specified offset only using business days.
l Date/Time - Use this mode to set the wait expiration time to a specified future date and time.
Specify the desired date and time.
l Property - Use this mode to set the wait expiration time using the value of a date time property or
Note: Ensure that the specified property (or expression) will have a valid date and time value
during Offer runtime.
Users can also enable a wait in Offer flow execution on wait-based delivery shapes. This includes the
“Send Email”, “Send SMS”, “Send Passbook”, “Send Generic”, “Send Multiple Treatments”, and “Push
Notifications" shapes. To enable the wait and configure the wait options (listed above), enable the
“Wait after sending” check box on these shapes.
Update Status
The Update Status shape is used to specify the status of the Offer as it works its way through various
stages of the Offer Flow. This status can be used to group Offers for reporting and other
aggregations. This status can also be used to determine the appropriate path to be taken down a
subsequent branch in the Offer Flow execution. The Update Status shape also enables the user to
record Behavior and Response information for the Offer into Interaction History.
The following Configuration options are available for the Update Status shape:
Name Purpose
Work Status Status of the Offer.
The out-of-the-box values for the Offer status include:
l New
l OfferSent
l Resolved-OfferAccepted
l Resolved-OfferExpired
l Resolved-OfferRejected
Behavior Denotes the behavior of the customer to the particular Offer. This information gets recorded in History.
The out-of-the-box values for Behavior include:
l Negative
l Neutral
l Positive
Response Denotes the response of the customer to the particular Offer. This information gets recorded in History.
The out-of-the-box values for Response include:
l Accepted
l NoResponse
l Pending
l Rejected
Hand Off
The Hand Off shape enables the user to launch other processes (in the background) from the Offer
Flow. This serves as a launching point for external processes which can be triggered at the
appropriate time in the Offer execution. An example use of this would be to initiate an Offer
Fulfillment process when a customer accepts an Offer.
Note: Initial processing of the handed-off work object is sequential with the Offer Flow execution
until the new work object reaches a stopping point (such as an Assignment). At this point, Offer Flow
execution resumes and the handed-off work object lives and executes separately on its own.
The following Configuration options are available for the Hand Off shape:
Name Purpose
Work Class Name Name of the class which contains the process (Work Object flow) to be started.
Work Flow Name Name of the process (flow) to be started.
Work Status Status of the Offer after the new process has been initiated.
(Status section)
As part of the Hand Off shape, the entire contents of the Offer work object (including Offer details)
are initially made available to the newly created work object. This information is stored in the top
level OfferWorkPage clipboard page. This information is available whilst the new work object shares
the execution with the Offer work object (see Note at the beginning of this section). If the new work
object requires any of this data for its processing, it is recommended to copy relevant data from the
OfferWorkPage onto appropriate locations on the new work object. This could be done via the use of
the default Data Transform rule (pyDefault) or by other mechanisms in the work process flow before
it enters a waiting point (such as an Assignment).
In a similar vein, a reference to the newly handed-off work object is stored on the original Offer work
object. This is made available under the pyReferencedInsKeys construct. This information can be used
to provide a reference code to the customer in an email or for any other cross-referencing purposes,
as deemed fit by the user.
Note: In order for the system to successfully create and launch the handed-off work object, all
necessary rules (such as Flow, Data Transform, Work Parties, etc.) should be properly configured for
the desired work object.
Some of the salient pieces involved in a handed-off work object are demonstrated in the following
OfferFulfillment example:
l Data Transform:
pyDefault
l Properties:
Channel
CustomerID
OfferName
l Flow:
FulfillOffer
l Work Parties:
Default
l Flow Action:
Approve
l Section:
FulfillOffer
This work object involves a minimal process flow where the object is placed in a workbasket and is
resolved upon approval. The FulfillOffer Flow rule is shown below:
The above flow is configured to create a new work object since we expect it to have its own lifecycle
and want it to be actionable after it is stored in the workbasket. For simpler flows with straight
through processing (no assignment shapes), the flow can be configured with the temporary object
setting in the Process tab.
As mentioned previously, both customer and offer data are available to this flow until it hits the first
assignment. After this assignment, only data that has been saved onto the work object will be
available.
The following (pyDefault) Data Transform demonstrates the copying of (both Offer and Customer)
data from the Offer page onto the work object, upon its initial creation:
In the above Data Transform, the Customer object is added as the Customer work party on the new
object.
A sample Work Parties rule for this work object is shown below:
The sample Flow Action and Section use basic PRPC concepts to display some of the copied over data
and present an action to resolve the work object. This is demonstrated by the following instance of a
handed-off Offer Fulfillment work object:
This set of options is available when the application includes Pega Field Marketing. Corporate
marketers can enable the checkbox to include this Hand Off shape in the list of engagement steps
that field marketers see in Field Marketing Campaigns. Additionally, they can also provide a
meaningful description to aid the field marketer in understanding this shape’s purpose.
Decision
The decision shape enables the user to execute a variety of different decision constructs (such as
decision trees, decision tables, etc.) to provide a basis for branching in the execution of the Offer
Flow.
l Boolean Expression
l Decision Table
l Decision Tree
l Fork
l Map Value
l Predictive Model
l Scorecard Model
Note: More information on the various options for configuring each of the decision types (listed
above) can be found in Pega Platform documentation.
Schedule Appointment
The Schedule Appointment smart shape enables the user to schedule and configure follow-up work
to be performed at a particular point in the Offer flow lifecycle.
The user can utilize the “Instructions” field to specify any instructions to aid in processing the
scheduled appointment.
Select Assignee
l Current Operator – Routes the appointment to the operator that initiates this Offer (e.g. by using it
in a Campaign and executing the Campaign).
l Specify Operator – Routes the appointment to the operator specified in the “Operator” field.
l Workbasket – Routes the appointment to the workbasket specified in the “Workbasket” field.
Schedule Options
l Relative Date - Sets the appointment time relative to the time when this shape is processed in the
Offer. The user must specify the relative number of days, the appointment time, and the time
zone. The user can also enable the “Business Days?” checkbox to denote that the relative number
of days should be applied using only business days.
l Specify Date – Sets the appointment time to the specified date and time
Start
The Start shape denotes the beginning of the Offer Flow. Each Offer Flow must have one and only
one Start shape.
End
The End shape denotes the termination point of the Offer Flow execution. Each Offer Flow can have
one or more End shapes.
Note: More information on the options for configuring the Start and End shapes can be found in
Pega Platform documentation.
l Simple Connectors
l Decision Connectors
l Wait Connectors
Simple Connectors
These connectors simply connect one shape to another. There is no logic path determination behind
these connectors.
l Inbound
l Update Status
l Hand Off
l Start
Decision Connectors
These connectors emanate from the Decision shape. Decision connectors can be sub-categorized
based on the condition type – Result, Always, When, and Else.
This condition type is used to represent the result of executing the Decision rule specified in the
Decision shape. The system automatically analyzes the Decision rule and populates the Result drop-
down with the possible set of outcomes from the decision.
This condition type represents a connector that is taken when the expression/condition specified in
the When input box evaluates to true.
Use the Percentage condition type to specify the percentage (relative amount) of time that the Offer
Flow should take this path during its execution.
The Else condition type serves as the catch-all connector and is taken when none of the other
connectors originating from the Decision shape can be taken. It is a best practice to have an else path
whenever the other execution paths aren’t collectively exhaustive (e.g. with percentage and when
condition types).
Wait Connectors
The wait connector emanates from shapes that have a waiting mechanism tied to them (wait-based
shapes). This includes the following shapes:
l Send Email
l Send SMS
l Send Generic
l Send Passbook
l Push Notification
l Wait
There are two types of the Wait connector – Continue and Wait Expired. Only one Wait connector can
originate from a wait-based shape. If waiting is enabled for the shape, the “Wait Expired” connector is
used; otherwise, the “Continue” connector is used. The appropriate Wait connector (Continue vs. Wait
Expired) is automatically generated when you connect a wait-based shape to another shape.
Note: Since the system manages the Wait connectors, these should not be changed manually. If you
wish to update the type of Wait connector originating from a shape, toggle the Wait field on the
shape. If you delete the Wait connector by accident, simply draw a new connector coming out of the
shape and the appropriate Wait connector will be recreated for you.
This connector should be used in tandem with the Wait Expired connector, as shown below:
In the Offer Flow depicted above, the System puts the Offer in a wait state for the duration specified
(5 days). If no response is received within this wait duration, Offer Flow execution will resume along
the Wait Expired path. However, if a response is received before the wait duration has expired; the
Offer will instantly get out of the wait state and go down the Response Received path.
Note: The ability of the system to go down the Response Received path is tied to the built-in
response mechanism for Email and SMS treatments. Refer to Embedding a Response Link in the
Treatments chapter for adding this mechanism to Email treatments. For SMS treatments, this
mechanism is handled via the configuration of Inbound SMS accounts. For more details, refer to
Configuring an Inbound SMS Account in the Email and SMS Accounts Configuration chapter.
1. Enable Wait on the shape and configure the wait duration. Then, draw a connector from the shape
to the backing shape for your Wait Expired action. The system will automatically create the Wait
Expired connector for you.
2. Draw a second connector from the shape to the backing shape for the Response Received path.
Open this connector’s properties panel and select ResponseReceived as the value for the Flow
Action smart prompt and provide a suitable Name for the connector (e.g. Response Received).
These errors and warnings are displayed underneath the Offer header.
If a shape has any errors associated to it, an error icon is also displayed on the shape. The tooltip on
the error icon displays the associated error message.
l Invalid rule references – e.g. Treatment, Template, Decision, Email Account, etc.
Note: Being able to successfully save an Offer with Draft mode disabled is an excellent gauge for
ensuring successful Offer flow execution. It is strongly recommended that any Offers that are live
(can be potentially sent to customers) should be validated by saving them with Draft mode disabled.
The system enables this inbound channel support functionality in the following two ways:
1. When an inbound request is received (for a specific Offer and customer), the system first
determines whether the specified Offer is already in flight for the specified customer. If so, the
particular Offer is loaded and Offer flow execution is forced down the Inbound path. This is done
by the use of the InboundTicket construct. The InboundTicket can be associated with most Offer
flow shapes (with the exception of the Start shape and the Wait shape). This ticket denotes the
place in the Offer flow where processing should jump (switch to) when an inbound request is
received for an in-flight Offer.
The InboundTicket is enabled by specifying it as the value for the Ticket Name in the Tickets
section (under Advanced) of the appropriate Offer flow shape, as shown below.
Note: To avoid ambiguity in Offer flow execution, the InboundTicket should be specified on only
one shape in an Offer flow.
2. On the other hand, if the specified Offer is not currently in-flight for the specified customer, the
system creates a new Offer object and starts executing the Offer flow on it, in the context of the
channel that was part of the inbound request. If there’s a need to have separate processing paths
for different channels (say Inbound vs. Outbound, or Call Center vs. ATM), this can be achieved by
branching the Offer flow on Channel at the appropriate place.
In the Offer flow snippet above, the flow execution is initially branched based on the channel. If
the channel on the input request is Call Center, the Offer flow goes down the Record Response
route – in this case, the customer is responding to the Offer in the Call Center, and there is no need
to send them the Offer email. For all other channels, we send the Offer email and wait for either
the customer to respond or the wait duration to expire.
Both the scenarios, outlined above, should be handled in an Offer if it needs to support requests on
an inbound channel. Thus, such an Offer should have both:
l A shape designated as the resumption point for inbound requests by having the InboundTicket set
on it
Note: When integrating with an inbound application (such as NBAA), it is typical to use the Inbound
shape to hold the InboundTicket.
Tip: Each of the data fields listed in the following sections is part of the proposition associated with
the Offer. To utilize a particular field in a different part of the application, reference the associated
property using the OfferData page under the Offer class.
l Bundle Attributes
l Custom Attributes
l Offer details
l Availability
l Financials
l Expected outcomes
Offer details
The following table describes the data fields contained in the Offer details section:
Availability
The following table describes the data fields contained in the Availability section:
Financials
The following table describes the data fields contained in the Financials section:
Agent AgentCompensation Compensation amount for the agent if a customer accepts this Offer
compensation
Price Pricing Description of the customer cost of this Offer (e.g. $45 per month)
description
Expected outcomes
The following table describes the data fields contained in the Expected outcomes section:
Bundle Attributes
Bundles attributes are used to specify the bundling settings for the Offer. Refer to the Offer Bundles
chapter for more details.
The main checkbox in this section allows the user to enable the use of this Offer in Field Marketing
Campaigns.
Once this checkbox is enabled, the user can configure the following additional options:
l Whether Field Marketing Campaigns based on this Offer must be submitted for approval
l Start and end restrictions on the time period when this Offer can be used in Field Marketing
Campaigns
Additionally, the user can also specify a Segment in the Segment Rule field to filter the Field
Marketer's contact list (for Field Marketing Campaigns that reference this Offer) to only those contacts
that are present in the specified Segment. When a Segment is selected, the system displays the last
run date and population count for the selected Segment. If the selected Segment is yet to be run, an
informational message is displaying alerting the user that the field marketer will not have any
contacts to target with their Field Marketing Campaign.
Finally, authorized users can choose whether Field Marketing Campaigns that utilize this Offer should
ignore the global exclusion list. Refer to the Exclusion List chapter for details.
Custom Attributes
The Custom Attributes section lists other proposition fields defined for use by implementers of
the application. The following sets of attributes display in this section:
l All Issue level custom attributes belonging to the Issue for this Offer
l All Group level custom attributes belonging to the Group for this Offer
If the Offer belongs to a versioned Group, implementers can customize the display of attributes. In
such a case, this section will utilize the customized form for specification of these attributes. Refer to
Pega Platform documentation for guidelines on creating custom forms for Decision Data rules.
1. Go to the Proposition Management landing page. This page is accessible in the Pega Marketing
portal via: Configuration > Decision Management > Proposition Management
2. Use the controls in the Hierarchy tab to perform the desired action, as described in the following
table.
To Do
Create a top level attribute Ensure Top Level is selected under the Business issues & groups
tree. Click the New Property… button to launch the New form.
Create an issue or group level Select the appropriate issue and/or group in the Business issues
attribute & groups tree. Click the New Property… button to launch the
New form.
3. Specify the Name and Type of the new attribute in the Create Property form and click Create.
The next steps vary based on whether the application utilizes Decision Data rules to version
propositions.
l Application versions propositions - The new attribute must be added to the Decision Data rule of
each group where it needs to be utilized. This process is described below.
b. If the Decision Data rule uses the standard form, Click Add field in the Form fields section.
In the new row, find and select the newly created attribute in the Identifier column.
l Select Recipients – Select a Seed List for executing the Offer test. The Offer test will be executed
for each seed in the Seed List. All the data associated with the seed will be available as customer
data in the Offer test execution and will be used (if referenced) in the various Offer Flow shapes.
Refer to the “Seed Lists” chapter for information on configuring a Seed List.
l Select Starting Point – Select an Offer Flow shape from where the Offer test should begin. All
shapes present in the Offer Flow (with the exception of the End shape) are listed in the Starting
Point drop-down and can be selected as the starting shape.
l Select Channel and Direction – Specify the channel and direction of communication for the
Offer test. These values are particularly useful in testing different branches of Offer Flow execution
which are dependent on the channel or direction.
Once the Offer test settings have been configured, the Offer can be tested via the Test Offer button.
At this point, the Offer is first saved. If the offer can be successfully saved, the test is submitted for
execution. If the test path includes correspondence, this will be sent to the entries in the specified
Seed List. Any response links that are present in the communication will be active and visible to the
recipients. Recipients can click these links to test the response handling paths of flow execution.
Information will not be captured for these responses in History.
Any errors in the test are reported at the top of the Test Offer tab. Once these are corrected, the test
can be re-executed.
The Track Results section lists the progress of recently executed and currently running tests.
After configuring the Test Offer tab, the test process can also be initiated directly from a shape in the
Offer Flow by utilizing the Test Offer from Here right-click menu item. This will trigger the Offer test
using the settings specified on the Test Offer tab, with the starting point set to the triggering shape.
1. Select the Wait Volumes item from the Overlay toolbar menu in the Offer canvas.
2. Specify the Campaign for which you wish to view waiting Offer counts. You can specify either the
name or the work id of the Campaign.
3. Click Submit.
Upon application of the overlay, the count of Offers waiting is shown on every wait-enabled shape. In
addition, the name and work id of the selected Campaign is displayed in the canvas toolbar next to
the Overlay menu. The count shown on each shape represents the number of instances of the Offer
that are waiting at the shape and have been initiated as part of the selected Campaign - either via a
scheduled run or via a triggered Event.
Hovering over the count on a shape displays an expanded view of the overlay with links to perform
the Update wait time and Stop offers actions.
Note: Action links in the overlay are disabled when no Offers are waiting at the corresponding
shape or if an action is currently being applied.
To view the wait volumes for a different Campaign, re-apply the overlay (by following steps 1-3
above) and select the desired Campaign.
To remove the applied overlay, select the None item from the Overlay menu.
To initiate this action, click the action link from the overlay detail pane.
Then, choose one of the following options to set the new wait expiration time:
l Offset - Select this option to increment the current expiration time of each waiting Offer by a
specified duration. Use the Days, Hours, and Minutes fields to specify the desired offset.
l Date/Time - Select this option to set the expiration time of each waiting Offer to a specified future
date and time. Specify the desired date and time.
Click Submit to update the expiration time of waiting Offers. The system performs this update in the
background. During this time period, a busy message is shown at the top of the Offer rule and all
further overlay actions are disabled.
Upon completion of the update, a confirmation message is displayed along with the number of
waiting Offers that were updated.
To initiate this action, click the action link from the overlay detail pane.
Confirm the stop request by clicking Submit. Upon submission, the system performs the update in
the background. During this time period, a busy message is shown at the top of the Offer rule and all
further overlay actions are disabled.
Upon completion, a confirmation message is displayed along with the number of waiting Offers that
were stopped.
Predictors sections.
Performance
This section provides an overview of how the Offer is performing across the following three metrics:
l Impression rate - Ratio (expressed as a percentage) of the number of times this Offer has been
opened (i.e. impressions) to the volume of the Offer
l Conversion rate - Ratio (expressed as a percentage) of the number of times this Offer has been
accepted to the volume of the Offer
Key Predictors
This section provides information on Adaptive Models that include this Offer. Each model is listed
separately and the first model is expanded by default. The information presented for each model
provides a quick profile of a customer that is likely to respond to this Offer.
l Model name - Click to open the behavior report associated with the model.
l Active predictors for the model. For each predictor, the group with the highest propensity is
shown. Hover over the green circle to see this propensity value.
Treatment rules are primarily accessed from and created in the context of Offers. When designing the
Offer, users can use the property panel of appropriate Offer shapes (e.g. Send Email, Send SMS, etc.)
to review existing treatments of the corresponding type. To create a new treatment, the user simply
needs to type in the desired name and click the magnifying glass to launch the Create form for the
treatment.
Treatments can be defined at the top level or can be categorized into issues and groups. The system
automatically selects the issue and group in the Create form using the corresponding values from the
Offer rule. Users can change these selections to store the new treatment at a different hierarchical
level.
Email Treatments
A newly created Email Treatment starts out with input fields - for Subject and Key Code - and a blank
canvas to compose the email content, as shown below.
The user can also utilize the Key Code field to specify a code for the Email Treatment. This code can
be used by downstream functionality, such as the Send Email shape in the Offer canvas.
When the Track Email Open Rate checkbox is enabled, the system automatically captures email
opens (impressions) in Interaction History. This setting is enabled by default in a new Email
Treatment.
The Email Treatment Editor enables the user to design high quality treatments to send to customers.
This editor supports two modes of editing:
l Design – This is the default editing mode. In this mode, users can enter free-form content and use
a wide array of editing tools to format this content. To apply formatting to content; select the
content first and then, use the formatting icons to update the content’s format.
l Source – This mode is for advanced users and provides direct access to the source HTML for this
treatment. In this mode, the formatting icons are disabled.
Users can switch between the two modes above by toggling the Source button:
The editor also includes an array of buttons to insert content (such as links, images, properties, etc.)
into the treatment:
Two of the buttons in this array are essential in designing effective customer-focused treatments.
These are further outlined below.
Upon clicking this button, the Property Parameters dialog can be configured to embed the
necessary data field. In addition to specifying the name of the field to be embedded, users can also
specify:
l Format – Reference to a Format rule that determines how this field should be formatted.
l When – Reference to a When rule that determines whether this field should be displayed or not.
Clicking this button opens the Button Parameters dialog. This dialog presents the user with a
variety of options for configuring the response mechanism for the treatment. The type of response
link is determined by the value selected in the Function drop-down. The following options are
available:
l Accept Offer - This option embeds a link for the customer to accept the Offer. The user must select
whether to direct the customer to a response screen or to an external URL.
l Decline Offer - This option embeds a link for the customer to decline the Offer. The user must
select whether to direct the customer to a response screen or to an external URL.
l Open Internal Page – This option embeds a link to launch an internal page. The user must specify
the name of the response screen (internal page).
l Open External URL – This option embeds a link to launch an external URL. The user must specify
the external URL to open.
For each of the above functions, the user can enable the Track Click Rate option. The system
automatically tracks clicks (in Interaction History) for any response links that are generated with this
option enabled. This setting is enabled by default.
This option is available for the Accept Offer, Decline Offer, and Open Internal Page links. The user can
configure a response screen to be displayed when the customer clicks on a response link in the Offer
email. This response screen is an internal page in the application and is typically configured using a
Section rule.
l For Accept Offer and Decline Offer, the response screen value is defaulted to the value configured
by the application administrator. In these cases, a typical response screen should represent a
confirmation for the action taken by the customer (accept or decline) and any other information
that needs to be presented.
l For Open Internal Page, the response screen can be considered as a page to provide more
information on the Offer. This page can contain appropriately configured action buttons (such as
accept and decline) that the customer can use to respond to the Offer.
If the value for the response screen is not set, the out-of-the-box default response screen
(DefaultEmailResponse) will be used. Both customer and Offer data are available to be referenced
when building and configuring a custom response screen.
This option is available for the Accept Offer, Decline Offer, and Open External URL links. The user can
further choose whether relevant Offer Data should be included while re-directing to the external URL.
If selected, these values are passed as URL parameters to the external URL being launched. The
following parameters are furnished:
l C – Customer ID
l R – Customer response
l OU – Name of the Campaign Run (batch output) class containing the Offer instance
The following style options can be specified for the response link:
l Button Text – The text that is displayed to the user as the link
l Custom Style – CSS formatting style that should be applied to the link
The following options are available for configuring the test message:
l To – Recipients of the test email. Select either Test Recipients or Seed List.
Test Recipients - Enter list of recipients. Each entry can either be the Operator ID of an existing
user in the system or a valid email address. If the operator ID is entered, operator information
such as the name and email is populated as the customer data and the test email is sent to the
operator’s email address.
Seed List - Select a predefined Seed List as the intended recipients of the test email. The data
for each seed is populated as the customer data and is visible (if referenced) in the test email. In
this case, the Email 1 column in the Seed List (.pyEmail1 property) specifies the email address
to which the test email is sent. Refer to the Seed Lists chapter for information on configuring a
Seed List.
l Test Account Settings – Specify Email Account settings for the test email.
Use Default Email Account - Select this option to use the Default outbound Email Account.
Specify Email Account - Select this option to specify the outbound Email Account to use for
delivering the test email. Specify the account name in the Account field.
From/Reply To : Use Email Account Settings - Select this option to use the sender’s name
and reply-to address that is configured on the Email Account being used.
From/Reply To : Use Operator Settings - Select this option to use the name and email
address of the current operator for these values.
From/Reply To : Override Account Settings - Select this option to specify the sender’s name
and reply-to address for the test email. Specify these values in the From and Reply To fields.
After the test message has been configured, it can be sent via the Send Test Message button.
Upon clicking this button, the Email Treatment is saved and the test email is sent to the specified
recipients. The status of the test is displayed.
Any errors in the test delivery are displayed in case of a failure. These can be corrected and the test
email can be resubmitted for delivery.
Passbook Treatments
Passbook is an application available on iOS devices (such as iPhone or iPod touch) that can be used
to store things (termed passes) such as boarding passes, tickets, and coupons. These passes can be
used to perform appropriate tasks, such as checking in to a flight or redeeming a coupon.
A Passbook Treatment enables marketing users to design the contents of a pass using interactive
tools and a preview pane that displays a rendering of the pass based on the user’s configurations.
Users can configure each element of a pass, preview the impact of their changes, and test the
generated pass by sending it as an email attachment.
Each pass is associated with a pass style. This style determines the overall visual appearance of the
pass and impacts the placement of different fields on the pass. Currently, the system supports the
following Passbook Styles:
Users must select the Passbook Style for the pass as part of creating a new Passbook Treatment.
Users can’t change the style of a Passbook Treatment while copying.
Note: For more details on Passbook, refer to Apple’s Passbook Programming Guide, available at:
https://developer.apple.com/library/ios/documentation/userexperience/conceptual/PassKi
t_PG/Chapters/Introduction.html
General tab
Use this tab to configure the following general settings for the pass:
Description Accessibility Description that the device will use for accessibility to differentiate this pass from other
Description passes
Visual Pass icon Icon that the Apple device shows with the pass on the lock screen and in iOS apps (such as
Elements Mail) when representing this pass. A preview of the selected icon is shown next to the field.
Visual High-res (or High-res version of the pass icon
Elements 2x) pass icon (used in Retina displays)
Visual Strip image Image that displays behind the Primary fields
Elements (Coupons
only)
Visual Thumbnail Image that displays to the right of the Primary fields
Elements image
(Generic
passes only)
Colors Large text Color used for the values of the fields shown on the front of the pass
elements
Colors Label text Color used for the labels of the fields shown on the front of the pass
elements
Colors Background Color used for the background of the front and back of the pass
of the
passbook
For images, users can use the gear icon to launch the Image Catalog, which can be used to search
and select the desired image.
For specifying colors, users can either directly enter the hex code for the color or click the color
square (next to the input box) to launch the color picker. The Standard tab provides commonly used
standard colors while the Custom tab provides multiple ways to select the desired color.
l Header Fields
Name Purpose
Main logo Logo image that displays at the top left corner of the pass
High-res (or 2x) logo High-res version of the logo icon
(used in Retina displays)
Logo text Optional text that displays next to the logo icon
For images, users can use the gear icon to launch the Image Catalog, which can be used to search
and select the desired image.
Header Fields
Use this section to add fields to be displayed in the pass header. Users can configure a maximum of
three fields for the header. Header fields are the only fields that are visible when the pass is stacked
with other passes in the Passbook app. They should be used sparingly to show only the most vital
pass information.
Refer to Configuring Pass Fields for details on configuration options for pass fields.
Primary tab
Use this tab to configure the primary field for the pass. The primary field typically contains the most
important pass information and is displayed prominently.
Refer to Configuring Pass Fields for details on configuration options for pass fields.
Secondary tab
Use this tab to configure the secondary fields for the pass. Users can configure a maximum of four
secondary fields. Secondary fields are less prominent than the primary field and are typically shown
in a smaller font size. Users should specify secondary fields in the order of their importance.
Refer to Configuring Pass Fields for details on configuration options for pass fields.
Auxiliary tab
Use this tab to configure additional fields to display on the pass. Users can configure a maximum of
four auxiliary fields. If secondary fields are present, they will take precedence over auxiliary fields.
Refer to Configuring Pass Fields for details on configuration options for pass fields.
Note: In most cases, coupons and generic passes can have a maximum of four secondary and
auxiliary fields, combined.
Barcode tab
Use this tab to specify the barcode configuration for the pass. Users can include a barcode in the pass
and configure the data contained in the barcode. Users can also choose to display a text message
beneath the barcode. The barcode inclusion in a pass is optional and users can choose to create a
pass without a barcode.
l Aztec
After selecting the barcode format, users need to select what should happen when the barcode is
scanned. The system provides support for the following two options:
Users can also choose to specify a text message that will display with the barcode. This field can be
used to display human-readable information (such as coupon codes or membership numbers). This
is particularly useful if the pass can be used at places where a barcode scanner might not be
available.
Finally, some barcode scanners require the data encapsulated in the barcode to be encoded. Users
can specify the encoding to use or use the default encoding (ISO 8859-1).
Relevance tab
Use this tab to configure locations at which this pass will be relevant. Users can specify up to ten
locations. When a holder of this pass is at (or within) one of the specified locations, the specified
notification message is displayed on the holder’s device. For each location, the user can specify:
l Location information - Users can either select a Geofence rule or directly specify the latitude and
longitude of the location. Refer to the Geofences chapter for more details on the Geofence rule.
l Notification message – Users can specify the message to display on the pass holder’s device when
the holder is at or within the specified location.
Back tab
Use this tab to configure fields to display on the back of the pass. Users can specify up to twenty
fields for the back of the pass. Users can use back fields to specify fields that are too long for the
front of the pass (e.g. terms and conditions) or any other additional information that may be helpful
for pass holders. If the contents of the back exceed what can be displayed on the screen at once, pass
holders are able to scroll through the contents.
Refer to Configuring Pass Fields for details on configuration options for pass fields.
l Type – Type of the field. Choose from a wide variety of supported types, such as String, Number,
Date, and Currency. For back fields, the type is String and can’t be changed. For Date, DateTime,
and Time, use the corresponding Dynamic option if the value is a property reference.
l Label – Label of the field. In most cases, the field label is displayed above the field value.
However, for coupons, the primary field’s label is displayed below (and less prominently than) the
field value. The label can be static, a property reference, or an expression. Users can use the
magnifying glass icon to open a referenced property and the gear icon to launch the expression
builder.
l Value – Value of the field. The value can be static, a property reference, or an expression. Users
can use the magnifying glass icon to open a referenced property and the gear icon to launch the
expression builder.
l Format – Format used to display the field. Users can specify formats for all field types with the
exception of String. The list of available formats depends on the type of field. Since back fields are
of type String, the Format option is not available for back fields.
l Alignment – Alignment of the field text. Users can select the desired alignment for all fields with
the exception of primary fields in coupons using one of the alignment buttons.
Note: For specific details on the various elements involved in pass creation (such as images, fields,
and barcodes), refer to the “Pass Design and Creation” chapter of Apple’s Passbook Programming
Guide, available at:
https://developer.apple.com/library/ios/documentation/userexperience/conceptual/PassKi
t_PG/Chapters/Creating.html
l Send a new pass every time a new offer or program uses this treatment
In this option, the system will send out a new pass each time this Passbook Treatment is used in a
new Offer or Campaign.
l Keep updating the pass even if different offers use this treatment
In this option, the system will update the existing pass when this Passbook Treatment is used in a
new Offer or Campaign. The pass update will be propagated to the customer’s device using the
update mechanism specified in the Send Passbook shape on the Offer canvas. A treatment with
this option enabled is frequently referred to as a global treatment.
Click the pass to open it – the front of the pass is displayed. Click the icon to view the back of the
pass. Use the Done button to return to the front of the pass. Use the Add button to add the pass to
your passbook.
Sections
A newly created Section starts out as shown below.
For more information about creating Sections, refer to the Pega Platform documentation.
Note: Unlike other marketing artifacts, a Section rule does not show Issue and Group drop-downs
in the Create form. However, these are still correctly set using the values from the Offer rule. The
Apply To setting of the Section rule is automatically set to correspond to the issues and group class
under PegaMKT-Work-Offer.
SMS Treatments
A newly created SMS Treatment starts out with an input field for the key code and a blank canvas to
compose the SMS message, as shown below.
l Character count - As a user types the message content, the editor displays the number of
characters in the message. Once the content goes past the length of one SMS message (160
characters), the editor also displays the message number along with an informational note to the
user about SMS message lengths.
l Spell check – Users can use perform a spell check via the Check Spelling icon:
Spelling errors are underlined in red. Clicking an incorrectly spelled word provides a list of
possible corrections. Selecting one of these corrections replaces the incorrect word with the
selected suggestion.
Upon clicking this icon, the Property Parameters dialog can be configured to embed the necessary
data field. In addition to specifying the name of the field to be embedded, users can also specify:
l Format – Reference to a Format rule that determines how this field should be formatted.
l When – Reference to a When rule that determines whether this field should be displayed or not.
Note: When an SMS message contains embedded fields, the character count is an approximation of
the message length. Each embedded field counts as 15 characters towards the character count for
the message.
The following options are available for configuring the test message:
l To – Recipients of the test message. Select either Test Recipients or Seed List.
Test Recipients - Enter list of recipients. Each entry can either be the Operator ID of an existing
user in the system or a valid mobile phone number. If the operator ID is entered, operator
information such as the name and phone number is populated as the customer data and the
test message is sent to the operator’s phone number.
Seed List - Select a predefined Seed List as the intended recipients of the test SMS message.
The data for each seed is populated as the customer data and is visible (if referenced) in the
message. In this case, the Mobile Phone column in the Seed List (.pyMobilePhone property)
specifies the phone number to which the test SMS message is sent. Refer to the Seed Lists
chapter for information on configuring a Seed List.
l Test Account Settings – Specify SMS Account settings for sending the test SMS message.
Use Default SMS Account - Select this option to use the Default outbound SMS Account.
Specify SMS Account - Select this option to specify the outbound SMS Account to use for
delivering the test message. Specify the account name in the Test Account field.
After the test message has been configured, it can be sent via the Send Test Message button.
Upon clicking this button, the SMS Treatment is saved and the test SMS message is sent to the
specified recipients. The status of the test is displayed. Any errors in the test delivery are displayed in
case of a failure. These can be corrected and the test message resubmitted for delivery.
You can define stages for each unique scenario in a customer journey, and specify the conditions in
which customers move between them. For example, customers may become aware that they need or
want a new mobile phone. They consider different phones, compare features and pricing, and make
a decision to purchase the product that best meets their needs. To capture this process, you can
define a customer journey with phases such as Awareness, Consideration, Decision, and Purchase.
Each stage has defined entry criteria, and can be further divided into steps. Each customer journey
step can be linked to an Offer.
Pega Marketing automatically selects relevant customer journeys based on entry criteria you define.
A customer may participate in multiple journeys at the same time. Customers progress through these
journeys in two ways:
l When customers respond to an Offer associated with a specific journey stage and step, they
progress to that stage and step in the journey.
l When data from data streams such as web analytics or event streams indicates that a customer
entered, progressed, or completed a specific journey. Pega Marketing compares the available data
to the entry criteria you define and moves the customer to the relevant stage of the journey.
2. Click Create.
l Issue and Group (Present content from) - Specify an Issue or Group if you want to assign
Offers to journey steps. Specifying an Issue or Group filters the list of Offers according to the
Issue or Group you select.
l Maximum journey length - Specify the expected number of days it takes the customer to
complete this journey. After this time, the customer will no longer be eligible for this journey.
l Journey rank - Specify the priority of this journey, relative to other journeys in your
application.
4. In the Entry Criteria section, click the gear icon to define proposition filters, which are
similar to offer eligibilities. For more information, see Configure Eligibilities.
5. In the Select how you want to configure your journey section, select if you want to create
the journey using a predefined template, or define all stages and steps manually.
l To create the journey from a template, click Start with a template, and then select a
predefined template from the list.
6. Define the stages that make up the customer journey. For example, a sales journey can consist of
Awareness, Consideration and Decision, after which the journey is considered complete.
l To remove a stage, click the down arrow by the name of the stage, and then click Delete
stage.
7. Define the entrance criteria for each stage in the customer journey. This helps ensure that the
customer's progress from stage to stage is tracked. For more information, see Configure
Eligibilities.
b. For each step, you can specify the entry criteria to define when a customer is eligible for this
step. Click the name of the step, then click the gear icon in the ENTRY CRITERIA section. For
more information, see Configure Eligibilities.
c. Optional: You can also link selected steps with Offers that should be extended to a customer at
this step of the journey. To associate a step with one or more offers, click the name of the step,
then click the gear icon in the CONTENT section. For more information, see Offers.
9. Click Save.
2. Click a customer journey to review its stages and steps. An Overview of the journey is displayed.
3. For each step in the journey, review the messages and communications on different channels,
displayed as nodes on the journey graph. Click a node to examine the performance of specific
messages for a specific journey step.
For example, you can compare the number of customers who progressed to the next journey step
to the number of customers who declined the Offer at this step. You can also view the top
grouping for each active predictor from the adaptive model in the Customer Predictors section. If
the step is associated with multiple Offers, you can compare volume, impression and click-
through statistics for each Offer.
4. Optional: To change the timeframe from the current quarter, select Last Quarter or This Year
in the Timeframe section.
5. Optional: To view an animated version of the journey progress, click Explore, and then click a
journey node. The number of customers who progressed through this step is displayed.
6. Create a template from the customer journey, so that other marketers can reuse it. To save a
customer journey as a template, click Actions > Save as template.
Note: To activate a customer journey, first make sure that you defined entry criteria for all
journey stages. For more information, see Defining Customer Journeys.
8. To edit a customer journey, deactivate it, then click Edit. You cannot edit a customer journey while
it is active.
9. To delete a customer journey, deactivate it, then click Delete. You cannot delete an active
customer journey.
l Send Email
l Send SMS
l Send Generic
Like most other marketing artifacts, Templates can be created at the top level or can be categorized
under Issues and Groups. The categorization level of the Template determines the attributes (Offer
details) that are available for use within the Template.
Both File and Database Template rules have the following tabs:
File Template
File Templates are listed on the Outbound tab of the File landing page. This landing page is
accessible in the Pega Marketing portal via: Configuration > Settings > Channels > File
Database Template
Database Templates are listed on the Outbound tab of the Database landing page. This landing
page is accessible in the Pega Marketing portal via: Configuration > Settings > Channels >
Database
A sample File Template with its output destination configured is shown below:
When the Template rule is saved, the system performs the following validations on the output
destination:
l File Template:
Note: Output file paths must be accessible by all configured system nodes.
l Database Template:
l Column Heading Names – This option is only available for the file header and when the write
mode is Overwrite. If this option is selected, column headers will be written to the output file upon
file finalization.
l Data Fields – Any relevant data fields (such as customer information, Offer details, etc.)
The Name column in the grid denotes the name of the database column or file column header, while
the Content column denotes the actual value for the individual records.
For File Templates, the user can also specify a format for dates and numeric fields. When one of
these fields is selected in the Content column, the Format column is loaded with the appropriate set
of available formats.
A sample File Template with its output content configured is shown below:
Note: Upon execution of a Database Template, the columns created in the corresponding database
table are of type varchar and of size 100.
Users can choose to finalize a file or table by selecting either the Finalize or Finalize and
Download action on a particular entry from the File or Database landing page.
The Schedule for finalizing a file or table can be specified via the Schedule options on the Finalize
tab. Enable the Enable Schedule checkbox and configure the desired schedule options.
Users can choose to send email notifications in either one or both of the finalization trigger scenarios.
To enable notifications, enable the checkbox for the desired scenario(s) in the Delivery Options
section. Configure the recipient(s), subject, and body of the notification email. For File Templates,
users can also choose to attach the finalized file to the notification email.
Note: The recipient of the finalization email must be an operator in the system. The finalization
email will be sent to the email address associated with the operator’s record.
Note: For File Templates, if the finalized file is greater than 5 MB and the Attach File option is
enabled, a small chunk of the file's contents are attached to the notification email. Users can
download the entire file from the File landing page.
Finalization also serves as a hook for a post-processing activity, if one is specified. An example usage
of this could be to upload the finalized file via FTP to a processing system. The post-processing
activity can be configured in the Advanced section of the Finalize tab, as shown below:
l Finalize and Download – (File only) Trigger finalization of the output file, and then download
the resulting file.
l Preview – (Database only) Presents a CSV file containing a subset of the contents in the database
table. The number of records returned in the preview file is configurable by the application
administrator.
l Retry – In case of a failure, this option can be used to retry writing the records to the appropriate
output file or table.
l Parent Offer - Each bundle must have one parent Offer. Typically, the Offer flow for the parent
Offer will propagate the offering of its member Offers. For example, the parent Offer flow will
send an email with details about its member Offers and action links to respond to the Offers.
l Fixed Bundle - This bundle type should be used when customers must purchase the bundle in
its entirety (all members). In this mode, the parent Offer flow is the only flow that is processed. All
Interaction History (IH) records are recorded for the parent bundle and all of its members. Any
response will progress the parent offer flow.
l Flexible Bundle - This bundle type should be used when customers can purchase the entire
bundle or can pick individual members to purchase. In this mode, the parent Offer flow is used as
a container for distributing communication about the collection of offerings. A response to an
individual offering will only start that member's Offer flow. Any IH recording in the member Offer
flow will record information for the member Offer and the parent Offer. Responding directly to
the parent bundle Offer will trigger all member Offers that haven't been started. However, the
parent Offer flow will not progress.
l Grouped Offers - This bundle type should be used when the user has a selection of Offers they
wish to market together to the customer. The individual Offers themselves may not have any
correlation to each other. In this mode, (similar to the flexible bundle mode) the parent Offer flow
is used as a container for distributing communication about the collection of offerings. A response
to an individual offering will only start that member's Offer flow. However, unlike a flexible
bundle, any IH recording in the member Offer flow will only record information for the member
Offer. Responding directly to the parent bundle Offer will not start any of the member Offers, but
will progress the parent Offer flow.
The differences in the behaviors of the three bundle types are summarized in the table below:
Note: Volume Constraints are currently only applied for fixed bundles.
l Bundle Name - Specify the name of the Offer bundle. This name should be the same for all Offers
(both parent and members) in the bundle.
l Offer Role - Specify the role this Offer will play in the bundle. Select Yes if this Offer is a parent
Offer, otherwise select No. Also, select the bundle type for the parent Offer.
The following example illustrates setting bundle characteristics using a Strategy rule.
For the parent Offer, the bundle type is specified ("FixedBundle", "FlexibleBundle", or
"GroupedOffers") and the bundle parent flag is set to true.
For all Offers (parent and two members), the bundle name is specified. In the above example, the
parent Offer's name is used as the bundle name.
Fixed Bundle
In a fixed bundle, the parent Offer flow is responsible for handling responses received for the bundle,
as shown in the flow snippet below.
Flexible Bundle
In a flexible bundle, the parent Offer flow is only responsible for the initial communication of the
Offer bundle. Responses received for the bundle will not progress the parent flow. A simple parent
flow is shown below.
Grouped Offers
In a grouped bundle, the parent Offer flow is responsible for the initial communication. Typically,
bundle-level response links are not provided in this mode. If a bundle-level link is made available, the
parent Offer flow will be resumed. This could be used to trigger a follow-up email with more
information and/or update Interaction History records for the parent and all member Offers that
haven't been started.
Fixed Bundle
In a fixed bundle, the member Offer flow is never started. Thus, the member Offer flow can simply
be an empty flow.
This treatment includes the following salient pieces of a bundle Email Treatment:
l Response link for bundle – Added using the Insert Button functionality
l Member details - References BundleTemplate section. This section uses the BundleOfferMembers
page list property to display the member Offers in a grid with accept and reject response links for
each member.
Another common usage pattern is to update the grid in the BundleTemplate (or equivalent) section
at the top level (PegaMKT-Work-Offer) to include a sub-section for displaying relevant Offer
information, say MemberOfferDetails. Users can then create a top-level version of this section to
serve as a base for all member Offers. To customize the details for a particular issue or group, the
user simply needs to override the details section in the appropriate issue or group class.
Microsites are listed in the Microsites landing page, which is accessed from the Pega Marketing portal
via: Content > Microsites
Note: Pega Marketing leverages Pega Platform's stage-based Case Management functionality for
building Microsites. Refer to official documentation for more details on this functionality.
Creating a Microsite
To create a new Microsite, use the Create button on the Microsites landing page.
Note: The Create button is only visible to users that have the CanCreateMicrosite Privilege. The
PegaNBAM_FW:MicrositeAdmin Access Role encapsulates this privilege and can be added to desired
Access Groups.
Provide a name and description for the Microsite. Users can also utilize the Advanced Settings
section to configure advanced options, such as inheritance and ruleset information.
Note: To nest the new Microsite under an existing one, select the existing Microsite in the Derives
From (Pattern) field (under Advanced Settings).
Upon clicking Submit, the system creates a new class for the Microsite (with class name PegaMKT-
Work-Microsite-<MicrositeName>). The system also creates starter rules for the Microsite in this class
and then presents the stage-based Microsite view.
l Load Data
In this stage, customer and Offer data (if available) is loaded so that it can be used by later stages.
For this data to be loaded, at runtime, the Microsite must be launched from a customer and/or
Offer-aware context. An example of such a context would be an Offer email that was sent to a
customer with a link to the Microsite.
l Display Microsite
In this stage, the Microsite is displayed to the customer. A new Microsite starts with a single page,
titled Page 1. Behind the scenes, the system has automatically generated corresponding Flow,
Flow Action, and Section rules to support this page. Primarily, users should only modify the
section to specify the contents of the Microsite. To do so, click the step in the stage to select it.
Then, click the Configure view button in the right pane to open the backing Section rule.
l Save Data
In this stage, values entered by the customer on Microsite pages are saved. This stage saves two
types of data:
Offer data – These values can later be used in the progressed Offer flow.
Custom Site data – These values are custom fields created and specified by the users. See
Defining and Using Custom Data Fields for details.
l Progress Offer
In this stage, the Offer that initiated the Microsite (e.g. via an email containing a link to the
Microsite) will be progressed along the ResponseReceived path. By default, the response value is
set to Accepted.
l Confirmation
In this stage, a confirmation page is displayed to the customer. The identifier of the out-of-the-box
generated confirmation page Section rule is Confirm.
Note: The system performs identity matching at relevant stages in the Microsite case lifecycle. Refer
to the Identity Matching in Microsites section in the Identity Matching chapter for details.
customer- or Offer-aware wouldn't require the Load Data and Progress Offer stages.
Deleting a Stage
Use the Delete stage action from the drop-down menu in the stage header to delete an existing
stage. Hover over the header to see a down arrow icon. Click this icon to open the actions menu.
Reordering Stages
Use the drag icon in the stage header to move the stage to its desired location among other stages.
Configuring a Stage
Each stage can have one or more steps that it performs. Typical steps for Microsites are provided out-
of-the-box and are associated with the default stages, e.g. load data, save site data, progress offer,
etc.
A marketing-specific step type is the page. Page steps are quick ways to inject a screen (or page) into
the Microsite process. To add a new page, the user can select the + STEP item in the steps area of a
stage. After the user specifies the desired page name, the system will automatically create the backing
structure (Flow, Flow Action, and Section).
To open the generated Section rule, users can select the page step and click the Configure view
button in the right pane.
Users can customize the section content to include any pertinent information to display to or gather
from the customer. The Next button in the section can be customized as well. This can be done by
overriding the NextButton section in the Microsite class and applying any desired styles to it.
In the Microsite stage view, the X icon on a step facilitates the deletion of the step while the four-
directional cursor allows for steps to be moved to their desired position within a stage. When a step
is deleted from a stage, the backing artifacts are not deleted and this page step can be added back to
the stage at a later point.
For advanced configuration, select the process item (first item) in a stage and then use the Open
process link in the right pane to open the backing Flow rule for the selected stage.
1. Add a new step or determine the existing step to replace. In this example, a step has been added
to the confirmation stage to redirect to another Microsite.
2. Select More > Processes > Redirect Microsite and then click Select
4. Select the newly added step and click the Open process link in the right pane. This will open the
RedirectMicrosite Flow rule.
8. Update the MicrositeClass parameter value to the class of the Microsite to redirect the customer
to.
These fields can then be used in a Microsite page to display or capture information. Access these
fields via the CustomSiteData page property on the Microsite class.
Use the Save Site Data step to save the values entered by the customer for custom data fields.
The following steps outline the process involved in adding a Microsite link in an Email Treatment:
1. Use the Insert Button functionality on an Email Treatment to configure the Microsite Link.
4. To include customer and Offer context in the link, enable the Include Offer Data checkbox.
5. Specify text, image, and style for the link (as desired).
http://<server>:<port>/MS/index.html?Site=<MicrositeName>
Note: The above URL pattern can only be used for testing and launching Microsites once the
Microsite war (provided as part of Pega Marketing) has been installed and configured by the
application administrator. Administrators should refer to the installation guide for more details.
This Microsite shows a simple page with the discounted value for the product and provides an input
field for customers to sign up.
The Page1 Section rule uses two custom site fields (via the .CustomSiteData page property). A snippet
of this section is shown below:
The confirmation section simply displays the previously entered (and then saved) email.
Since this Microsite does not have an Offer context, the NewValue custom data property is initialized
via the pyDefault Data Transform rule in the class of this Microsite.
Note: It is critical that this Data Transform must be in the Microsite-specific class and must have the
Call superclass data transform? checkbox enabled.
Upon launching the Microsite launch URL with "Site=SampleMicrosite", the following is displayed:
After entering an email and clicking Next, the confirmation page is displayed:
This Microsite first loads relevant Offer and customer data. At runtime, the Offer context is
determined from the URL used to launch the Microsite. This context is then used to load the Offer
and customer data. The Microsite then uses this data to display a personalized page to the customer
with pertinent customer and Offer information.
In the above section, customer data is referenced via the .Customer page property, while Offer data is
referenced via the .Offer.OfferData page property.
On the next page, the customer is prompted for their priority code (an Offer data field).
Once the customer enters this information, the Save Site Data step saves the Offer data value (since
the Microsite is Offer-aware). The Progress Offer step resumes the Offer along the ResponseReceived
path with an Accepted response. The Offer can utilize the saved Offer data value (Priority Code, in
this example) and use it to branch the flow, as shown below:
In the above Offer, the initial email shape sends out a link to the Microsite. If the customer responds
to this Offer (e.g. via the Microsite), the Offer flow uses the priority code (entered via the Microsite) to
branch flow execution.
At runtime, when the above Offer is initiated, the customer gets an email with a link for the Microsite.
Upon clicking the email link, the Microsite is launched with an Offer and customer context. The
Microsite loads the necessary data from these contexts and displays the first page.
Upon clicking Next, the customer enters their priority code on the next screen.
Upon clicking Next again, the priority code is saved (as Offer data) and the Offer is progressed. The
Offer uses the entered code value to branch flow execution. Finally, the confirmation page is
displayed to the customer.
Tip: In cases that the organization truly wants to remove a Microsite (such as one that was never
made public), administrative users can utilize the Delete a Class wizard to delete the class (and all
contained rules) that backs the Microsite.
Note: The shipped implementation provides a basic infrastructure for supporting customer
unsubscribes and management of subscription preferences. As such, custom implementations are
expected to extend the provided functionality and integrate the saved preference data into their
marketing processes (such as handling customer unsubscribes).
l Since the Subscription Microsite is customer-specific, users must enable the Include Offer Data
checkbox.
On the primary screen, the customer can select a reason for unsubscribing and click the
Unsubscribe button to complete the process.
Tip: To include additional items in the list of unsubscribe reasons, implementers should create
appropriate field values for the following property:
PegaMKT-Data-Microsite.Reason
The customer can also use the link at the bottom of the primary screen to manage their subscription
preferences. This launches the Subscription Preferences screen, which lists the various
communication channels and the customer’s current subscription preference for each of these
channels. The customer can update individual preferences or can utilize the last checkbox to
unsubscribe from all channels.
These preferences are retained across multiple sessions. When the customer next visits this page, it
will reflect their previous saved subscription preferences. In the screen below, the customer had
previously opted out of email communications and, thus, the preference for the email channel is
unchecked.
Clicking the above link launches the report, which displays a chart for the email unsubscribes in the
last 30 days. The chart groups unsubscribes by Treatment Name. Within each group (bar), there is a
further classification based on the unsubscribe reason.
In addition to the chart, the report also displays an expandable breakdown of unsubscribes by
reason:
Clicking on a region in the chart (or an expanded row in the reason breakdown) switches the display
to a list. This list includes relevant details that were captured as part of the unsubscribe request, such
as the Issue, Group, and Offer Name.
1. Load Data – This stage uses the LoadSupportingData Flow to load data for the referenced
customer. If a customer context cannot be established, this flow switches to the No Identified
Customer alternative stage.
3. Manage Preferences – This stage loads the customer’s previous preferences and renders the
manage preferences screen.
4. Save Preferences – This stage utilizes the UpdateSubscriptionPreferences Flow rule to save any
changes to the customer’s subscription preferences. This Flow also handles the cancel path, when
The Subscription Microsite also includes the following alternate stage flow:
1. No Identified Customer – This stage renders the Customer Not Found screen.
l CustomerID
l Channel
An instance of this class represents a specific customer’s subscription preference for a specific
channel. Instances of this class are stored in the MKT_SUBSCRIPTION table in the ExternalMKTData
data source.
In addition to the above keys, the shipped implementation also includes the following properties in
this class:
l OfferIssue – Issue of the Offer, from which the Microsite was launched
l OfferGroup – Group of the Offer, from which the Microsite was launched
l OfferName – Name of the Offer, from which the Microsite was launched
l Treatment – Name of the Treatment, from which the Microsite was launched
Geofences are accessible in the Pega Marketing portal, via: Content > Real-Time Artifacts >
Geofences
The Geofences landing page provides a quick overview of the various fences configured in the
application. The Geofence rule can be opened by double-clicking the Geofence row.
Geofence Management
This section explains the various modes available for managing Geofences.
l Address – Users can directly specify the desired address in the input box.
l Coordinates – Users can specify the latitude and longitude of the desired location.
After specifying the location for the Geofence, the “Search” button is used to locate the Geofence in
the map. If the specified location is valid, the Map section will render the Geofence and the Details
section will display available details for the Geofence.
The radius of the Geofence and the unit of measurement can be modified. Upon modification, the
Map will re-render using the new radius values.
In addition to the above common interactions, the following Geofence-specific interactions are also
available:
l Dragging the Geofence pin to relocate the Geofence’s location. The details section will display
the new address and coordinates.
l Resizing the Geofence by dragging any of the four endpoints (north, south, east, and west). The
details section will display the new radius value.
The map on the Geofence rule form can also be used to view nearby Geofences. This is helpful in
determining potential overlaps across Geofences. By default, nearby Geofences are not displayed.
Use the “Nearby Geofences” menu on the map to toggle the display of nearby fences.
1. Hide Other Geofences - This is the default option. In this mode, nearby Geofences are not
displayed.
2. Show without Radius - Select this option to view nearby Geofence locations. Each Geofence is
represented by a blue pin and the radius of the Geofence is not displayed. Users can hover over
the pin to view the name of the Geofence.
If multiple Geofences are located in too close a radius to render separately, they are represented
together by a circle with the number of Geofences it contains. Users can click on the number to
view a list of the contained Geofences.
3. Show with Radius - Select this option to view nearby Geofences along with their radii. Each
neighboring Geofence is represented by a blue pin as its center and a blue circle corresponding in
size to its radius.
As previously, if there is a high density of Geofences, they are represented by a circle with the
number of contained Geofences. The shading of the circle also provides a visual cue to its density.
Denser circles will be more opaque than less dense circles.
Importing Geofences
Users can also choose to bulk import Geofences into the system. Click the Import link on the
Geofences landing page to launch the Import Geofences process. The import process has the
following three stages:
Import
Use the Choose File button to select the comma-separated values (CSV) file containing the list of
Geofences to import. After selecting the CSV file, use the “Next” button to proceed to the review stage.
l Radius unit should be either “Miles” or “Kilometers”. If radius unit is not provided, it is defaulted to
“Kilometers”.
l Using coordinates:
PegaBedford,2,Miles,42.928,-71.464,,,,,
Review
This stage enables the user to review the import process and handle any conflicts. The user is
presented with total number of Geofence records, number of Geofences that will be created, number
The Geofences to Import grid lists each entry in the import file along with its pertinent details and
its status. The grid is paginated if there are sufficient entries in the import file.
1. (Blank) - Geofence is valid and has no conflicts. This Geofence can be successfully created.
2. Warning - Geofence is valid, but has conflicts with either an existing Geofence rule in the system
or another Geofence in the import file. The creation of this Geofence will depend on the conflict
management option selected in the “Import Options” section. The reason for the warning is
displayed as a tooltip on the status.
3. Error - Geofence is invalid and will not be created. The reason for the error is displayed as a
tooltip on the status.
If desired, users can return to the import stage via the Back button and re-import the file after
addressing any errors.
Managing Conflicts
The system provides the following options for handling conflicts in the import process:
Select this option to ignore any conflicting Geofence entries and retain the original Geofence rule
or the first Geofence import file entry, as appropriate.
Select this option to overwrite existing Geofence rules (in the system) and/or earlier import file
entries with the latest file entry.
Select this option to pick which import file entries should overwrite existing entries. Select the
Overwrite checkbox for each desired entry. Entries where the checkbox is not checked will be
ignored.
After reviewing the import results and managing the conflicts, users must check the I have reviewed…
checkbox.
Finally, use the Next button to finalize the import of Geofences and initiate the back-end creation (or
updating) of Geofence rules.
Summary
This stage provides the user with a summary of the Geofence import process.
After reviewing the results, use the Done button to exit the import process.
Geofence Services
In addition to configuring Geofence rules in Pega Marketing, the app that wishes to detect when a
Geofence is entered (tripped) must make service requests to the system to determine if a Geofence is
tripped. If a Geofence is tripped, all Events associated with it will be triggered (assuming they are
currently applicable). The system provides multiple services which can be used separately or in
tandem to facilitate this functionality.
http://<host>:<port>/prweb/PRHTTPService/PegaMKTGeolocation/Services/HandleMktPreferredF
ences?Key=Closest&BaseLatitude=<DeviceLatitude>&BaseLongitude=<DeviceLongitude>&Closest
Count=<NumberOfGeofences>
http://<host>:<port>/prweb/PRRestService/PegaMKTGeolocation/Services/HandleMktPreferredFe
nces/Closest?BaseLatitude=<DeviceLatitude>&BaseLongitude=<DeviceLongitude>&ClosestCount=
<NumberOfGeofences>
l ClosestCount – Number of closest Geofences to return for the specified location. If this value is
not provided, the system returns up to ten Geofences.
The content type for the response differs between the variants:
{
GeolocationArray : [{
"GeofenceName" : "PegaBedford",
"RadiusNormalized" : "1000",
"Latitude" : "42.928",
"Longitude" : "-71.464"
}, {
"GeofenceName" : "ManchesterBRAirport",
"RadiusNormalized" : "3218.688",
"Latitude" : "42.928",
"Longitude" : "-71.438"
}]
}
In error scenarios, such as when the location coordinates are not provided, an error response is
returned.
{
ErrorsList : [{
"pyMessage" : "Error: One or more input parameters are invalid."
}]
}
Note: The system provides out-of-the-box support for closest Geofence lookup (“Key” request
parameter is set to “Closest” in the example URLs above). Custom implementations may extend this
functionality to provide support for other lookup modes.
Detect/Trigger Geofences
The Detect/Trigger set of services are used to detect whether a customer’s device has tripped a
Geofence in the system and to trigger Events associated with tripped Geofences. These services
support handling requests for multiple customers in a single request.
http://<host>:<port>/prweb/PRHTTPService/PegaMKTGeolocation/Services/HandleMktGeolocatio
ns?CustomerID=<CustomerID1,2,..n>&DeviceID=<DeviceID1,2,..n>&DeviceLatitude=<DeviceLatitu
de1,2,..n>&DeviceLongitude=<DeviceLongitude1,2,.n>
When using this service for multiple customers, ensure that each of the values are comma-
separated (e.g. CustomerID=A1,A2,B1) and that the length of each of the request fields (such as
CustomerID, DeviceLatitude, etc.) is the same.
The following URL provides the WSDL for your this service:
http://<host>:<port>/prweb/PRSOAPServlet/SOAP/PegaMKTGeolocation/Services?WSDL
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:geol="GeolocationPayload">
<soap:Header/>
<soap:Body>
<geol:GeolocationPayload>
<Geolocation>
<CustomerID>JR</CustomerID>
<DeviceID>ANDR1234</DeviceID>
<DeviceLatitude>41.34</DeviceLatitude>
<DeviceLongitude>-71.79</DeviceLongitude>
</Geolocation>
<Geolocation>
<CustomerID>RA</CustomerID>
<DeviceID>IO12</DeviceID>
<DeviceLatitude>41.797</DeviceLatitude>
<DeviceLongitude>-72.077</DeviceLongitude>
</Geolocation>
</geol:GeolocationPayload>
</soap:Body>
</soap:Envelope>
For each customer location, the system evaluates whether the location trips any of the defined
Geofences. For each Geofence that is tripped, the system triggers all Events associated to that
Geofence.
Real-Time Events are listed on the Events tab of the Real-Time Artifacts landing page. This landing
page is accessible in the Pega Marketing portal via: Content > Real-Time Artifacts
The Events landing page provides a quick overview of the Event rules configured in the application.
The landing page indicates whether an Event is active or inactive. The Valid From and Valid To
values (if configured) are displayed in green if they are currently satisfied.
Event Management
This section explains the various aspects of managing Events.
Use the Edit multiple button to add multiple Geofences using a list-to-list interaction.
The left list contains the available Geofences while the right list contains the currently selected
Geofences. Use the icons adjacent to the lists to manage Geofences between (and within) the lists.
Icon Purpose
Move all available Geofences to the associated list.
Move the selected Geofence from the available to the associated list.
Move the selected Geofence from the associated to the available list.
Move all associated Geofences back to the available list.
Triggering an Event
In the marketing application, configured Events can be triggered via a SOAP request. The following
URL provides the WSDL for your application’s Event handling SOAP Service:
http://<host>:<port>/prweb/PRSOAPServlet/SOAP/PegaMKTDataMktEvent/Services?WSDL
The following is an example request triggering the AccountOpened Event, passing in the Customer’s
id, their location (latitude/longitude), and information about the Event:
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:even="EventPayload"
xmlns:urn="urn:PegaRULES:SOAP:PegaMKTDataMktEvent:Services">
<soapenv:Header>
<even:EventPayload>?</even:EventPayload>
</soapenv:Header>
<soapenv:Body>
<urn:EventPayload>
<CustomerID>JR</CustomerID>
<EventName>AccountOpened</EventName>
<EventType>Branch</EventType>
<Latitude>42.9613</Latitude>
<Longitude>-71.4798</Longitude>
</urn:EventPayload>
</soapenv:Body>
</soapenv:Envelope>
When an Event is triggered, the system determines whether the referenced Event is valid, enabled,
and available (date and time are valid). If so, any Campaigns that are associated with the events are
initiated. The payload for the Event (including customer id) is propagated to the Campaign, and from
there to the Strategy, and finally to the Offer. Refer to the Multi-Channel Campaigns chapter for more
information on associating Events with Campaigns.
Further, users can integrate ESM with Pega Marketing Real-Time Events. This integration enables the
triggering of a Real-Time Event in Pega Marketing by an ESM Data Flow.
Pega Marketing provides integration support for ESM in a variety of deployment scenarios:
1. Pega Marketing and ESM are deployed on same instance, ESM Data Flows have access to the Pega
Marketing application.
2. Pega Marketing and ESM are deployed on same instance, ESM Data Flows do not have access to
the Pega Marketing application.
In scenario 1, integrators can directly use a hook activity. For scenarios 2 and 3, integrators will need
to use an integration ruleset.
Use the parameters of this activity to specify the values necessary for triggering the Real-Time Event,
such as EventName and CustomerID. The EventType parameter determines which Event service will
be invoked. Pass in either HTTP or SOAP for this parameter based on the protocol you wish to
utilize.
The SampleCEPDF Data Flow rule provides an example configuration that invokes the hook activity.
This ruleset includes the following items that enable the triggering of Pega Marketing Events:
l TriggerPegaMKTEvent Activity rule - Use this activity (as described previously) to trigger a Real-
Time Event in Pega Marketing.
l ConnectMKTURL Dynamic System Setting - Update this setting to the URL where the Pega
Marketing application is deployed.
l MKT_Integration:SysAdmins Access Group - Update this access group to reference the application
that has access to the PegaMKT-Integration ruleset.
Pega Marketing provides a set of APIs, which can be invoked from real-time channels, to facilitate the
population of a Container and to capture customer responses.
Real-Time Containers are listed on the Containers tab of the Real-Time Artifacts landing page. This
landing page is accessible in the Pega Marketing portal via: Content > Real-Time Artifacts
The Containers landing page provides a quick overview of the Containers configured in the
application.
Container Management
This section explains the various aspects of managing Real-Time Containers.
Select Yes to enable the Container and have it respond to requests. Select No to prevent the
Container from responding to requests. If an inactive Container is requested, it will simply be
ignored.
l Impression Capture
This setting governs how an impression is captured when the Container is requested. Choose
between the following two options:
Captured on retrieval – Select this option to have the Container processing API
(ExecuteWebContainer) automatically capture an impression before rendering the Container.
Captured by channel – Select this option to not capture the impression while rendering the
Container. In this case, the channel will need to separately invoke the impression capture API
(CaptureWebImpression).
This setting governs what happens when the channel invokes the click-through capture API
(CaptureWebClickThrough). Choose between the following two options:
Capture click through only – Select this option to simply record a click in Interaction
History (IH).
Capture click through and initiate offer flow – Select this option to record a click in IH
and to initiate the Offer for the customer. If the Offer is already in flight for the specified
customer, the particular Offer is loaded and Offer Flow execution is forced down the Inbound
path. If the specified Offer is not currently in flight for the specified customer, the system
instantiates a new Offer and starts executing the Offer Flow on it. This is done in the context of
the Channel that was part of the inbound request. Refer to Adding Inbound Channel Support for
more details.
Note: The click-through URL is configured on the Details tab of the Offer rule form. This URL can
also be over-ridden in the Strategy. For proper re-direction, this URL should begin with the
protocol prefix - such as http:// or https://.
The Campaigns Associated with this Container section displays Campaigns that have been
associated with this Container. Refer to the Multi-Channel Campaigns chapter for details on
associating Containers with Campaigns.
The Next-Best-Action Strategies Associated with this Container section displays the NBA
configuration that has been associated with this Container. Refer to the Next-Best-Action chapter for
details on associating Containers with NBA.
Note: A Container can have multiple entities associated with it, as long as only one of them is active
at any given point in time.
The following table lists the information that displays for each entity - i.e. Campaign or NBA
configuration - associated with this Container:
Column Description
Associated Campaign / Name of the Campaign or NBA configuration, to which this Container is associated. Click
Associated Strategy the name to open the entity.
Enabled Whether the associated entity currently has Container processing enabled on it
Start Date Date and time when this Container becomes active for this entity
End Date Date and time when this Container stops being active for this entity
Status Current status of the associated entity
When invoked, each API sets one of the following HTTP status codes in its response:
Container
Container is a REST service that supports the POST HTTP method. This service allows callers to trigger
a Real-Time Container. Unlike other Container services, this service supports the concept of a
centralized decisioning hub, where a Pega Marketing application behaves as the hub for decision
logic and any other Pega application can leverage Container features without being built on Pega
Marketing.
Note: This service supports identity matching only for the Web and Mobile channels.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/V1/Container
Service Request
For the request, the service expects a JSON Object with the following attributes:
{
"ContainerName": "SampleContainerName",
"CustomerID": "SampleCustomerID",
"Channel": "SampleChannel",
"Direction": "Inbound"
}
Service Response
For the response, the service returns a JSON Object with the following attributes:
l RankedResults - An array containing one or more Offers returned by Strategy execution. Each
Offer in this array has the following attributes:
Channel – Channel for communicating this Offer
InteractionID – Interaction History record identifier for this Offer. This will be same for all Offers
in the list since they are all part of the same Strategy execution.
In case of an error, the response object instead contains the following two fields:
{
"Status": "OK",
"RankedResults":
[{
"Channel": "Web",
"Rank": 1,
"Direction": "Inbound",
"Group": "Handsets",
"CampaignID": "P-3968",
"Issue": "Sales",
"Propensity": 0.5,
"InteractionID": "-3457926003646498105",
"Priority": 0.5,
"Name": "SamsungGalaxyS4",
"ClickThroughURL": "",
"Label": "Samsung Galaxy S4",
},
{
"Channel": "Web",
"Rank": 2,
"Direction": "Inbound",
"Group": "Handsets",
"CampaignID": "P-3968",
"Issue": "Sales",
"Propensity": 0.5,
"InteractionID": "-3457926003646498105",
"Priority": 0.5,
"Name": "NokiaLumia",
"ClickThroughURL": "",
"Label": "Nokia Lumia",
}]
}
CaptureResponse
CaptureResponse is a REST service that supports the POST HTTP method. This service allows callers
to capture responses to Offers triggered via Real-Time Containers.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/V1/CaptureResponse
This service can also be used to initiate the first offer in its request. To utilize this feature and include
offer initiation, use the following URL pattern:
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/V1/CaptureResponse/Initiate
Service Request
For the request, the service expects a JSON Object with the following attributes:
l RankedResults – An array containing Offers for which to capture responses. Each Offer in this list
should have the following attributes:
Name – Name of the Offer
Behaviour - Predefined behavior for the specified outcome (e.g. Positive, Negative, Neutral,
etc.)
Outcome - Response to record for this Offer (e.g. Accepted, Rejected, Impression, etc.)
{
"CustomerID": "CGS1234",
"ContainerName": "LatestOffer",
"RankedResults": [{
"Name": "PremierRewardsCard",
"Issue": "DemoIssue",
"Group": "DemoGroup",
"CampaignID": "P-3344",
"InteractionID": "-5352764169004433549",
"Outcome": "Accepted",
"Behaviour": "Positive"
"Channel": "Web",
"Direction": "Inbound"
}]
}
Service Response
For the response, the service returns a JSON object with the following attributes:
{
"Status": "OK",
"Message": "Response captured successfully"
}
CustomerOfferHistory
CustomerOfferHistory is a REST service that supports both GET and POST HTTP methods. This service
returns the Interaction History records for a customer.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/V1/CustomerOfferHistory
Service Request
For the request, the service expects a JSON Object with the following attributes:
{
"CustomerID": "CONNOR",
}
Service Response
For the response, the service returns a JSON object with the following attributes:
l OfferHistory – An array of History records for the customer. Each record contains the following
attributes:
Name - Name of the Offer
Outcome - Response recorded for this Offer (e.g. Accepted, Rejected, Impression, etc.)
Behaviour - Behavior of the specified outcome (e.g. Positive, Negative, Neutral, etc.)
Note: For Negotiation history records, there is a nested OfferHistory element which is an array of
Offer names.
{
"OfferHistory": [
{
"Name": "Negotiation",
"Issue": "Negotiation",
"Channel": "CallCenter",
"InteractionID": "7382338912749122452",
"ExternalID": "S-13805",
"OutcomeTime": "20160225T125501.526 GMT",
"Behaviour": "Negative",
"OfferHistory": [
{ "Name": "Handsets_fromGoogleNexus4" },
{ "Name": "DataPlan100Min" },
{ "Name": "MemoryCard_V2_M3" }
],
"Outcome": "Rejected",
"Identifier": "/Negotiation/Negotiation/Negotiation",
"Direction": "Inbound",
"Group": "Negotiation"
},
{
"Name": "MI",
"Issue": "Sales",
"Channel": "CallCenter",
"InteractionID": "-7714067498846096636",
"ExternalID": "",
"OutcomeTime": "20160224T101058.055 GMT",
"Behaviour": "Positive",
"Outcome": "Accepted",
"Identifier": "/Sales/Handsets/MI",
"Direction": "Inbound",
"Group": "Handsets"
}]
}
ExecuteContainer
ExecuteContainer is a generic channel REST service that supports the POST HTTP method. This service
allows callers to trigger a Real-Time Container.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/Services/ExecuteContainer
Service Request
For the request, the service expects a JSON Object with the following attributes:
{
"CustomerID": "CGS1234",
"ContainerName": "LatestOffer",
"Channel": "Web"
}
Service Response
For the response, the service returns a JSON object with the following attributes:
l OffersList - An array containing one or more Offers. Each Offer in this array has the following
attributes:
OfferID – Name of the Offer rule
InteractionID – Interaction History record identifier for this Offer. This will be same for all the
Offers in the list since they are all part of the same Strategy execution.
In case of an error, the response object instead contains the following two fields:
{
"Status": "OK",
"CustomerID": "CGS1234",
"ContainerName": "LatestOffer",
"Channel": "Web",
"Direction": "Inbound",
"OffersList": [{
"OfferID": "PremierRewardsCard",
"Issue": "DemoIssue",
"Group": "DemoGroup",
"CampaignID": "P-3344",
"OfferName": "Premier Rewards Card",
"ImageURL": "ad-imgs/PremierRewardsSmall.jpg",
"InteractionID": "-5352764169004433549",
"ClickThroughURL":
"<yourmktserver>:<port>/prweb/PRHTTPService/PegaMKTContainer/Services
/CaptureClickThrough?Px=<encryptedurlstring>"
}]
}
ExecuteMobileContainer
ExecuteMobileContainer is a REST service that supports the POST HTTP method. This service allows
callers to trigger a Real-Time Container from a mobile application.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/Services/ExecuteMobileCont
ainer
Service Request
For the request, the service expects a JSON Object with the following attributes:
{
"CustomerID": "CGS1234",
"ContainerName": "LatestOffer",
"Intent": "Retention",
"AdvertisingID": "M3445432"
}
Service Response
The response from this service is identical to that from the ExecuteContainer service, with the
following exceptions:
ExecuteWebContainer
ExecuteWebContainer is a REST service that supports the POST HTTP method. This service allows
callers to trigger a Real-Time Container for the Web channel.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/Services/ExecuteWebContai
ner
Service Request
For the request, the service expects a JSON Object with the following attributes:
{
"CustomerID": "CGS1234",
"ContainerName": "LatestOffer",
"CurrentPage": "ViewOffers",
"PreviousPage": "SignOut"
}
Service Response
The response from this service is identical to that from the ExecuteContainer service, with the
following exceptions:
2. Copy the TransformSROutput Data Transform rule into the implementation ruleset.
3. In the Pages & Classes tab of this rule, update the Class for the PublicComponent.pxResults
entry to be the implementation layer's SR class.
4. In the Definition tab of this rule, add mappings for the properties to include in the JSON
response.
CaptureMobileImpression
CaptureMobileImpression is a REST service that supports the POST HTTP method. This service allows
callers to capture impressions for a list of Offers on the Mobile channel. This service is typically
invoked when the Container’s automatic impression capture setting is disabled.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/Services/CaptureMobileImpr
ession
Service Request
For the request, this service expects a JSON Object with the following attributes:
l OffersList – An array of Offers for which to capture impressions. Each Offer should have the
following attributes:
OfferID – Name of the Offer rule
{
"CustomerID": "CGS1234",
"ContainerName": "LatestOffer",
"OffersList":[{
"OfferID": "PremierRewardsCard",
"Issue": "DemoIssue",
"Group": "DemoGroup"
"CampaignID": "P-3344",
"InteractionID": "-5352764169004433549"
}]
}
The captured impression will automatically be associated with the "Mobile" channel and the
"Inbound" direction.
Service Response
For the response, this service returns a JSON Object which contains the following attributes:
CaptureWebImpression
CaptureWebImpression is a REST service that supports the POST HTTP method. This service allows
callers to capture impressions for a list of Offers on the Web channel. This service is typically invoked
when the Container’s automatic impression capture setting is disabled.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/Services/CaptureWebImpres
sion
Service Request
For the request, this service expects a JSON Object with the following attributes:
l OffersList – An array of Offers for which to capture impressions. Each Offer should have the
following attributes:
{
"CustomerID": "CGS1234",
"ContainerName": "LatestOffer",
"OffersList":[{
"OfferID": "PremierRewardsCard",
"Issue": "DemoIssue",
"Group": "DemoGroup",
"CampaignID": "P-3344",
"InteractionID": "-5352764169004433549"
}]
}
The captured impression will automatically be associated with the "Web" channel and the "Inbound"
direction.
Service Response
For the response, this service returns a JSON Object which contains the following attributes:
CaptureClickThrough
CaptureClickThrough is an HTTP service that allows callers to request the handling of a click on the
Container for a generic channel. This service records a click in IH before redirecting to the requested
URL. Based on the Container’s configuration, this service may also initiate the specified Offer for the
customer.
To invoke this service, callers must use the ClickThroughURL that was returned for the Offer by the
ExecuteContainer API.
http://<yourmktserver>:<port>/prweb/PRHTTPService/PegaMKTContainer/Services/Capture
ClickThrough?Px=<encryptedurlstring>"
CaptureMobileClickThrough
CaptureMobileClickThrough is an HTTP service that allows callers to request the handling of a click on
the Container for the Mobile channel. This service records a click in IH before redirecting to the
requested URL. Based on the Container’s configuration, this service may also initiate the specified
Offer for the customer.
To invoke this service, callers must use the ClickThroughURL that was returned for the Offer by the
ExecuteMobileContainer API.
http://<yourmktserver>:<port>/prweb/PRHTTPService/PegaMKTContainer/Services/Capture
MobileClickThrough?Px=<encryptedurlstring>"
CaptureWebClickThrough
CaptureWebClickThrough is an HTTP service that allows callers to request the handling of a click on
the Container for the Web channel. This service records a click in IH before redirecting to the
requested URL. Based on the Container’s configuration, this service may also initiate the specified
Offer for the customer.
To invoke this service, callers must use the ClickThroughURL that was returned for the Offer by the
ExecuteWebContainer API.
http://<yourmktserver>:<port>/prweb/PRHTTPService/PegaMKTContainer/Services/Capture
WebClickThrough?Px=<encryptedurlstring>"
CaptureResponse (Legacy)
CaptureResponse is a REST service that supports the POST HTTP method. This service allows callers
to capture responses to Offers triggered via Real-Time Containers.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/Services/CaptureResponse
Service Request
For the request, the service expects a JSON Object with the following attributes:
l OffersList – Array of Offers for which to capture responses. Each Offer in this list should have the
following attributes:
OfferID – Name of the Offer rule
Outcome - Response to record for this Offer (e.g. Accepted, Rejected, Impression, etc.)
Behaviour - Predefined behavior for the specified outcome (e.g. Positive, Negative, Neutral,
etc.)
{
"CustomerID" : "CGS1234",
"ContainerID" : "LatestOffer",
"OffersList": [{
"OfferID": "PremierRewardsCard",
"Issue": "DemoIssue",
"Group": "DemoGroup",
"CampaignID": "P-3344",
"InteractionID" : "-5352764169004433549",
"Outcome" : "Accepted",
"Behaviour" : "Positive"
"Channel" : "Web",
"Direction" : "Inbound"
}]
}
Service Response
For the response, the service returns a JSON Object with the following attributes:
CaptureWebResponse
CaptureWebResponse is a REST service that supports the POST HTTP method. This service allows
callers to capture responses to Offers triggered via Real-Time Containers for the Web channel.
http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/Services/CaptureWebRespo
nse
This service is a specialization of the legacy CaptureResponse service. It defaults the Channel to "Web"
and the Direction to "Inbound" for each Offer.
This script includes a service controller object which has methods that invoke the various Container
APIs.
4. Initialize the service controller object using one of the following mechanisms.
b. Invoke the initialize method on the service controller after instantiating it. For example:
nbamServiceCtrl.initialize(window.location.hostname,
window.location.port);
5. Invoke the desired API using the corresponding service controller method.
The following snippet shows an example invocation of the ExecuteWebContainer API to get the list
of Offers to display in the Container:
l The OOTB base prospect class is PegaMKT-Data-Prospect. This class has direct inheritance to the
base customer class (PegaMKT-Data-Customer). This class ships with a set of defined external
mappings associating standard properties with column names.
l The base prospect class can be used (without customizations) if the prospect lists to be imported
will obey the shipped structure.
l If a different structure is expected for the prospect class, a custom prospect class should be
created. This class should have the following inheritance configurations:
Pattern inheritances from custom customer class (or base customer class, if customer class
hasn't been customized)
l All prospects (upon import) will be stored in one table. The set of columns for this table should be
the superset of all properties present in the prospect lists to import.
l If a custom prospect class is used, the ProspectTemplate xlsx binary file in the system should be
overtaken in the application's customization ruleset. This file should be updated to represent the
format of the expected prospect list. Use the shipped version of this file as a template and
add/remove columns following the established patterns. Provide this template to marketing users
to use as a template for their prospect lists. The placeholder row should be replaced by data rows
in an actual prospect list.
l If a custom prospect class is used, copy the following rules into the extended prospect class.
Prospect Data Set
This page lists the prospect lists that have already been imported into the system, along with their
tags, row counts, and status. The Open action (in the Actions menu) can be used to view the import
work object.
To import a new prospect list, Use the New button on the landing page. Clicking this button will
initiate a new Prospect Import work object, as shown below:
Specify a unique name for the prospect list. Users can also specify a tag to apply to each prospect
imported from the list. Tags can be used to group prospects imported from different prospect lists.
Select the location of the prospect list xlsx file.
Next, select between the following options for determining the unique id of the prospect:
Select this option to have the system generate the unique id for the prospect. The id will be a
concatenation of the list name and a uniquely generated string.
Select this option to denote one of the fields in the prospect list spreadsheet as the unique field.
Select this unique field from the list of available fields.
After configuring the necessary fields, click the Create button to proceed to the summary stage. Use
the Refresh action from the Other actions menu to periodically check the status of the prospect
import. This information is also available on the Prospect Lists landing page. The number of prospect
entries created and errors detected are displayed along with details of the invalid rows.
Use the See Prospect Data link to view a report containing information about the prospect data
that was imported. A sample report is shown below:
Prospect Segments
Upon importing a prospect list, the system automatically creates a top-level Segment rule and its
backing infrastructure. Before this Segment can be used, the user needs to execute the Segment.
The user can also create new Segments against prospects in the system. To create a prospect-based
Segment, select Prospect as the segment subject on the Segment new form.
To target prospects from a specific prospect list, optionally specify the prospect list name on the
Segment new form.
Click Create and open to launch the Segment rule form. If a prospect list was specified, the system
automatically generates the necessary criteria for this in the first criteria tab. Users can specify
desired criteria and interact with the Segment form, as they would with customer-based Segments.
There are two exceptions to the criteria options available:
l Analytical criteria (both modeled and static) are not available for prospect-based Segments.
l The data fields that are available as criteria are those that are defined on the prospect class.
Execute the Segment via the Run button to populate it. After population, the total prospect count and
the count of prospects in the Segment are shown. Use the Show Prospects button to view data for
the selected prospects.
Additionally, the tooltip on the Segment entry in the Decisions explorer denotes when a Segment is
prospect-based.
When selecting the Campaign's audience, the user must select a prospect-based Segment. For the
Campaign's marketing strategy, the user can select a Strategy rule defined in either the prospect or
the customer class.
Other setup remains the same when targeting prospects via Campaigns. If the Offers that are being
propagated contain email or SMS delivery, the user must ensure that the appropriate delivery
address fields (e.g. pyEmail1 for Email, pyMobilePhone for SMS) are populated on the prospect data
in the system.
Each seed represents a make-believe customer and all applicable customer attributes can be
specified for a seed. Multiple lists, each containing their own seed data, can be created and managed
within the marketing application. These lists can be used to test the following capabilities:
l Campaign execution
l Offer execution
Each of these modes of testing is explained in the chapter pertaining to the entity being tested (e.g.
Campaigns, Offers, etc.).
Seed Lists are listed under the Seed Lists landing page, which is accessible in the Pega Marketing
portal via: Configuration > Segmentation > Seed Lists
The following actions are available on the Seed Lists landing page:
l Create – Create a new Seed List. See Creating a new Seed List.
In addition, the Update Seed List Columns operation is available in the Manage Data
Relationships tab of the Application Settings landing page. See Updating Seed List Columns for
details.
Click Submit to create the Seed List. At this point, the backing structure of the Seed List is created.
The landing page grid should refresh and display the newly created Seed List. The row count column
for the new Seed List will initially be 0.
This editor displays all entries (seeds) as rows in the Seed List. The columns of the Seed List are made
up of the columns from the customer table.
To.. Do…
Add a new seed Click the add icon. Fill in all necessary fields and click anywhere outside the input row to
save the record. To cancel your changes and discard the new record, click the delete icon
at the right end of the row.
Modify an existing seed Click anywhere in the desired row. The row should toggle to editable mode. After making
the desired changes, click anywhere outside the row to save your changes.
Delete an existing seed Click the delete icon at the right end of the row.
Upon clicking this button, the backing Seed List structure will be synchronized with the customer
class.
This task should typically be performed by the administrator and will impact all existing Seed Lists.
This task should be performed in the following scenarios:
l When attributes are added to (or removed from) the customer class and these changes need to be
reflected in the seed data
The administrator can also use the Seed List Definition link to view the current Seed List structure.
Clicking this link opens the SeedListPopulationRD Report Definition, which represents the structure
utilized by the Seed List editor. If desired, administrators can directly modify this Report Definition to
update the columns visible in the Seed List editor. However, any manual updates to this Report
Definition will be overwritten when the Update Seed List Columns button is used on the landing
page.
The implementation of the exclusion list functionality utilizes the Segment rule. This enables
marketers to use the power of segmentation to build a global list of customers to exclude from
outbound communication. When a global exclusion list is specified in the system, outbound
processing evaluates target recipients against the exclusion list and ignores those recipients that are
in the exclusion list.
Exclusion list membership is checked during offer initiation and wait expiration in outbound paths.
These include the following:
l Outbound Campaigns
l Field Campaigns
The exclusion list Segment can be any customer-based Segment in the system. Marketers can utilize
the rich feature set of the Segment functionality to construct the exclusion list Segment. Furthermore,
the scheduling capability of Segments provides marketers with the ability to keep their exclusion list
up to date.
A sample exclusion list Segment configuration is shown below. In this example, the exclusion list
contains all customers that have either opted out or have had bounce backs.
To disable the exclusion list feature, the administrator simply needs to clear out the aforementioned
configuration setting.
Note: Whenever a change is made to the exclusion list configuration setting, all event-based
Campaigns need to be suspended and re-submitted for execution.
Multi-Channel Campaigns
For Multi-Channel Campaigns, the ignore exclusion list option is available in the Plan tab when the
audience type is customer.
Outbound Campaigns
For Outbound Campaigns, the ignore exclusion list option is available in the Campaign details
section.
Field Campaigns
For Field Campaigns, the ignore exclusion list option is available in the Field Marketing Details
section of the Campaign's backing Offer Template.
The Checklists widget displays existing Checklists in the system. Users wishing to utilize Checklists
should add this widget to their home page. The Create link in this widget enables users to create
new Checklists. Checklists can be stored at the top level or can be categorized into Issues and Groups.
A new Checklist starts out with input fields where basic information about the Checklist can be
entered, as shown below:
Note: The Checklist name must be unique across the system. Unlike some of the other rules (such
as Offer), the same Checklist name can’t be used at different hierarchical levels.
Note: Checklists associated with Offers can be seen in the Checklists tab on the Offer rule, while
those associated with Multi-Channel Campaigns can be seen in the overview pane in the Campaign
display.
Checklist Display
Clicking Create after entering the information above creates the Checklist work object and switches
to the Checklist work object display, as shown below:
l Checklist Header
l Tasks Panel
l Links Panel
Checklist Header
The Checklist header displays the following information about the Checklist:
l Name
l Work ID
l Status
l Button Strip – Contains buttons for the actions that can be performed on the Checklist, including:
Save As - Create a copy of this Checklist.
Other actions - View a list of available actions that can be taken on the Checklist at the
current point of time.
The Checklist Details panel displays the following information about the Checklist:
l Description
l Owner
l Percent Complete - Completion percent of this Checklist which is calculated by averaging the
completion percent of the child Tasks.
l Issue
l Group
l Start Date
l Due Date
Tasks Panel
The Tasks panel lists the various tasks that have been added to this Checklist. It also provides a
mechanism for adding new tasks. Individual tasks can be acted upon directly from the Tasks panel by
utilizing the Actions menu on the individual Task. The Tasks panel also supports performing actions
on multiple tasks via the Actions for Selected Tasks menu.
Links Panel
The Links panel contains various useful links, including the following:
l History - View a historical record of the various actions that have been performed on this
Checklist.
l Follow - (For managers) Mark this Checklist as an item to follow. Followed items are displayed in
the “Following” list in the Case Manager portal.
l Unfollow - (For managers) Remove this Checklist from the list of followed items.
l Tags - Manage the tags associated with this Checklist. Managers can directly search for work
objects by tags in the Case Manager portal by selecting the “Matching Tags” link in the search
results pane.
l Start Checklist - Start working on this Checklist. This item is only shown for new Checklists.
l Reopen Checklist - Reopen a Checklist. This item is only shown for completed or withdrawn
Checklists.
Start Checklist
This action is available directly in the Links panel for new Checklists. Performing this action marks the
Checklist as being “In Progress”.
Add Tasks
This action enables the user to add Tasks to the Checklist. Tasks are added by using the add button
at the bottom. All pertinent information for the Task (such as name, start date, due date, effort,
etc.) can be specified in the Update Task modal window.
Complete Checklist
This action enables the user to mark a Checklist as being completed. The user can enter a completion
note and choose whether this note gets shown in the Pega Pulse panel in the Checklist Display.
Note: Completing a Checklist doesn’t complete the individual Tasks on the Checklist. Typically, this
action should be taken when all Tasks in the Checklist have been completed.
Withdraw Checklist
This action enables the user to mark a Checklist as being withdrawn. The user can enter a note and
choose whether this note gets shown in the Pega Pulse panel in the Checklist Display.
Note: Withdrawing a Checklist doesn’t withdraw the individual Tasks on the Checklist.
Reopen Checklist
This action is available directly in the Links panel for Checklists that have either been completed or
withdrawn.
Task Display
The Task display can be accessed in the following ways:
l By clicking the link on the Task name in the Tasks panel on the Checklist display.
l By opening Tasks that are assigned to you from your work list.
l Task Header
l Links Panel
Task Header
The Task header displays the following information about the Task:
l Name
l Work ID
l Status
l Button Strip - Contains buttons for the actions that can be performed on the Task, including:
Other actions - View a list of available actions that can be taken on the Task at the current
point of time.
The Task Details panel displays the displays the following information about the Task:
l Description
l Owner
l Percent Complete
l Start Date
l Due Date
l Issue
l Group
l Estimated Effort
l Actual Effort
l Remaining Effort
Links Panel
The Links panel contains various useful links, including the following:
l History - View a historical record of the various actions that have been performed on this Task.
l Follow - (For managers) Mark this Task as an item to follow. Followed items are displayed in the
“Following” list in the Case Manager portal.
l Unfollow - (For managers) Remove this Task from the list of followed items.
l Tags - Manage the tags associated with this Task. Managers can directly search for work objects
by tags in the Case Manager portal by selecting the “Matching Tags” link in the search results pane.
l Start Task - Start working on this Task. This item is only shown for new Tasks.
l Reopen Task - Reopen a Task. This item is only shown for completed or withdrawn Tasks.
l Directly from the Task display. While performing an action in this mode, it is possible to switch to
a different action (if it’s currently available) via the Other actions button.
l From the Actions menu on a particular task in the Tasks panel in the Checklist display.
Start Task
This action is available directly in the Links panel for new Tasks. Performing this action marks the
Task as being “In Progress”.
Update Task
This action enables the user to update Task details.
Complete Task
This action enables the user to mark a Task as being completed. The user can enter a completion note
and choose whether this note gets added to the Pega Pulse feed. Performing this action on a Task
resets the remaining effort on the Task to zero.
Withdraw Task
This action enables the user to mark a Task as being withdrawn. The user can enter a note and
choose whether this note gets added to the Pega Pulse feed. Withdrawn Tasks no longer appear in
the Tasks Panel of the parent Checklist and also do not factor into the Checklist’s completion
percentage.
Reopen Task
This action is available directly in the Links panel for Tasks that have either been completed or
withdrawn.
l Default: System-wide default account for sending emails. This account is also the default account
for sending Email and Passbook Treatments in Offers.
Administrators should configure both these accounts appropriately to ensure proper delivery of
emails to both users and customers. To edit the account details inline, use the edit icon on the
account row. To view or update other account details (not shown in the inline edit), use the link in the
Account Name column to open the account’s data record.
In addition to these two accounts, other accounts can be created via the Add new link on the landing
page. These accounts can then be referenced as the delivery account in the Send Email, Send
Passbook, and Send Multi shapes in an Offer.
Refer to Specifying Delivery Time Frames for details on configuring availability options for the
account.
l Default: This is the default account for sending SMS Treatments in Offers.
Administrators should configure this account appropriately to ensure proper delivery of SMS
messages. To edit the account details, use the Edit link on the account row. To test the account, use
the Test link in the Connection column.
In addition to the Default account, other accounts can be created via the Add new connection
button on the landing page. These accounts can then be referenced as the SMS delivery account in
the Send SMS and Send Multi shapes in an Offer.
An outbound SMS account configuration is split into the following three tabs:
l Setup - The Setup tab is used to configure basic information about the SMS account, such as
name, address, port, etc.
Refer to Specifying Delivery Time Frames for details on configuring availability options for the
account.
l Advanced - The Advanced tab can be used to configure advanced account settings, such as
response timeout, character encoding, and reconnect options.
l Additional settings - The Additional settings tab enables the administrator to directly specify
additional SMPP configuration settings as name-value pairs. This provides a mechanism to set
SMPP properties which are not exposed in the Setup and Advanced tabs.
Delivery time frames are configured in the Account Availability section of the Outbound Email
and SMS account details dialog.
l Always Available - This implies that this account is always available to deliver messages.
l Specify Range - This implies that this account will only deliver messages during the specified time
range. The following values need to be specified with this option:
From - Start value for the time range
Time Zone - Time zone for the start and end time values. This is defaulted to the current user’s
default time zone.
A sample configuration for the Specify Range availability option is shown below:
The Inbound tab on the SMS landing page lists the various inbound SMS accounts that are
configured in the system. This landing page is accessible in the Pega Marketing portal via:
Configuration > Settings > Channels > SMS
Use the Add new connection button on the landing page to create a new inbound SMS account.
Clicking this button opens the connection configuration modal window. This modal is split into three
tabs: Connection setup, Additional settings, and Response behaviors.
After creating an account, use the toggle control in the Running column to start and stop the
account. The Connection status column indicates the current status of the account.
Connection setup
This tab is used to specify the connection details for the inbound SMS account. This includes the
following settings:
Field Description
Account name Unique name for the Inbound SMS account
Additional settings
This tab enables the administrator to directly specify additional configuration settings as name-value
pairs. This provides a mechanism to set SMSC properties which are not exposed in the Connection
setup tab.
Response behaviors
This tab is used to specify how the application should process inbound SMS messages that are
received by this inbound SMS account.
Perform the following steps to configure the response behaviors for the account:
1. Select and configure the mechanism for matching received messages to responses. Choose from
the following options:
l One response
l Decision table
One response
Select this option to assign one response for all inbound SMS messages that are received for the
inbox specified in the connection tab. For this option, use the Responses for inbound messages
section to specify the single response value and the Offer to associate with the response.
Decision table
Select this option for advanced response handling configuration. This option allows for the
configuration of one or more decision tables to associate the inbound message received with a
response value. Furthermore, each result from the decision table can be associated with an individual
offer (if desired).
Use the Manage decision tables section to specify desired configuration options.
l One offer – Select this option if all messages received on this inbox should be associated to a
single Offer. In this case, specify the Offer. This Offer name will be listed as the Offer for all result
entries in the decision table grid.
l Individual offers – Select this option if this inbox is used for receiving responses to multiple Offers.
In this case, specify each Offer name alongside the response value in the decision table grid.
Then, add and configure your decision tables. To add a new decision table, enter or select it from the
list of available decision tables and click Add decision table. The newly added decision table
should display in the decision table grid. Expand the decision table node in the grid to see the results
returned by the decision table. Associate each result with a response value and, if applicable, an Offer
name.
Multiple decision tables can be added to the grid in a similar fashion. When an inbound message is
received, the decision tables will be evaluated in sequential order until a result value is successfully
determined.
Note: For a decision table to be visible to the application, it should be created in the PegaMKT-
Work-Offer class.
In order to properly determine the appropriate Offer and response values for an inbound message,
both message and customer data are made available for use in the decision tables.
Customer data can be accessed directly via the .Customer page property under the Offer class.
Inbound message data is made available under the .InboundResponseData.SMS page property under
the Offer class. This page includes properties for the incoming number (.SourceNumber) and the
message content (.MessageBody).
Note: If multiple decision tables are to be used, do not specify a return value for the otherwise
clause in the decision tables. This will allow for processing to move on to evaluating the next
decision table in the list.
l Push it to a workbasket – Select this option to prevent customers from responding to Offers that
have not been initiated for them. If this option is selected and a response is received from a
customer for an Offer that is not active for the customer, the response is treated as an error and
moved to the UnhandledInboundSMS work basket for further processing. This workbasket is
accessible to marketing managers via the Case Manager portal.
l Start the Offer for the customer – Select this option to initiate a new Offer for the customer if they
respond to an Offer that is not active for them.
Pega Marketing currently provides support for sending push notifications to apps running on the
following platforms:
Refer to the above links for more details on each of these services.
The following table lists the various roles involved in the push notification process along with their
responsibilities:
Setting Purpose
Name Name of the app. This is how the app will be referred within the marketing application (e.g. in Offer flows).
Description Description of the app
Platform Platform on which this app is available. Choose between Android and iOS.
Unique ID Unique identifier for this app. This ID is used for validating push notification service requests, such as those
for registering and un-registering app users. See Push Notification User Registration Services for details.
Setting Purpose
Google Google key for this app. This value should be provided by the app developer and is required for using the GCM
Key service.
Setting Purpose
App Apple .p12 certificate for this app. Use the Choose File button to locate the certificate.
Certificate
Certificate Name to use for storing the certificate in the system
Name
Certificate Password associated with the certificate. The system will validate this password and will not upload the
Password certificate in case the password is invalid.
Certificate Type of certificate. Select either Production or Development.
Type
Monitor Apple provides a feedback service which can be used to detect failed push notification message delivery when
Apple’s the user has uninstalled the app from their iOS device. Pega Marketing ships with an agent that periodically
notification polls the APNs feedback service to detect these errors. If any delivery errors are reported by the feedback
feedback service, the system un-registers the associated device registrations (as recommended by Apple), thereby
service? preventing future deliveries.
Choose Yes to enable the system to monitor the feedback service for this app. When this option is selected,
erroneous devices will automatically be un-registered from the marketing system.
Alternately, choose No to monitor the feedback service via an external system or mechanism. In this case, the
external mechanism should invoke the un-registration service to un-register push tokens that are no longer
valid.
Refer to the following link for details on the APNs feedback service:
https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsP
G
/Chapters/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW3
Click Submit to create the new app and the associated platform variant.
The configured variants for an app can be viewed via the expand pane icon, located to the left of the
app name.
Use the Make Default action from the Actions menu to mark an application as the default.
Use the Test action from the Actions menu for an app variant to launch the test variant dialog.
Provide a value for Test Push Token and click the Test button to send the test push notification
message. A push token uniquely identifies the installation of an app on a particular device. The app
developer should be able to provide you with the push token associated with the test device.
The system displays the status of the test message in the Test Result field.
The test message is delivered (as a push notification) to the app on the test device. The following
image shows the test notification, as received for a sample app running on the Android platform:
Note: The Remove action is disabled on a variant once app users have been registered to receive
notifications for it.
General Configuration
The following general configuration options are available in the General section of the properties
panel for this shape:
Name Purpose
Message Notification message to push to the customer’s registered device(s). This can be plain text or an expression.
Play Associate sound with the notification message. If this setting is enabled, the message payload references the
Sound? default sound. When the message is received by the device, the device-specific default sound for notifications (if
enabled) is played.
Key Marketing code to identify the shape. This value can be passed to the device along with the notification message
Code (as additional values).
Application Configuration
The following settings are available in the Application Configuration section of the properties
panel for this shape:
Name Purpose
Default Determines whether the notification message should be pushed for the default app.
Application
Other Determines whether the notification message should be pushed for the specified app. Select the app to
Application notify from the drop-down of configured apps.
Name Purpose
Wait Determines whether Offer flow execution should wait after pushing the notification message.
When this is enabled, the user can specify the duration for the wait by setting the properties
below appropriately.
Days Number of days to wait
Business Determines whether the wait duration should be in terms of business days or regular week days.
Days?
Hours Number of hours to wait
Minutes Number of minutes to wait
Seconds Number of seconds to wait
Enable the Send Additional Values? checkbox (in the Additional Details section of the
properties panel) to pass additional values. Use the grid controls to add fields. For each field, specify
a name and value. The name must be plain text, but the value can be an expression. The key code
can also be passed as an additional field (as shown in the example below).
Set Badge
The Set Badge? option (in the Additional Details section of the properties panel) allows users to
set a numeric badge value along with the notification message. This value only has an impact if it's
supported by the app platform. For example, in iOS, the badge value is shown as a number on the
app's icon. The Badge Value field can either be a static number or a numeric expression.
l Registration Service
l Un-registration Service
Registration Service
The registration service is a REST service that supports the POST HTTP method. The URL for this
service is:
http://<host>:<port>/prweb/PRRestService/PushNotification/Registration/Register
For the request, this service expects a JSON object having the following structure:
{
"AppVariantID":"<AppVariantID>",
"PushToken":"<PushToken>",
"UserID":"<UserID>"
}
l AppVariantID - Unique ID for the app variant configured in the system. This is specified when
the app variant is created in the system and is used as a means for validating genuine requests.
l PushToken - Token assigned by the platform messaging service that is used for pushing
notification messages for the selected app on the selected device.
l UserID - ID associating the app user with a customer in the system. In the out-of-the-box
implementation, the expected value for this field is the CustomerID property. Custom
implementations can override the mechanism by which this field is associated to a customer in
the system.
For the response, this service sets the appropriate HTTP status code. In case of errors, an appropriate
message is also returned as part of the error stream.
Un-registration Service
The un-registration service is a REST service that supports the POST HTTP method. The URL for this
service is:
http://<host>:<port>/prweb/PRRestService/PushNotification/Registration/Unregister
For the request, this service expects a JSON object having the following structure:
{
"AppVariantID":"<AppVariantID>",
"PushToken":"<PushToken>"
}
l AppVariantID - Unique ID for the app variant configured in the system. This is specified when
the app variant is created in the system and is used as a means for validating genuine requests.
l PushToken - Token assigned by the platform messaging service that is used for pushing
notification messages for the selected app on the selected device.
For the response, this service sets the appropriate HTTP status code. In case of errors, an appropriate
message is also returned as part of the error stream.
Note: Un-registering a push token removes the push token registration from the system. The Data-
PushNotification-Delivery-Registration.PreRegistrationDelete activity is provided as an extension
point for custom implementations. This activity can be used to insert desired behavior before the
registration entry is deleted. This activity can also be used to bypass the deletion process. For more
details, refer to the usage guidelines specified in this activity.
Marketing Profile is accessible in the Pega Marketing portal via: Reports > Customer Profile
When initially launched, the Marketing Profile simply contains a search box. Users can use this box to
search for the desired customer either by the customer’s name or ID. Upon searching, the system
presents a list of matching customers. Users can select the desired customer from this list to view
that customer’s profile.
Note: Marketing Profile can also be used to search for and review anonymous customers. Refer to
the Identity Matching and Marketing Profile section in the Identity Matching chapter for details.
Profile Elements
This section outlines the various elements of a customer’s Marketing Profile. This includes the
following:
l Customer Details
l Customer Dimensions
l Customer Demographics
l Propensity Scores
l Engagement History
Customer Details
This section provides basic information about the customer such as their name, image, gender,
address, and email.
In addition to basic information, this section also presents a view of the customer’s segmentation, i.e.
the Segments to which this customer belongs. In our example, the customer is a member of five
different Segments.
The customer segmentation view provides the user with a quick insight into the customer’s
categorization. This information can be useful when determining how to appeal to a particular
customer.
Note: The Segments list for a customer does not display virtual Segments.
Customer Dimensions
This section provides the user with a visual overview of the customer’s performance across various
dimensions including Lifetime Value, Churn Risk and Credit Risk.
The scores on each of these dimensions are visually indicated and are also classified into high (H),
medium (M), and low (L).
In addition, the recommended next best action for this customer is also displayed.
Customer Demographics
This section displays basic information about the customer. This information is further categorized
into:
Propensity Scores
This section displays the customer’s propensity scores for the top three Offers for the customer.
Propensity is the likelihood that the customer will accept the Offer.
Engagement History
This section presents an overview of the customer’s engagement with the organization. The top of
this section contains a visual breakdown of this engagement, in terms of customer interactions,
impressions, and the Offers taken by the customer.
In addition, the interactions count is further broken down into the various communication channels
(such as Email, Web, etc.), as shown below:
Finally, this section also presents a summary of the customer’s engagement. This information is
displayed in a chronological order, with the most recent engagement at the top. For each
engagement, the icon on the timeline indicates the channel of communication. Additionally, if the
engagement resulted in an impression or the Offer being taken, this is indicated via the appropriate
colored dot next to the interaction date.
Users can utilize the calendar icon to specify a different time period for the timeline.
Furthermore, users can click the engagement circles to filter the timeline to the specific engagement
type (e.g. Impression or Offer Taken).
Perform the following steps if you already have a Next-Best-Action type strategy:
Otherwise if you don’t have a Next-Best-Action type strategy, perform the following:
3. Implement your Next-Best-Action logic, arbitrating across the business issues you plan to
implement (i.e. Sales, Retention, Servicing, etc.)
Perform the following steps if you already have a Next-Best-Offer type strategy:
Otherwise if you don’t have a Next-Best-Offer type strategy, perform the following:
3. Implement your Next-Best-Offer logic, arbitrating across the various types of Offers you plan to
make
3. Re-map the MKTProfileDecisionResults component to point to your existing CLV and Risk strategy
Marketers (with suitable permissions) can launch this landing page via the Manage Data link for a
particular entity (e.g. customer or prospect) on the Manage Data Relationships tab of the Application
Settings landing page.
Upon clicking this link, the Data Management landing page opens in the context of the launching
entity (e.g. customer). Marketers can utilize this landing page to perform the following actions:
l Import instances
l Export instances
When the landing page initially opens, it displays the Default view. This view displays all externally
mapped properties for the data type. In this view, the first column in the grid is the key property of
the data type. The Default view for the customer entity has an additional feature. Marketers can click
the link value in the first (key) column in the grid to open the Marketing Profile for the corresponding
customer.
Implementers of the application can define other views to use with their data types. Marketers can
see the list of available views in the drop-down above the header and can switch to a different view
by selecting it in the drop-down and clicking the View button.
Tip: Each view is backed by a Report Definition in the entity's data class. For a Report Definition to
be available as a data view, it must have a custom field defined with the field name set to
DataManagement and the value set to Views.
Marketers can also search for particular instances by specifying the desired text in the search input
field above the grid and clicking the magnifying glass icon. The system performs the search across all
columns in the current view and displays the results in the data grid.
l Add an instance - To add an instance, click the Add record link at the bottom of the grid. Fill in
all necessary fields and click anywhere outside the input row. To cancel your changes and discard
the new record, click the delete icon at the end of the row.
l Modify an instance - To modify an instance, click anywhere in the desired row. The row will
toggle to editable mode. After making the desired changes, click anywhere outside the row to save
the modified instance.
l Delete an instance - To delete an instance, click the delete icon at the end of the row.
Note: Access to add, modify, or delete data instances is managed by standard Pega Platform
security constructs. Administrators can utilize these constructs to grant or restrict access as needed.
Importing Instances
Marketers can utilize the import mechanism on the Data Management landing page to import
multiple instances using a comma-separated-values (CSV) file.
To initiate an import, click the Import link above the instances grid.
Note: The Import link is disabled if a data import is already in progress for the data type.
At a high level, the import process has the following three steps:
1. Upload CSV file and select one of the following import purposes:
a. Add or update - Use this option to create new records for those instances in the import file that
don't currently exist in the system, and to update records for those instances that do exist.
b. Add only - Use this option to only create new records for those instances in the import file that
don't currently exist in the system. Records for existing instances will not be updated.
c. Delete- Use this option to delete matching records from the system.
2. Map fields - Select the field to use for matching records and specify the mappings for all fields to
import.
3. Import records - Trigger the import process. Optionally, choose to save the specified field
mappings for subsequent imports.
Tip: The import process utilizes the Data Management functionality of the Pega Platform. Use the
help icon in the wizard to launch the Pega 7 Help topic for details on this process.
When importing large files, the import progress can take some time. Marketers can close the import
window and continue with other activities. The system displays the status of the import at the top of
the Data Management landing page. Once the import completes, the system displays the number of
instances that were added or updated by the import. If there were errors during the import, the
number of erroneous records is also shown.
Click the See more link to download a CSV file containing the records which failed to import. The last
column in this file contains a description of the error that occurred.
Note: Import functionality is not currently supported for prospect data from the Data Management
landing page. Users can import prospects from the Prospect Lists landing page. Refer to the
Prospects chapter for details.
Exporting Instances
Click the Export link above the instances grid in the Data Management landing page to export a CSV
file containing data instances represented by the currently selected view.
Revision Management enables marketing users to revision, package, and import marketing artifacts.
The DecisionManager:PegaMarketing role facilitates Revision Management in the Pega Marketing
portal. This role is automatically added to the RevisionManager and StrategyDesigner access groups
for overlays created for Pega Marketing applications.
Most marketing artifacts can be included and updated in revisions using the processes described in
the Revision Management guide. Revision managers can start a new Revision and create Change
Requests within the Revision. A Change Request can contain marketing rules and can be assigned to a
marketer. The My Work widget (shown below) and the Revision Management widget enable
marketers to view their assigned Change Requests.
This widget displays Change Requests that are assigned to the user and lists each rule within the
request. Users can click Edit to open the rule directly from the widget.
Users can directly open these rules from the grid shown above. Unlike other rule types, these rules
will need to be checked out before they can be updated. Once the rule has been updated, it should be
checked back in.
l Packaged directly
No special action is required to package these rules as they will be included in the revision package
which is generated upon completion of the Revision.
Packaged directly
Even when there isn't an active Revision, users can open and modify Segments and Samples. In such
a case, once all modified rules have been checked in, revision managers can utilize the Package
rules... button to package these rules directly from the Segmentation tab in the Revision
Management landing page.
Clicking this button automatically generates a Revision, completes it, and makes the revision package
available.
l Output Templates
l Segments
l Samples
l Volume Constraints
For such packages, the optional test phase of the import process must be skipped by enabling the
Skip test phase checkbox in the Review contents stage.
After the import is complete, the following actions are recommended for such packages:
l Review imported Volume Constraints and determine if any of the manually reset constraints
should be reset.
Note: For marketing rules that support scheduling (Segments, Samples, Analysis Projects, Output
Templates), the import process retains the schedule configuration (if configured) on the destination
environment.
When an individual is anonymous (e.g. not logged in), relevant information is captured during their
various interactions with the application. This information can then be utilized to determine the Next-
Best-Action for this individual. When the individual authenticates themselves as a customer, their
anonymous interaction data is merged with their previous interaction history. This allows the
marketing application to maintain a complete view of the customer journey.
l Email
l Microsites
l Real-Time Containers
Identity matching utilizes browser cookies to store identifying information. For individuals yet to be
identified, a unique id is stored in the cookie. Once an individual has been identified as a customer,
their (encrypted) customer id is stored. During the individual's interactions with the application,
additional data is collected and associated with the appropriate identifier (customer id or unique id).
The captured associations are specific to the functional area and are listed in the corresponding
section.
The following associations are captured when a customer opens a marketing email (handled by the
IMPR service):
l CustomerID ↔ UniqueID
l CustomerID ↔ IP Address
l UniqueID ↔ IP Address
The following associations are captured when a user clicks on a response link in a marketing email
(handled by the PORE service):
l CustomerID ↔ UniqueID
l CustomerID ↔ IP Address
l UniqueID ↔ IP Address
The following associations are captured during interactions with the Microsite:
l CustomerID ↔ UniqueID
1. Load Data - In addition to loading customer data, this stage also saves the aforementioned
association data. For example, if the browser cookie contains the unique id but the Microsite is
aware of the customer, this stage associates the unique id and the customer id. Additionally, the
cookie is updated with customer information.
2. Confirmation - In this stage, the Perform Identity Matching step associates available Microsite
attributes. For example, if the Microsite collects email information, this information is associated
Note: To perform identity matching during a different stage, include the Perform Identity Matching
step in that stage.
In addition to the above stages, identity matching also occurs in the following areas in Microsites:
l Launching another Microsite - When a Microsite launches (or redirects to) another Microsite,
identity matching attributes - such as customer id or unique id - are propagated to the new
Microsite.
Note: If the Perform Harness rule is specialized in the new Microsite class, ensure that the
IdentityMatchingConfiguration Section rule is included in this Harness. This section enables the
Internet Application Composer (IAC) gadget to update the browser cookie.
The following associations are captured during interactions with the Real-Time Container:
l CustomerID ↔ UniqueID
l CustomerID ↔ IP Address
Additionally, identity matching is implicitly performed by the following Real-Time Container services:
l ExecuteWebContainer
l CaptureWebImpression
l CaptureWebClickThrough
Note: To allow for the searching of anonymous users, the MKTProfileEnabled When rule must be
enabled (i.e. set to true).
The Marketing Profile search functionality provides an additional Search by UID checkbox to allow
for searching of anonymous users.
When this checkbox is unchecked, the search looks for existing customers based on their identifier
and name.
When this checkbox is checked, the search looks for anonymous customers using their unique
identifier.
Upon clicking the link for the anonymous customer, their interaction details are displayed.
At a later point, if the anonymous individual identifies themselves as a known customer, the
anonymous interaction details are merged with the customer's interaction history. Searching for the
anonymous individual (by their unique id) now reveals the identified customer in the search results.
Paid Media Manager is included in Pega Marketing 7.31. You can enable it with the appropriate
license on top of the Pega Marketing 7.31 license.
After Next-Best-Action adds customers to a Paid Media Audience, they are targeted with
corresponding advertisements at the specified priority. For example, a customer may be in a Paid
Media Audience for mortgage - high propensity and travel credit card – low propensity based on the
strategy results. The advertising campaigns that target each of these audiences are configured with
the appropriate advertising creative assets and the proper bidding threshold that is appropriate for
the given offer and priority.
l CRM Matching-based Destinations
l File-based Destinations
CRM Matching-based Destinations
Modern media platforms offer the ability to associate users to an audience by comparing a hashed
version of an email address or other personally identifiable information (PII) over a secure
connection. After an anonymous link is established, Paid Media Manager can add and remove
customers based on the offers that have been assigned to them by NBA in near real-time. These
updates can be triggered by scheduled runs, real-time container calls, or offer responses.
The primary benefit of this people-based approach is that Paid Media Audience updates for a
customer can be made outside of web-sessions and across devices. The main limitation is the need to
have PII that matches what a media platform may have, for example, an email address or a phone
number.
Paid Media Manager uses the Customer Relationship Matching matching APIs for Facebook Ads and
Google AdWords to synchronize Paid Media Audiences.
Notes: Paid Media Manager for Pega Marketing 7.31 uses Google AdWords API v201705 and
Facebook Marketing API v2.10 by default. Since both Facebook and Google periodically release new
versions of their API, make sure to install any API-related hotfixes available on the Pega Marketing
hotfixes page. Paid Media Manager API hotfixes are published before the relevant API enters its
sunset phase. For more information about the availability dates of each API, refer to Google
AdWords API and Facebook Marketing API documentation:
l Facebook Ads API: Changelog
For more information on targeting audiences via Facebook Ads and Google AdWords, refer to
Facebook Ads and Google AdWords documentation:
l Destination name
l Account ID
l App token
5. In the Field mapping section, map the Facebook API properties to Pega Marketing properties.
For example, you can map Email (EMAIL) to .pyEmail1. Mapping these properties will allow the
integration to match your existing customers to their Facebook accounts and target them with the
right ads on the right platform.
You can map the Email (EMAIL) and Phone (PHONE) Facebook API properties to multiple Pega
Marketing properties. In this way, you can specify multiple emails or phone numbers for each
customer and rank them in order of priority. Mapping multiple emails or phone numbers makes it
possible to generate higher match rates and reach more customers. At least one email or phone
mapping is required.
6. Optional: In the Field mapping section, use the Use External Id (EXTERN_ID) field to specify a
unique customer ID that can be used in place of hashed customer data for subsequent updates for
a given customer. This feature is enabled and set to use the customer class key from your
customer class by default. Keep in mind that disabling this setting will result in slower
synchronization with Facebook.
The property used as external ID is not hashed during synchronization with Facebook. If you want
to change it, select a property that can identify a customer uniquely without exposing their
internal data.
7. Optional: Configure the additional settings in the Facebook Ads assets generation section:
l All customers audience - This setting is enabled by default. While this setting is enabled,
after customers are placed in a Paid Audience, they are also added to an automatically
generated audience containing all next-best-action managed customers. To ensure that
customers who are placed in the All customers audience do not receive anonymously targeted
ads, negative target this audience on Facebook in all advertising campaigns that are not based
on next-best-action strategies. Customers who are present in the segment for the consecutive
outbound runs or real-time container updates will be removed from this audience. For more
information, refer to Facebook Ads documentation: Exclude specific audiences for better ad
results.
The default name for the All customers audience is Next-Best-Action managed. If you
disable or rename the All customers audience for a previously configured destination,
customers who are assigned to this audience will be removed from it.
l Enable campaign generation – Enable this setting if you want Paid Media Manager to
speed up campaign generation by automatically creating campaigns for each offer and ad
group with the following default settings:
AdSet name – The same as the name of the Paid Audience. The audience created on
Facebook will be associated with the AdSet.
isAutoBid – Enabled.
Automatically generated campaigns are created inactive. Review the campaign settings on the
Campaigns landing page, make any required changes and activate them manually.
8. Click Apply.
l Destination name
l Client ID
l Client secret
l Developer token
l Refresh token
l Client customer ID
5. In the Field mapping section, map the Google AdWords Email (EMAIL) property to a Pega
Marketing property, for example .pyEmail1. Mapping the emails will allow the integration to
match your existing customers to their Google accounts and target them with the right ads on the
right platform.
You can map the Email (EMAIL) Google AdWords property to multiple Pega Marketing
properties. In this way, you can specify multiple emails for each customer and rank them in order
of priority. Mapping multiple emails makes it possible to generate higher match rates and reach
more customers. At least one email mapping is required.
6. Optional: Configure the additional settings in the Google Adwords assets generation section:
l All customers audience - This setting is enabled by default. While this setting is enabled,
after customers are placed in a Paid Audience, they are also added to an automatically
generated audience containing all next-best-action managed customers. To ensure that
customers who are placed in the All customers audience do not receive anonymously targeted
ads, negative target this audience on Google AdWords in all advertising campaigns that are not
based on next-best-action strategies. Customers who are present in the segment for the
consecutive outbound runs or real-time container updates will be removed from this audience.
For more information, refer to Google AdWords documentation: Exclude specific audiences
from your targeting.
The default name for the All customers audience is Next-Best-Action managed. If you
disable or rename the All customers audience for a previously configured destination,
customers who are assigned to this audience will be removed from it.
l Enable campaign generation – Enable this setting if you want Paid Media Manager to
speed up campaign generation by automatically creating campaigns for each offer and ad
group with the following default settings:
AdSet name – The same as the name of the Paid Audience. The audience created in Google
AdWords will be associated with the AdSet.
isAutoBid – Enabled.
Automatically generated campaigns are created inactive. Review the campaign settings on the
Campaigns landing page, make any required changes and activate them manually.
7. Click Apply.
File-based Destinations
Some advertising technology platforms allow audiences to be updated in bulk based on transferred
files. Paid Media Manager supports this type of synchronization for Adobe Audience Manager. Use
Adobe Audience Manager to push Paid Media Audiences to one or more paid destinations, for
example, The Trade Desk, TubeMogul or DoubleClick Bid Manager.
The primary benefit of this approach is the ability to synchronize Paid Media Audiences across many
media platforms with a single integration. However, data management platforms such as Adobe
Audience Manager take 24 to 36 hours to sync Paid Media Audiences with downstream destinations.
For more information about building CRM-based audiences for paid destinations via Adobe Audience
Manager, see Adobe Inbound Customer Data Ingestion FAQ.
l Destination name
l DP ID
l Data source ID
l API password
l API client ID
5. In the Sync Configuration section, map the Adobe Audience Manager Sync ID property to a
Pega Marketing property that holds the value of the universally unique identifier (UUID) that
identifies the customer. The UUID property is implemented as part of the Adobe ID
synchronization and works as a synchronization key, allowing the integration to match your
existing customers to their accounts and target them with the right ads on the right platform.
l Full synchronization - Enable this setting if you want to send all Paid Media Audience
information to Adobe Audience Manager destinations every time that the synchronization runs.
Enabling full synchronization results in larger files being uploaded into Adobe Audience
Manager. This can slow the synchronization. This setting is not enabled by default. When full
synchronization is not enabled, the synchronization only sends information which has been
updated in Pega Marketing since the last synchronization date.
l All customers audience - This setting is enabled by default. While this setting is enabled,
after customers are placed in a Paid Audience, they are also added to an automatically
generated audience containing all next-best-action managed customers. To ensure that
customers who are placed in the All customers audience do not receive anonymously targeted
ads, negative target this audience in Adobe Audience Manager in all advertising campaigns that
are not based on next-best-action strategies. Customers who are present in the segment for the
consecutive outbound runs or real-time container updates will be removed from this audience.
The default name for the All customers audience is Next-Best-Action managed. If you
disable or rename the All customers audience for a previously configured destination,
customers assigned to this audience will be removed from it.
7. In the Delivery Configuration section, configure the location where Paid Media Manager sends
files with synchronization data to be uploaded into Adobe Audience Manager. Adobe Audience
Manager provides an FTP location or an Amazon S3 bucket for the files. For more information,
contact your Adobe Audience Manager implementation team.
8. Click Apply.
The primary benefit of this approach is the ability to update Paid Media Audiences in real-time
without a reliance on having shared personally identifiable information (PII). However, updates can
be made only while a customer is in a web session in a browser that allows access to third-party
cookies.
You can use a tag management solution such as Google Tag Manager or Adobe Dynamic Tag
Management instead of directly manipulating JavaScript. For more information on using Google Tag
Manager to send values to a remarketing tag, see Implement AdWords, Doubleclick, and
Dynamic Remarketing.
5. Click Apply.
6. Configure the web service call for this web destination. You can use the example service call as
your template, or enter your own code into the box.
7. Click Apply.
3. Click the business issue or group in which you want to enable paid audiences.
4. Click Edit.
5. In the Triggered by section, specify the trigger for the audience update:
l Real-time containers - If paid audiences and a real-time container are configured at any
level of the hierarchy, each real-time container call will result in a paid audience update. The
system makes a secondary call with direction as outbound and channel as paid. If you want to
configure the real-time container to use a broader range of offers than what is required for the
current page, see step 7. For more information on configuring real-time containers, see Real-
Time Containers.
Real-time containers are currently supported for Facebook Ads and Google AdWords
destinations.
l Outbound schedule - If you configure paid audiences and outbound runs at any level of the
hierarchy, each outbound run results in a paid audience update. If you configure paid
audiences at multiple levels of the hierarchy, the paid audiences are selected based on the
latest decision for each customer. For best results, configure a single paid outbound schedule at
the highest level of the hierarchy. For more information on configuring outbound campaigns,
see Outbound Campaigns.
6. In the Paid Media > Media strategy section, click Configure to select the media strategy. For
more information on configuring strategies, see Strategies.
7. In the Paid Media > Paid accounts section, click Configure to select one or more paid
destinations.
8. Optional: To execute the paid update from the highest level where you configured a paid real-time
container, click Paid Media > Paid accounts > Use Real-time container configured at
Next-Best-Action level. For example, if you configure a real-time container at the group level
and at the issue level above the group in the Next-Best-Action hierarchy, this setting executes the
real-time container at the issue level.
9. Click Save.
{ "CustomerID":"TestID31265",
"externalaudienceid":"90a6",
"AccountId" : "facebook_test_ac",
"ReferredUrl": "facebook.com",
"Source": "facebook",
"Utm_medium":"Banner Ad" ,
"AudienceID":"23842593604320755"}
The externalaudienceid must resolve to valid pyIssue, pyGroup, and pyName properties. The
Paid Media Audiences landing page displays the externalaudienceid for each audience in the
AUDIENCE KEY field. For more information, see Monitoring for Paid Media.
The audiences are grouped by offer. The top row contains the offer name and the number of
audiences created for this offer. The child rows contain audiences grouped by destination. The
following information is displayed for each audience:
l Platform icon
l Audience name
l Audience key
A spark line graph shows the trends of population and matched count over the last thirty days. To see
the audience count for a specific date, hover your mouse over a point on the spark line.
To access the Paid Media Audiences landing page, log in to the Pega Marketing portal and click
Audiences > Paid Media Audiences.
2. To review the ongoing outbound runs list, click the Batch processing tab.
3. To review the real-time container updates list, click the Real-time processing tab.
If an error occurs, confirm that your account in the integrated platform is properly configured and
activated, then resolve the error work object before triggering another paid run.
Errors displayed in the Next-Best-Action Designer come directly from the integrated external system.
If you cannot resolve the problem yourself, contact the product team for your advertising platform.
audience and are available for anonymously targeted campaigns on Facebook, Google, and Adobe
Audience Manager. The default is 1 day. Raise this value to keep customer records in the All
customers audience for a longer time.
Optional: Modify any of the following dynamic system settings for Adobe Audience Manager. For
more information, contact your Adobe Audience Manager implementation team.
Marketing-specific user preferences are listed in the Pega Marketing preferences section of the
Preferences dialog and include the following:
The Application Settings landing page is available only to marketing administrators and lists various
configuration options. This landing page is accessible in the Pega Marketing portal via:
Configuration > Settings > Application Settings
To change any of these settings, click the Edit button on the particular setting’s landing page. In edit
mode, click Save to save and apply your changes to the settings; or click Cancel to discard your
changes.
Note: These settings are stored in a node-level data page. Any changes made to these settings on a
particular node should be immediately visible to all processes running on that node. In a multi-node
environment, changes may take up to an hour to reflect across other nodes. In such situations, it is
advisable to manually flush the data page on each of the nodes after changing these settings. To do
so, open the Declare_MKTSystemSetting data page (under PegaMKT-System-Setting) and click the
Clear Data Page button on the Load Management tab.
Configuration Settings
This landing page contains settings pertaining to the overall execution infrastructure.
Note: Exercise extreme caution in toggling the Enable Partitioning and Use Decision Data
Source settings on a live system. These settings are propagated to and utilized in the creation of
Segment and Campaign execution data. Toggling these settings after creation of Segments or
execution of Campaigns might necessitate the re-creation of these artifacts.
Artifact Settings
This landing page contains settings pertaining to the behavior and display of artifacts.
Default Offer Email Specifies the Section rule that will be used as the default page for Email
Expired Page Responses responses to expired Offers.
Default Offer Not Email Specifies the Section rule that will be used as the default page for Email
Available Page Responses responses to Offers that are no longer available.
Mapping License Geofences Specifies the license key to use for the Google Maps™ mapping service.
Key
Default Customer Geofences Specifies the properties on the customer class to use as defaults for the
Location Properties customer’s location (latitude and longitude) when filtering on Geofences
in Strategies.
Number of Upcoming Specifies the number of Campaign Runs that the system will schedule at a
scheduled Campaign time for open-ended Campaigns - i.e. where the end date is not set.
Campaign Runs Runs
Campaign contacts Field Determines the mode to use when managing contacts in Field
editing mode Campaigns Campaigns. This setting is only visible if the application includes Pega
Field Marketing.
Note: Any property specified here must be a property on the customer class and must be mapped
(via the external mappings) to a column in the customer table.
Note: The name of any database column listed in the External Mapping tab of the customer and
prospect classes must not exceed 27 characters.
This landing page also enables synchronization of the Seed List structure with the customer class
structure. For details, refer to the Updating Seed List Columns section of the Seed Lists chapter.
Refer to the Configuring your Customer Class chapter of the Pega Marketing Implementation Guide
for details.
Use the Manage Data link next to a data entity to launch the Data Management landing page for
that entity.
l Apple Certificate
l Organization Certificate
Only one instance of this certificate type can be uploaded into the system. Use the Upload Apple
Certificate button to launch the upload certificate dialog. Use the Choose File button to locate the
certificate and upload it. No other information is required while uploading this certificate.
Currently, only one instance of this certificate type can be uploaded into the system. Use the Upload
Organization Certificate button to launch the upload certificate dialog. Use the Choose File
button to locate the certificate.
Setting Description
Certificate Password associated with the certificate. The system will validate this password and will not
Password upload the certificate in case the password is invalid.
Organization (Optional) Organization name to display on delivered passes. If this is not provided, the
Name organization name associated with the certificate will be used.
To review an existing certificate or to delete a certificate, use the Open action from the Actions
menu to launch the certificate rule form.
Each time the System Health landing page is launched (or refreshed), the health check is initiated.
Once the check is complete, the results of the check are displayed and resemble the following:
Note: Due to the nature of some of the checks performed (e.g. validating Email and SMS account
connectivity), the System Health check may take some time to complete. During this duration, a
loading screen is displayed. To reduce this load time, administrators should ensure all connection-
related errors and warnings are resolved.
These cards are displayed at the top of the System Health landing page and provide the administrator
with a quick overview of the status of their application. Each card displays the total number and a
breakdown of this total into the following categories:
l Agent
l Channel
l Configuration
l Runtime
Clicking anywhere on a card ensures that the corresponding (Errors/Warnings) grid below is visible.
This may result in the other grid being collapsed.
These grids provide detailed information on the health check failure (i.e. error or warning). The
following columns are available in both grids:
Column Description
Name
Category Category of the error or warning
(Agent, Channel, Configuration, or Runtime)
Source Actionable area of the system associated with the error or warning. This could be a
landing page, a data instance, a rule form, or a work object. Clicking this field will
open the referenced object or page. In most cases, the administrator should be able
to rectify the failure by making appropriate changes in the opened object or page.
Message Descriptive text that explains the error or warning. For longer messages, use the
More link to view the complete message and the Less link to revert to the abridged
view.
The header of each grid displays the total number of items in the grid. Users can also click the header
to toggle the grid view between expanded and collapsed. Additionally, each column in the two grids
supports sorting and filtering.
For each entry in the Agent category, if the failure is node-specific, the Message column contains
messages for each failing node, prefixed by the node id.
Optional Pega Marketing agents are those that are not tied to core functionality and may not be
utilized in some installations. Typically, these agents perform channel-specific functionality such as
Email, SMS, and Push Notification. Administrators should be aware of the functionality being used by
their marketing application, so they can better assess the true impact of failures in these agents.
Default or PegaMKT-Work Outbound Email Error Open the Email Account’s rule form. Administrators should correct
Account fails to connect any configuration issues in the account’s settings.
Other Outbound Email Account fails to Warning Open the Email Account’s rule form. Administrators should correct
connect any configuration issues in the account’s settings.
Default Outbound SMS Account doesn’t exist Warning Open the Outbound SMS landing page. Administrators should
create the Default account from this page.
Outbound SMS Account fails to connect Warning Open the Outbound SMS landing page. Administrators should
correct any configuration issues in the account’s settings.
Inbound SMS Account connection has failed Warning Open the Inbound SMS landing page. Administrators should
correct any configuration issues in the account’s settings.
There are recent Offer Email delivery errors Warning Open the Error Tracking landing page. Administrators can review
and mange errors from this page.
Error occurred while writing to output file or Error Open the Outbound File or Database landing page. Administrators
table can review the error and retry from this page.
Apple or organizational Passbook certificate Warning Open the Passbook Settings landing page. Administrators can
is missing or expired manage the certificates from this page.
No default Push Notification app exists or Warning Open the Push Notifications landing page. Administrators can
default app has no defined variants configure apps and app variants from this page.
Push Notification iOS app certificate is Warning Open the Push Notifications landing page. Administrators can
missing or expired configure apps and app variants from this page.
Column referenced in External Mappings of Error Open the class rule. Administrators should review all
customer or prospect class does not exist in the mappings and make any necessary corrections.
database.
PM Access Group doesn’t have Default destination Error Open the Access Group. Administrators should set the
ruleset configured Default destination ruleset to their marketing
application’s artifacts ruleset.
Default destination ruleset configured on PM Access Error Open the Access Group. Administrators should validate
Group doesn’t exist that the correct RuleSet Version is being used.
Default destination ruleset configured on PM Access Error Open the Access Group. Administrators should update
Group is locked, but an open RuleSet Version exists instance to reference an unlocked RuleSet Version.
for the same RuleSet
Default destination ruleset configured on PM Access Error Open the RuleSet. Administrators should add a new
Group is locked and no open versions exist for the unlocked version and update the Access Group to
RuleSet reference this new version.
Batch decisioning agent is not running on any nodes Error Open the Decisioning Topology landing page.
Administrators should enable the ProcessBatchJob agent
on at least one of the system nodes.
Batch decisioning agent doesn’t have number of Error Open the Decisioning Topology landing page.
threads configured Administrators should set the number of threads to a
positive number for each enabled node.
Public Link URL is not specified Warning Open the Resource URLs landing page. Administrators
should set this URL if their marketing application utilizes
the Email delivery channel.
Mapping License Key for Google Maps is not Warning Open the Artifact Settings landing page. Administrators
specified should set a value for this key if their application utilizes
the Import Geofences wizard.
Note: In most cases when the System Health references recent failures, the time duration is
configured as one of the criteria in the backing Report Definition (which is marked as extensible). The
shipped implementations usually use a time duration of “Greater than or equal to Yesterday” for
determining whether a failure is recent.
1. Items list - The left half of the window has a list of selectable items. This component has the
following usage patterns:
l The modal presents the twenty most recently updated rules (e.g. Strategies) in the system.
l If there are more than twenty results, use the View 20 more results link at the bottom to
load the next set of results.
l The refresh icon refreshes the list of results, retaining any search criteria that was previously
entered.
l Use the Create link (if available in the window) to create a new rule. The system pre-populates
relevant fields on the rule's create form. After creating the rule, refresh the list of results in the
modal to see your new rule.
l Click an entry in the list to select it. Upon selection, the system displays information about the
selected entry in the details panel on the right.
2. Item details panel - The upper portion of the right half of the window lists pertinent details
about the currently selected item. Use the link in this panel (if present) to open the corresponding
rule.
3. Selected items panel - The lower portion of the right half of the configuration window lists the
items that have been selected so far. Clicking an item link in this section opens the corresponding
rule. This panel also displays an informational message (either Only 1 can be added or Multiple
can be added) to indicate how many elements can be selected using this configuration window.
Selecting Items
Based on the element being configured and its intended usage, users can either select a single item
from the list or multiple items.
Click Add to include the corresponding item as a selection for the configuration. In the case of a
single-select configuration modal, the Add button is disabled on all other rows once an item has been
selected. To select a different item, first remove the currently added item by either clicking Remove
in the item's row or by clicking the corresponding trashcan icon in the selected items panel.
After adding the desired items, click Apply to confirm your selection changes and close the
configuration window. Alternately, click Cancel at any time to discard selection changes and close
the configuration window.
Note: When a configuration window is triggered from an already open configuration modal
window, the new window slides in. Upon application of selected values or cancellation, the
secondary window slides out and returns the user back to the original configuration window.