Jump to main content
HCL® Campaign v11.0 documentation
Welcome to the HCL® Campaign v11.0 documentation, where you can find information about how to install, administer, and use HCL Campaign.
Release Notes
An installation of Campaign is complete when you install, configure, and deployinstall and configure Campaign. The Campaign Installation Guide provides detailed information about installing, configuring, and deployinginstalling and configuring Campaign.
Installation overview
An installation of Campaign is complete when you install, configure, and deployinstall and configure Campaign. The Campaign Installation Guide provides detailed information about installing, configuring, and deployinginstalling and configuring Campaign.
Planning the Campaign and Attribution Modeler installation
When you plan your Campaign and Attribution Modeler installation, you must ensure that you have set up your system correctly, and that you have configured your environment to deal with any failures.
Preparing data sources for Campaign
The Campaign runtime environment uses data sources to store user and interaction data.
Installing Campaign
You must run the HCL® Marketing Software installer to start the installation of Campaign. The HCL Marketing Software installer starts the Campaign installer during the installation process. Make sure that the HCL Marketing Software installer and the product installer are saved at the same location.
Configuring Campaign before deployment
Before you deploy Campaign, create and populate the Campaign and eMessage system tables and register Campaignand eMessage manually.
Deploying the Campaign web application
You can deploy the Campaign web application by using an EAR file or you can deploy the individual WAR files.
Configuring Campaign after deployment
After you deploy Campaign, you must verify that the Campaign listener is running, set up the Campaign system user, set Campaign configuration properties, and verify the Campaign installation.
Configuring multiple partitions for Campaign
In the Campaign family of products, partitions provide a way to secure the data that is associated with different groups of users. When you configure Campaign or a related HCL® Marketing Software application to operate with multiple partitions, users can see each partition as a separate instance of the application. There is no indication that other partitions exist on the same computer.
Configuring multiple partitions in eMessage
Configure multiple partitions in eMessage to isolate and secure data for different groups of eMessage users. As each partition has its own set of configuration properties, you can customize eMessage for each group of users.
Marketing Platform utilities
This section provides an overview of the Marketing Platform utilities, including some details that apply to all of the utilities and which are not included in the individual utility descriptions.
Uninstalling Campaign and Attribution Modeler
Run the Campaign and Attribution Modeler uninstallers to uninstall Campaign. When you run the Campaign uninstaller, the files that were created during the installation process are removed. For example, files such as configuration files, installer registry information, and user data are removed from the computer.
HCL® Campaign web application clustering
You can configure the HCL® Campaign web application (J2EE application) in a cluster by completing additional tasks during the HCL Campaign installation.
Installing a clustered listener environment
Follow these instructions if you want to install a clustered listener configuration. A listener cluster is a set of two or more listeners that act as a unit to provide load balancing and high availability. HCL® Campaign listener clusters are Active-Active; meaning each node serves requests using the load-balanced approach. Each Campaign listener provides an interface between front-end clients (such as the Campaign web application) and back-end analytical server processes.
Upgrade Guide
An upgrade of Campaign is complete when you upgrade, configure, and deployupgrade and configure Campaign. The Campaign Upgrade Guide provides detailed information about upgrading, configuring, and deployingupgrading and configuring Campaign.
Fast Upgrade Guide
HCL® Campaign is a web-based solution that enables you to design, run, and analyze direct marketing campaigns.
HCL® Campaign overview
HCL® Campaign is a web-based solution that enables you to design, run, and analyze direct marketing campaigns.
Creating and managing campaigns
One of the first things you do in HCL Campaign is to create a marketing campaign to identify your objective. Each campaign is defined by its business objective, initiative, and effective date range. A campaign always consists of at least one flowchart, where you select recipients and assign offers. You can create, view, edit, delete, and perform similar operations on marketing campaigns.
Designing flowcharts
HCL® Campaign flowcharts define the campaign logic. Each campaign consists of at least one flowchart. A flowchart performs a sequence of actions on data that is stored in your customer databases or flat files.
Managing flowcharts
HCL® Campaign flowcharts define the campaign logic. Each flowchart in a campaign performs a sequence of actions on data that is stored in your customer databases or flat files.
Offer management
Offers are specific marketing communications that you send to particular groups of people, using one or more channels. Each offer is based on an offer template that a Campaign administrator defines.
Target cell management
A cell is a group of people that you want to target, such as high value customers. A target cell is a cell that has an offer assigned to it.
Contact history
HCL® Campaign maintains contact history to record information about offers that are sent to contacts. History is also recorded about control cells, to identify customers who are purposely not sent the offer.
Campaign response tracking
Use the Response process in a flowchart to track the actions that occur after a campaign. When you run the Response process, data is recorded in the response history tables and is available for the Campaign performance reports.
Stored objects
If there are campaign components that you use frequently, you can save them as stored objects. Reusing stored objects across flowcharts and campaigns saves time and ensures consistency.
Session flowcharts
Sessions provide a way to create persistent, global "data artifacts" for use in all campaigns. Each session contains one or more flowcharts. Running a session flowchart makes the outcome of the session (the data artifacts) available globally to all campaigns.
HCL® Campaign reports overview
HCL® Campaign provides reports to aid in campaign and offer management.
Special characters in HCL® Campaign object names
Some special characters are not supported in any HCL® Campaign object names. In addition, some objects have specific naming restrictions.
Packaging flowchart files for troubleshooting
If you need help from HCL® to troubleshoot a flowchart, you can automatically collect relevant data to send to HCL Technical Support.
The Settings menu provides access to most of the tasks that Campaign administrators typically perform.
HCL® Campaign administration overview
The Settings menu provides access to most of the tasks that Campaign administrators typically perform.
Security in HCL® Campaign
Security policies control user access to the objects and features in HCL® Campaign.
Database table administration
HCL® Campaign administrators must perform initial one-time tasks and routine administration tasks that pertain to database tables.
Customizing campaigns
Administrators can customize campaigns by using custom campaign attributes, initiatives, and products.
Offer template administration
Before administrators perform offer template management tasks, there are several important concepts to understand.
Audience level administration
HCL® Campaign is delivered with a single audience level called Customer. You can define any additional audience levels that you need. Audience levels let flowchart designers target specific groups, such as Households, in marketing campaigns.
Contact history administration
Contact history is stored in the HCL® Campaign system database in separate tables by audience level. Therefore, you need to set up audience levels before you begin working with contact history.
Response history administration
Before you begin working with response history, you should read the audience level administration topics and set up required audience levels.
Monitoring and controlling flowchart runs
Choose Campaign > Monitoring and use the All monitored runs page to view the status of all active flowcharts and suspend, resume, or stop flowchart runs.
Dimension hierarchy administration
A dimension hierarchy is a data construct that groups data into bins based on value ranges. Dimension hierarchies are the basis for a variety of reports.
Trigger administration
HCL® Campaign allows you to define inbound and outbound triggers that can be used in all flowcharts in a partition.
HCL® Campaign log files
HCL® Campaign records information in several different log files.
Unique code administration
Each campaign, cell, offer, and treatment in Campaign has an identifying code that is generated by code generators, and conforms to a specified format.
Advanced settings for individual flowcharts
When a flowchart is open for editing, administrators can choose the Advanced settings option on the Admin menu to make administrative changes that affect only the current flowchart.
HCL® Campaign integration with other HCL® products
HCL® Campaign optionally integrates with a number of other HCL products.
HCL® Campaign listeners
The listener is a key component of HCL® Campaign. It provides an interface between front-end clients and back-end analytical server processes.
HCL® Campaign utilities
Administrators use the Campaign utilities to manage listeners, sessions, and flowcharts, and perform other important administrative tasks.
Non-ASCII data in Campaign
Campaign supports the use of localized data and non-United States locales, including multiple user-preferred locales within the same installation of the HCL® application.
Campaign configuration properties
The configuration properties for HCL® Campaign are located at Settings > Configuration.
Special characters in HCL® Campaign object names
Some special characters are not supported in any HCL® Campaign object names. In addition, some objects have specific naming restrictions.
Internationalization and character encodings
This section provides information on character encodings and language-sensitive database considerations, and lists the encodings supported by Campaign.
Campaign Error Codes
Campaign notifies users of error events when they occur with error messages that consist of a code number and error text.
Tuning Guide
The purpose of this document is to improve performance of flowchart execution, which is the core of the HCL® Campaign application. The performance of HCL Campaign is tied closely to database performance. Optimal settings of database-related parameters can significantly improve overall HCL Campaign application performance.
Troubleshooting Guide
Use these topics to help troubleshoot performance and other issues.
System Tables Guide
The HCL® Campaign System Tables document is intended to help you understand the HCL Campaign data model for integration purposes.
Validation PDK Guide
Use the HCL® Validation Plug-in Developer's Kit (PDK) to develop custom validation logic for use in HCL Campaign.
Macros
This chapter provides usage information about HCL® Campaign macros. Be sure to read this chapter before you attempt to use macros in HCL Campaign.
SOAP API Specification
The HCL® Campaign SOAP API specification defines version 3.0 of the Application Programming Interface, also referred to as CampaignServices. This specification is delivered as part of the CampaignServices Software Developer's Tookit (devkits) installed with HCL Campaign.
REST API Guide
Use the HCL® Campaign REST API to manipulate campaigns, offers, offer lists, attributes, and target cell objects.
Campaign and IBM Engage Integration Guide
The integration of HCL Campaign and HCL Engage combines the marketing segmentation tools of HCL Campaign with the messaging capabilities of HCL Marketing Cloud.
Marketing Operations and Campaign Integration Guide
HCL® Marketing Operations and Campaign to use the marketing resource management features of Marketing Operations to create, plan, and approve campaigns.
IBM SPSS Modeler Advantage Enterprise Marketing Management Edition v8.0.0 and HCL Campaign v10.1 integration documentation
Welcome to the IBM SPSS Modeler Advantage Enterprise Marketing Management Edition and HCL Campaign integration documentation, where you can find information about how to install, administer, and use the integration of these two products. The IBM SPSS Modeler Advantage Enterprise Marketing Management Edition v8.0.0 consists of an IBM SPSS Collaboration and Deployment Services server (v6.0.0) and an IBM SPSS Modeler Advantage server (v8.0.0). IBM SPSS Modeler Advantage Enterprise Marketing Management Edition and HCL Campaign are linked to a shared file system.
Executive Summary
HCL Marketing Software Support in the GDPR Context
HCL Marketing Software provides GDPR support for the following Marketing Software products:
Campaign - GDPR – General Technical Aspect of The Right of Erasure
Campaign provides the gdpr_purge.bat/sh utility. Campaign users may use this utility to generate delete statements for customers' records that are required to be erased from the Campaign system. These delete statements are generated for the Campaign system tables. Customer records that are required to be erased are provided in an input file and the output is the generated delete statements. We have listed the Campaign system tables in which customer data may reside (for which delete statements are generated) in the following two sections.
Procedure: High Level
This section describes the high level procedure to execute the Campaign GDPR utility.
Procedure: Detailed