Jump to main content
HCL Logo Help Center
HCL TECHNOLOGIES ABOUT US PRODUCTS & SOLUTIONS RESOURCES CONTACT US
HCL®Campaign v11.0.1 documentation
Welcome to the HCL® Campaign v11.0.1 documentation, where you can find information about how to install, administer, and use HCL Campaign.
HCL® Campaign is part of the HCL® Marketing Software suite of products. Campaign version 11.0.1 requires Marketing Platform 11.0.1.
HCL® Campaign 11.0.1 system requirements and compatibility
HCL® Campaign is part of the HCL® Marketing Software suite of products. Campaign version 11.0.1 requires Marketing Platform 11.0.1.
New features and changes in version 11.0.1
HCL® Campaign 11.0.1 includes a number of new features and changes. These are listed underneath and were added in version 11.0 and are carried forward to 11.0.1. Note that 11.0.1 is a localization release. So, the product is localized for 10 languages; namely Traditional Chinese, French (France), German (Germany), Japanese, Korean, Portuguese (Brazil), Spanish (Spain), English (United Kingdom), Simplified Chinese and Italian.
Fixed defects in HCL® Campaign 11.0.1
The following defects were fixed in Campaign 11.0.1.
Known issues in HCL® Campaign 11.0.1
Campaign 11.0.1 includes the following known issues.
Known limitations in HCL® Campaign 11.0.1
Campaign 11.0.1 includes the following known limitations.
About the HCL® Campaign Reports Package
The Campaign Reports Package delivers reporting schemas that you can use to track campaign, offer, and cell performance. To use the Reports Package, Campaign must be integrated with IBM® Cognos®
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.
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.
Upgrade overview
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.
Planning the CampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectionDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerMarketing PlatformMarketing Platform upgrade
You can upgrade your current version of Campaign to bring it up-to-date with the latest features.
Upgrading Campaign
You can upgrade HCL® Campaign to version 11.0.1 from version 10.1.x.x only.
Upgrade considerations for eMessage
To upgrade to the latest version of eMessage, you must upgrade Campaign to the same version.
Deploying the HCL 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 in Campaign
For the HCL® Marketing Software applications that operate with Campaign, you can configure the application within the partitions where you have configured an instance of Campaign. Application users within each partition can access the Campaign functions, data, and customer tables that are configured for Campaign in the same partition.
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.
HCL Marketing Platform utilities and SQL scripts
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 CampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectionDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution 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.
You can configure the HCL® Campaign web application (J2EE application) in a cluster by completing additional tasks during the HCL Campaign installation.
Follow these instructions if you want to upgrade your existing single-listener configuration for HCL® Campaign to 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.
Before you begin fast upgrade
High-level steps involved in the Fast Upgrade process
The IBM Marketing Software Fast upgrade process is introduced to help complete the upgrade process in a short time so that you encounter less downtime on your production environment. Also, Fast upgrade process will get executed on clean 11.0.1 environment, so users existing environment will remain untouched.
Procedure: Fast upgrade Marketing Platform
Procedure: Fast upgrade Campaign
Procedure: Fast upgrade Contact Optimize
Procedure: Fast upgrade Interact
Procedure: Fast upgrade Marketing Operations
Procedure: Fast upgrade Reports
Troubleshooting
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.
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.
HCL® Campaign performance configuration overview
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.
Database tuning for HCL® Campaign: DB2®
A good starting point for tuning your configuration is to use the DB2® AUTOCONFIGURE command. This command generates values for parameters based on your responses to questions about workload characteristics.
Setting in-database optimization to improve flowchart performance
Using in-database optimization can improve flowchart performance. When in-database optimization is on, processing is done on the database server and output is stored in temporary tables on the database server whenever possible.
Adjusting configuration properties in HCL® Campaign to improve performance
You can adjust configuration properties in HCL® Campaign and HCL Marketing Platform to improve performance.
Troubleshooting HCL® Campaign Performance
Performance depends on many factors, including your database and web server configuration, network connectivity, and HCL® Campaign and HCL Marketing Platform configuration.
Use these topics to help troubleshoot performance and other issues.
Troubleshooting HCL® Campaign Performance
Performance depends on many factors, including your database and web server configuration, network connectivity, and HCL® Campaign and HCL Marketing Platform configuration.
Using log files to troubleshoot
These topics explain how to use the Campaign log files for troubleshooting.
Troubleshooting HCL® Campaign configuration and integration
These topics provide troubleshooting information about Campaign configuration and integration.
Troubleshooting localization and internationalization
Refer to this section for assistance in troubleshooting issues with configuring Campaign for use with non-ASCII data or non-United States locales.
Troubleshooting database issues
Refer to this section for assistance in troubleshooting database issues for HCL® Campaign system tables and user tables (data sources).
Troubleshooting utilities
Refer to this section for assistance in troubleshooting issues with the Campaign utilities.
Troubleshooting user administration and security
Refer to this section for assistance in troubleshooting issues relating to application access and user permissions.
Troubleshooting Campaign interface issues
Refer to this section for assistance in troubleshooting issues with using the Campaign interface.
Troubleshooting flowcharts and processes
Refer to this section for assistance in troubleshooting issues with Campaign processes and flowcharts.
Troubleshooting cell management
Refer to this section for assistance in troubleshooting issues with cell management, including target cell spreadsheets, cell codes, and cell code formats.
Troubleshooting contact history and response tracking
Refer to this section for assistance in troubleshooting issues with contact history and response tracking in Campaign.
Troubleshooting stored objects
Refer to this section for assistance in troubleshooting issues with stored objects, including derived fields, user variables, custom macros, and templates.
Troubleshooting customizing campaigns
Refer to this section for assistance in troubleshooting issues with customizing campaigns.
Troubleshooting installation and upgrades
Refer to this section for assistance in troubleshooting issues with installing and upgrading Campaign.
Troubleshooting data migrations
Refer to this section for assistance in troubleshooting issues with migrating and re-migrating data to Campaign from pre-7.x versions of Affinium Campaign.
The HCL® Campaign System Tables document is intended to help you understand the HCL Campaign data model for integration purposes.
HCL® Campaign system tables overview
The HCL® Campaign System Tables document is intended to help you understand the HCL Campaign data model for integration purposes.
HCL Campaign system table reference
The system table reference provides details on each of the HCL Campaign system tables. The data types that are indicated in the following tables are generic types that may be different in your HCL Campaign installation, depending on the database that is used for the system tables. The HCL Campaign system tables are stored in a database that was created prior to the HCL Campaign installation. The database can have any name. The ODBC or native connection provides a connection to the database. The HCL Campaign configuration settings under Campaign | partitions | partition1 | dataSources | UA_SYSTEM_TABLES determine how HCL Campaign interacts with databases, including its own system tables, for the default partition.
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.
HCL® Campaign SOAP API Overview
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.
Using the HCL® Campaign SOAP API
To use the HCL® Campaign Web Services SOAP API, you can use the client API .jar file or use the WSDL directly. An example shows how to use the .jar file method to create an offer.
SOAP API data types
The HCL® Campaign Services SOAP API uses the following public data types.
SOAP API methods
The HCL® Campaign Services SOAP API uses the following methods.
SOAP API common exceptions
The HCL® Campaign SOAP API may throw the following common exceptions. All exception localized messages are in the requested locale if available to HCL Campaign. The usual Java™ locale fallback policies apply.
Use the HCL® Campaign REST API to manipulate campaigns, offers, offer lists, attributes, and target cell objects.
HCL® Campaign REST API
Use the HCL® Campaign REST API to manipulate campaigns, offers, offer lists, attributes, and target cell objects.
Use the HCL® Validation Plug-in Developer's Kit (PDK) to develop custom validation logic for use in HCL Campaign.
Validation Plug-in Developer's Kit (PDK) overview
Use the HCL® Validation Plug-in Developer's Kit (PDK) to develop custom validation logic for use in HCL Campaign.
Developing validation plug-ins for Campaign
A plug-in is a Java™ class that is loaded at startup time and called whenever a campaign or offer is validated.
Calling an application to handle validation
The Validation PDK includes a sample validator, ExecutableCampaignValidator, which runs an executable, validate.sh, from the command line, to perform validation.
This chapter provides usage information about HCL® Campaign macros. Be sure to read this chapter before you attempt to use macros in HCL Campaign.
Using macros in HCL® Campaign
This chapter provides usage information about HCL® Campaign macros. Be sure to read this chapter before you attempt to use macros in HCL Campaign.
Using macros in HCL® Interact
This chapter provides usage information about HCL® Interact macros. Be sure to read this chapter before you attempt to use macros in HCL Interact.
HCL® Macros Reference
This section describes each available macro that is available for use in HCL Campaign, HCL Interact, or both. Macros are listed in alphabetical order.
The integration of HCL Campaign and IBM Engage combines the marketing segmentation tools of HCL Campaign with the messaging capabilities of IBM Marketing Cloud.
Overview of the Campaign and Engage integration
The integration of HCL Campaign and IBM Engage combines the marketing segmentation tools of HCL Campaign with the messaging capabilities of IBM Marketing Cloud.
Configuring the Campaign and Engage integration
To ensure a successful integration of Campaign and Engage, the following products must be configured: HCL Campaign, IBM Engage, IBM UBX, and IBM UBX Toolkit.
Email: using Campaign and Engage
If HCL Campaign and Engage are integrated, you can use HCL Campaign to send personalized email communications from IBM Engage.
SMS text messaging: using Campaign and Engage
If HCL Campaign is integrated with Engage, you can you can use HCL Campaign to send SMS text messages from IBM Engage.
Mobile push: using Campaign and Engage
If HCL Campaign and Engage are integrated, you can use Campaign to send mobile push notifications from IBM Engage.
Response tracking tables for the integration
To support the Campaign and Engage integration, response tracking tables are required to store data about user responses to email, SMS, and push events.
HCL® Marketing Operations and Campaign to use the marketing resource management features of Marketing Operations to create, plan, and approve campaigns.
Introduction to the integration
HCL® Marketing Operations and Campaign to use the marketing resource management features of Marketing Operations to create, plan, and approve campaigns.
Campaign project template design
You can create as many campaign project templates as you want. For example, you might want to create a separate campaign project template for each type of campaign that you run.
Creating a campaign in an integrated environment
The workflow for creating a campaign when Marketing Operations and Campaign are integrated consists of the following tasks.
Offers and offer templates in an integrated system
If offer integration is enabled, you create offers in Marketing Operations, then publish them for use in Campaign. You can set up offers before they are assigned to cells in Campaign. Offers are based on templates, which are also created in Marketing Operations.
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.
IBM SPSS Modeler Advantage Enterprise Marketing Management Edition 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.
IBM SPSS Modeler Advantage Enterprise Marketing Management Edition and HCL Marketing Software Integration Release Notes
The integration of IBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition 8.0 into the HCL Marketing Software suite of products requires HCL® Marketing Platform 11.0 and HCL Campaign 11.0.
HCL Campaign and SPSS Modeler Advantage Enterprise Marketing Management Edition Integration Guide
The integration of HCL® Campaign and IBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition provides a complete solution for creating predictive models, which marketers can then score to predict future customer behavior. Marketers can use modeling and scoring to reach customers who are more likely to accept an offer, which results in better response rates for marketing campaigns.
IBM SPSS Modeler Advantage Enterprise Marketing Management Edition Installation Guide
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.
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