Affinium Campaign. Installation Guide. Version 7.0.1

Transcription

1 Affinium Campaign Installation Guide Version 7.0.1

2 Copyright Copyright, Unica Corporation All rights reserved. Unica Corporation Reservoir Place North 170 Tracer Lane Waltham, MA Examples and Data All software and related documentation is subject to restrictions on use and disclosure as set forth in the applicable Unica Software License and Services Agreement or End User License Agreement, with restricted rights for U.S. government users and applicable export regulations. Companies, names, and data used in examples herein are fictitious unless otherwise noted. Trademarks and Patents Unica, the Unica logo, Affinium, and NetTracker are registered trademarks of Unica Corporation with the U.S. Patent and Trademark Office. Affinium Campaign, Affinium Campaign Collaborate, Affinium Campaign emessage, Affinium Campaign Interact, Affinium Campaign Optimize, Affinium Detect, Affinium NetInsight, Affinium Leads, Affinium Leads Referral, Affinium Leads Contact, Affinium Model, Affinium Plan, Affinium Mart, Universal Dynamic Interconnect, Interconnect Modules, Marketic, Powering Marketing Success, Customer Value Maximization, MAP, One-to-One Optimization, and Right-time Marketing are trademarks of Unica Corporation. All other trademarks are the property of their respective owners. Portions of the software described in this document are covered by U.S. Patent Numbers: 6,317,752, 6,269,32, 6,542,894, and 6,782,390. NOTICE: This document contains confidential and proprietary information of Unica Corporation ( Unica ). Use, duplication, or disclosure without the express written consent of Unica Corporation is prohibited. Document Information Affinium Campaign Installation Guide, for Affinium Campaign Version 7.0.1

3 Table of Contents Preface About this Guide and Unica Technical Support 11 About this guide Related documents Typographic conventions Special information Keyboard conventions Unica technical support Gathering information for Technical Support Contacting Technical Support Chapter 1 Introduction 17 What does Affinium Campaign do? How does Affinium Campaign work? Who uses Affinium Campaign? Chapter 2 Basic Installation on Windows 21 Overview System requirements Client machines Upgrades Internationalization and localization Utilities Preparing for installation Task 1: Obtain software and installation license key Task 2: Obtain the Affinium Manager host and port Task 3: Set up privileges Task 4: Configure for SSL (optional) Installing the Campaign server and web application Task 5: Install the Campaign server and J2EE web application. 27 Affinium Campaign Installation Guide Unica Confidential 3

4 Table of Contents Setting up and configuring the Campaign system tables...32 Overview of Campaign system table set-up...32 Task 6: Set up the Campaign database...32 Task 7: Create and populate the system tables...33 Task 8: Perform language-specific updates to tables...34 Task 9: Configure the ODBC or native data source...34 Task 10: Configure the JDBC data source...35 Task 11: Store system table database credentials...50 Task 12: Configure system tables as Campaign data sources...51 Setting up and configuring additional data sources...54 Task 13: Set up additional data sources...54 Configuring Affinium Campaign...55 Task 14: Set general configuration parameters...55 Task 15: Install the license key...57 Task 16: Configure multiple partitions...58 Task 17: Install and configure Affinium Reports...58 Deploying the web application and verifying the installation...58 Task 18: Modify environment properties...59 Task 19: Start thecampaign server...62 Task 20: Deploy the Campaign web application...64 Task 21: Map tables...66 Task 22: Verify the installation...66 Troubleshooting...68 Chapter 3 Basic Installation on UNIX 69 Overview...70 System requirements...70 Client machines...70 Upgrades...71 Internationalization and localization...71 Utilities...71 Preparing for installation...72 Task 1: Obtain software and installation license key Task 2: Obtain the Affinium Manager host and port...73 Task 3: Set up privileges...73 Task 4: Configure for SSL (optional)...73 Installing the Campaign server and web application...75 Task 5: Install the Campaign server and J2EE web application.75 4 Unica Confidential Affinium Campaign Installation Guide

5 Table of Contents Setting up and configuring the Campaign system tables...81 Overview of Campaign system table set-up...81 Task 6: Set up the Campaign database...81 Task 7: Create and populate the system tables...82 Task 8: Perform language-specific updates to tables...83 Task 9: Configure the ODBC or native data source...83 Task 10: Configure the JDBC data source...84 Task 11: Store system table database credentials...99 Task 12: Configure system tables as Campaign data sources.100 Setting up and configuring additional data sources Task 13: Set up additional data sources Configuring Affinium Campaign Task 14: Set general configuration parameters Task 15: Configure the startup script Task 16: Install the license key Task 17: Configure multiple partitions Task 18: Install and configure Affinium Reports Deploying the web application and verifying the installation Task 19: Modify environment properties Task 20: Start thecampaign server Task 21: Deploy the Campaign web application Task 22: Map tables Task 23: Verify the installation Troubleshooting Chapter 4 Configuring Multiple Partitions 119 Overview What are partitions? Partition configuration process overview Adding partitions and their directories Task 1: Configure new partitions in the central configuration file 122 Task 2: Create the partitions directory structures Task 3: Create the partitions in Affinium Manager Configuring partition system tables and other data sources Task 4: Create and populate the system tables Task 5: Configure the ODBC or native data source Task 6: Configure the JDBC data source Task 7: Configure the system tables as Campaign data sources 129 Version Unica Confidential 5

6 Table of Contents Task 8: Store database credentials for each partition Task 9: Configure additional data sources Completing partition set-up Task 10: Stop and restart Campaign Task 11: Map customer tables Task 12: Add users to a partition Task 13: Configure Affinium Reports for multiple partitions Chapter 5 Upgrading to Affinium Campaign Upgrade and migration overview Upgrade and migration prerequisites Knowledge requirements System compatibility and accessibility Upgrading to Affinium Campaign Task 1: Install Affinium Manager and migrate users and their data sources Task 2: Back up Affinium Campaign 6.4.x Task 3: Install and configure Affinium Campaign When you have successfully upgraded to Affinium Campaign Chapter 6 Migrating Data to Affinium Campaign Upgrade and migration overview About migration Feature changes affecting migration Migration tool limitations About the migration tool About the migration log About migrating partitions About starting and stopping servers during migration About cancelling migration About re-migration Migrating data to Affinium Campaign Task 4: Set up the migration environment Task 5: Migrate Affinium Campaign data and files Stage 1 Setup Stage 2 Consistency checks Stage 3 File system artifacts Stage 4 Database artifacts Unica Confidential Affinium Campaign Installation Guide

7 Table of Contents Stage 5 Offer/campaign/session artifacts Stage 6 Finish migration or migrate next partition Task 6: Verify migration Task 7: Perform manual configuration and migration Task 8: Re-map audience levels Chapter 7 Migration Reference 163 Chapter 8 Overview Migrating objects in Affinium Campaign Campaigns Cells Configuration information Contact and response history Control groups Creatives Cubes and strategic segments Custom attributes Custom macros Derived fields Dimension hierarchies Flowcharts Flowchart templates Folders Initiatives Offers Offer templates Offer versions Processes Security Strategic segments Sessions Table catalogs Triggers Configuring Affinium Campaign for a Non-English Language 181 Overview Version Unica Confidential 7

8 Table of Contents Understanding encodings Sample configurations Locale-specific data conventions Configuring for a non-english language Task 1: Configure the operating system Task 2: Configure the browser language Task 3: Configure the Campaign server and web application Task 4: Un-map and re-map system tables Task 5: Test your database configuration Task 6: Test Campaign Sample configurations French German Traditional Chinese Hebrew Thai Japanese Korean Chapter 9 Repairing and Uninstalling Affinium Campaign 211 Repairing Affinium Campaign with the installer Backups Configuration and user data Repairing Affinium Campaign Uninstalling Affinium Campaign Affinium Manager requirement Uninstalling Affinium Campaign Appendix A Properties in the Central Configuration File 217 Overview of the Affinium configuration file Properties moved from other configuration files Hierarchy of categories and properties File location Configuring property values Reading your changes into the system Properties in the suite category partitions > partition partitions > partition1 > proxy Unica Confidential Affinium Campaign Installation Guide

9 Table of Contents Properties in the applications category Campaign Campaign > navigation Campaign > logging Campaign > ProductReindex Campaign > caching Campaign > server Campaign > unicaaclistener Campaign > monitoring Report Scheduler Properties in the partition1 category reports validation datasources datasources > UA_SYSTEM_TABLES systemtablemapping offercodegenerator server > dataprocessing server > encoding server > filedialog server > flowchartconfig server > flowchartrun server > flowchartsave server > internal server > logging server > optimization server > permissions server > profile server > systemcodes server > timeout Date format reference Formats for DateFormat Formats for DateOutputFormatString Appendix B Internationalization and Encodings 299 About character encodings Encoding uses Version Unica Confidential 9

10 Table of Contents Internationalization and localization Encoding tutorials Unicode Encodings available in Campaign UNIX ODBC log The language-sensitive database Communicating with the database The database client Date formats Character encoding Bulk loaders Supported encodings About this list Special cases: ASCII and UTF Encodings list Useful links Character encodings Languages Internationalization (general) Java-specific Appendix C Active X Cleanup Utility 315 Overview of the Active X cleanup utility Location of the utility Prerequisites for running the utility Utility usage Syntax Options Glossary 319 Index Unica Confidential Affinium Campaign Installation Guide

11 ABOUT THIS GUIDE AND UNICA TECHNICAL SUPPORT This preface provides information about the conventions used in this Installation Guide, and how to contact Unica Technical Support. This chapter includes the following topics: About this guide Unica technical support Affinium Campaign Installation Guide Unica Confidential 11

12 About this guide This guide is designed provide Affinium administrators the information they need to use Affinium Campaign. Related documents In addition to this guide, you can find more information about Affinium Campaign in the following documents: Affinium Campaign User s Guide Affinium Campaign Administrator s Guide Affinium Campaign Release Notes Affinium Macros Guide All guides assume familiarity with Microsoft Windows environments and Microsoft Internet Explorer. Typographic conventions Specific conventions are used in this guide to convey additional information about a subject. Style Description Example Code Italic code Bold code Code style is used for text that is used literally, appearing exactly as shown. This includes command names, path names, and system information. Italic code style is used for names of variables that you must provide. For example, you need to supply a value for your_file in the path name example to the right. Bold code style is used to indicate the option used by default if none is specified. \Affinium\model\model.exe \Affinium\data\your_file {ALL COL ROW} 12 Unica Confidential Affinium Campaign Installation Guide

13 About this guide Style Description Example GUI [ ] { } The GUI style is used to indicate objects in the application s interface or keys on your keyboard. Square brackets are used to enclose optional items in syntax descriptions. Braces enclose a list from which you must choose an option. the User Name field, the Enter key macro_name(required_var [, optional_variable]) {ALL COL ROW} A vertical bar separates items in a list. {ALL COL ROW} Ellipses in a syntax description indicate that the preceding parameter can be repeated multiple times. For instance, you could use multiple filenames as parameters in the example to the right. run filename, Special information Notes in the text are displayed like this. They highlight information or provide supplementary information. Critical information is displayed with this label, to inform you of an important point. Be sure to read this before continuing. Keyboard conventions Convention Keystrokes Example KEY1 + KEY2 KEY1 - KEY2 A plus sign (+) between two keys means to press both keys down at the same time. A dash (-) between two keys means to press one key, followed by the other. Ctrl+C means to press the Ctrl key and hold it down while pressing the letter C. Alt-F-P means to press the Alt key followed by the letter F, and then the letter P. Version Unica Confidential 13

14 Unica technical support If you encounter a problem that you cannot resolve by consulting the Affinium Campaign documentation, your company s designated support contact can log a call with Unica Technical Support. Use the information in this section to ensure that your problem is resolved efficiently and successfully. If you are not a designated support contact at your company, contact your Affinium administrator for information. Gathering information for Technical Support Before you contact Unica Technical Support, you should gather the following information: A brief description of the nature of your issue. Detailed error messages you see when the issue occurs. Detailed steps to reproduce the issue. Related log files, session files, configuration files, and data files. Information about your Affinium environment, which you can obtain as described in Accessing system information on page 14. Accessing system information When you log a call with Unica Technical Support, you may be asked to provide information about your environment. If your problem does not prevent you from logging in to your Affinium application, much of this information is available on the About Affinium page, which provides information about any Affinium application from which you view the page. In Affinium Manager only, the About Affinium page includes a link to an additional page, the Complete System Information page. The Complete System Information page provides the About page information for each of the installed Affinium applications that uses the instance of Affinium Manager from which you are viewing the page. 14 Unica Confidential Affinium Campaign Installation Guide

15 Unica technical support Accessing the About Affinium and Complete System Information pages In any Affinium application, click About at the top of any page to open the About Affinium page. In Affinium Manager, click the Complete System Information link on the About Affinium page to open the Complete System Information page. Information on the About Affinium page The About Affinium page provides the following information about the Affinium application from which you access the page: Version number Release number Operating system on which the application is installed Java version in the web application server on which the application is deployed Version information for the application server on which the application is deployed Unica Support URL Copyright information Additional information that may vary by product. If the About Affinium page is not accessible, you can obtain the version number of any Affinium application by viewing the version.txt file located under each application s root installation directory. Contacting Technical Support Your company s designated support contact can reach Unica Technical Support by any of the following methods, listed in preferred order of contact: Log into TeamTrack at Telephone Version Unica Confidential 15

16 If you choose to contact Unica by or telephone, use the appropriate contact information for your region: Region Americas Europe France Asia Pacific Contact information Unica Corporation, Reservoir Place North, 170 Tracer Lane, Waltham, MA support@unica.com Unica Corporation Limited, European Headquarters Harman House 1 George Street Uxbridge Middlesex UB81QQ 44 (0) supporteurope@unica.com Unica France Immeuble Le Monge 22, Place des Vosges La Défense cedex 5 33 (0) supporteurope@unica.com Unica Corporation, 7 Temasek Boulevard, Suntec Tower One, #44-01, Singapore, apsupport@unica.com 16 Unica Confidential Affinium Campaign Installation Guide

17 1 INTRODUCTION This chapter provides an introduction to Affinium Campaign. This chapter includes the following topics: What does Affinium Campaign do? Who uses Affinium Campaign? How does Affinium Campaign work? What does Affinium Campaign do? Affinium Campaign is a web-based, Enterprise Marketing Management (EMM) solution that consists of a back-end server, a web server, an Active X client, and the Affinium Manager. Campaign is designed to enable marketers no matter what their level of technical expertise to design, execute, and analyze direct marketing campaigns easily and efficiently. The emphasis is on reuse, modularity, ease of use, flexibility, and customization. Affinium Campaign supports large volume environments and can manage hundreds or even thousands of campaigns. Affinium Campaign also supports Affinium Campaign Installation Guide Unica Confidential 17

18 Chapter 1: Introduction ease of use and organization with custom, hierarchical foldering, bookmarking, and keyword searching of all managed objects (campaigns, sessions, segments, offers, and products). The Campaign and Affinium Manager installation and configuration are performed by the Campaign administrator with the assistance of a Unica consulting team. These are not user tasks and, therefore, will not be discussed in this guide. For information on installation and configuration, see your UNICA representative. Once Campaign and Affinium Manager have been installed and configured, and the servers have been started, users can run the Campaign client from any machine with a supported browser and network access to the Campaign web server. Before meaningful work can be done, however, database tables must be mapped, data models (like segments, dimensions, cubes) may need to be created, and the individual campaign must be carefully planned and designed. These tasks are initially performed with the help of a Unica consultant with the expectation that the initial campaign along with this guide will enable users to design and run additional campaigns themselves or refine, expand, and build upon their initial campaign with varying degrees of assistance. How does Affinium Campaign work? Affinium Campaign provides an extensible, feature-rich, and easy to use graphical user interface that encapsulates complex SQL queries and transactions, as well as Unica s sophisticated, patented data mining algorithms to facilitate the creation of direct marketing campaigns. Although the application supports raw SQL requests, macros, and functions, users do not have to know SQL in order to design campaigns. Once mapped, database tables can be selected, merged, sampled, and segmented; the resulting customers can be associated with a variety of offers; campaigns can be optimized; the results of a campaign can be recorded and the ROI calculated; campaigns can be scheduled to run at a particular time or triggered by an particular event, and so forth, all without the user ever having to issue a raw SQL request. The emphasis is always on making the complicated and the complex simple and easy to understand without sacrificing power or flexibility. 18 Unica Confidential Affinium Campaign Installation Guide

19 Who uses Affinium Campaign? With Affinium Campaign, the user interface never restricts nor confounds users, no matter what their level of expertise. Everything is centered on clear, selfevident, visual selection. Affinium Campaign treats a marketing campaign as a discrete entity that is made up of one or more flowcharts, which are comprised of one or more processes. However, in its more sophisticated form, a campaign can be associated with one or more strategic segments, offers, and reports, and can consist of multiple flowcharts. The processes, which are defined in a flowchart, are the heart of Campaign, since they perform the actual data manipulation, scheduling, reporting, and optimization; in effect, the processes are how the user defines and implements a campaign. As a result, this guide spends a great deal of time discussing and explaining how to use the various processes that Campaign supports, as well as how the various parts of a campaign all work together to form a whole that is much more than a mere sum of its parts. Who uses Affinium Campaign? Affinium Campaign is designed to be used by both sophisticated data-mining, OLAP, and SQL experts, as well as by marketing experts with perhaps very little or no knowledge of data mining or SQL. The technical experts map the database tables, work with the data marts, create and populate the data models, and essentially lay the ground work for their colleagues whose expertise is direct marketing and the development and execution of campaigns. Core persistent data models, such as strategic segments, are created in a special area of the application called a session, and are subsequently available for use in all campaigns. Version Unica Confidential 19

20 Chapter 1: Introduction 20 Unica Confidential Affinium Campaign Installation Guide

21 2 BASIC INSTALLATION ON WINDOWS This chapter contains all the steps necessary to implement a successful installation of the Affinium Campaign software application on the Windows operating system. For information on installing on the UNIX operating system, see Chapter 3, Basic Installation on UNIX, on page 69. Unica strongly recommends that you engage with Unica Consulting Services for installations of Affinium products. This chapter includes the following topics: Overview Preparing for installation Installing the Campaign server and web application Setting up and configuring the Campaign system tables Setting up and configuring additional data sources Configuring Affinium Campaign Affinium Campaign Installation Guide Unica Confidential 21

22 Chapter 2: Basic Installation on Windows Deploying the web application and verifying the installation Troubleshooting Overview Installing Affinium Campaign is a multi-part process. To ensure a successful installation, perform the steps in the order described in this chapter. This overview provides additional information that you should keep in mind when performing the installation procedures. System requirements Hardware, operating system, web server, and database requirements are described in the Affinium Campaign Supported Software Environments and Minimum System Requirements document. Client machines Client machines should meet the following configuration requirements: Campaign uses an ActiveX control for flowcharts and administration functions. This flowchart automatically downloads when needed. The recommended security settings for the IE browser is medium-low for local intranet. Specifically, the client browser must have enabled: Download signed ActiveX controls Run ActiveX controls and plugins Script ActiveX controls marked safe for scripting On the Internet Explorer Tools > Internet Options > Settings dialog box, in the Check for newer versions of stored pages section, Every visit to the page should be selected. If pop-up blocker (ad blocker) software is installed on the client machine, Affinium Campaign may not function properly. We recommend disabling pop-up blocker software while running Affinium Campaign. 22 Unica Confidential Affinium Campaign Installation Guide

23 Overview Upgrades If you are upgrading from a previous version of Affinium Campaign, see Chapter 5, Upgrading to Affinium Campaign 7.0.1, on page 135 before installing. Internationalization and localization Utilities The instructions in this chapter assume you are configuring Campaign to use the English language. If you are planning to use any other language, see Chapter 8, Configuring Affinium Campaign for a Non-English Language, on page 181. Affinium Campaign is distributed with a variety of utilities. See Appendix C, Active X Cleanup Utility, on page 315 for details on using the Active X cleanup utility, uacflchk.exe. This utility is designed to resolve Object not Loaded / Object does not support this property or method errors when a user tries to access Campaign pages with Active X controls. See the Affinium Campaign Administrator s Guide for details on using the following utilities: The Affinium Campaign Server Manager (unica_svradm), a command-line server management utility that allows you to perform the following tasks: Connect to the Affinium Campaign listener View all currently open flowcharts View and set environment variables The Affinium Campaign Session Utility (unica_acsesutil), which allows you to pass in a flowchart file or table catalog as input, and generate a table catalog as output. You can also use it to move campaigns, sessions, and flowcharts from one server to another. Database test utilities: (cxntest, db2test, odbctest, oratest), which you can use to test connections to a target database and execute queries and perform a variety of tasks. Version 7.0 Unica Confidential 23

24 Chapter 2: Basic Installation on Windows Preparing for installation Before you can install Affinium Campaign, you need to perform the preparatory tasks described in this section as follows: Task 1: Obtain software and installation license key Task 2: Obtain the Affinium Manager host and port Task 3: Set up privileges Task 4: Configure for SSL (optional) Task 1: Obtain software and installation license key For new installations, the Unica Consulting team obtains a copy of the Affinium Campaign software and a license key for you by ing a software request form to support@unica.com. If you download the installation files from an FTP site, download them in binary mode and then change permissions to make the files executable before you install them on your Campaign server. Task 2: Obtain the Affinium Manager host and port Affinium Manager must be installed and running before you install Affinium Campaign. Obtain the host and port information for the Affinium Manager instance that you plan to use with Affinium Campaign. See the Affinium Manager Installation Guide for information on installing or upgrading Affinium Manager. Verify that the SDK selected for the WebLogic domain you are using is the Sun SDK by looking in the startup script (startweblogic.cmd) for the JAVA_VENDOR variable. It should be set to: JAVA_VENDOR=Sun. If it is set to JAVA_VENDOR=BEA, JRockit has been selected. JRockit is not supported. To change the selected SDK, refer to the BEA WebLogic documentation. 24 Unica Confidential Affinium Campaign Installation Guide

25 Preparing for installation Task 3: Task 4: Set up privileges You must log in to Windows as a user with Administrator privileges to install Affinium Campaign. Configure for SSL (optional) If you want to configure the Campaign listener to communicate using SSL, you must perform the configuration tasks described in this section, and also select the Use secure connection option when you install the Campaign server. This section describes the following configuration tasks: Configure the web application server to use SSL. Set several configuration parameters in the affinium_config.xml configuration file. To configure the web application server to use SSL 1 Enable the SSL port in the web application server (WebLogic or WebSphere). Consult the web application server s documentation for instructions on how to do this, or follow the directions in the Implementing Trusted Application Support chapter of the Affinium Manager Installation Guide for configuring the default SSL port to use the Unica keystores. You do not have to implement trusted application support, but you must enable SSL. 2 When you deploy the Campaign server, use the port that has SSL enabled. 3 If desired, you can also deploy the Campaign web application in SSL mode, by deploying the web application to use the port that is configured to use SSL. Set configuration parameters 1 Log in to Affinium Manager and click Configuration Manager. Version 7.0 Unica Confidential 25

26 Chapter 2: Basic Installation on Windows 2 Under applications > Campaign > unicaaclistener, set properties as described in the following table. Property Value usessl serverport yes The SSL port the server will listen on 3 If you are using the operational monitor, and you deploy the Campaign web application in SSL mode, under applications > Campaign > unicaaclistener, use the HTTPS protocol when you set the value of the serverurl property to the URL of the Campaign web application. For example: 4 Open the config.xml file in a text or XML editor. The file is located in the Affinium\conf directory. 5 Under bootstrap > applications > Campaign > server, set the value of the UnicaServerSSLFile property to the full path to the certificate you want to use for the Affinium Campaign server. The server certificate supplied by Unica is named unicaclient.pem and is located in the security directory under your Affinium Suite installation. for example: C:\Affinium\security\unicaclient.pem 6 Save and close the config.xml file. 26 Unica Confidential Affinium Campaign Installation Guide

27 Installing the Campaign server and web application Installing the Campaign server and web application Next, you need to install the Affinium Campaign server and web application. Task 5: Install the Campaign server and J2EE web application, on page 27 describes this task. Each InstallShield package requires a java virtual machine (JVM) to run. If InstallShield cannot find a JVM in the path, it installs a JVM automatically into the installation directory. This JVM is used only by the installer and uninstaller, and is removed when you uninstall Campaign. Task 5: Install the Campaign server and J2EE web application This section describes the basic features of the Affinium Campaign installer and provides an overview of the installation and configuration process. About the Affinium Campaign installer Affinium Campaign installers are provided for the following operating systems: Windows Solaris HP-UX AIX You can run the Affinium Campaign installer in either command line or GUI mode. The installer can perform these types of installs: New install Described in this Task. Repair install When you run the installer and select a root directory where the same version of Affinium Campaign has previously been installed, the installer automatically runs in repair mode. The repair install is described in Chapter 9, Repairing and Uninstalling Affinium Campaign, on page 211. Version 7.0 Unica Confidential 27

28 Chapter 2: Basic Installation on Windows Navigating in the installation wizard When the installer runs in GUI mode, you navigate using the Next, Back, Cancel, and Finish buttons. When the installer runs in command line (console) mode, you navigate by entering numbers that correspond to the buttons in GUI mode, as described in the help text on each screen of the wizard. In command line mode, an additional redisplay command is available. A number is displayed in square brackets at the end of the prompt line; this is the default command issued if you press Enter without typing a number. For example, if the end of the line displays [1], pressing Enter displays the next screen. Selecting Campaign components The Affinium Campaign installer allows you to choose whether you want to install the Campaign server, Campaign J2EE web application, user documentation, Campaign report models, and developer toolkit on the same machine, or on different machines. The component installations do the following: The Campaign server installation creates the startup scripts, and allows you to start Affinium Campaign from the Windows Start menu and run multiple Campaign servers, if necessary. You must have Administrator privileges to install Affinium Campaign. The Campaign J2EE web application installation installs log and configuration files, as well as all the files you need to deploy Campaign on your web application server. The user documentation installation installs the PDF version of the Affinium Campaign User s Guide and Affinium Campaign Administration Guide and places entries for these documents in the Windows Start menu. The Reports installation installs the Reports directory and data model files, which are necessary if you plan to implement Affinium Reports. See the Affinium Reports Installation Guide for details. The developer toolkit installs the validation classes that are used to implement custom validation. 28 Unica Confidential Affinium Campaign Installation Guide

29 Installing the Campaign server and web application The Affinium Campaign installer provides a wizard to guide you through the installation process. The following sections describe how the installer works when you perform a new install. Install location The installer lets you select a root installation directory by entering it or by browsing and selecting it. The installer requires that Affinium Campaign be installed in the Affinium\Campaign directory, and it enforces this by appending \Affinium\Campaign to the end of any root installation directory path you select. You can specify a path relative to the directory from which you are running the installer by typing a period before the path. If the root directory you specify does not exist, the installer creates it, assuming the account with which you log in to your operating system has sufficient privileges. Affinium Suite and Affinium Manager requirement All Affinium products must be installed under a root Affinium Suite, which consists of an Affinium directory and several subdirectories and configuration files. The installer checks for the presence of the Affinium Suite in the root installation directory and installs these directories and files if they are not present. If the installer must install the Suite, you are prompted to provide the host and port of the Affinium Manager instance that you plan to use with this Suite. You also have the option of specifying whether the connection to Affinium Manager is secure (over SSL). If the installer is unable to connect with Affinium Manager, the installer displays a warning message. If the warning message appears, you can go back and verify that you entered the correct host and port. If the warning still appears, you may cancel, or continue with the installation. If you install without connecting to Affinium Manager, you must do the following: Version 7.0 Unica Confidential 29

30 Chapter 2: Basic Installation on Windows Set the configurationserverbaseurl property in the config.xml file manually. The file is located in the conf directory under the Affinium Suite root directory (for example, in Affinium/conf). Summary pages The installer displays one or more summary pages that provide details about the installation location, features, and total size of the files it will install. You can review this information and go back to make changes, or proceed with the install. Windows shortcuts In Windows, the installer creates shortcuts under Affinium Campaign for the uninstaller, the Administration Guide, and the User s Guide. Use the procedure below that is appropriate for your operating system to run the Affinium Campaign installer. Installer file names The Campaign installation files are named according to the version of the application and the operating system with which they are intended to be used. For example, Campaign70_win32.exe is version 7.0 and is intended for installation on the Windows 32-bit operating system. The examples in the following procedures use the name CampaignX_OS.exe to stand for all the possible file names. Installing Affinium Campaign Use the following guidelines to install Affinium Campaign. To install Affinium Campaign 1 Double-click the CampaignX_OS.exe file to run the Affinium Campaign installer, and follow the instructions in the wizard. 30 Unica Confidential Affinium Campaign Installation Guide

31 Installing the Campaign server and web application 2 If you are installing the server and J2EE application on different machines, you need to install Reports only once, on either machine. You copy the Reports component to the Cognos install directory when you install Affinium Reports. See the Affinium Reports Installation Guide for details. 3 If the installer detects that the Affinium Suite does not exist in the root Affinium directory you have specified, you are prompted to provide the information shown in the following table. Field Host Port Use secure connection checkbox Description Enter the name or IP address of the machine where the Campaign server is installed. Enter the port where the Campaign server is installed. Check this if you want the listener to communicate using SSL. See Task 4: Configure for SSL (optional), on page 25 for additional procedures required for SSL configuration. Version 7.0 Unica Confidential 31

32 Chapter 2: Basic Installation on Windows Setting up and configuring the Campaign system tables Setting up and configuring the Campaign system tables is a multi-step procedure, as described in the following overview. Note that, in Affinium Campaign 7.0.x, the dbconfig.lis file is no longer in use. You use the affinium_config.xml file to configure all data sources (Campaign system tables and customer data). Overview of Campaign system table set-up The process for setting up the Campaign system tables differs slightly depending on whether Campaign is configured for a single partition or multiple partitions This section provides an overview of setting up system tables for an instance of Campaign configured to use a single partition (the default partition, partition1). Each step is explained in detail in later sections of this chapter. For information on setting up system tables for multiple partitions, see Chapter 4, Configuring Multiple Partitions, on page 119. To set up system tables for one partition Task 6: Set up the Campaign database Task 7: Create and populate the system tables Task 8: Perform language-specific updates to tables Task 9: Configure the ODBC or native data source Task 10: Configure the JDBC data source Task 11: Store system table database credentials Task 12: Configure system tables as Campaign data sources Task 6: Set up the Campaign database Work with the database administrator to do the following: Set up a database that will hold the Affinium Campaign system tables. 32 Unica Confidential Affinium Campaign Installation Guide

33 Setting up and configuring the Campaign system tables If your database is Microsoft SQL Server, enable the TCP/IP protocol on the SQL server. Set up or identify a database user with owner privileges. Make a note of this user s user name and password. You will need this information in subsequent procedures: Task 9: Configure the ODBC or native data source, on page 34 Task 10: Configure the JDBC data source, on page 35. Task 11: Store system table database credentials, on page 50. Task 7: Create and populate the system tables Scripts are packaged with the Affinium Campaign software that contain the execution commands needed to create and populate the Affinium Campaign system tables. Run these scripts in the database client (for example, Enterprise Manager for SQL Server). See your database administrator for assistance, if necessary. The scripts are located in the Campaign\ddl directory. To create the system tables Run the script appropriate for your database, as described in the following table. Script Name Database ac_systab_db2.sql ac_systab_ora.sql ac_systab_sqlsvr.sql DB2 Oracle SQL Server Run the DB2 script with the following options: db2 -td@ -vf ac_populate_tables_db2.sql If you are running the script from outside of the ddl directory, include the path to the script. Version 7.0 Unica Confidential 33

34 Chapter 2: Basic Installation on Windows To populate the system tables Run the script appropriate for your database, as described in the following table. Script Name Database ac_populate_tables_db2.sql ac_populate_tables_ora.sql ac_populate_tables_sqlsvr.sql DB2 Oracle SQL Server Task 8: Perform language-specific updates to tables If you are installing a non-english version of Affinium Campaign, you must run a database script to update the UA_AttributeDef table with localized attribute display names and descriptions. To localize UA_AttributeDef values Run the script appropriate for your language, as described in the following table. You can run the English version of the script to restore the English values to UA_AttributeDef. Script Name custom_attr_update_en.sql custom_attr_update_fr.sql custom_attr_update_de.sql custom_attr_update_ja.sql Language English French German Japanese Task 9: Configure the ODBC or native data source The machine on which the Affinium Campaign server is installed must be able to communicate with the database that holds the Campaign system tables. Create 34 Unica Confidential Affinium Campaign Installation Guide

35 Setting up and configuring the Campaign system tables an ODBC or native data source for the Campaign system table database on the machine where the Campaign server is installed. Use the following guidelines: If you are configuring just one partition, name the data source UA_SYSTEM_TABLES. If you are configuring more than one partition, do not name any of the data sources UA_SYSTEM_TABLES. Follow the directions in Chapter 4, Configuring Multiple Partitions, on page 119. If your database is Oracle or DB2, consult your database client documentation for instructions on creating a native data source. If your database is SQL Server, create an ODBC data source. See the database and operating system documentation for specific configuration instructions. Task 10: Configure the JDBC data source Campaign version 7.0x uses JDBC (as well as an ODBC or native connection) to connect to the Campaign system tables. You must set up the JDBC connection in the web application server where you deploy the Campaign web application. Use the guidelines below that are appropriate for your web application server: Configuring the JDBC data source in WebLogic on page 35 Configuring the JDBC data source in WebSphere on page 42 If you are not familiar with configuring a JDBC data source in your web application server, consult the web application server documentation for additional details. Unica recommends that you use the latest vendor-provided Type 4 drivers when you set up the JDBC connection. The procedures in this section follow this guideline. Configuring the JDBC data source in WebLogic If WebLogic is your web application server, use the procedures in this section that are appropriate for your database. There are two steps to configuring the JDBC data source in WebLogic: Version 7.0 Unica Confidential 35

36 Chapter 2: Basic Installation on Windows Create a connection pool. This section provides separate procedures for creating a connection pool for each of the database types that are supported for Affinium Campaign system tables. Create a data source and associate it with the connection pool. This section describes this procedure, which is the same for all database types. Creating the connection pool for SQL Server Perform this procedure if your database is SQL Server and your web application server is WebLogic. To create a connection pool for SQL Server in WebLogic 1 Obtain the Microsoft SQL Server 2005 JDBC driver and unpack it on the machine where WebLogic is installed. 2 In the WebLogic startup script (startweblogic.cmd) add the sqljdbc.jar file to the CLASSPATH, before the weblogic.jar entry. Use the full path to the location where you unpacked the driver. 3 Restart the WebLogic server. 4 In the WebLogic Console, configure a new JDBC connection pool using the following guidelines. 5 On the Choose Database page, complete the fields using the following guidelines. Field Database Type Database Driver Description Select MS SQL Server from the drop-down list. Select Other from the drop-down list. 36 Unica Confidential Affinium Campaign Installation Guide

37 Setting up and configuring the Campaign system tables 6 On the Define connection properties page, complete the fields using the following guidelines. Field Name Driver Classname URL Database User Name Password Confirm Password Description Enter any unique name for the connection pool. Enter com.microsoft.sqlserver.jdbc.sqlserverdriver Enter jdbc:sqlserver://servername:port; databasename=dbname where servername, port, and DBName are values appropriate for your environment. For example: jdbc:sqlserver://corporateserver:1433; databasename=campaign The default port is your port may be different. Enter the user name of the database account you noted in Task 6: Set up the Campaign database, on page 32. Enter the password of the database account you noted in Task 6: Set up the Campaign database, on page 32. Re-enter the password. If you did not create a password for the database user when you installed SQL Server, you must go back and create one. 7 Test your connection. 8 A JDBC error may occur if your database goes down and restarts and you navigate to a page the data for which has not been cached (or the data cache for which has expired). To prevent this, adjust the test frequency or test reserved connections frequency property as described in the WebLogic JDBC connection documentation. Creating the connection pool for Oracle Perform this procedure if your database is Oracle and your web application server is WebLogic. Version 7.0 Unica Confidential 37

38 Chapter 2: Basic Installation on Windows To create a connection pool for Oracle in WebLogic 1 Copy the ojdbc14.jar file located in the jdbc directory under your Oracle client installation and use it to overwrite the ojdbc14.jar file located in the server/lib/ directory under your WebLogic installation. 2 Restart the WebLogic server. 3 In the WebLogic Console, configure a new JDBC connection pool using the following guidelines. 4 On the Choose Database page, complete the fields using the following guidelines. Field Database Type Database Driver Description Select Oracle from the drop-down list. Select Oracle s Driver (Thin): Versions 9.0.1, 9.2.0, 10 from the dropdown list. 5 On the Define connection properties page, complete the fields using the following guidelines. Field Name Description Enter any unique name for the connection pool. Database Name Host Name Port Enter the name of the database that contains the Campaign system tables. Enter the name of the machine where the database that contains the Campaign system tables is installed. Enter the port of the database that contains the Campaign system tables. 38 Unica Confidential Affinium Campaign Installation Guide

39 Setting up and configuring the Campaign system tables Field Database User Name Password Confirm Password Description Enter the user name of the database account you noted in Task 6: Set up the Campaign database, on page 32. Enter the password for the database account you noted in Task 6: Set up the Campaign database, on page 32. Re-enter the password. 6 Test your connection. 7 A JDBC error may occur if your database goes down and restarts and you navigate to a page the data for which has not been cached (or the data cache for which has expired). To prevent this, adjust the test frequency or test reserved connections frequency property as described in the WebLogic JDBC connection documentation. Creating the connection pool for DB2 Perform this procedure if your database is DB2 and your web application server is WebLogic. To create a connection pool for DB2 in WebLogic 1 Obtain following DB2 driver files and copy them to the machine where WebLogic is installed: db2jcc.jar db2jcc_license_cu.jar 2 In the WebLogic startup script (startweblogic.cmd) add the db2jcc.jar and db2jcc_license_cu.jar files to the CLASSPATH, before the weblogic.jar entry. Use the full path to the location of the files. 3 Restart the WebLogic server. Version 7.0 Unica Confidential 39

40 Chapter 2: Basic Installation on Windows 4 In the WebLogic Console, configure a new JDBC connection pool using the following guidelines. 5 On the Choose Database page, complete the fields using the following guidelines. Field Database Type Database Driver Description Select DB2 from the drop-down list. Select Other. 6 On the Define connection properties page, complete the fields as follows: Field Name Driver Classname URL Database User Name Password Confirm Password Description Enter any unique name for the connection pool. Enter com.ibm.db2.jcc.db2driver Enter jdbc:db2://servername:port/dbname where servername, port, and DBName are values appropriate for your environment. For example: jdbc:db2://corporateserver:50000/campaign The default port is your port may be different. Enter the user name for the database account you noted in Task 6: Set up the Campaign database, on page 32. Enter the password for the database account you noted in Task 6: Set up the Campaign database, on page 32. Re-enter the password. 7 Test your connection. 40 Unica Confidential Affinium Campaign Installation Guide

41 Setting up and configuring the Campaign system tables 8 A JDBC error may occur if your database goes down and restarts and you navigate to a page the data for which has not been cached (or the data cache for which has expired). To prevent this, adjust the test frequency or test reserved connections frequency property as described in the WebLogic JDBC connection documentation. Creating the data source for all database types Perform this procedure for all database types when your web application server is WebLogic. To create a data source and associate it with the connection pool in WebLogic 1 In the WebLogic Console, configure a new JDBC data source using the guidelines in the following table. Field Name JNDI Name Honor Global Transactions Emulate Two- Phase Commit for non-xa Driver Description Enter any name. For example: campaign partition1 Enter a name for this data source. The name must: Be unique within the web application server domain Match the value of the JndiName property in the affinium_config.xml file. The default value for this property in the default partition is campaignpartition1ds. Check the checkbox. Leave the checkbox unchecked. 2 On the Connect to connection pool page, select the connection pool for you created for database that contains the Affinium Campaign system tables. 3 If necessary, modify affinium_config.xml to use the data source JNDI name you entered in step 1. See Task 12: Configure system tables as Campaign data sources, on page 51 for details. Version 7.0 Unica Confidential 41

42 Chapter 2: Basic Installation on Windows Configuring the JDBC data source in WebSphere If WebSphere is your web application server, use the procedures in this section that are appropriate for your database. There are two steps to configuring the JDBC data source in WebSphere: Create the J2 authentication data entry, which is where WebSphere stores the user name and password for the JDBC connection to the database. This section describes this procedure, which is the same for all database types. Configure the JDBC data source. This section provides separate procedures for configuring the JDBC data source for each of the database types that are supported for Affinium Campaign system tables. Creating the J2 authentication data entry for all database types Perform this procedure for all database types when your web application server is WebSphere. To create the J2 authentication data entry 1 In the Administrative Console, select Security > JAAS Configuration > J2C Authentication Data. 2 On the Configure the data source page, complete the fields using the following guidelines. Field Alias Description Enter any name. Make a note of the name: you will use it in a subsequent procedure. 42 Unica Confidential Affinium Campaign Installation Guide

43 Setting up and configuring the Campaign system tables Field User ID Password Description Description Enter the user name for the database account you noted in Task 6: Set up the Campaign database, on page 32. Enter the password for the database account you noted in Task 6: Set up the Campaign database, on page 32. Enter a description for this alias. Creating the JDBC data source for SQL Server Perform this procedure if your database is SQL Server and your web application server is WebSphere. To configure the JBDC data source for SQL Server in WebSphere 1 Obtain the Microsoft SQL Server 2005 JDBC driver and unpack it on the machine where WebSphere is installed. 2 In the Administrative Console, create a new JDBC provider using the guidelines in the following table that are appropriate for your version of WebSphere. Field Description WebSphere JDBC Providers Class Path Driver Class Name Select User-defined JDBC provider from the dropdown list. Change to the full path to the extracted sqljdbc.jar file. Enter com.microsoft.sqlserver.jdbc. SQLServerConnectionPoolDataSource WebSphere Version 7.0 Unica Confidential 43

44 Chapter 2: Basic Installation on Windows Field Database type Provider type Implementation type Class Path Driver Class Name Description Select User-defined from the drop-down list. Select User-defined JDBC provider from the dropdown list. Select User-defined from the drop-down list. Change to the full path to the extracted sqljdbc.jar file. Enter com.microsoft.sqlserver.jdbc. SQLServerConnectionPoolDataSource 3 Save your changes to the master configuration. 4 Click the JDBC provider you just created and click Data Sources under Additional Properties. 5 Add a new data source using the following guidelines. Field Name JNDI name Componentmanager authentication alias Description Enter any name. Enter a name. The name must: Be unique within the web application server domain Match the value of the JndiName property in the affinium_config.xml file. The default value for this property in the default partition is campaignpartition1ds Select DefaultNode/J2 alias from the drop-down list where J2 alias is the alias you created in To create the J2 authentication data entry on page Unica Confidential Affinium Campaign Installation Guide

45 Setting up and configuring the Campaign system tables 6 Go to the data source s Custom Properties and add new properties using the following guidelines. Property name Value servername portnumber databasename enable2phase Enter the name of the SQL server that hosts the database that contains the Campaign system tables. Enter the port number of the SQL server that hosts the database that contains the Campaign system tables. Enter the physical name of the database that contains the Campaign system tables. Enter false. 7 Save your changes to the master configuration. 8 Test your connection. 9 If necessary, modify affinium_config.xml to use the data source JNDI name you entered in step 4. See Task 12: Configure system tables as Campaign data sources, on page 51 for details. Creating the JDBC data source for Oracle Perform this procedure if your database is Oracle and your web application server is WebSphere. Version 7.0 Unica Confidential 45

46 Chapter 2: Basic Installation on Windows To configure the JDBC data source for Oracle in WebSphere 1 In the Administrative Console, create a new JDBC provider using the guidelines in the following table that are appropriate for your version of WebSphere. Field JDBC Providers Class Path Description WebSphere Select Oracle JDBC Provider from the drop-down list. Change to the full path to the JDBC Oracle Type 4 driver located in the jdbc/lib directory under your Oracle client installation. WebSphere Database type Provider type Implementation type Class Path Select Oracle from the drop-down list. Select Oracle JDBC Driver from the drop-down list. Select Connection Pool Datasource from the dropdown list. Change to the full path to the JDBC Oracle Type 4 driver located in the jdbc/lib directory under your Oracle client installation. 2 Save your changes to the master configuration. 3 Click the JDBC provider you just created and click Data Sources under Additional Properties. 46 Unica Confidential Affinium Campaign Installation Guide

47 Setting up and configuring the Campaign system tables 4 Add a new data source using the following guidelines. Field Name JNDI name Componentmanager authentication alias URL Description Enter any name. Enter a name. The name must: Be unique within the web application server domain Match the value of the JndiName property in the affinium_config.xml file. The default value for this property in the default partition is campaignpartition1ds Select DefaultNode/J2 alias from the drop-down list Where J2 alias is the alias you created in To create the J2 authentication data entry on page 42. Change the value to reflect your configuration, using the following format: jdbc:oracle:thin:@db_server_name:port:db_name For example: jdbc:oracle:thin:@mydbhost:1521:mydb 5 Save your changes to the master configuration. 6 Test your connection. 7 If necessary, modify the affinium_config.xml to use the data source JNDI name you entered in step 4. See Task 12: Configure system tables as Campaign data sources, on page 51 for details. Creating the JDBC data source for DB2 Perform this procedure if your database is DB2 and your web application server is WebSphere. Version 7.0 Unica Confidential 47

48 Chapter 2: Basic Installation on Windows To configure the JBDC data source for DB2 in WebSphere 1 In the Administrative Console, create a new JDBC provider using the guidelines in the following table that are appropriate for your version of WebSphere. Field JDBC Providers drop-down list Class Path Description WebSphere Select DB2 Universal JDBC Driver Provider. Change to the full path to the Universal JDBC Driver Provider files located in the java directory under your DB2 client installation. The files are: db2jcc.jar db2jcc_license_cu.jar db2jcc_license_cisuz.jar These files must be on the same machine where WebSphere is installed. WebSphere Database type Provider type Implementation type Class Path Select DB2 from the drop-down list. Select DB2 Universal JDBC Driver Provider from the drop-down list. Select Connection Pool Datasource from the dropdown list. Change to the full path to the Universal JDBC Driver Provider files located in the java directory under your DB2 client installation. The files are: db2jcc.jar db2jcc_license_cu.jar db2jcc_license_cisuz.jar 2 Save your changes to the master configuration. 3 Click the JDBC provider you just created and click Data Sources under Additional Properties. 48 Unica Confidential Affinium Campaign Installation Guide

49 Setting up and configuring the Campaign system tables 4 Add a new data source using the following guidelines. Field Name JNDI name Componentmanager authentication alias Description Enter any name. Enter a name. The name must: Be unique within the web application server domain Match the value of the JndiName property in the affinium_config.xml file. The default value for this property in the default partition is campaignpartition1ds Select DefaultNode/J2 alias from the drop-down list where J2 alias is the alias you created in To create the J2 authentication data entry on page Go to the data source s Custom Properties and set values using the guidelines in the following table that are appropriate for your version of WebSphere. Field Description WebSphere only databasename servername portnumber Enter the physical name of the database that contains the Campaign system tables. Enter the name of the DB2 server that hosts the database that contains the Campaign system tables. Enter the port number of the DB2 server that hosts the database that contains the Campaign system tables. WebSphere and resultsetholdability Set the value to 1. If you do not find a field named resultsetholdability, add this value as a connectionattribute. 2 Save your changes to the master configuration. 3 Test your connection. Version 7.0 Unica Confidential 49

50 Chapter 2: Basic Installation on Windows 4 If necessary, modify affinium_config.xml to use the data source JNDI name you entered in step 4. See Task 12: Configure system tables as Campaign data sources, on page 51 for details. Task 11: Store system table database credentials You must identify or create a Campaign system user in Affinium Manager and give that system user access to the Affinium Campaign system tables. You do this by adding a data source to the user s account in Affinium Manager. The following procedure assumes familiarity with Affinium Manager. For additional details on working with Affinium Manager, see the Affinium Manager Administrator s Guide. To store system table database credentials 1 Your database administrator should have set up database credentials (user name and password) for the Campaign system user. Obtain the following information: The database login name for the Campaign system user The database password for the Campaign system user For example, the information you obtain might be: user name: sa password: sa 2 Log in to Affinium Manager and identify an existing Affinium user you want to use as the Campaign system user, or create a new user. If you create a new user, you do not need to complete all the fields on the New User page. The Login field is the only required field. The following table shows the recommended way to complete the page. Field Login Action / Description Enter any name. This name must match the value you give to the ASMUserForDBCredentials property. See Task 12: Configure system tables as Campaign data sources, on page 51 for details. 50 Unica Confidential Affinium Campaign Installation Guide

51 Setting up and configuring the Campaign system tables Field First Name Last Name Action / Description Enter User This field is optional. Enter Campaign This field is optional 3 Add a new data source for the user you identified or created in step 2. On the New Data Source page, complete the form as shown in the following table: Field Data Source Data Source Login Alternate Login Data Source Password Confirm Password Action / Description Enter UA_SYSTEM_TABLES Enter the login name for this data source. Required. Leave blank. Enter the password for this data source. Campaign allows this field to be empty, if the data source account does not have a password. Passwords are case-sensitive and must match the original password exactly. Enter the password again (leave empty if you left the Data Source Password field empty). 4 Save your changes and log out of Affinium Manager. Task 12: Configure system tables as Campaign data sources The following procedure describes how to configure the Campaign system tables in the default partition, partition1, with the default language, English. For additional information, see: Chapter 4, Configuring Multiple Partitions, on page 119 Chapter 8, Configuring Affinium Campaign for a Non-English Language, on page 181 Version 7.0 Unica Confidential 51

52 Chapter 2: Basic Installation on Windows To configure the system tables in the affinium_config.xml file 1 Each data source is configured in the affinium_config.xml file, which is located under your Affinium Manager installation in the confdata directory. The properties and default values in the default partition are designed for SQL Server. If your database is Oracle or DB2, you should copy and paste the data source XML from the template provided with your Campaign installation. See To copy the DB2 or Oracle template on page 53 for instructions. 2 Log in to Affinium Manager and click Configuration Manager. 3 Set required properties in the applications > Campaign > partitions > partition1 > datasources > UA_SYSTEM_TABLES category as described in the following table. Property Value JndiName Type ASMUserForDBCredentials DSN Set the value to the JNDI name you specified when you set up the JDBC connection in the web application server. The default value is campaignpartition1ds. This name must be unique within the web application server. Set the value appropriate for your database type. Valid values are: SQLServer DB2, DB2ODBC ORACLE ORACLE8 ORACLE9 Set the value to the login name of the system user you created or used in Task 11: Store system table database credentials. If your ODBC or native data source name is not UA_SYSTEM_TABLES, set this value to the name of the ODBC or native data source pointing to your Campaign database. 52 Unica Confidential Affinium Campaign Installation Guide

53 Setting up and configuring the Campaign system tables 4 Configure other properties as desired. For detailed descriptions of the properties and their allowed and default values, see Appendix A, Properties in the Central Configuration File, on page 217. To copy the DB2 or Oracle template 1 Open the datasource_templates.xml file in a text or XML editor. The file is located in the conf directory under your Affinium Campaign installation. 2 Locate the category appropriate for your database, as follows: Oracle <category name="[oracle Example]"> DB2 <category name="[db2 Example]"> 3 Copy the entire category, including the opening and closing tags. For example: <category name="[oracle9 Example]">... [many XML tags]... </category> 4 Open the affinium_config.xml file and locate the applications > Campaign > partitions > partition1 > datasources category. 5 Paste the category you copied within the datasources category (before the closing datasources tag). 6 Change the name of the category you pasted to UA_SYSTEM_TABLES. 7 There can be only one category named UA_SYSTEM_TABLES in each partition. Therefore, change the name of the original datasources > UA_SYSTEM_TABLES category under your new partition to anything else, or simply delete the name. Version 7.0 Unica Confidential 53

54 Chapter 2: Basic Installation on Windows Setting up and configuring additional data sources Setting up additional data sources such as customer tables is a similar process to setting up the Campaign system tables, with a few important differences. This section provides an overview of setting up additional data sources in the default partition, partition1, with the default language, English. For additional information, see: Chapter 4, Configuring Multiple Partitions, on page 119 Chapter 8, Configuring Affinium Campaign for a Non-English Language, on page 181 Task 13: Set up additional data sources 1 For each additional data source (for example, customer tables), set up either an ODBC or, in the case of Oracle and DB2, a native connection. Select any unique name for the data source (except for UA_SYSTEM_TABLES - do not use this name for your customer tables). 2 Add a data source as described in Task 12: Configure system tables as Campaign data sources, on page 51. Note that the datasource_templates.xml file contains samples for the database types supported for customer tables, which include types not supported for Affinium Campaign system tables. 3 Set the category name to the ODBC or native connection name for the data source. 4 Set the applications > Campaign > partitions > partition1 > your_data_source_name > Type property in the new data source. Set the value appropriate for your database type. Valid values are: ORACLE ORACLE8 ORACLE9 54 Unica Confidential Affinium Campaign Installation Guide

55 Configuring Affinium Campaign SYBASE SQLServer DB2, INFORMIX7 INFORMIX8 INFORMIX9 TERADATA DB2ODBC NETEZZA SAS SASDB 5 Configure other properties as desired. For detailed descriptions of the properties and their allowed and default values, see Appendix A, Properties in the Central Configuration File, on page 217. Configuring Affinium Campaign To complete Affinium Campaign configuration, you edit the Affinium Suite configuration file, install the license key, and optionally configure multiple partitions and install and configure Affinium Reports. The following sections describe these tasks: Task 14: Set general configuration parameters Task 15: Install the license key Task 16: Configure multiple partitions Task 17: Install and configure Affinium Reports Task 14: Set general configuration parameters The configuration parameters that were found in the campaign_server.cfg, campaign_config.xml, and unica_acsvr.cfg files in various earlier versions of Affinium Campaign are now located in the affinium_config.xml file. Affinium Manager now provides a GUI interface that allows you to set property values in the affinium_config.xml file. You must set values to configure the following: Version 7.0 Unica Confidential 55

56 Chapter 2: Basic Installation on Windows The directory where the Affinium Campaign log property file resides The Campaign server host and port, if different from the defaults The specifications for the default partition, partition1 The Affinium drop-down menu The following procedure describes how to set values for a basic installation, which uses the default partition. For information on configuring for multiple partitions, see Chapter 4, Configuring Multiple Partitions, on page 119. For detailed descriptions of the properties and their allowed and default values, see Appendix A, Properties in the Central Configuration File, on page 217. If you make changes to this file after you deploy Campaign, you must restart the web application server (WebLogic or WebSphere). To set minimum required property values 1 Log in to Affinium Manager and click Configuration Manager. 56 Unica Confidential Affinium Campaign Installation Guide

57 Configuring Affinium Campaign 2 Set required properties as described in the following table. For detailed descriptions of these properties, see Appendix A, Properties in the Central Configuration File, on page 217. Property applications > Campaign > logging > log4jconfig applications > Campaign > unicaaclistener > serverhost applications > Campaign > unicaaclistener > serverport Value Set the value to the full path to your campaign_log4j.properties file. Specify the complete path, including the file name. Use back slashes (\). By default the file is located in the conf directory of your Campaign installation. For example: C:\Affinium\Campaign\conf\campaign_log4j.p roperties If the Campaign server is not installed on the same machine where Affinium Manager is installed, change the value to the machine name or IP address of the machine where the Campaign server is installed. If you do not want to accept the default port number (4664), set the value to the desired port number. 3 To configure the default partition, set values as desired in the applications > Campaign > partitions > partition1 category. 4 To configure the Affinium menu, set the applications > product_name > navigation > serverurl properties to the URLs of the installed applications. See Configure for SSL (optional) on page 25 if you want to use SSL. Task 15: Install the license key Next, you must install the license key that you obtained by ing a software request form to support@unica.com. To install the license key 1 Verify that Affinium Manager is deployed and started. Version 7.0 Unica Confidential 57

58 Chapter 2: Basic Installation on Windows 2 Open a command prompt, and do the following: a b c Set the AFFINIUM_HOME environment variable. For example: set AFFINIUM_HOME=C:\Affinium Change directories to the Affinium\Campaign\bin directory Run install_license.exe, using the number contained in the file you received from Unica. For example: install_license.exe 7UXB2AWXYZWFDMUMKS8Q 3 Open the Campaign\conf directory, and verify that there is a license.txt file. Task 16: Configure multiple partitions This step is optional. For information on configuring multiple Affinium Campaign partitions, see Chapter 4, Configuring Multiple Partitions, on page 119. Task 17: Install and configure Affinium Reports To enable reporting, refer to the following documents to install and configure Affinium Reports: For basic installation, see the Affinium Reports Installation Guide. To customize Affinium Campaign reports, see the Affinium Campaign Administrator s Guide. Deploying the web application and verifying the installation To deploy the web application and verify the installation, perform the following tasks: Task 18: Modify environment properties 58 Unica Confidential Affinium Campaign Installation Guide

59 Deploying the web application and verifying the installation Task 19: Start thecampaign server Task 20: Deploy the Campaign web application Task 21: Map tables Task 22: Verify the installation Task 18: Modify environment properties For all installations, perform the procedure described in Modifying the JAVA_OPTIONS property on page 59. If version 2.1 of Affinium Security Manager was previously deployed on your web application server, perform the procedure described in Checking and correcting the java.security file on page 61. Modifying the JAVA_OPTIONS property Affinium products may require that you modify the web application server s JAVA_OPTIONS property. Also, if earlier versions of Affinium applications were previously installed on the web application server on which you plan to deploy Affinium Campaign, you may need to remove or modify this property. Select the procedure below that is appropriate for your web application server (WebSphere or WebLogic). To check and correct the JAVA_OPTIONS property in WebLogic 1 Locate the appropriate WebLogic startup script to edit: If WebLogic is started from a script, edit the startmanagedweblogic.cmdstartmanagedweblogic.sh file. If WebLogic is installed as a Windows service, edit the installservice.cmd file. These files are located the home directory of the domain where you deployed Affinium products, under WebLogic's domain home directory. For example: \\bea\user_projects\domains\mydomain 2 Open the file in a text editor and find the JAVA_OPTIONS entry. Version 7.0 Unica Confidential 59

60 Chapter 2: Basic Installation on Windows 3 Check and modify the JAVA_OPTIONS property if necessary, as described in the following table. JAVA_OPTIONS entry AFFINIUM_HOME auth.login.config Take this action This entry is not required for Affinium Campaign. If this entry exists, do one of the following: If none of the Affinium products you are installing requires this entry, remove it. If any of the Affinium products you are installing requires this entry, verify that the value is correct. The value should be full path to the root installation directory of the Affinium Suite. For example: -DAFFINIUM_HOME=C:\Affinium See product documentation to determine whether this entry is required. This entry is not required for Affinium Campaign. Remove this entry if it is present. 4 Stop and restart your web application server. To check and correct the JAVA_OPTIONS property in WebSphere 1 In the WebSphere Administrative Console, navigate to the Generic JVM arguments for the server where you are deploying Affinium Campaign. 60 Unica Confidential Affinium Campaign Installation Guide

61 Deploying the web application and verifying the installation 2 Check and modify the JAVA_OPTIONS property if necessary, as described in the following table. JAVA_OPTIONS entry AFFINIUM_HOME auth.login.config Take this action This entry is not required for Affinium Campaign. If this entry exists, do one of the following: If none of the Affinium products you are installing requires this entry, remove it. If any of the Affinium products you are installing requires this entry,verify that the value is correct. The value should be full path to the root installation directory of the Affinium Suite. For example: -DAFFINIUM_HOME=C:\Affinium See product documentation to determine whether this entry is required. Do one of the following: If this entry exists, verfiy that its value is correct. If this entry does not exist, add it. For example: -Djava.security.auth.login.config== C:\Affinium\conf\jaas.config Note the double equals sign (==). If there is already text in the Generic JVM arguments field, enter the text at the beginning of the line and ensure that there is a space after the text you enter (entries are separated by spaces). 3 Stop and restart your web application server. Checking and correcting the java.security file If version 2.1 of Affinium Security Manager was previously deployed on your web application server, verify that the web application server security property is not set in the java.security file, as this could cause problems. Perform the following procedure. To check and correct the java.security file 1 Open the java.security file in a text editor. Version 7.0 Unica Confidential 61

62 Chapter 2: Basic Installation on Windows The file is located in java_home\jre\lib\security, where java_home is your web application server's JRE root directory. For example: \bea\jdk141_05\jre\lib\security If you typically use Notepad to open text files, and the formatting of this file is difficult to read when you open it, try using WordPad. 2 Find the login.config.url.1 property and be sure that there is a # at the beginning of the line. (The # character comments out the line; removing it uncomments the line.) Task 19: Start thecampaign server You can start the Campaign server directly, or install it as a service. To start the Campaign server directly 1 Verify that Affinium Manager is deployed and started. 2 If you installed Campaign using the default port number 4664 do one of the following: From the Windows Start menu, select Start > Programs > Affinium Campaign Server. Start the Campaign server directly by clicking on the cmpserver.bat file located in the Campaign\bin directory. Run the cmpserver.bat file from a command window. When the unica_aclsnr.exe process appears on the Windows Task Manager Processes tab, the server has started successfully. To install the Campaign server as a service 1 Verify that Affinium Manager is deployed and started. 2 If Campaign\bin is included in the system path environment variable, remove it. You do not need Campaign\bin in the path environment variable to install the Campaign server as a service. 62 Unica Confidential Affinium Campaign Installation Guide

63 Deploying the web application and verifying the installation Including any installation of Campaign in the client machine s path environment variable interferes with the flowchart ActiveX control download. 3 If you are upgrading from a previous version of Campaign that had the server installed as a service, do the following: a b c Select Start > Settings > Control Panel > Administrative Tools > Services. The Services (Local) window appears. Select Unica Affinium Campaign Listener (the unica_aclsnr service). Click Stop. 4 From the command prompt, go to the Campaign\bin directory. 5 Run the following on the command line to create the Campaign server service: unica_aclsnr i You can verify that you created the service correctly by looking in Start > Settings > Control Panel > Administrative Tools > Services. It should be listed among the running services. 6 If the server service fails to start, change the account used to log on the service from the local system account (default) to a valid account in the network domain, by performing the following steps: a b c d From the Services window, double-click the Unica Affinium Campaign Listener service. The Unica Affinium Campaign Listener Properties window appears. Click the Log On tab. Click This Account in the Log on as field. Browse for and select a valid account on the domain. 7 If you want the server to start automatically, do the following: Version 7.0 Unica Confidential 63

64 Chapter 2: Basic Installation on Windows a a From the Services window, double-click the Unica Affinium Campaign Listener service (unica_aclsnr). The Unica Affinium Campaign Listener Properties window appears. Select Automatic from the Startup type drop-down list. To determine the process ID for the server you started, view the unica_aclsnr.pid file located in the conf directory under your Affinium Campaign installation. Task 20: Deploy the Campaign web application Because the Affinium Suite applications require configurational control of the Java Virtual Machine (JVM), you must deploy Affinium applications on a dedicated JVM. You cannot deploy non-unica applications in the same JVM as any Unica Affinium application. If necessary, Unica can provide a separate JVM for Affinium applications. This task describes how to deploy the Affinium Campaign web application on either IBM WebSphere or on WebLogic. For complete details on deploying web applications, consult your web application server s documentation. Deploying on IBM WebSphere Use the following procedure to deploy the Campaign web application on IBM WebSphere. To deploy the Campaign web application on IBM WebSphere 1 Verify that the Campaign server is running, as described in Task 19: Start thecampaign server. 64 Unica Confidential Affinium Campaign Installation Guide

65 Deploying the web application and verifying the installation The Campaign server must be running when you start the Campaign web application. If you restart the Campaign server, you must also restart the Campaign web application. 2 Start the WebSphere application server. 3 Log in to the Administrative Console and deploy the Campaign.war file as an enterprise application, following these guidelines: If you are deploying on WebSphere Express 6.0.2, create a new custom server property named prependslashtoresource and set its value to to true. For more information, search on prependslashtoresource or SRVE0238E in the IBM documentation. On the server s Configuration > General Properties tab, set ClassloaderMode = PARENT_LAST and WAR Classloader Policy = APPLICATION. In the server s Web Container > Session Management section, enable cookies and change the cookie name from JSESSIONID to CAMPAIGNSESSIONID. 4 When the deployment is complete, start the application. Deploying on BEA WebLogic Affinium products customize the JVM used by WebLogic. You may need to create a WebLogic instance dedicated to Affinium products if you encounter JVM-related errors. The BEA WebLogic Express server initially installs with a limited license. If this is a new WebLogic installation you must upgrade the license. For more information, see the License Update Readme.txt file in the WebLogic installation media. Use the procedure below that applies to your configuration of WebLogic. To deploy the Campaign web application using WebLogic s console 1 Verify that the Campaign server is running, as described in Task 19: Start thecampaign server. Version 7.0 Unica Confidential 65

66 Chapter 2: Basic Installation on Windows The Campaign server must be running when you start the Campaign web application. If you restart the Campaign server, you must also restart the Campaign web application. 2 Verify that the SDK selected for the WebLogic domain you are using is the Sun SDK by looking in the startup script (startweblogic.cmd) for the JAVA_VENDOR variable. It should be set to: JAVA_VENDOR=Sun. If it is set to JAVA_VENDOR=BEA, JRockit has been selected. JRockit is not supported. To change the selected SDK, refer to the BEA WebLogic documentation. 3 If you are configuring WebLogic to use the IIS plug-in, review the WebLogic documentation at 4 Start the WebLogic application server. 5 Log in to the Administration Console. and deploy the Campaign.war file as a web application module. Unica recommends you name the deployment Campaign. This is case-sensitive in UNIX. Task 21: Map tables System tables should map automatically when you first log in to Affinium Campaign. However, you need map any other data sources you have configured. See the Affinium Campaign Administrator s Guide for information on mapping tables. Task 22: Verify the installation Use the following procedure to verify the installation. Affinium Campaign 7.0 uses an ActiveX control for flowcharts and administration functions. This flowchart automatically downloads when needed. The recommended security settings for the IE browser is medium-low for local intranet. Specifically, the client browser must have enabled: - Download signed ActiveX controls 66 Unica Confidential Affinium Campaign Installation Guide

67 Deploying the web application and verifying the installation - Run ActiveX controls and plugins - Script ActiveX controls marked safe for scripting To verify the installation 1 Verify that the Campaign server is running. Look for unica_aclsnr.exe on the Processes tab of the Task Manager. 2 Log in to the Campaign web application. The URL for accessing the Campaign web application depends on the context root defined when you deployed the application to the web application server. It is generally: To log in as a newly created Affinium user, you must log in to Campaign as or an existing user in the Campaign Administrators group in Affinium Manager (for example, asm_admin) and add at least one security role (e.g., Global Policy / Admin) to your new user. You can then log in as that new user. 3 Verify that all system tables exist in the Administration > Manage Table Mappings window. 4 Create a new campaign to test writing to system tables and the campaign code generator. To do this, you must log in as a user with appropriate permissions in Campaign. See the Affinium Campaign Administrator s Guide for instructions on how to set up user security policies. 5 Create a new flowchart. 6 Create a new offer to test the offer code generator. Version 7.0 Unica Confidential 67

68 Chapter 2: Basic Installation on Windows Troubleshooting The following table describes some problems you may encounter when testing the installation, and their resolution. Error Root Folder for [CampaignObject] was not found Error 1786 Server process has exited System tables did not map automatically Resolution The Campaign objects may be Campaigns, Segments, Offers, or Sessions. Action: Verify all the SQL scripts were run to populate the system tables. See Task 7: Create and populate the system tables, on page 33. This error occurs when the listener has not been restarted after setting the roles. Action: Stop the listener and restart the web application server. Action: Verify that the Campaign system user is set up in Affinium Manager and that this user has the Campaign system tables as a data source. 68 Unica Confidential Affinium Campaign Installation Guide

69 3 BASIC INSTALLATION ON UNIX This chapter contains all the steps necessary to implement a successful installation of the Affinium Campaign software application on the UNIX operating system. For information on installing on the Windows operating system, see Chapter 2, Basic Installation on Windows, on page 21. Unica strongly recommends that you engage with Unica Consulting Services for installations of Affinium products. This chapter includes the following topics: Overview Preparing for installation Installing the Campaign server and web application Setting up and configuring the Campaign system tables Setting up and configuring additional data sources Configuring Affinium Campaign Affinium Campaign Installation Guide Unica Confidential 69

70 Chapter 3: Basic Installation on UNIX Deploying the web application and verifying the installation Troubleshooting Overview Installing Affinium Campaign is a multi-part process. To ensure a successful installation, perform the steps in the order described in this chapter. This overview provides additional information that you should keep in mind when performing the installation procedures. System requirements Hardware, operating system, web server, and database requirements are described in the Affinium Campaign Supported Software Environments and Minimum System Requirements document. Client machines Client machines should meet the following configuration requirements: Campaign uses an ActiveX control for flowcharts and administration functions. This flowchart automatically downloads when needed. The recommended security settings for the IE browser is medium-low for local intranet. Specifically, the client browser must have enabled: Download signed ActiveX controls Run ActiveX controls and plugins Script ActiveX controls marked safe for scripting On the Internet Explorer Tools > Internet Options > Settings dialog box, in the Check for newer versions of stored pages section, Every visit to the page should be selected. If pop-up blocker (ad blocker) software is installed on the client machine, Affinium Campaign may not function properly. We recommend disabling pop-up blocker software while running Affinium Campaign. 70 Unica Confidential Affinium Campaign Installation Guide

71 Overview Upgrades If you are upgrading from a previous version of Affinium Campaign, see Chapter 5, Upgrading to Affinium Campaign 7.0.1, on page 135 before installing. Internationalization and localization Utilities The instructions in this chapter assume you are configuring Campaign to use the English language. If you are planning to use any other language, see Chapter 8, Configuring Affinium Campaign for a Non-English Language, on page 181. Affinium Campaign is distributed with a variety of utilities. See Appendix C, Active X Cleanup Utility, on page 315 for details on using the Active X cleanup utility, uacflchk.exe. This utility is designed to resolve Object not Loaded / Object does not support this property or method errors when a user tries to access Campaign pages with Active X controls. See the Affinium Campaign Administrator s Guide for details on using the following utilities: The Affinium Campaign Server Manager (unica_svradm), a command-line server management utility that allows you to perform the following tasks: Connect to the Affinium Campaign listener View all currently open flowcharts View and set environment variables The Affinium Campaign Session Utility (unica_acsesutil), which allows you to pass in a flowchart file or table catalog as input, and generate a table catalog as output. You can also use it to move campaigns, sessions, and flowcharts from one server to another. Database test utilities: (cxntest, db2test, odbctest, oratest), which you can use to test connections to a target database and execute queries and perform a variety of tasks. Version 7.0 Unica Confidential 71

72 Chapter 3: Basic Installation on UNIX Preparing for installation Before you can install Affinium Campaign, you need to perform the preparatory tasks described in this section as follows: Task 1: Obtain software and installation license key Task 2: Obtain the Affinium Manager host and port Task 3: Set up privileges Task 4: Configure for SSL (optional) Task 1: Obtain software and installation license key For new installations, the Unica Consulting team obtains a copy of the Affinium Campaign software and a license key for you by ing a software request form to support@unica.com. If you download the installation files from an FTP site, download them in binary mode and then change permissions to make the files executable before you install them on your Campaign server. To obtain software 1 Do one of the following: Insert the software CD and mount the CD_ROM drive (for example, mount /dev/device/ directory_to_mount), and copy the Affinium Suite installation files from the CD-ROM to your machine. Use the mount command to mount the CD-ROM drive. For example: mount /dev/device/ directory_to_mount Download the installation files from the Unica Support FTP site. Contact Unica support for login and URL information. See Unica technical support on page 14 for contact information. 2 Change the file permissions on the.bin installation files to 777. For example: chmod 777 CampaignServer_OS.bin 72 Unica Confidential Affinium Campaign Installation Guide

73 Preparing for installation Task 2: Obtain the Affinium Manager host and port Affinium Manager must be installed and running before you install Affinium Campaign. Obtain the host and port information for the Affinium Manager instance that you plan to use with Affinium Campaign. See the Affinium Manager Installation Guide for information on installing or upgrading Affinium Manager. Verify that the SDK selected for the WebLogic domain you are using is the Sun SDK by looking in the startup script (startweblogic.sh) for the JAVA_VENDOR variable. It should be set to: JAVA_VENDOR="Sun". If it is set to JAVA_VENDOR="BEA", JRockit has been selected. JRockit is not supported. To change the selected SDK, refer to the BEA WebLogic documentation. Task 3: Task 4: Set up privileges You must create a user in a group that shares privileges with the UNIX users of Campaign (the UNIX group to which all the Affinium Manager alternate logins for Campaign users belong). In addition, this user must be a member of the group to which the user that installed Affinium Manager belongs. Log in to UNIX as this user to install Affinium Campaign. Configure for SSL (optional) If you want to configure the Campaign listener to communicate using SSL, you must perform the configuration tasks described in this section, and also select the Use secure connection option when you install the Campaign server. This section describes the following configuration tasks: Configure the web application server to use SSL. Set several configuration parameters in the affinium_config.xml configuration file. To configure the web application server to use SSL 1 Enable the SSL port in the web application server (WebLogic or WebSphere). Version 7.0 Unica Confidential 73

74 Chapter 3: Basic Installation on UNIX Consult the web application server s documentation for instructions on how to do this, or follow the directions in the Implementing Trusted Application Support chapter of the Affinium Manager Installation Guide for configuring the default SSL port to use the Unica keystores. You do not have to implement trusted application support, but you must enable SSL. 2 When you deploy the Campaign server, use the port that has SSL enabled. 3 If desired, you can also deploy the Campaign web application in SSL mode, by deploying the web application to use the port that is configured to use SSL. Set configuration parameters 1 Log in to Affinium Manager and click Configuration Manager. 2 Under applications > Campaign > unicaaclistener, set properties as described in the following table. Property Value usessl serverport yes The SSL port the server will listen on 3 If you are using the operational monitor, and you deploy the Campaign web application in SSL mode, under applications > Campaign > unicaaclistener, use the HTTPS protocol when you set the value of the serverurl property to the URL of the Campaign web application. For example: 4 Open the config.xml file in a text or XML editor. The file is located in the Affinium/conf directory. 5 Under bootstrap > applications > Campaign > server, set the value of the UnicaServerSSLFile property to the full path to the certificate you want to use for the Affinium Campaign server. 74 Unica Confidential Affinium Campaign Installation Guide

75 Installing the Campaign server and web application The server certificate supplied by Unica is named unicaclient.pem and is located in the security directory under your Affinium Suite installation. for example: /home/affinium/security/unicaclient.pem 6 Save and close the config.xml file. Installing the Campaign server and web application Next, you need to install the Affinium Campaign server and web application. Task 5: Install the Campaign server and J2EE web application, on page 75 describes this task. Each InstallShield package requires a java virtual machine (JVM) to run. If InstallShield cannot find a JVM in the path, it installs a JVM automatically into the installation directory. This JVM is used only by the installer and uninstaller, and is removed when you uninstall Campaign. Task 5: Install the Campaign server and J2EE web application This section describes the basic features of the Affinium Campaign installer and provides an overview of the installation and configuration process. About the Affinium Campaign installer Affinium Campaign installers are provided for the following operating systems: Windows Solaris HP-UX AIX Version 7.0 Unica Confidential 75

76 Chapter 3: Basic Installation on UNIX You can run the Affinium Campaign installer in either command line or GUI mode. The installer can perform these types of installs: New install Described in this Task. Repair install When you run the installer and select a root directory where the same version of Affinium Campaign has previously been installed, the installer automatically runs in repair mode. The repair install is described in Chapter 9, Repairing and Uninstalling Affinium Campaign, on page 211. Navigating in the installation wizard When the installer runs in GUI mode, you navigate using the Next, Back, Cancel, and Finish buttons. When the installer runs in command line (console) mode, you navigate by entering numbers that correspond to the buttons in GUI mode, as described in the help text on each screen of the wizard. In command line mode, an additional redisplay command is available. A number is displayed in square brackets at the end of the prompt line; this is the default command issued if you press Enter without typing a number. For example, if the end of the line displays [1], pressing Enter displays the next screen. Selecting Campaign components The Affinium Campaign installer allows you to choose whether you want to install the Campaign server, Campaign J2EE web application, user documentation, Campaign report models, and developer toolkit on the same machine, or on different machines. The component installations do the following: The Campaign server installation creates the startup scripts, and allows you to run multiple Campaign servers, if necessary. The Campaign J2EE web application installation installs log and configuration files, as well as all the files you need to deploy Campaign on your web application server. The user documentation installation installs the PDF version of the Affinium Campaign User s Guide and Affinium Campaign Administration Guide. 76 Unica Confidential Affinium Campaign Installation Guide

77 Installing the Campaign server and web application The Reports installation installs the Reports directory and data model files, which are necessary if you plan to implement Affinium Reports. See the Affinium Reports Installation Guide for details. The developer toolkit installs the validation classes that are used to implement custom validation. The Affinium Campaign installer provides a wizard to guide you through the installation process. The following sections describe how the installer works when you perform a new install. Install location The installer lets you select a root installation directory by entering it or by browsing and selecting it. The installer requires that Affinium Campaign be installed in the Affinium/Campaign directory, and it enforces this by appending /Affinium/Campaign to the end of any root installation directory path you select. You can specify a path relative to the directory from which you are running the installer by typing a period before the path. If the root directory you specify does not exist, the installer creates it, assuming the account with which you log in to your operating system has sufficient privileges. Affinium Suite and Affinium Manager requirement All Affinium products must be installed under a root Affinium Suite, which consists of an Affinium directory and several subdirectories and configuration files. The installer checks for the presence of the Affinium Suite in the root installation directory and installs these directories and files if they are not present. If the installer must install the Suite, you are prompted to provide the host and port of the Affinium Manager instance that you plan to use with this Suite. You also have the option of specifying whether the connection to Affinium Manager is secure (over SSL). Version 7.0 Unica Confidential 77

78 Chapter 3: Basic Installation on UNIX If the installer is unable to connect with Affinium Manager, the installer displays a warning message. If the warning message appears, you can go back and verify that you entered the correct host and port. If the warning still appears, you may cancel, or continue with the installation. If you install without connecting to Affinium Manager, you must do the following: Set the configurationserverbaseurl property in the config.xml file manually. The file is located in the conf directory under the Affinium Suite root directory (for example, in Affinium/conf). Summary pages The installer displays one or more summary pages that provide details about the installation location, features, and total size of the files it will install. You can review this information and go back to make changes, or proceed with the install. Installer file names The Campaign installation files are named according to the version of the application and the operating system with which they are intended to be used. For example, Campaign70_aix64.bin is version 7.0 and is intended for installation on the AIX 64-bit operating system. The examples in the following procedures use the name CampaignX_OS.bin to stand for all the possible file names. Installing Affinium Campaign Use the following guidelines to install Affinium Campaign. To install Affinium Campaign 1 Verify the following: If you are installing on HP or AIX, ensure that the /var directory has at least 36 MB of free space. If you are installing on any UNIX platform, verify that your login account has a valid home directory. 78 Unica Confidential Affinium Campaign Installation Guide

79 Installing the Campaign server and web application The installer requires this. 2 Run the installer. For example:./campaignx_os.bin You may use the following options: console Allows you to run the installer in command line mode without using an X client. For example:./campaignx_os.bin -console -is:tempdir path The installer requires approximately 400 MB free space in a temporary directory to cache files. By default, each UNIX user has a temporary directory (usually /tmp). If your default temporary directory does not have enough free space, use this option to point to a different directory. You must use a full path, rather than a relative path. The installer creates the directory that you specify if it does not yet exist. For example:./campaignx_os.bin -is:tempdir /opt/newtempdir 3 If you are installing the server and J2EE application on different machines, you need to install Reports only once, on either machine. You copy the Reports component to the Cognos install directory when you install Affinium Reports. See the Affinium Reports Installation Guide for details. Version 7.0 Unica Confidential 79

80 Chapter 3: Basic Installation on UNIX 4 If the installer detects that the Affinium Suite does not exist in the root Affinium directory you have specified, you are prompted to provide the information shown in the following table. Item Host Port Use secure connection checkbox Description Enter the name or IP address of the machine where the Campaign server is installed. Enter the port where the Campaign server is installed. Check this if you want the listener to communicate using SSL. See Task 4: Configure for SSL (optional), on page 73 for additional procedures required for SSL configuration. 80 Unica Confidential Affinium Campaign Installation Guide

81 Setting up and configuring the Campaign system tables Setting up and configuring the Campaign system tables Setting up and configuring the Campaign system tables is a multi-step procedure, as described in the following overview. Note that, in Affinium Campaign 7.0.x, the dbconfig.lis file is no longer in use. You use the affinium_config.xml file to configure all data sources (Campaign system tables and customer data). Overview of Campaign system table set-up The process for setting up the Campaign system tables differs slightly depending on whether Campaign is configured for a single partition or multiple partitions This section provides an overview of setting up system tables for an instance of Campaign configured to use a single partition (the default partition, partition1). Each step is explained in detail in later sections of this chapter. For information on setting up system tables for multiple partitions, see Chapter 4, Configuring Multiple Partitions, on page 119. To set up system tables for one partition Task 6: Set up the Campaign database Task 7: Create and populate the system tables Task 8: Perform language-specific updates to tables Task 9: Configure the ODBC or native data source Task 10: Configure the JDBC data source Task 11: Store system table database credentials Task 12: Configure system tables as Campaign data sources Task 6: Set up the Campaign database Work with the database administrator to do the following: Set up a database that will hold the Affinium Campaign system tables. Version 7.0 Unica Confidential 81

82 Chapter 3: Basic Installation on UNIX If your database is Microsoft SQL Server, enable the TCP/IP protocol on the SQL server. Set up or identify a database user with owner privileges. Make a note of this user s user name and password. You will need this information in subsequent procedures: Task 9: Configure the ODBC or native data source, on page 83 Task 10: Configure the JDBC data source, on page 84. Task 11: Store system table database credentials, on page 99. Task 7: Create and populate the system tables Scripts are packaged with the Affinium Campaign software that contain the execution commands needed to create and populate the Affinium Campaign system tables. Run these scripts in the database client (for example, Enterprise Manager for SQL Server). See your database administrator for assistance, if necessary. The scripts are located in the Campaign/ddl directory. To create the system tables Run the script appropriate for your database, as described in the following table. Script Name Database ac_systab_db2.sql ac_systab_ora.sql ac_systab_sqlsvr.sql DB2 Oracle SQL Server Run the DB2 script with the following options: db2 -td@ -vf ac_populate_tables_db2.sql If you are running the script from outside of the ddl directory, include the path to the script. 82 Unica Confidential Affinium Campaign Installation Guide

83 Setting up and configuring the Campaign system tables To populate the system tables Run the script appropriate for your database, as described in the following table. Script Name Database ac_populate_tables_db2.sql ac_populate_tables_ora.sql ac_populate_tables_sqlsvr.sql DB2 Oracle SQL Server Task 8: Perform language-specific updates to tables If you are installing a non-english version of Affinium Campaign, you must run a database script to update the UA_AttributeDef table with localized attribute display names and descriptions. To localize UA_AttributeDef values Run the script appropriate for your language, as described in the following table. You can run the English version of the script to restore the English values to UA_AttributeDef. Script Name custom_attr_update_en.sql custom_attr_update_fr.sql custom_attr_update_de.sql custom_attr_update_ja.sql Language English French German Japanese Task 9: Configure the ODBC or native data source The machine on which the Affinium Campaign server is installed must be able to communicate with the database that holds the Campaign system tables. Create Version 7.0 Unica Confidential 83

84 Chapter 3: Basic Installation on UNIX an ODBC or native data source for the Campaign system table database on the machine where the Campaign server is installed. Use the following guidelines: If you are configuring just one partition, name the data source UA_SYSTEM_TABLES. If you are configuring more than one partition, do not name any of the data sources UA_SYSTEM_TABLES. Follow the directions in Chapter 4, Configuring Multiple Partitions, on page 119. If your database is Oracle or DB2, consult your database client documentation for instructions on creating a native data source. If your database is SQL Server, create an ODBC data source. You create a new ODBC data source in an ODBC.ini file. The procedure for creating an ODBC data source differs, depending on the database type and the version of UNIX. See the database and operating system documentation for specific ODBC driver installation and configuration instructions. Task 10: Configure the JDBC data source Campaign version 7.0x uses JDBC (as well as an ODBC or native connection) to connect to the Campaign system tables. You must set up the JDBC connection in the web application server where you deploy the Campaign web application. Use the guidelines below that are appropriate for your web application server: Configuring the JDBC data source in WebLogic on page 85 Configuring the JDBC data source in WebSphere on page 91 If you are not familiar with configuring a JDBC data source in your web application server, consult the web application server documentation for additional details. Unica recommends that you use the latest vendor-provided Type 4 drivers when you set up the JDBC connection. The procedures in this section follow this guideline. 84 Unica Confidential Affinium Campaign Installation Guide

85 Setting up and configuring the Campaign system tables Configuring the JDBC data source in WebLogic If WebLogic is your web application server, use the procedures in this section that are appropriate for your database. There are two steps to configuring the JDBC data source in WebLogic: Create a connection pool. This section provides separate procedures for creating a connection pool for each of the database types that are supported for Affinium Campaign system tables. Create a data source and associate it with the connection pool. This section describes this procedure, which is the same for all database types. Creating the connection pool for SQL Server Perform this procedure if your database is SQL Server and your web application server is WebLogic. To create a connection pool for SQL Server in WebLogic 1 Obtain the Microsoft SQL Server 2005 JDBC driver and unpack it on the machine where WebLogic is installed. 2 In the WebLogic startup script (startweblogic.sh) add the sqljdbc.jar file to the CLASSPATH, before the weblogic.jar entry. Use the full path to the location where you unpacked the driver. 3 Restart the WebLogic server. 4 In the WebLogic Console, configure a new JDBC connection pool using the following guidelines. Version 7.0 Unica Confidential 85

86 Chapter 3: Basic Installation on UNIX 5 On the Choose Database page, complete the fields using the following guidelines. Field Database Type Database Driver Description Select MS SQL Server from the drop-down list. Select Other from the drop-down list. 6 On the Define connection properties page, complete the fields using the following guidelines. Field Name Driver Classname URL Database User Name Password Confirm Password Description Enter any unique name for the connection pool. Enter com.microsoft.sqlserver.jdbc.sqlserverdriver Enter jdbc:sqlserver://servername:port; databasename=dbname where servername, port, and DBName are values appropriate for your environment. For example: jdbc:sqlserver://corporateserver:1433; databasename=campaign The default port is your port may be different. Enter the user name of the database account you noted in Task 6: Set up the Campaign database, on page 81. Enter the password of the database account you noted in Task 6: Set up the Campaign database, on page 81. Re-enter the password. If you did not create a password for the database user when you installed SQL Server, you must go back and create one. 7 Test your connection. 86 Unica Confidential Affinium Campaign Installation Guide

87 Setting up and configuring the Campaign system tables 8 A JDBC error may occur if your database goes down and restarts and you navigate to a page the data for which has not been cached (or the data cache for which has expired). To prevent this, adjust the test frequency or test reserved connections frequency property as described in the WebLogic JDBC connection documentation. Creating the connection pool for Oracle Perform this procedure if your database is Oracle and your web application server is WebLogic. To create a connection pool for Oracle in WebLogic 1 Copy the ojdbc14.jar file located in the jdbc directory under your Oracle client installation and use it to overwrite the ojdbc14.jar file located in the server/lib/ directory under your WebLogic installation. 2 Restart the WebLogic server. 3 In the WebLogic Console, configure a new JDBC connection pool using the following guidelines. 4 On the Choose Database page, complete the fields using the following guidelines. Field Description Database Type Database Driver Select Oracle from the drop-down list. Select Oracle s Driver (Thin): Versions 9.0.1, 9.2.0, 10 from the dropdown list. Version 7.0 Unica Confidential 87

88 Chapter 3: Basic Installation on UNIX 5 On the Define connection properties page, complete the fields using the following guidelines. Field Name Description Enter any unique name for the connection pool. Database Name Host Name Port Database User Name Password Confirm Password Enter the name of the database that contains the Campaign system tables. Enter the name of the machine where the database that contains the Campaign system tables is installed. Enter the port of the database that contains the Campaign system tables. Enter the user name of the database account you noted in Task 6: Set up the Campaign database, on page 81. Enter the password for the database account you noted in Task 6: Set up the Campaign database, on page 81. Re-enter the password. 6 Test your connection. 7 A JDBC error may occur if your database goes down and restarts and you navigate to a page the data for which has not been cached (or the data cache for which has expired). To prevent this, adjust the test frequency or test reserved connections frequency property as described in the WebLogic JDBC connection documentation. Creating the connection pool for DB2 Perform this procedure if your database is DB2 and your web application server is WebLogic. To create a connection pool for DB2 in WebLogic 1 Obtain following DB2 driver files and copy them to the machine where WebLogic is installed: db2jcc.jar 88 Unica Confidential Affinium Campaign Installation Guide

89 Setting up and configuring the Campaign system tables db2jcc_license_cu.jar 2 In the WebLogic startup script (startweblogic.sh) add the db2jcc.jar and db2jcc_license_cu.jar files to the CLASSPATH, before the weblogic.jar entry. Use the full path to the location of the files. 3 Restart the WebLogic server. 4 In the WebLogic Console, configure a new JDBC connection pool using the following guidelines. 5 On the Choose Database page, complete the fields using the following guidelines. Field Database Type Database Driver Description Select DB2 from the drop-down list. Select Other. 6 On the Define connection properties page, complete the fields as follows: Field Name Driver Classname URL Description Enter any unique name for the connection pool. Enter com.ibm.db2.jcc.db2driver Enter jdbc:db2://servername:port/dbname where servername, port, and DBName are values appropriate for your environment. For example: jdbc:db2://corporateserver:50000/campaign The default port is your port may be different. Version 7.0 Unica Confidential 89

90 Chapter 3: Basic Installation on UNIX Field Database User Name Password Confirm Password Description Enter the user name for the database account you noted in Task 6: Set up the Campaign database, on page 81. Enter the password for the database account you noted in Task 6: Set up the Campaign database, on page 81. Re-enter the password. 7 Test your connection. 8 A JDBC error may occur if your database goes down and restarts and you navigate to a page the data for which has not been cached (or the data cache for which has expired). To prevent this, adjust the test frequency or test reserved connections frequency property as described in the WebLogic JDBC connection documentation. Creating the data source for all database types Perform this procedure for all database types when your web application server is WebLogic. 90 Unica Confidential Affinium Campaign Installation Guide

91 Setting up and configuring the Campaign system tables To create a data source and associate it with the connection pool in WebLogic 1 In the WebLogic Console, configure a new JDBC data source using the guidelines in the following table. Field Name JNDI Name Honor Global Transactions Emulate Two- Phase Commit for non-xa Driver Description Enter any name. For example: campaign partition1 Enter a name for this data source. The name must: Be unique within the web application server domain Match the value of the JndiName property in the affinium_config.xml file. The default value for this property in the default partition is campaignpartition1ds. Check the checkbox. Leave the checkbox unchecked. 2 On the Connect to connection pool page, select the connection pool for you created for database that contains the Affinium Campaign system tables. 3 If necessary, modify affinium_config.xml to use the data source JNDI name you entered in step 1. See Task 12: Configure system tables as Campaign data sources, on page 100 for details. Configuring the JDBC data source in WebSphere If WebSphere is your web application server, use the procedures in this section that are appropriate for your database. There are two steps to configuring the JDBC data source in WebSphere: Create the J2 authentication data entry, which is where WebSphere stores the user name and password for the JDBC connection to the database. This section describes this procedure, which is the same for all database types. Version 7.0 Unica Confidential 91

92 Chapter 3: Basic Installation on UNIX Configure the JDBC data source. This section provides separate procedures for configuring the JDBC data source for each of the database types that are supported for Affinium Campaign system tables. Creating the J2 authentication data entry for all database types Perform this procedure for all database types when your web application server is WebSphere. To create the J2 authentication data entry 1 In the Administrative Console, select Security > JAAS Configuration > J2C Authentication Data. 2 On the Configure the data source page, complete the fields using the following guidelines. Field Alias User ID Password Description Description Enter any name. Make a note of the name: you will use it in a subsequent procedure. Enter the user name for the database account you noted in Task 6: Set up the Campaign database, on page 81. Enter the password for the database account you noted in Task 6: Set up the Campaign database, on page 81. Enter a description for this alias. Creating the JDBC data source for SQL Server Perform this procedure if your database is SQL Server and your web application server is WebSphere. 92 Unica Confidential Affinium Campaign Installation Guide

93 Setting up and configuring the Campaign system tables To configure the JBDC data source for SQL Server in WebSphere 1 Obtain the Microsoft SQL Server 2005 JDBC driver and unpack it on the machine where WebSphere is installed. 2 In the Administrative Console, create a new JDBC provider using the guidelines in the following table that are appropriate for your version of WebSphere. Field Description WebSphere JDBC Providers Class Path Driver Class Name Select User-defined JDBC provider from the dropdown list. Change to the full path to the extracted sqljdbc.jar file. Enter com.microsoft.sqlserver.jdbc. SQLServerConnectionPoolDataSource WebSphere Database type Provider type Implementation type Class Path Driver Class Name Select User-defined from the drop-down list. Select User-defined JDBC provider from the dropdown list. Select User-defined from the drop-down list. Change to the full path to the extracted sqljdbc.jar file. Enter com.microsoft.sqlserver.jdbc. SQLServerConnectionPoolDataSource 3 Save your changes to the master configuration. 4 Click the JDBC provider you just created and click Data Sources under Additional Properties. Version 7.0 Unica Confidential 93

94 Chapter 3: Basic Installation on UNIX 5 Add a new data source using the following guidelines. Field Name JNDI name Componentmanager authentication alias Description Enter any name. Enter a name. The name must: Be unique within the web application server domain Match the value of the JndiName property in the affinium_config.xml file. The default value for this property in the default partition is campaignpartition1ds Select DefaultNode/J2 alias from the drop-down list where J2 alias is the alias you created in To create the J2 authentication data entry on page Go to the data source s Custom Properties and add new properties using the following guidelines. Property name servername portnumber databasename enable2phase Value Enter the name of the SQL server that hosts the database that contains the Campaign system tables. Enter the port number of the SQL server that hosts the database that contains the Campaign system tables. Enter the physical name of the database that contains the Campaign system tables. Enter false. 7 Save your changes to the master configuration. 8 Test your connection. 9 If necessary, modify affinium_config.xml to use the data source JNDI name you entered in step 4. See Task 12: Configure system tables as Campaign data sources, on page 100 for details. 94 Unica Confidential Affinium Campaign Installation Guide

95 Setting up and configuring the Campaign system tables Creating the JDBC data source for Oracle Perform this procedure if your database is Oracle and your web application server is WebSphere. To configure the JDBC data source for Oracle in WebSphere 1 In the Administrative Console, create a new JDBC provider using the guidelines in the following table that are appropriate for your version of WebSphere. Field JDBC Providers Class Path Description WebSphere Select Oracle JDBC Provider from the drop-down list. Change to the full path to the JDBC Oracle Type 4 driver located in the jdbc/lib directory under your Oracle client installation. WebSphere Database type Provider type Implementation type Class Path Select Oracle from the drop-down list. Select Oracle JDBC Driver from the drop-down list. Select Connection Pool Datasource from the dropdown list. Change to the full path to the JDBC Oracle Type 4 driver located in the jdbc/lib directory under your Oracle client installation. 2 Save your changes to the master configuration. 3 Click the JDBC provider you just created and click Data Sources under Additional Properties. Version 7.0 Unica Confidential 95

96 Chapter 3: Basic Installation on UNIX 4 Add a new data source using the following guidelines. Field Name JNDI name Componentmanager authentication alias URL Description Enter any name. Enter a name. The name must: Be unique within the web application server domain Match the value of the JndiName property in the affinium_config.xml file. The default value for this property in the default partition is campaignpartition1ds Select DefaultNode/J2 alias from the drop-down list Where J2 alias is the alias you created in To create the J2 authentication data entry on page 92. Change the value to reflect your configuration, using the following format: jdbc:oracle:thin:@db_server_name:port:db_name For example: jdbc:oracle:thin:@mydbhost:1521:mydb 5 Save your changes to the master configuration. 6 Test your connection. 7 If necessary, modify the affinium_config.xml to use the data source JNDI name you entered in step 4. See Task 12: Configure system tables as Campaign data sources, on page 100 for details. Creating the JDBC data source for DB2 Perform this procedure if your database is DB2 and your web application server is WebSphere. 96 Unica Confidential Affinium Campaign Installation Guide

97 Setting up and configuring the Campaign system tables To configure the JBDC data source for DB2 in WebSphere 1 In the Administrative Console, create a new JDBC provider using the guidelines in the following table that are appropriate for your version of WebSphere. Field JDBC Providers drop-down list Class Path Description WebSphere Select DB2 Universal JDBC Driver Provider. Change to the full path to the Universal JDBC Driver Provider files located in the java directory under your DB2 client installation. The files are: db2jcc.jar db2jcc_license_cu.jar db2jcc_license_cisuz.jar These files must be on the same machine where WebSphere is installed. WebSphere Database type Provider type Implementation type Class Path Select DB2 from the drop-down list. Select DB2 Universal JDBC Driver Provider from the drop-down list. Select Connection Pool Datasource from the dropdown list. Change to the full path to the Universal JDBC Driver Provider files located in the java directory under your DB2 client installation. The files are: db2jcc.jar db2jcc_license_cu.jar db2jcc_license_cisuz.jar 2 Save your changes to the master configuration. 3 Click the JDBC provider you just created and click Data Sources under Additional Properties. Version 7.0 Unica Confidential 97

98 Chapter 3: Basic Installation on UNIX 4 Add a new data source using the following guidelines. Field Name JNDI name Componentmanager authentication alias Description Enter any name. Enter a name. The name must: Be unique within the web application server domain Match the value of the JndiName property in the affinium_config.xml file. The default value for this property in the default partition is campaignpartition1ds Select DefaultNode/J2 alias from the drop-down list where J2 alias is the alias you created in To create the J2 authentication data entry on page Go to the data source s Custom Properties and set values using the guidelines in the following table that are appropriate for your version of WebSphere. Field Description WebSphere only databasename servername portnumber Enter the physical name of the database that contains the Campaign system tables. Enter the name of the DB2 server that hosts the database that contains the Campaign system tables. Enter the port number of the DB2 server that hosts the database that contains the Campaign system tables. WebSphere and resultsetholdability Set the value to 1. If you do not find a field named resultsetholdability, add this value as a connectionattribute. 2 Save your changes to the master configuration. 3 Test your connection. 98 Unica Confidential Affinium Campaign Installation Guide

99 Setting up and configuring the Campaign system tables 4 If necessary, modify affinium_config.xml to use the data source JNDI name you entered in step 4. See Task 12: Configure system tables as Campaign data sources, on page 100 for details. Task 11: Store system table database credentials You must identify or create a Campaign system user in Affinium Manager and give that system user access to the Affinium Campaign system tables. You do this by adding a data source to the user s account in Affinium Manager. The following procedure assumes familiarity with Affinium Manager. For additional details on working with Affinium Manager, see the Affinium Manager Administrator s Guide. To store system table database credentials 1 Your database administrator should have set up database credentials (user name and password) for the Campaign system user. Obtain the following information: The database login name for the Campaign system user The database password for the Campaign system user For example, the information you obtain might be: user name: sa password: sa 2 Log in to Affinium Manager and identify an existing Affinium user you want to use as the Campaign system user, or create a new user. If you create a new user, you do not need to complete all the fields on the New User page. The Login field is the only required field. The following table shows the recommended way to complete the page. Field Login Action / Description Enter any name. This name must match the value you give to the ASMUserForDBCredentials property. See Task 12: Configure system tables as Campaign data sources, on page 100 for details. Version 7.0 Unica Confidential 99

100 Chapter 3: Basic Installation on UNIX Field First Name Last Name Action / Description Enter User This field is optional. Enter Campaign This field is optional 3 Add a new data source for the user you identified or created in step 2. On the New Data Source page, complete the form as shown in the following table: Field Data Source Data Source Login Alternate Login Data Source Password Confirm Password Action / Description Enter UA_SYSTEM_TABLES Enter the login name for this data source. Required. Enter the UNIX login name for a user in a group that shares privileges with the UNIX users of Campaign. Enter the password for this data source. Campaign allows this field to be empty, if the data source account does not have a password. Passwords are case-sensitive and must match the original password exactly. Enter the password again (leave empty if you left the Data Source Password field empty). 4 Save your changes and log out of Affinium Manager. Task 12: Configure system tables as Campaign data sources The following procedure describes how to configure the Campaign system tables in the default partition, partition1, with the default language, English. For additional information, see: Chapter 4, Configuring Multiple Partitions, on page 119 Chapter 8, Configuring Affinium Campaign for a Non-English Language, on page Unica Confidential Affinium Campaign Installation Guide

101 Setting up and configuring the Campaign system tables To configure the system tables in the affinium_config.xml file 1 Each data source is configured in the affinium_config.xml file, which is located under your Affinium Manager installation in the confdata directory. The properties and default values in the default partition are designed for SQL Server. If your database is Oracle or DB2, you should copy and paste the data source XML from the template provided with your Campaign installation. See To copy the DB2 or Oracle template on page 102 for instructions. 2 Log in to Affinium Manager and click Configuration Manager. 3 Set required properties in the applications > Campaign > partitions > partition1 > datasources > UA_SYSTEM_TABLES category as described in the following table. Property Value JndiName Type ASMUserForDBCredentials DSN Set the value to the JNDI name you specified when you set up the JDBC connection in the web application server. The default value is campaignpartition1ds. This name must be unique within the web application server. Set the value appropriate for your database type. Valid values are: SQLServer DB2, DB2ODBC ORACLE ORACLE8 ORACLE9 Set the value to the login name of the system user you created or used in Task 11: Store system table database credentials. If your ODBC or native data source name is not UA_SYSTEM_TABLES, set this value to the name of the ODBC or native data source pointing to your Campaign database. Version 7.0 Unica Confidential 101

102 Chapter 3: Basic Installation on UNIX 4 Configure other properties as desired. For detailed descriptions of the properties and their allowed and default values, see Appendix A, Properties in the Central Configuration File, on page 217. To copy the DB2 or Oracle template 1 Open the datasource_templates.xml file in a text or XML editor. The file is located in the conf directory under your Affinium Campaign installation. 2 Locate the category appropriate for your database, as follows: Oracle <category name="[oracle Example]"> DB2 <category name="[db2 Example]"> 3 Copy the entire category, including the opening and closing tags. For example: <category name="[oracle9 Example]">... [many XML tags]... </category> 4 Open the affinium_config.xml file and locate the applications > Campaign > partitions > partition1 > datasources category. 5 Paste the category you copied within the datasources category (before the closing datasources tag). 6 Change the name of the category you pasted to UA_SYSTEM_TABLES. 7 There can be only one category named UA_SYSTEM_TABLES in each partition. Therefore, change the name of the original datasources > UA_SYSTEM_TABLES category under your new partition to anything else, or simply delete the name. 102 Unica Confidential Affinium Campaign Installation Guide

103 Setting up and configuring additional data sources Setting up and configuring additional data sources Setting up additional data sources such as customer tables is a similar process to setting up the Campaign system tables, with a few important differences. This section provides an overview of setting up additional data sources in the default partition, partition1, with the default language, English. For additional information, see: Chapter 4, Configuring Multiple Partitions, on page 119 Chapter 8, Configuring Affinium Campaign for a Non-English Language, on page 181 Task 13: Set up additional data sources 1 For each additional data source (for example, customer tables), set up either an ODBC or, in the case of Oracle and DB2, a native connection. Select any unique name for the data source (except for UA_SYSTEM_TABLES - do not use this name for your customer tables). 2 Add a data source as described in Task 12: Configure system tables as Campaign data sources, on page 100. Note that the datasource_templates.xml file contains samples for the database types supported for customer tables, which include types not supported for Affinium Campaign system tables. 3 Set the category name to the ODBC or native connection name for the data source. 4 Set the applications > Campaign > partitions > partition1 > your_data_source_name > Type property in the new data source. Set the value appropriate for your database type. Valid values are: ORACLE ORACLE8 ORACLE9 Version 7.0 Unica Confidential 103

104 Chapter 3: Basic Installation on UNIX SYBASE SQLServer DB2, INFORMIX7 INFORMIX8 INFORMIX9 TERADATA DB2ODBC NETEZZA SAS SASDB 5 Configure other properties as desired. For detailed descriptions of the properties and their allowed and default values, see Appendix A, Properties in the Central Configuration File, on page 217. Configuring Affinium Campaign To complete Affinium Campaign configuration, you edit the Affinium Suite configuration file and the Campaign startup script, install the license key, and optionally configure multiple partitions and install and configure Affinium Reports. The following sections describe these tasks: Task 14: Set general configuration parameters Task 15: Configure the startup script Task 16: Install the license key Task 17: Configure multiple partitions Task 18: Install and configure Affinium Reports Task 14: Set general configuration parameters The configuration parameters that were found in the campaign_server.cfg, campaign_config.xml, and unica_acsvr.cfg files in various earlier versions of Affinium Campaign are now located in the affinium_config.xml file. Affinium Manager now provides a GUI interface that allows you to set property values in the affinium_config.xml file. 104 Unica Confidential Affinium Campaign Installation Guide

105 Configuring Affinium Campaign You must set values to configure the following: The directory where the Affinium Campaign log property file resides The Campaign server host and port, if different from the defaults The specifications for the default partition, partition1 The Affinium drop-down menu The following procedure describes how to set values for a basic installation, which uses the default partition. For information on configuring for multiple partitions, see Chapter 4, Configuring Multiple Partitions, on page 119. For detailed descriptions of the properties and their allowed and default values, see Appendix A, Properties in the Central Configuration File, on page 217. If you make changes to this file after you deploy Campaign, you must restart the web application server (WebLogic or WebSphere). To set minimum required property values 1 Log in to Affinium Manager and click Configuration Manager. Version 7.0 Unica Confidential 105

106 Chapter 3: Basic Installation on UNIX 2 Set required properties as described in the following table. For detailed descriptions of these properties, see Appendix A, Properties in the Central Configuration File, on page 217. Property applications > Campaign > logging > log4jconfig applications > Campaign > unicaaclistener > serverhost applications > Campaign > unicaaclistener > serverport Value Set the value to the full path to your campaign_log4j.properties file. Specify the complete path, including the file name. Use forward slashes (/). By default the file is located in the conf directory of your Campaign installation. For example: /home/affinium/campaign/conf/campaign_log4 j.properties If the Campaign server is not installed on the same machine where Affinium Manager is installed, change the value to the machine name or IP address of the machine where the Campaign server is installed. If you do not want to accept the default port number (4664), set the value to the desired port number. 3 To configure the default partition, set values as desired in the applications > Campaign > partitions > partition1 category. 4 To configure the Affinium menu, set the applications > product_name > navigation > serverurl properties to the URLs of the installed applications. See Configure for SSL (optional) on page 73 if you want to use SSL. Task 15: Configure the startup script To configure the startup script 1 Open the setenv.sh file in a text editor. The file is located in the bin directory under your Campaign server installation. 106 Unica Confidential Affinium Campaign Installation Guide

107 Configuring Affinium Campaign 2 Set the database environment variables as described in the following table: Database Syntax and Description DB2DIR=<full_dir_path> export DB2DIR Directory location where DB2 is installed (e.g. /usr/lpp/db2_06_01). DB2 Oracle. <full path to db2profile> This command sources the database configuration for DB2 users (e.g. /home/db2inst1/sqllib/db2profile). To source the database configuration, the full path to db2profile must be preceded by a. (period and then a space). ORACLE_BASE=<full_dir_path> export ORACLE_BASE Directory location where Oracle is installed (e.g. /home/oracle). ORACLE_HOME=<full_dir_path> export ORACLE_HOME Directory location of Oracle s home directory (e.g. /home/oracle/orahome1). SYBASE=<full_dir_path> export SYBASE Directory location where Sybase is installed (e.g. /home/sybase). ODBC (Sybase) ODBC=<full_dir_path> export ODBC Directory location where the ODBC driver is installed (e.g. /home/sybase/drivers). ODBCINI=<full path to ini file> export ODBCINI File location where the odbc.ini file exists (e.g. /home/informix/etc/odbc.ini). 3 Define the library environment variable as follows based on your UNIX operating system: Version 7.0 Unica Confidential 107

108 Chapter 3: Basic Installation on UNIX For example: SHLIB_PATH = "/usr/lib: $ORACLE_HOME/lib" Operating System Value SunOS AIX HP LD_LIBRARY_PATH LIBPATH SHLIB_PATH Based on your operating system and Oracle database version, you may have lib32, lib, and/or lib64 in your Oracle directory. Be sure to place your lib32 directory first in your LIBPATH. For example: LIBPATH=/usr/lib:$ORACLE_HOME/lib32:$ORACLE_HOME/lib Task 16: Install the license key Next, you must install the license key that you obtained by ing a software request form to support@unica.com. To install the license key 1 Verify that: Affinium Manager is deployed and started. You have appropriate permissions to edit environment variables on your machine 2 Set the following values: a b c Set your library path to include the Campaign libraries, which are located in the bin directory under your Campaign installation. Set the AFFINIUM_HOME environment variable. For example: AFFINIUM_HOME=/opt/Affinium export AFFINIUM_HOME Set the CAMPAIGN_HOME environment variable. For example: 108 Unica Confidential Affinium Campaign Installation Guide

109 Deploying the web application and verifying the installation CAMPAIGN_HOME==/opt/Affinium/Campaign export CAMPAIGN_HOME 3 Go to the Campaign/bin directory and run install_license, using the number contained in the file you received from Unica. For example: install_license UXB2AWXYZWFDMUMKS8Q 4 Open the Campaign/conf directory, and verify that there is a license.txt file. Task 17: Configure multiple partitions This step is optional. For information on configuring multiple Affinium Campaign partitions, see Chapter 4, Configuring Multiple Partitions, on page 119. Task 18: Install and configure Affinium Reports To enable reporting, refer to the following documents to install and configure Affinium Reports: For basic installation, see the Affinium Reports Installation Guide. To customize Affinium Campaign reports, see the Affinium Campaign Administrator s Guide. Deploying the web application and verifying the installation To deploy the web application and verify the installation, perform the following tasks: Task 19: Modify environment properties Task 20: Start thecampaign server Task 21: Deploy the Campaign web application Task 22: Map tables Task 23: Verify the installation Version 7.0 Unica Confidential 109

110 Chapter 3: Basic Installation on UNIX Task 19: Modify environment properties For all installations, perform the procedure described in Modifying the JAVA_OPTIONS property on page 110. If version 2.1 of Affinium Security Manager was previously deployed on your web application server, perform the procedure described in Checking and correcting the java.security file on page 112. Modifying the JAVA_OPTIONS property Affinium products may require that you modify the web application server s JAVA_OPTIONS property. Also, if earlier versions of Affinium applications were previously installed on the web application server on which you plan to deploy Affinium Campaign, you may need to remove or modify this property. Select the procedure below that is appropriate for your web application server (WebSphere or WebLogic). To check and correct the JAVA_OPTIONS property in WebLogic 1 Locate the WebLogic startup script. This file is located the home directory of the domain where you deployed Affinium products, under WebLogic's domain home directory. For example: /bea/user_projects/domains/mydomain 2 Open the file in a text editor and find the JAVA_OPTIONS entry. 110 Unica Confidential Affinium Campaign Installation Guide

111 Deploying the web application and verifying the installation 3 Check and modify the JAVA_OPTIONS property if necessary, as described in the following table. JAVA_OPTIONS entry AFFINIUM_HOME auth.login.config Take this action This entry is not required for Affinium Campaign. If this entry exists, do one of the following: If none of the Affinium products you are installing requires this entry, remove it. If any of the Affinium products you are installing requires this entry, verify that the value is correct. The value should be full path to the root installation directory of the Affinium Suite. For example: -DAFFINIUM_HOME=/home/Affinium See product documentation to determine whether this entry is required. This entry is not required for Affinium Campaign. Remove this entry if it is present. 4 Stop and restart your web application server. To check and correct the JAVA_OPTIONS property in WebSphere 1 In the WebSphere Administrative Console, navigate to the Generic JVM arguments for the server where you are deploying Affinium Campaign. Version 7.0 Unica Confidential 111

112 Chapter 3: Basic Installation on UNIX 2 Check and modify the JAVA_OPTIONS property if necessary, as described in the following table. JAVA_OPTIONS entry AFFINIUM_HOME auth.login.config Take this action This entry is not required for Affinium Campaign. If this entry exists, do one of the following: If none of the Affinium products you are installing requires this entry, remove it. If any of the Affinium products you are installing requires this entry,verify that the value is correct. The value should be full path to the root installation directory of the Affinium Suite. For example: -DAFFINIUM_HOME=/homeAffinium See product documentation to determine whether this entry is required. Do one of the following: If this entry exists, verfiy that its value is correct. If this entry does not exist, add it. For example: -Djava.security.auth.login.config== /home/affinium/conf/jaas.config Note the double equals sign (==). If there is already text in the Generic JVM arguments field, enter the text at the beginning of the line and ensure that there is a space after the text you enter (entries are separated by spaces). 3 Stop and restart your web application server. Checking and correcting the java.security file If version 2.1 of Affinium Security Manager was previously deployed on your web application server, verify that the web application server security property is not set in the java.security file, as this could cause problems. Perform the following procedure. To check and correct the java.security file 1 Open the java.security file in a text editor. 112 Unica Confidential Affinium Campaign Installation Guide

113 Deploying the web application and verifying the installation The file is located in java_home/jre/lib/security, where java_home is your web application server's JRE root directory. For example: /bea/jdk141_05/jre/lib/security 2 Find the login.config.url.1 property and be sure that there is a # at the beginning of the line. (The # character comments out the line; removing it uncomments the line.) Task 20: Start thecampaign server Use the following procedure to start the Affinium Campaign server. To start the Campaign server 1 Verify that Affinium Manager is deployed and started. 2 Change the directory to the Campaign/bin directory. 3 Start the Affinium Campaign server by executing the rc.unica_ac program with a start argument. You must run this command as root. For example:./rc.unica_ac start To determine whether the unica_aclsnr process has started successfully, enter this command: ps -ef grep unica_aclsnr. To determine the process ID for the server you started, view the unica_aclsnr.pid file located in the conf directory under your Affinium Campaign installation. Task 21: Deploy the Campaign web application Because the Affinium Suite applications require configurational control of the Java Virtual Machine (JVM), you must deploy Affinium applications on a dedicated JVM. You cannot deploy non-unica applications in the same JVM as any Unica Affinium application. If necessary, Unica can provide a separate JVM for Affinium applications. Version 7.0 Unica Confidential 113

114 Chapter 3: Basic Installation on UNIX This task describes how to deploy the Affinium Campaign web application on either IBM WebSphere or on WebLogic. For complete details on deploying web applications, consult your web application server s documentation. Deploying on IBM WebSphere Use the following procedure to deploy the Campaign web application on IBM WebSphere. To deploy the Campaign web application on IBM WebSphere 1 Verify that the Campaign server is running, as described in Task 20: Start thecampaign server. The Campaign server must be running when you start the Campaign web application. If you restart the Campaign server, you must also restart the Campaign web application. 2 Start the WebSphere application server. 3 Log in to the Administrative Console and deploy the Campaign.war file as an enterprise application, following these guidelines: If you are deploying on WebSphere Express 6.0.2, create a new custom server property named prependslashtoresource and set its value to to true. For more information, search on prependslashtoresource or SRVE0238E in the IBM documentation. On the server s Configuration > General Properties tab, set ClassloaderMode = PARENT_LAST and WAR Classloader Policy = APPLICATION. In the server s Web Container > Session Management section, enable cookies and change the cookie name from JSESSIONID to CAMPAIGNSESSIONID. 4 When the deployment is complete, start the application. 114 Unica Confidential Affinium Campaign Installation Guide

115 Deploying the web application and verifying the installation Deploying on BEA WebLogic Affinium products customize the JVM used by WebLogic. You may need to create a WebLogic instance dedicated to Affinium products if you encounter JVM-related errors. The BEA WebLogic Express server initially installs with a limited license. If this is a new WebLogic installation you must upgrade the license. For more information, see the License Update Readme.txt file in the WebLogic installation media. Use the procedure below that applies to your configuration of WebLogic. To deploy the Campaign web application using WebLogic s console 1 Verify that the Campaign server is running, as described in Task 20: Start thecampaign server. The Campaign server must be running when you start the Campaign web application. If you restart the Campaign server, you must also restart the Campaign web application. 2 Verify that the SDK selected for the WebLogic domain you are using is the Sun SDK by looking in the startup script (startweblogic.sh) for the JAVA_VENDOR variable. It should be set to: JAVA_VENDOR="Sun". If it is set to JAVA_VENDOR="BEA", JRockit has been selected. JRockit is not supported. To change the selected SDK, refer to the BEA WebLogic documentation. 3 If you are configuring WebLogic to use the IIS plug-in, review the WebLogic documentation at 4 Start the WebLogic application server. On UNIX, you must start WebLogic from the console to allow correct rendering of graphical charts. The console is usually the machine on which the server is running. In some cases, however, the web application server is set up differently. Version 7.0 Unica Confidential 115

116 Chapter 3: Basic Installation on UNIX If a console is not accessible or does not exist, you can emulate a console using Exceed. You must configure Exceed so that your local Xserver process connects to the UNIX machine in root window or single window mode. If you start the webserver using Exceed, you must keep Exceed running in the background to allow the web application server to continue running. Please contact Unica Technical Support for detailed instructions if you encounter problems with the chart rendering. Connecting to the UNIX machine via telnet or SSH will always causes problems rendering the charts. 5 Log in to the Administration Console. and deploy the Campaign.war file as a web application module. Unica recommends you name the deployment Campaign. This is case-sensitive in UNIX. Task 22: Map tables System tables should map automatically when you first log in to Affinium Campaign. However, you need map any other data sources you have configured. See the Affinium Campaign Administrator s Guide for information on mapping tables. Task 23: Verify the installation Use the following procedure to verify the installation. Affinium Campaign 7.0 uses an ActiveX control for flowcharts and administration functions. This flowchart automatically downloads when needed. The recommended security settings for the IE browser is medium-low for local intranet. Specifically, the client browser must have enabled: - Download signed ActiveX controls - Run ActiveX controls and plugins - Script ActiveX controls marked safe for scripting 116 Unica Confidential Affinium Campaign Installation Guide

117 Deploying the web application and verifying the installation To verify the installation 1 Verify that the Campaign server is running. For example: ps -ef grep unica_aclsnr 2 Log in to the Campaign web application. The URL for accessing the Campaign web application depends on the context root defined when you deployed the application to the web application server. It is generally: To log in as a newly created Affinium user, you must log in to Campaign as or an existing user in the Campaign Administrators group in Affinium Manager (for example, asm_admin) and add at least one security role (e.g., Global Policy / Admin) to your new user. You can then log in as that new user. 3 Verify that all system tables exist in the Administration > Manage Table Mappings window. 4 Create a new campaign to test writing to system tables and the campaign code generator. To do this, you must log in as a user with appropriate permissions in Campaign. See the Affinium Campaign Administrator s Guide for instructions on how to set up user security policies. 5 Create a new flowchart. 6 Create a new offer to test the offer code generator. Version 7.0 Unica Confidential 117

118 Chapter 3: Basic Installation on UNIX Troubleshooting The following table describes some problems you may encounter when testing the installation, and their resolution. Error Root Folder for [CampaignObject] was not found Error 1786 Server process has exited System tables did not map automatically Resolution The Campaign objects may be Campaigns, Segments, Offers, or Sessions. Action: Verify all the SQL scripts were run to populate the system tables. See Task 7: Create and populate the system tables, on page 82. This error occurs when the listener has not been restarted after setting the roles. Action: Stop the listener and restart the web application server. Action: Verify that the Campaign system user is set up in Affinium Manager and that this user has the Campaign system tables as a data source. 118 Unica Confidential Affinium Campaign Installation Guide

119 4 CONFIGURING MULTIPLE PARTITIONS This chapter describes the steps necessary to create multiple partitions on Affinium Campaign. This chapter includes the following topics: Overview Adding partitions and their directories Configuring partition system tables and other data sources Completing partition set-up Overview Partitioning in Affinium Campaign addresses the need to separate data associated with different groups of users. With partitioning, a user s partition appears as if it were a separate running instance of Affinium Campaign, with no indication that other partitions are running on the same system. Affinium Campaign Unica Confidential 119

120 : Multiple partitions are useful for setting up strong security between groups of users, as each group has its own set of Affinium Campaign system tables. Multiple partitions are not recommended when groups of users must share data. Each partition has its own set of configuration settings, so Affinium Campaign can be customized for each group of users. However, all partitions share the same installation binaries. This minimizes installation and upgrading efforts, compared with performing multiple separate installations. What are partitions? Partitions have the following characteristics: A user of one partition cannot view or change data in any other partition. Each Affinium user must belong to exactly one partition. A user who does not belong to any partition of Affinium Campaign does not have any access to Affinium Campaign. A user who requires access to multiple partitions must have a separate Affinium login for each one. Access to partitions is managed through membership in Affinium Manager groups. A user who is not a member of any Affinium Manager group cannot access any partition. Affinium Campaign dialog boxes that navigate the file system cannot navigate above the root directory of the user s partition. For example, if two partitions, named partition1 and partition2, exist on Campaign, and you belong to the group associated with partition1, you can not navigate the directory structure for partition2 in a dialog box. Partition configuration process overview This section provides an overview of setting up multiple partitions, and the remainder of this chapter provides details for each task. You should add partitions after you have completed the steps described in the basic installation chapter. Setting up multiple partitions requires you to perform, for each new partition, many of the same tasks you perform in a basic installation. However, there are significant differences, so read this chapter carefully. 120 Unica Confidential Affinium Campaign

121 Overview To set up multiple partitions Task 1: Configure new partitions in the central configuration file Define new partitions in the Affinium Suite s central configuration file. Task 2: Create the partitions directory structures For each partition, create the required directory structure under your Affinium Campaign installation. Task 3: Create the partitions in Affinium Manager Use the tool provided with Affinium Manager to create an initial admin user, group, and security for each partition. Task 4: Create and populate the system tables For each partition, use the scripts packaged with Affinium Campaign to create the system tables. Task 5: Configure the ODBC or native data source For each partition s system tables, set up either an ODBC or, in the case of Oracle and DB2, a native connection. Do this on the machine where the Campaign server is installed. Task 6: Configure the JDBC data source For each partition s system tables, set up a JDBC data source in the web application server where the Campaign server is deployed. Task 7: Configure the system tables as Campaign data sources Copy the XML appropriate for your database type and paste it into the affinium_config.xml file. In Affinium Manager s Configuration manager, you can view and set the required data source properties, and any additional data source properties needed for your installation of Affinium Campaign. Task 8: Store database credentials for each partition In Affinium Manager, store data source credentials for each partition. Task 9: Configure additional data sources Set up additional data sources such as customer tables. Task 10: Stop and restart Campaign Restart the Campaign server to ensure that the new partitions are enabled. Version Revision A Unica Confidential 121

122 : Task 11: Map customer tables Log in to Campaign as a user of each new partition and map customer tables as needed. Task 12: Add users to a partition Add users to each of your new partitions. Task 13: Configure Affinium Reports for multiple partitions See the Affinium Reports Installation Guide for information on configuring Affinium Report for multiple partitions. Adding partitions and their directories To begin configuring new partitions perform the following steps: Task 1: Configure new partitions in the central configuration file Task 2: Create the partitions directory structures Task 3: Create the partitions in Affinium Manager This section describes these tasks. Task 1: Configure new partitions in the central configuration file 1 Open the affinium_config.xml file in a text or XML editor. The file is located in the confdata directory under your Affinium Manager installation. 2 Locate the applications > Campaign > partitions > partition 1 category. Copy the partition1 tag (including all sub-categories and properties within it - approximately 500 lines of XML) and paste it just above the closing tag of the applications > Campaign > partitions category. 3 Edit the partition name in the category tag. For example: <category name="partition2"> 122 Unica Confidential Affinium Campaign

123 Adding partitions and their directories 4 Log in to Affinium Manager and click Configuration Manager. 5 Configure properties in the new partition category as desired. For detailed descriptions of the properties and their allowed and default values, see Appendix A, Properties in the Central Configuration File, on page 217. Directions for configuring data sources are in the next section in this chapter, Configuring partition system tables and other data sources on page 128. Task 2: Create the partitions directory structures 1 In the partitions directory under your installation, add a new partition directory for each partition, using the name you gave the partition in Task 1: Configure new partitions in the central configuration file, on page 122. For example, if you named a partition category partition2 in the affinium_config.xml file, you would create a Campaign/partitions/partition2 directory. 2 Copy all of the directories under the default partition directory, Campaign/partitions/partition1. They are: campaigns catalogs conf cubes ftp logs profile segments sessions templates tmp If you are using Affinium Campaign Collaborate, also add a Collaborate directory. Version Revision A Unica Confidential 123

124 : 3 Paste the copied directories under each new partition directory. 4 Delete any files that may exist in the pasted directories. Task 3: Create the partitions in Affinium Manager Partitions are associated with Affinium Campaign policies and roles. These policies and roles and their partition associations are stored in the Affinium Manager system tables. For each partition you create, you must seed the Affinium Manager system tables with basic policy and role information, using a utility packaged with Affinium Manager. Location of the utility The utility is named partitiontool and is located in the tools/bin directory under your Affinium Manager installation. Prerequisites for running the utility The following are prerequisites for running the Affinium Manager partitiontool utility. This utility connects to the Affinium Manager system tables. For this reason, you must stop the web application server on which Affinium Manager is deployed before you run the utility. You must have the JAVA_HOME environment variable set, either in the setenv script located in the tools/bin directory of your Affinium Manager installation, or in the command window. Run the utility from the tools/bin directory under your Affinium Manager installation. On UNIX, run the utilities with the same user account that runs the application server on which Affinium Campaign is deployed. If you run a utility with a different user account, adjust the permissions on the uasm.log file to allow that user account to write to it. 124 Unica Confidential Affinium Campaign

125 Adding partitions and their directories Special characters and spaces Characters that are designated as reserved characters in the operating system must be escaped. Consult your operating system documentation for a list of reserved characters and how to escape them. Any user, group, or partition name that contains spaces must be enclosed in double quotes. Commands The following commands are available in the partitiontool utility. -clone Replicates an existing partition specified using the -s option. This command does the following: Creates a new Affinium user with the Admin role in both the Administrative Roles policy and the global policy in Affinium Campaign. Creates a new Affinium Manager group and makes the new Admin user a member of that group. Creates a new partition object. Replicates all the policies associated with the source partition and associates them with the new partition. For each replicated policy, replicates all roles associated with the policy. For each replicated role, maps all functions in the same way that they were mapped in the source role. Assigns the new Affinium Manager group to the last system-defined Admin role created during role replication. If you are cloning the default partition, partition1, this is the default Administrative Role (Admin). -list Lists the roles and policies assigned to partitions, and the partition description, if one exists. If used with the -n option, lists the following for the named partition: Version Revision A Unica Confidential 125

126 : Each role and policy The names of groups mapped to the role or policy, The number of groups, users, and functions mapped to the role or policy. If used without the -n option, lists the information described above for all partitions. If used with the -v option, lists the information described above, and also includes: The names of functions mapped to each role Creation and update details for each role and policy Options The following options are available in the partitiontool utility. -d "partition description" Optional, used with -clone only. Specifies a description that appears in the output from the -list command. Must be 256 characters or less. Enclose in double quotes if the description contains spaces. -g group_name Optional, used with -clone only. Specifies the name of the Affinium Manager Admin group. The name must: Be unique within this instance of Affinium Manager Match the value you gave to the allowgroups property in Task 1: Configure new partitions in the central configuration file, on page 122. If not defined, the name defaults to partition_nameadmingroup. -h Display help. -n partition_name Optional with -list, required with -clone. Must be 32 characters or less. If used with -list, specifies the partition whose information is listed. 126 Unica Confidential Affinium Campaign

127 Adding partitions and their directories If used with -clone, specifies the partition to be replicated, and the value is used as the password for the Admin user. The partition name must match the name you gave the partition in Task 1: Configure new partitions in the central configuration file, on page s Required, used with -clone only. The name of the source partition to be replicated. -u admin_user_name Optional, used with -clone only. Specifies the user name of the Admin user for the replicated partition.the name must be unique within this instance of Affinium Manager. If not defined, the name defaults to partition_nameadminuser. This user s password is the partition name. -v Verbose output when used with the -list option. Examples Command partitiontool -list partitiontool -clone -s partition1 -n mypartition -d Cloned from partition1 Result List all partitions. Create a new partition with the following characteristics: Cloned from partition1 Name is mypartition Uses the default user name (mypartitionadminuser) Uses the default group name (mypartitionadmingroup) Description is Cloned from partition1 Version Revision A Unica Confidential 127

128 : Command partitiontool -clone -s partition1 -n customera -u customera -g customeragroup -d CustomerA partition Result Create a new partition with the following characteristics: Cloned from partition1 Name iscustomera Specifies user name of customera Specifies group name of customeragroup Description is CustomerA partition. Configuring partition system tables and other data sources Setting up and configuring the Campaign system tables for multiple partitions requires the following steps: Task 4: Create and populate the system tables Task 5: Configure the ODBC or native data source Task 6: Configure the JDBC data source Task 7: Configure the system tables as Campaign data sources Task 8: Store database credentials for each partition Task 9: Configure additional data sources This section describes these tasks. Task 4: Create and populate the system tables For each partition, create a different schema in your database to hold the system tables. Partitions cannot share schemas. Use the scripts packaged with Affinium Campaign to create and populate the system tables. For details on using the scripts, see: Windows: Task 7: Create and populate the system tables, on page 33 UNIX: Task 7: Create and populate the system tables, on page 82 This section describes these tasks. 128 Unica Confidential Affinium Campaign

129 Configuring partition system tables and other data sources Task 5: Task 6: Task 7: Configure the ODBC or native data source The machine on which the Affinium Campaign server is installed must be able to communicate with the databases or schemas that hold the Campaign system tables for each partition. Set up either an ODBC connection (or, in the case of Oracle and DB2, a native connection) for each partition s database or schema. Because the name of the ODBC or native connection must be unique within the machine, you cannot name it UA_SYSTEM_TABLES for every partition. Give it any descriptive name you want. In a later task, you will use the DSN property to specify the connection name within the Affinium Suite s central configuration file. For guidelines on creating the ODBC or native data source, see: Windows: Task 9: Configure the ODBC or native data source, on page 34 UNIX: Task 9: Configure the ODBC or native data source, on page 83 Configure the JDBC data source You must set up the JDBC connection for each partition s system tables in the web application server where you deploy the Campaign web application. For details on configuring the JDBC data source, see: Windows: Task 10: Configure the JDBC data source, on page 35 UNIX: Task 10: Configure the JDBC data source, on page 84 Configure the system tables as Campaign data sources Perform the following procedure for each partition. Version Revision A Unica Confidential 129

130 : To configure the partition system tables in the central configuration file 1 Each data source is configured in the affinium_config.xml file, which is located under your Affinium Manager installation in the confdata directory. The properties and default values copied from the default partition are designed for SQL Server. If your database is Oracle or DB2, you should copy and paste the data source XML from the template provided with your Campaign installation, See To copy the DB2 or Oracle template on page 131 for instructions. 2 Log in to Affinium Manager and click Configuration Manager. 3 Set required properties in the applications > Campaign > partitions > your_partition_name > datasources > UA_SYSTEM_TABLES category as described in the following table. Property Value JndiName Type ASMUserForDBCredentials DSN Set the value to the JNDI name you specified when you set up the JDBC connection in Task 6: Configure the JDBC data source, on page 129. Set the value to the database type. Permitted values for system tables are: ORACLE ORACLE8 ORACLE9 SQLServer DB2 Set the value to the login name of the system user you created or used for this partition in Task 8: Store database credentials for each partition. Set this value to the name you gave to the ODBC or native connection in Task 5: Configure the ODBC or native data source, on page Unica Confidential Affinium Campaign

131 Configuring partition system tables and other data sources To copy the DB2 or Oracle template 1 Open the datasource_templates.xml file in a text or XML editor. The file is located in the conf directory under your Affinium Campaign installation. 2 Locate the category appropriate for your database, as follows: Oracle <category name="[oracle Example]"> DB2 <category name="[db2 Example]"> 3 Copy the entire category, including the opening and closing tags. For example: <category name="[oracle9 Example]">... [many XML tags]... </category> 4 Open the affinium_config.xml file and locate the new partition you configured in Task 1: Configure new partitions in the central configuration file, on page Paste the category you copied within the datasources category in your new partition (before the closing datasources tag). 6 Change the name of the category you pasted to UA_SYSTEM_TABLES. 7 There can be only one category named UA_SYSTEM_TABLES in each partition. Therefore, change the name of the original datasources > UA_SYSTEM_TABLES category under your new partition to anything else, or simply delete the name. Version Revision A Unica Confidential 131

132 : Task 8: Task 9: Store database credentials for each partition For each partition, store database credentials for the Campaign system tables. You do this in Affinium Manager by adding the system tables as a data source for an Affinium user. You should create a new system user for each partition. For details on storing the system table database credentials, see: Windows: Task 11: Store system table database credentials, on page 50 UNIX: Task 11: Store system table database credentials, on page 99 Configure additional data sources For each partition, configure additional data sources (for example, customer tables) as needed. For details on configuring additional data sources, see: Windows: Task 13: Set up additional data sources, on page 54 UNIX: Task 13: Set up additional data sources, on page 103 Note that you will configure each additional data source within the applications > Campaign > partitions > your_partition_name > datasources cateogry. Completing partition set-up To finish configuring new partitions perform the following steps: Task 10: Stop and restart Campaign Task 11: Map customer tables Task 12: Add users to a partition Task 13: Configure Affinium Reports for multiple partitions This section describes these tasks. Task 10: Stop and restart Campaign When you add a new partition, or when you make a change to an existing partition, you need to stop and re-start the web application server and the 132 Unica Confidential Affinium Campaign

133 Completing partition set-up Campaign server so the changes you made will be picked up. Use the following procedure. To stop and restart Campaign 1 Stop and re-start the web application server (WebLogic or WebSphere) where the Campaign server is deployed. 2 Restart the Campaign server. For details see: Windows: Task 19: Start thecampaign server, on page 62 UNIX: Task 20: Start thecampaign server, on page 113 Task 11: Map customer tables After Campaign is running with multiple partitions, you need to map tables as needed for each partition. Log in to each new partition as a member of an Affinium Manager group with access to that partition and Admin privileges in Campaign, and map customer tables as needed. For example, you may log in as the Campaign Admin user created by the partition tool. For instructions on mapping tables, see the Affinium Campaign Administrator s Guide. Task 12: Add users to a partition Use the following guidelines to add users to the a partition you have created. To add users to partitions 1 Log in to Affinium Manager as a user with Admin privileges in Affinium Manager. For example, you may log in as the default Manager Admin user, asm_admin. Version Revision A Unica Confidential 133

134 : 2 Add the desired users to the groups you have assigned to each partition. Remember, a user can be a member of only one partition, so you must not add any user to more than one partition group. 3 Log in to Campaign as the Admin user for the partition. For example, you may log in as the Campaign Admin user created by the partition tool. 4 Assign at least one security role to each member of that partition s group. Do not assign security roles to members of any other partition s group, as this will cause errors. Task 13: Configure Affinium Reports for multiple partitions See the Affinium Reports Installation Guide for information on configuring Affinium Report for multiple partitions. 134 Unica Confidential Affinium Campaign

135 5 UPGRADING TO AFFINIUM CAMPAIGN This chapter describes prequisites and procedures for upgrading to Affinium Campaign version You must perform the tasks detailed in this chapter before migrating data from your Affinium Campaign 6.4.x system. Key topics include Upgrade and migration overview Upgrade and migration prerequisites Upgrading to Affinium Campaign Throughout this chapter, any maintenance version on the 6.4 line is referred to as Affinium Campaign 6.4.x. Source environments and components refer to the 6.4.x system from which you are migrating, and target environments and components refer to the system to which you are migrating. Affinium Campaign Installation Guide Unica Confidential 135

136 Chapter 5: Upgrading to Affinium Campaign Upgrade and migration overview Upgrading to Affinium Campaign and migrating configuration settings, files, and data from any Affinium Campaign 6.4.x version is a multi-step process. Upgrade tasks are covered in this chapter. You must perform the tasks detailed in this chapter before migrating data from your Affinium Campaign 6.4.x system. Migration tasks are covered in Chapter 6, Migrating Data to Affinium Campaign 7.0.1, on page 141. Before you proceed, you must be aware of the requirements for upgrading and migrating. For details, see Upgrade and migration prerequisites on page 136. Upgrade and migration prerequisites Read this section to understand the requirements for performing migration successfully, and the compatibility and accessibility requirements of the source and target systems. Knowledge requirements System compatibility and accessibility System compatibility File system accessibility System table accessibility and permissions Knowledge requirements These instructions assume that the person performing the migration has a basic understanding of: The installation and configuration process for Affinium Campaign versions 6.4.x and 7.0.1; General Affinium Campaign functionality and components, including the structure of the file system; 136 Unica Confidential Affinium Campaign Installation Guide

137 Upgrade and migration prerequisites The functionality and usage of Affinium Manager versions 6.4 and 7.0.2; Viewing and working with database tables. System compatibility and accessibility The migration tool must be able to read the file system and system tables of your old installation of Affinium Campaign, and read and modify the file system and system tables of your new installation. The following sections detail compatibility and accessibility requirements for the Affinium Campaign 6.4.x and environments, file systems, and system table database. System compatibility Affinium Campaign 6.4.x and Affinium Campaign must: be installed on the same type of operating system; use the same database type and version for their system tables, have their database tables in the same database instance, and be deployed on the same type of web application server. File system accessibility The Affinium Campaign 6.4.x file system must be visible from the Affinium Campaign system. Therefore, either both versions of Affinium Campaign must be hosted on the same machine, or the old system s root directory must be added as a shared drive/nfs mount on the machine where you run the Affinium Campaign migration tool. System table accessibility and permissions The accessibility and permission requirements for the system tables are: The Affinium Campaign system tables must be in the same database and database server instance as the Affinium Campaign 6.4.x system tables. That is, it must be possible to SELECT from the source 6.4.x tables into the target tables. Version Unica Confidential 137

138 Chapter 5: Upgrading to Affinium Campaign The database login you provide to the migration tool must be able to SELECT from the 6.4.x system tables and SELECT from and INSERT into the Affinium Campaign system tables. The migration tool creates temporary tables in the same schema as the Affinium Campaign system tables in the first target partition you specify. These temporary tables are used throughout the migration and are then dropped in the final step, after all data is migrated for each partition. The database login you provide to the migration tool must have the same privileges as the user who created the tables. Upgrading to Affinium Campaign This section describes in detail the tasks you need to perform to upgrade to Affinium Campaign Task 1: Install Affinium Manager and migrate users and their data sources Task 2: Back up Affinium Campaign 6.4.x Task 3: Install and configure Affinium Campaign After performing these upgrade tasks, proceed to Chapter 6, Migrating Data to Affinium Campaign 7.0.1, on page 141 for tasks relating to migration. Task 1: Install Affinium Manager and migrate users and their data sources To install Affinium Manager and migrate users and their data sources 1 Follow the directions in the Affinium Manager Installation Guide to install Affinium Manager version Unica Confidential Affinium Campaign Installation Guide

139 Upgrading to Affinium Campaign You must be able to run both old and new installations of Affinium Manager simultaneously (for example, by installing version on a different machine, on a different instance of the web application server, or on a different domain). 2 Migrate users and their data sources from your old Affinium Manager installation to the new version, using the migration utility provided with Affinium Manager. The user name data from the old Affinium Manager system must be present in the new Affinium Manager system. See the Affinium Manager Installation Guide for details on this migration step. Task 2: Back up Affinium Campaign 6.4.x Back up all files and the system table database used by your existing installation of Affinium Campaign 6.4.x. Task 3: Install and configure Affinium Campaign To install and configure Affinium Campaign Read the following guidelines: See Upgrade and migration prerequisites on page 136 for the system compatibility and accessibility requirements of the old and new systems. You must be able to run both old and new installations of Affinium Campaign simultaneously (for example by installing version on a different machine, on a different instance of the web application server, or on a different domain). If your Affinium Campaign 6.4.x installation has multiple partitions that you want to migrate, create the the same number of partitions in Affinium Campaign The migration does not automatically create new partitions in Affinium Campaign Version Unica Confidential 139

140 Chapter 5: Upgrading to Affinium Campaign Ensure that the code formats for generated codes in the Affinium Campaign system (cell codes, offer codes, campaign codes) are compatible with the generated code formats in your Affinium Campaign 6.4.x installation. Ensure that user-defined fields in the Affinium Campaign system tables (for example, in your contact history, response history, and product tables) are compatible with the equivalent fields in your Affinium Campaign 6.4.x installation. They must have the same physical name, data type, and width. The login that you specify in your application server s JDBC data source configuration must be able to access the system tables in both your 6.4.x installation and your installation. 2 When you have verified that your installation environment and data meet the requirements for installation and migration, follow the detailed installation steps in Chapter 2, Basic Installation on Windows, on page 21 or Chapter 3, Basic Installation on UNIX, on page 69 to install Affinium Campaign When you have successfully upgraded to Affinium Campaign When you have successfully performed the upgrade tasks detailed in this chapter, proceed to the migration tasks detailed in Migrating Data to Affinium Campaign on page Unica Confidential Affinium Campaign Installation Guide

141 6 MIGRATING DATA TO AFFINIUM CAMPAIGN This chapter describes the procedures for migrating your existing data from any Affinium Campaign 6.4.x version to version Perform the tasks detailed in this chapter after successfully completing the upgrade tasks in Chapter 5, Upgrading to Affinium Campaign 7.0.1, on page 135. Key topics include Upgrade and migration overview About migration About re-migration Migrating data to Affinium Campaign Affinium Campaign Installation Guide Unica Confidential 141

142 Chapter 6: Migrating Data to Affinium Campaign Throughout this chapter, any maintenance version on the 6.4 line is referred to as Affinium Campaign 6.4.x. Source environments and components refer to the 6.4.x system from which you are migrating, and target environments and components refer to the system to which you are migrating. Upgrade and migration overview Upgrading to Affinium Campaign and migrating configuration settings, files, and data from any Affinium Campaign 6.4.x version is a multi-step process. Migration tasks are covered in this chapter. Upgrade tasks are covered in Chapter 5, Upgrading to Affinium Campaign 7.0.1, on page 135. You must perform the upgrade tasks before migrating data from your Affinium Campaign 6.4.x system. Before you proceed with migration, you must be aware of requirements and limitations relating to migration. For details, see About migration on page 142, Feature changes affecting migration on page 143, and Migration tool limitations on page 144. About migration When you perform migration, the configuration settings, files, and data are copied from your source Affinium Campaign 6.4.x system to the target system that you have set up, following the tasks outlined in Chapter 5, Upgrading to Affinium Campaign 7.0.1, on page 135. The migration process does not modify any source data or files, including affinium _config.xml. After migration, some manual steps might be required. For details, see Feature changes affecting migration on page 143, Migration tool limitations on page 144, and Perform manual configuration and migration on page Unica Confidential Affinium Campaign Installation Guide

143 About migration The following sections provide conceptual details about migration issues: Feature changes affecting migration Migration tool limitations About the migration tool About the migration log About migrating partitions About starting and stopping servers during migration About cancelling migration About re-migration Feature changes affecting migration Significant feature changes between Affinium Campaign 6.4.x and Affinium Campaign affect the amount of migration that can take place without manual intervention. For details, see the following: The Backward compatibility notes section in the Affinium Campaign Release Notes version 7.0.1; The section for each object type in Chapter 7, Migration Reference, on page 163; Perform manual configuration and migration on page 161. For complete information about features in Affinium Campaign version 7.0.1, see the Affinium Campaign User s Guide and the Affinium Campaign Administrator s Guide. Version Unica Confidential 143

144 Chapter 6: Migrating Data to Affinium Campaign Migration tool limitations The Affinium Campaign migration tool has the following limitations: It supports migration from Affinium Campaign 6.4.x versions only. You must upgrade pre-6.4 versions of Affinium Campaign to at least version 6.4 before upgrading to Campaign version See the Affinium Campaign Installation Guide for instructions. It does not support in place migration; that is, data is not migrated within the same instance of Affinium Campaign. You must migrate your source installation of Affinium Campaign 6.4.x to a separate Affinium Campaign system. It supports system table migration for Oracle, IBM DB2, and Microsoft SQL Server databases only. It does not support migration of internationalized or localized versions of Campaign. It does not copy database configuration from the old to the new system tables. The following configurations are not migrated: Database-specific scaling and performance features (such as DB2 partitions) Existing constraints/indexes on system tables in the source database. You must re-create the constraints/indexes manually if you want them in the new tables. When re-migrating contact and response history, the migration tool will check contact and response history records on the target system based on date. If records from the source system do not have the same dates as records in the target system, these new records are inserted into the target system tables. However, if contact and response history records from the source system share dates with records already in the target system, these records will not be migrated. This situation might arise if contact or response flowcharts were run multiple times on the same date. If your source system contains such contact and response history data, you must clean it up before attempting to re-migrate contact and response history. 144 Unica Confidential Affinium Campaign Installation Guide

145 About migration In addition to these stated limitations, to perform migration successfully you must meet some system compatibility and accessibility requirements. For details, see Upgrade and migration prerequisites on page 136. For migration and re-migration details and limitations, see Feature changes affecting migration on page 143 and Chapter 7, Migration Reference, on page 163. About the migration tool The Affinium Campaign 6.4.x to migration process consists of six distinct stages, each one executed by a separate script. For each partition in your environment, run the six scripts in sequence to migrate system table data and all of the corresponding underlying objects. Where are the migration scripts? The migration tool scripts are located in the tools/migration/6.4to7.0 directory under your Affinium Campaign installation directory. The script files are named for the migration stage they execute, as follows: stage1 stage2 stage3 stage4 stage5 stage6 About the migration log After you run each migration stage, the scripts write out processing details, warnings, or errors to a log. By default, the log is named migration.log and is located in: Version Unica Confidential 145

146 Chapter 6: Migrating Data to Affinium Campaign C:\unica\701\Affinium\Campaign\tools\migration\6.4To7.0\logs Details from each stage are appended to the log after the details for the previous stage. If you prefer that details for each migration stage are captured in a separate file, save the log file with a different name after each stage completes, so that logging details from the next migration stage you run are captured in the log file without the details from the previous stage. For example, after you run Stage 1 migration, if you rename migration.log to stage1.log, then logging details for Stage 2 are written to migration.log and will be in a separate log from Stage 1. The log s location and level of verbosity are specified in the setenv script file, and can be modified as detailed in Task 4: Set up the migration environment on page 148. About migrating partitions When you start the migration at Stage 1 you must choose an initial partition to migrate. If only one partition exists, it is automatically selected for migration. In Stage 6, after the initial partition is completely migrated, you can switch to another partition. Each time a partition is chosen, the following partition-specific information is requested by the script: A security policy for PolicyID fields for details, see Partition details on page 152; A default username for CreateBy fields for details, see Partition details on page 152; A date for CreateDate fields for details, see Partition details on page 152; Minimum and maximum database ID limits for source and target systems for details, see Database ID limits for source and target systems on page Unica Confidential Affinium Campaign Installation Guide

147 About re-migration The initial partition s system table database in the target installation is where the migration tool creates its temporary tables. The location of these tables does not change when you switch to a new partition in Stage 6. You must completely migrate each partition before switching to another one; you cannot resume an incomplete migration after you have switched to a new partition. About starting and stopping servers during migration The source and target Campaign listeners must be shut down during the migration process, except where the scripts specify otherwise. Each script provides information on which servers must be started or shut down. The web application server on which Affinium Campaign is deployed must always remain running to provide access to the database drivers when the JDBC drivers in WebLogic are used for migration. About cancelling migration You can abort the migration at any prompt during any stage by typing abort. About re-migration Re-migration refers to the migration of the same object(s) multiple times. This process might be required if any objects (campaigns, sessions, flowcharts, or offers) cannot immediately be made production-ready in a 7.0 system, and need to continue to operate and be modified in a source system until another migration attempt is made. Re-migration is performed by the Stage5 script with some restrictions. For details on re-migration limitations for each object type, see Migrating objects in Affinium Campaign on page 164. When you select an object for re-migration you have the following options: Version Unica Confidential 147

148 Chapter 6: Migrating Data to Affinium Campaign Overwrite (replace) In this mode, if the selected objects already exist in the target system, they are updated, EXCEPT if treatments for a re-migrated offer exist in the target system. If treatments exist in the target system for an offer, that offer will not be re-migrated and a warning is written out to the migration log. Skip (preserve) In this mode, only new objects are migrated. Objects selected for re-migration that already exist in the target system are skipped; they are not overwritten in the target system. Migrating data to Affinium Campaign This section describes in detail the tasks you need to perform to migrate data from Affinium Campaign version 6.4.x to These tasks assume that you have successfully completed the upgrade tasks detailed in Chapter 5, Upgrading to Affinium Campaign 7.0.1, on page 135, and that you are aware of migration requirements and limitations detailed in About migration on page 142. Task 4: Set up the migration environment Task 5: Migrate Affinium Campaign data and files Task 6: Verify migration Task 7: Perform manual configuration and migration Task 8: Re-map audience levels Task 4: Set up the migration environment You must edit the setenv file to set environment variables required by the migration tool. To edit the setenv file 1 Open the setenv file in a text editor. 148 Unica Confidential Affinium Campaign Installation Guide

149 Migrating data to Affinium Campaign The file is located in the tools/migration/6.4to7.0 directory under your Affinium Campaign installation. 2 Set the value for AFFINIUM_HOME to the root directory of the Affinium Suite used by your Affinium Campaign installation. For example: Windows UNIX set AFFINIUM_HOME=C:\Program Files\Affinium AFFINIUM_HOME='/Affinium' export AFFINIUM_HOME 3 Set the value for CAMPAIGN_HOME to the directory used by your Affinium Campaign installation. For example: Windows UNIX set CAMPAIGN_HOME=C:\Program Files\Affinium\Campaign CAMPAIGN_HOME='/Affinium/Campaign' export CAMPAIGN_HOME 4 Set LOG_TEMP_DIR to the directory where you want the migration tool to create log files. For example: Windows UNIX set LOG_TEMP_DIR=C:\temp set LOG_TEMP_DIR='/var/tmp' export LOG_TEMP_DIR 5 Set ERROR_MSG_LEVEL to the desired logging level. Valid values, listed from most to least verbose, are: Version Unica Confidential 149

150 Chapter 6: Migrating Data to Affinium Campaign INFO DEBUG ERROR FATAL Windows UNIX set ERROR_MSG_LEVEL=DEBUG set ERROR_MSG_LEVEL='DEBUG' export ERROR_MSG_LEVEL Task 5: Migrate Affinium Campaign data and files The Affinium Campaign 6.4.x to migration process consists of six distinct stages, each one executed by a separate script. For each partition in your environment, run the six scripts in sequence to migrate system table data and all of the corresponding underlying objects. For information about the migration tool, including the script locations, see About the migration tool on page 145 and About the migration log on page 145 On UNIX, you must run the migration tool as root to preserve permissions and ownership. To migrate partitions Stage 1 Setup Run the stage1 script only once for each partition that you are migrating. However, if the script fails to complete, you must initiate it again. The stage1 script performs the following actions: 150 Unica Confidential Affinium Campaign Installation Guide

151 Migrating data to Affinium Campaign Discovers information about the source and target system Sets up database connections to the source and the target system Creates temporary migration tables in the target system Servers that must be running during Stage 1 Target Web application server Target Affinium Manager instance Servers that must be stopped during Stage 1 Source and target Campaign listeners Source and target UDI servers (if applicable) Required information for Stage 1 This section describes the information that the stage1 script prompts you to provide. You might find it helpful to gather or decide this information in advance. In most cases, the script attempts to detect the information, and either presents options for you to select or, if it cannot find the infomation, prompts you to provide it. Before running Stage 1 migration, you should have modified the setenv script file as detailed in Task 4: Set up the migration environment on page 148. Operating systems The operating system on which the source and target systems are running. Both systems must be installed on the same type of operating system. Root installation directory of target system The root installation directory of the target system (AFFINIUM_HOME). The script provides a default based on the value of AFFINIUM_HOME you set in the setenv script. Version Unica Confidential 151

152 Chapter 6: Migrating Data to Affinium Campaign Affinium Manager connection information The script prompts you for the following details required for accessing Affinium Manager: URL for example, Username for example, asm_admin Password (if any) for example, admin Partition details The script attempts to detect the partitions in the source Campaign system. If only one partition is defined, it is automatically selected for migration. If more than one partition is defined, you must choose an initial partition to migrate. You run all six stages of migration on the same initial partition before selecting the next partition to migrate. For details required to migrate partitions, see About migrating partitions on page 146. Connection details to source system tables database The script prompts you to select a connection method to the system tables in both the source and target systems. If you use WebLogic as the application server, you should select WebLogic. If you use WebSphere as the application server, you must select JDBC. Select one of the options: WebLogic If you select this option, the script prompts you to enter the following details: hostname for example, mymachine port number for example, 7001 Web application server username for example, weblogic password for example, weblogic 152 Unica Confidential Affinium Campaign Installation Guide

153 Migrating data to Affinium Campaign full path (including filename) to the Web application server s library.jar file for example, C:\bea\weblogic81\server\lib\weblogic.jar JDBC If you select this option, the script prompts you to enter the following details: driver class name for example, oracle.jdbc.driver.oracledriver URL including host, db name, port for example, jdbc:oracle:thin:@machinename:1521:orcl database username and password Source system tables information Catalog/database (depending on your database system s terminology) the script detects the available options for you to select. Schema/owner (depending on your database system s terminology) the script detects the available options for you to select. Target system tables information Catalog/database (depending on your database system s terminology) the script detects the available options for you to select. Schema/owner (depending on your database system s terminology) the script detects the available options for you to select. Path to affinium_config.xml s directory on the source system The full path to the directory containing the affinium_config.xml file on the source system. Do not include the filename. For example, C:\unica\6.4\Affinium\authorization\confdata Path to the Affinium Campaign installation directory on the source system The path to the Affinium Campaign installation directory on the source system. For example, C:\unica\6.4\Affinium\Campaign Version Unica Confidential 153

154 Chapter 6: Migrating Data to Affinium Campaign Path to the partition home The path to the selected partition s directory on the source system. For example, C:\unica\6.4\Affinium\Campaign\partitions Database ID limits for source and target systems In Affinium Campaign 6.4.x and 7.0.1, database ID limits are set for each partition using the internalidlowerlimit and internalidupperlimit properties located in the affinium_config.xml file. Source system The stage1 script prompts you to enter new values or change the existing values for lower and upper ID limits in the source system. In the source system, the lower ID limit is optional, but the upper ID limit is required. The upper ID limit in the source system must: Be higher than the lower ID limit Be higher than the highest ID used in the source system tables Allow some unused IDs for new rows to be created during the migration If you define different values during migration from existing values in the source system s affinium_config.xml, you must manually update your source system s affinium_config.xml to correspond with the new ID range values you specified during migration. Otherwise, if the source system remains in production, new objects created there might be assigned IDs that fall outside the specified range, and might not be migrated by the migration process. The migration scripts do not automatically modify any source data or files, including affinium _config.xml. Target system The stage1 script prompts you to enter new values or change the existing values for lower and upper ID limits in the target system. In the target system, the lower ID limit is required, but the upper ID limit is optional. The lower ID limit in the target system must be higher than the upper ID limit in the source system. 154 Unica Confidential Affinium Campaign Installation Guide

155 Migrating data to Affinium Campaign If you specify an upper ID limit in the target system, it must: Be higher than the lower ID limit in the target system Be higher than the highest ID used in the source system tables Allow some unused IDs for new rows to be created during the migration The range of IDs in the two systems must not overlap, to prevent ID conflicts between rows created in the two systems during migration. IDs from the source system are copied over directly, and the migration also creates some new objects requiring IDs. To run the Stage 1 script 1 Open a command window and run the stage1 script. 2 Provide the information requested by the prompts. 3 When the script completes, you are prompted to press any key to continue. 4 Check the log for errors. See About the migration log on page 145. After Stage 1 of the migration is complete, do not change any Affinium Manager user names or Affinium Campaign system table mappings. Stage 2 Consistency checks You can run the stage2 script multiple times for each partition that you migrate. The stage2 script functions as follows: Performs database and file system consistency checks on the source system and reports errors. Version Unica Confidential 155

156 Chapter 6: Migrating Data to Affinium Campaign If errors are reported, their causes are logged in detail. Consult the log to learn what you need to correct in order to run this stage successfully. Validates internal ID ranges on both the source and the target system. IDs from the source system are copied over directly, and the migration also creates some new objects requiring IDs. For that reason, the ID range for both systems must not overlap. Checks if the AssignOffer macro exists in any stored derived fields. These cannot be migrated. Required information for Stage 2 The script prompts you to provide the Web application server password for the target system. To run the Stage 2 script 1 Open a command window and run the stage2 script. 2 Provide the information requested by the prompts. 3 When the script completes, you are prompted to press any key to continue. 4 Check the log for errors. See About the migration log on page If any errors are reported: Correct the errors. Re-run the script. Stage 3 File system artifacts Run the stage3 script only once for each partition that you are migrating. However, if the script fails to complete, you must initiate it again. 156 Unica Confidential Affinium Campaign Installation Guide

157 Migrating data to Affinium Campaign The stage3 script functions as follows: Copies artifacts on the file system from source to target. Copies configuration settings from the following files to their correct equivalents in the affinium_config.xml file: dbconfig.lis unica_aclnsr.cfg Required information for Stage 3 The script prompts you to provide the Web application server password for the target system. The script prompts you for the name given to the 6.4.x system tables datasource after attempting to find one. To run the Stage 3 script 1 Open a command window and run the stage3 script. 2 Provide the information requested by the prompts. 3 When the script completes, you are prompted to press any key to continue. 4 Check the log for errors. See About the migration log on page 145. Stage 4 Database artifacts Run the stage4 script only once for each partition that you are migrating. However, if the script fails to complete, you must initiate it again. The stage4 script migrates data that is not associated with a specific campaign or session from the source system table database into the target system database. Version Unica Confidential 157

158 Chapter 6: Migrating Data to Affinium Campaign Required information for Stage 4 The script prompts you to provide the Web application server password for the target system. To run the Stage 4 script 1 Open a command window and run the stage4 script. 2 Provide the information requested by the prompts. 3 When the script completes, you are prompted to press any key to continue. 4 Check the log for errors. See About the migration log on page 145. Stage 5 Offer/campaign/session artifacts You can run the stage5 script multiple times for each partition that you migrate. Each time this script finishes migrating a selected item or group of items, you can choose whether to migrate more data. You can repeat the migration steps within the script for all items that you want to migrate, before the script completes. You can also re-migrate objects with this script. For more details about remigration, see About re-migration on page 147. The stage5 script functions as follows: Migrates the item types you specify: Campaigns and associated offers Offers not used in any campaign Sessions Custom macros, derived fields, or triggers 158 Unica Confidential Affinium Campaign Installation Guide

159 Migrating data to Affinium Campaign For offers in campaigns, allows you to choose whether to migrate the associated contact history and response history data. If you do this, you must have created and mapped all audience level tables in both source and target systems. Allows you to select, for the item type selected, whether you migrate: Individual items prompts you to enter the item name if you choose this option. A folder of items prompts you to enter the folder name if you choose this option. All available items of this type For campaigns, allows you to specify an individual flowchart to re-migrate. Required information for Stage 5 The script prompts you to provide the Web application server password for the target system. To run the Stage 5 script 1 Open a command window and run the stage5 script. 2 Provide the information requested by the prompts. Before each selected item or group of items is migrated, you see a preview list for confirmation. 3 When each selected item or group of items completes migration, you are prompted to indicate whether you want to migrate more data. If you enter yes, you are prompted to choose the item type to migrate. If you enter no, stage 5 migration completes. 4 When the script completes, you are prompted to press any key to continue. 5 Check the log for errors. See About the migration log on page 145. Version Unica Confidential 159

160 Chapter 6: Migrating Data to Affinium Campaign Stage 6 Finish migration or migrate next partition You can run the stage6 script multiple times per partition that you migrate. The stage6 script performs the following functions: Allows you to specify a different partition to migrate. For details that you are prompted to provide each time you select a partition for migration, see To migrate partitions on page 150. Cleans up and removes temporary migration tables from the target system. To run the Stage 6 script 1 Open a command window and run the stage6 script. 2 Provide the information requested by the prompts. 3 When the script completes, you are prompted to press any key to continue. 4 Check the log for errors. See About the migration log on page 145. Task 6: Verify migration After you have finished executing the six migration steps, you can verify that the migration was completed successfully. To verify migration 1 Restart the Campaign servers. 2 Log in to Affinium Campaign and verify that: You can view and open flowcharts and process boxes You can perform test runs of flowcharts 160 Unica Confidential Affinium Campaign Installation Guide

161 Migrating data to Affinium Campaign Task 7: Perform manual configuration and migration The following list covers areas where manual intervention after migration is required. Depending on the content and configuration of the source system, you might need to perform manual steps in other areas. Processes and files output by processes The Contact process is converted to a MailList process in migrated flowcharts, but must be manually reconfigured. The Track process is migrated but is unconfigured after migration. The new concept of contact status was introduced in Affinium Campaign 7.0.1, and any existing contacts require an initial contact status. You must configure migrated Track processes to log to contact history, then subsequently update the contact status for generated treatments. The Response process is migrated but is unconfigured after migration. After migration, you must set up valid User Response Types in the UA_UsrResponseType table, then in the Response process configuration dialog, select a Response Type Code and, at a minimum, map Treatment Code as a matching field The Optimize process is migrated but is unconfigured after migration. Files that have been output from Snapshot processes are not migrated. You must move these manually to the target system if desired. Cubes and strategic segments If any migrated flowcharts create cubes or strategic segments, you must rerun these flowcharts to re-create the cube or strategic segments. Trigger files References to triggers, which are stored in the UA_Triggerlist system table, are migrated. However, the files or scripts invoked by triggers are not migrated. References to triggers are stored in the database, in the UA_Triggerlist system table. The files invoked by the trigger are stored in arbitrary locations, and the migration tool does not move these files. You must move the files manually to your target system and ensure that the corresponding value in UA_TriggerList is updated. Version Unica Confidential 161

162 Chapter 6: Migrating Data to Affinium Campaign Control groups are not migrated, so you must re-create them if you need them. Flowchart templates and table catalogs The following tables were added in version for catalogs and flowchart templates: UA_TableCatalog for catalogs UA_FlowchartTmpl for flowchart templates The migration tool copies the catalog and template file system folders from the source system to the target system, but it does not populate the tables. These tables are automatically populated for the whole system when you click Tools > Stored Templates or Tools > Stored Catalogs in any flowchart. AssignOffer macro The AssignOffer() macro is no longer supported in Affinium Campaign 7.0. Any processes that used the AssignOffer() macro will appear unconfigured after migration and must be manually reconfigured. Task 8: Re-map audience levels Re-map your audience levels for each partition. When you have done this, you have finished migrating your data. 162 Unica Confidential Affinium Campaign Installation Guide

163 7 MIGRATION REFERENCE This chapter provides migration and re-migration details and limitations for objects in Affinium Campaign. Key topics in this chapter are: Overview Migrating objects in Affinium Campaign Throughout this chapter, any maintenance version on the 6.4 line is referred to as Affinium Campaign 6.4.x. Source environments and components refer to the 6.4.x system from which you are migrating, and target environments and components refer to the system to which you are migrating. Overview Before migrating configuration settings, files, and data from your Affinium Campaign 6.4.x system to your system, you should have a good understanding of the limitations of migration or re-migration, and of the expected migration results for the objects you migrate. Affinium Campaign Installation Guide Unica Confidential 163

164 Chapter 7: Migration Reference Use this chapter to gain this understanding and to verify that migration has completed as designed. In addition, see About migration on page 142, and About re-migration on page 147. For areas where manual intervention is required after migration, see Task 7: Perform manual configuration and migration on page 161. For procedures for upgrading and migrating data, see Chapter 5, Upgrading to Affinium Campaign 7.0.1, on page 135 and Chapter 6, Migrating Data to Affinium Campaign 7.0.1, on page 141. Migrating objects in Affinium Campaign This section provides details, by object type or functional area, of migration and re-migration, if supported. The list of objects and functional areas is arranged alphabetically. Campaigns Cells Configuration information Control groups Creatives Cubes and strategic segments Custom attributes Custom macros Derived fields Dimension hierarchies Flowcharts Flowchart templates Folders Initiatives 164 Unica Confidential Affinium Campaign Installation Guide

165 Migrating objects in Affinium Campaign Offers Offer templates Offer versions Processes Strategic segments Sessions Table catalogs Triggers Campaigns Migration Campaigns can be migrated individually or as part of a specified folder. Associated offers and flowcharts are migrated as part of each campaign. When you migrate a campaign you can choose to include the associated contact and response history. For details, see Contact and response history on page 167. Stored objects All stored objects referenced by flowcharts in campaigns (custom macros, triggers, and stored derived fields) are migrated as a whole from the source system during Stage 3; they cannot be individually specified for migration. In stage 5, when campaigns are migrated, flowcharts are migrated, including their references to these objects. These referenced objects can be re-migrated but again only as a whole for the system; they can not be individually specified, and only Overwrite mode is available. Custom attributes For details about migrating campaign custom attributes, see Campaign custom attributes on page 169. Version Unica Confidential 165

166 Chapter 7: Migration Reference Re-migration Campaigns can be re-migrated individually or as part of a specified folder. Associated offers and flowcharts are re-migrated as part of the campaign. When you re-migrate campaigns, you can specify how objects already in the target system are handled by choosing either Overwrite or Skip mode. For details, see About re-migration on page 147. :Any new flowcharts in the target system that do not exist in the source system are not affected or changed when the campaign is re-migrated. Cells Cells are migrated and re-migrated with processes in flowcharts. For details, see Processes on page 175. Configuration information Migration The following configuration files are migrated to Affinium Manager s affinium_config.xml. dbconfig.lis unica_aclnsr.cfg udisvr.cfg The following files from pre 6.4.x versions of Affinium Campaign are not migrated: acsvr.cfg Campaign_config.xml Re-migration Configuration files cannot be re-migrated. 166 Unica Confidential Affinium Campaign Installation Guide

167 Migrating objects in Affinium Campaign Contact and response history Migration You can select whether to migrate contact history and response history when you select campaigns or sessions for migration. You can only migrate both contact history and response history together; you cannot migrate only one and not the other. Re-migration You can select whether or not to re-migrate contact history and response history when you select campaigns or sessions for re-migration. You can only re-migrate both contact history and response history together; you cannot re-migrate only one and not the other. Contact and response history records that were generated on the same date as records already in the target system tables cannot be re-migrated. When re-migrating contact and response history, the migration tool will check contact and response history records on the target system based on date. If records from the source system do not have the same dates as records in the target system, these new records are inserted into the target system tables. However, if contact and response history records from the source system share dates with records already in the target system, these records will not be migrated. This situation might arise if contact or response flowcharts were run multiple times on the same date. If your source system contains such contact and response history data, you must clean it up before attempting to re-migrate contact and response history. Control groups Control groups are not migrated from Affinium Campaign 6.4.x to due to significant differences in functionality. In Affinium Campaign 7.0.1, all controls: Version Unica Confidential 167

168 Chapter 7: Migration Reference are no contact controls are never output in contact lists are never rolled up in performance reports If you have controls in Affinium Campaign 6.4.x you will need to manually recreate them in the target system. For details, see Task 7: Perform manual configuration and migration on page 161. Creatives For details, see Creatives on page 173. Cubes and strategic segments Migration Although flowcharts containing the Cube or CreateSeg processes are migrated intact and appear configured, the actual cube or strategic segment files are not migrated. You must re-run the flowcharts after migration to re-create the cubes or strategic segments. For details, see Task 7: Perform manual configuration and migration on page 161. Re-migration Flowcharts containing the Cube or CreateSeg processes can be re-migrated, but cube or strategic files are not migrated or re-migrated. Custom attributes Migration Custom attributes can only be migrated once, in association with the object of which they are an attribute. 168 Unica Confidential Affinium Campaign Installation Guide

169 Migrating objects in Affinium Campaign Campaign custom attributes Campaign custom attributes are migrated intact in the UA_CampaignExtAttr table. Offer custom attributes The UA_OfferExtAttr table in Affinium Campaign 6.4.x no longer exists in Affinium Campaign Contents of UA_OfferExtAttr in the source system are migrated to the corresponding new tables in the target system: UA_OfferAttribute, UA_AttributeDef. Re-migration Re-migration is not supported for custom attributes. That is, new custom attributes added to source system objects that have already been migrated cannot be migrated even if the main object (for example, a campaign or offer) can be remigrated. However, if you change the values of offer custom attributes in the source system then re-migrate the offers, the new values of the offer custom attributes are carried over to the target system. Not all offer attribute values can be re-migrated. For details, see the Re-migration section under Offers on page 173. Custom macros Migration All stored objects referenced by flowcharts in campaigns (custom macros, triggers, and stored derived fields) are migrated as a whole from the source system during Stage 3; they cannot be individually specified for migration. In stage 5, when campaigns are migrated, flowcharts are migrated, including their references to these objects. AssignOffer macro The AssignOffer() macro is no longer supported in Affinium Campaign 7.0. Stored derived fields that used the AssignOffer() macro will not be migrated. Version Unica Confidential 169

170 Chapter 7: Migration Reference Any instances of stored derived fields that are not migrated for this reason will be noted in the migration log. Re-migration These referenced objects can be re-migrated but again only as a whole for the system; they can not be individually specified, and only Overwrite mode is available. Derived fields Migration All stored objects referenced by flowcharts in campaigns (custom macros, triggers, and stored derived fields) are migrated as a whole from the source system during Stage 3; they cannot be individually specified for migration. In stage 5, when campaigns are migrated, flowcharts are migrated, including their references to these objects. Re-migration These referenced objects can be re-migrated but again only as a whole for the system; they can not be individually specified, and only Overwrite mode is available. Dimension hierarchies Migration Dimension hierarchies can only be migrated once. Re-migration Re-migration is not supported for dimension hierarchies. 170 Unica Confidential Affinium Campaign Installation Guide

171 Migrating objects in Affinium Campaign Flowcharts Migration Flowcharts are migrated as part of campaigns or sessions. For details, see Campaigns on page 165 and Sessions on page 178. Some flowcharts might require manual intervention after migration. For details, see Task 7: Perform manual configuration and migration on page 161. Re-migration Flowcharts can be re-migrated as part of campaigns or sessions. As well, specific flowcharts within campaigns can be selected for re-migration without remigrating all flowcharts in a campaign. Any flowchart associated with a campaign will not be re-migrated if the flowchart already exists in the target system and there are treatments associated with it in the target system. If the flowchart selected for re-migration is not found in the target system, but there are treatments associated with it, the existing treatments and any contact and response history associated with that flowchart are deleted before migrating the flowchart. This behavior addresses the scenario where a flowchart has been deleted from the target system without its history being cleared. If ownership of re-migrated flowcharts has changed in the source system since previous migration, the ownership in the target system will be updated to reflect this. Flowchart templates Migration All flowchart template files are migrated intact to the target system in the UA_FlowchartTmpl table, but table entries are not populated by migration. The target Affinium Campaign system automatically populates the table when View Templates/Catalogs is first performed in the target system after migration. For details, see Task 7: Perform manual configuration and migration on page 161. Version Unica Confidential 171

172 Chapter 7: Migration Reference Re-migration Re-migration is not supported for flowchart templates. Folders Migration You can choose to migrate entire folders of objects. The existing tree structure from the source system is migrated intact. Re-migration You can re-migrate entire folders of objects. If objects have been moved between folders in the source system after initial migration, when you attempt to re-migrate, note that supporting files that were previously migrated to the target system will remain in their original folder locations. To avoid data conflicts, you should re-migrate the entire contents of new or changed folders, and ensure that you re-migrate the parent folders of subfolders. Initiatives Migration Initiatives can only be migrated once. Re-migration Re-migration is not supported for initiatives. 172 Unica Confidential Affinium Campaign Installation Guide

173 Migrating objects in Affinium Campaign Offers Migration Offers can be migrated individually, as part of a folder s contents, or as part of a campaign (that is, if a campaign references the offer). Offers will not be migrated if they have treatments associated with them in the target system. Such offers will be skipped by the migration process but migration will continue. Creatives Affinium Campaign 7.0 does not support multiple creatives per offer; therefore only the first creative for each migrated offer is migrated. Creatives other than the first one associated with an offer are dropped. Custom attributes For details about migrating offer custom attributes, see Offer custom attributes on page 169. Templates Offer templates did not exist in Affinium Campaign 6.4.x. When offers are migrated from the source system, a default template is created by the migration process. All migrated offers will use this default offer template in the target system. Re-migration Re-migration of offers is supported in Stage 5 migration, either as part of campaign re-migration, or individually selected when not used in campaigns. When you re-migrate offers, you can specify how objects already in the target system are handled by choosing either Overwrite or Skip mode. For details, see About re-migration on page 147. Offers that have been used in production in the target system (that is, those that have written out treatments to the target system tables) cannot be re-migrated. Version Unica Confidential 173

174 Chapter 7: Migration Reference When you re-migrate an offer, changes made in the source system (since previous migration) to any of the following offer attributes are not carried over by re-migration: Offer Name Offer Version Name Version Code Offer Group ID Channel Offer templates Migration Offer templates did not exist in Affinium Campaign 6.4.x, therefore there is no migration of offer templates. A default template is created in the target system for all migrated offers. For details, see Templates on page 173. Re-migration When offers are re-migrated, their offer templates are not changed. The original template associated with an offer when the offer was first migrated is left unchanged. Offer versions Offer versions as they existed in Affinium Campaign versions 6.4.x are no longer supported in Affinium Campaign Migration Offer versions from Affinium Campaign versions 6.4.x are migrated as new offers in Affinium Campaign Contact history that is associated with each offer version is migrated to each new offer in the target system. 174 Unica Confidential Affinium Campaign Installation Guide

175 Migrating objects in Affinium Campaign In the target system, after migration, the new offer has the following: Offer name consisting of <Offer name> - <offer version name> Offer code <System-generated offer code> - <version code> New offer custom attribute whose value is the source offer version code New offer custom attribute <Offer name> - <group code> where group code is the OfferGroupID in the UA_Offer table. Re-migration Re-migration of offer versions is handled in the same way as re-migration of offers. For details, see Offers on page 173. Processes Migration Processes that were configured in the source system can in most cases be migrated to Affinium Campaign as configured processes and should be available for running without manual intervention. Exceptions are noted below. For areas where manual intervention is required after migration, see Task 7: Perform manual configuration and migration on page 161. The following processes are configured and can be run after migration without user intervention: Audience CallList CreateSeg Cube Extract MailList Merge Model Version Unica Confidential 175

176 Chapter 7: Migration Reference Sample Schedule Segment Select Score Snapshot Migrated but unconfigured The following processes are migrated, but are unconfigured after migration and must be manually reconfigured. For details, see Task 7: Perform manual configuration and migration on page 161. Optimize Response Track Contact process The Contact process will be transformed to a MailList process in migrated flowcharts, but must be manually reconfigured. Interactive flowchart migration not supported Flowcharts containing the following processes are migrated but cannot be opened after migration. Decision EMessage EventIn EventOut Recommend Legacy processes not migrated The following legacy processes from Affinium Campaign 4.x are no longer supported Affinium Campaign 7.0. When flowcharts containing these processes are migrated, these processes will disappear from the migrated flowcharts. Evaluate SelectOpt 176 Unica Confidential Affinium Campaign Installation Guide

177 Migrating objects in Affinium Campaign TestOpt Cell codes For all processes, the Cell Code tab was removed in Affinium Campaign 7.0. For each process migrated, the migration process will find the proper cell code to associate with the process from the output process that created a target cell. In the rare case that there are two or more different cell code values downstream for the same cell, migration will choose any one of these to use. The details pertaining to the cell code chosen and the cell code(s) not chosen are captured in the individual flowchart s log. AssignOffer macro The AssignOffer() macro is no longer supported in Affinium Campaign 7.0. Any processes that used the AssignOffer() macro will appear unconfigured after migration and must be manually reconfigured. Re-migration Re-migration of processes is achieved through re-migration of flowcharts. For details, see Flowcharts on page 171. Security Users and groups that existed in Affinium Security Manager for the source system are preserved and migrated intact to the target system by the Affinium Manager migration process. For details, see the Affinium Manager Installation Guide. The default Affinium Campaign security policy shipped with Affinium Campaign will be backward compatible for the following roles without manual intervention: Read-only Read/write Read/write/execute Administrator Version Unica Confidential 177

178 Chapter 7: Migration Reference Strategic segments For details, see Cubes and strategic segments on page 168. Sessions Migration Sessions can be migrated individually or as part of a specified folder. Associated flowcharts are migrated as part of each session. Stored objects All stored objects referenced by flowcharts in sessions (custom macros, triggers, and stored derived fields) are migrated as a whole from the source system during Stage 3; they cannot be individually specified for migration. In stage 5, when sessions are migrated, flowcharts are migrated, including their references to these objects. These referenced objects can be re-migrated but again only as a whole for the system; they can not be individually specified, and only Overwrite mode is available. Re-migration Sessions can be re-migrated individually or as part of a specified folder. When a session is re-migrated, any flowcharts in that session are also re-migrated. When you re-migrate sessions, you can specify how objects already in the target system are handled by choosing either Overwrite or Skip mode. For details, see About re-migration on page 147. Any new flowcharts in the target system that do not exist in the source system are not affected or changed when the session is re-migrated. 178 Unica Confidential Affinium Campaign Installation Guide

179 Migrating objects in Affinium Campaign Table catalogs Migration Table catalogs can only be migrated once. All table catalog file system folders are migrated intact to the target system in UA_TableCatalog, but table entries are not populated by migration. The target Affinium Campaign system automatically populates the table when View Templates/Catalogs is first performed in the migrated target system. For details, see Task 7: Perform manual configuration and migration on page 161. Re-migration Re-migration is not supported for table catalogs. Triggers Migration All stored objects referenced by flowcharts in campaigns (custom macros, triggers, and stored derived fields) are migrated as a whole from the source system during Stage 3; they cannot be individually specified for migration. In stage 5, when campaigns are migrated, flowcharts are migrated, including their references to these objects. References to triggers, which are stored in the UA_Triggerlist system table, are migrated. However, the files or scripts invoked by triggers are not migrated. References to triggers are stored in the database, in the UA_Triggerlist system table. The files invoked by the trigger are stored in arbitrary locations, and the migration tool does not move these files. You must move the files manually to your target system and ensure that the corresponding value in UA_TriggerList is updated. Version Unica Confidential 179

180 Chapter 7: Migration Reference Re-migration These referenced objects can be re-migrated but again only as a whole for the system; they can not be individually specified, and only Overwrite mode is available. 180 Unica Confidential Affinium Campaign Installation Guide

181 8 CONFIGURING AFFINIUM CAMPAIGN FOR A NON- ENGLISH LANGUAGE This chapter describes the steps required to ensure that Affinium Campaign works properly on a system configured for a non-english language. The basic steps for configuration are contained in this chapter. This chapter includes the following topics: Overview Configuring for a non-english language Sample configurations Overview Configuring Affinium Campaign for non-english data is a multi-part process. Unica strongly recommends that you avoid any use of the Campaign system Affinium Campaign Installation Guide Unica Confidential 181

182 Chapter 8: Configuring Affinium Campaign for a Non-English Language before it is completely configured for a non-english language and tested. Thus, it is best to perform non-english configuration on a new installation of Campaign. The following procedure provides a high-level overview of the required steps. Each step is explained in detail in later sections of this chapter. To configure Campaign for non-english data: overview Task 1: Configure the operating system On the machine where the Campaign server will run, and on every machine that will access the Campaign web application, configure language and regional settings for the operating system. Task 2: Configure the browser language On every machine that will access Campaign s web application, configure language settings for the browser. Task 3: Configure the Campaign server and web application Configure settings to control how Campaign reads and writes data in text files and log files, how Campaign reads and writes date fields and text fields within the database, and how Campaign handles text it receives from the database. Task 4: Un-map and re-map system tables If Campaign s system tables have already been mapped before you configured for a non-english language, you must perform this step to ensure that your settings are applied. Task 5: Test your database configuration Test the Campaign server before you configure the web application. Task 6: Test Campaign Test your configuration. Understanding encodings Before you attempt to configure Campaign to work with non-english languages, you need to understand character encodings. A brief overview and links to 182 Unica Confidential Affinium Campaign Installation Guide

183 Configuring for a non-english language additional resources are provided in Appendix B, Internationalization and Encodings, on page 299. Sample configurations Sample configurations are provided in Sample configurations on page 202. These sample configurations in this chapter are intended to demonstrate Campaign's international data capabilities. Locale-specific data conventions Affinium Campaign has been modified to be International-ready for Western European (Latin1) domains. Affinium Campaign recognizes Windows international settings, and supports locale-specific data conventions, as follows: Various orderings of month/day/year Numeric data with decimal comma (for example, 120,60 for ) Configuring for a non-english language The steps in this section are written in a specific order to minimize the likelihood of an incorrect configuration. All of these steps must be performed, and in the correct order; skipping a step could result in error messages and corrupted data. The following configuration steps are described in this section: Task 1: Configure the operating system Task 2: Configure the browser language Task 3: Configure the Campaign server and web application Task 4: Un-map and re-map system tables Task 5: Test your database configuration Task 6: Test Campaign Version Unica Confidential 183

184 Chapter 8: Configuring Affinium Campaign for a Non-English Language Task 1: Configure the operating system On every machine where the Campaign server will run, and on every machine that will access Campaign, configure language and regional settings for the operating system. Your database may also require that you set the operating system language and region on the machine where the database is installed. See the database documentation to determine whether this is required. Perform the procedure below that is appropriate for your operating system Setting the language and region on UNIX UNIX systems require that appropriate languages are installed. To determine if the desired language is supported on an AIX, HP, or Solaris machine, use this command: # locale -a The command returns all supported locales on the system. Note that Campaign does not require that you install support for X Fonts and translations. The following links may be helpful in setting up supported UNIX variants to work with a given language: Solaris 9 International Language Environments Guide AIX 5.3 National Language Support Guide and Reference m.aix.doc/aixprggd/nlsgdrf/mastertoc.htm HP-UX 11 Internationalization Features White Paper Unica Confidential Affinium Campaign Installation Guide

185 Configuring for a non-english language Setting the language and region on Windows XP Pro and 2003 The following procedure describes how to configure language settings on Windows XP Pro and You may need your system installation CD to complete this task. For additional information see To set the language and region on Windows XP Pro and Open the Control Panel and click Regional and Language Options. The Regional and Language Options dialog box opens with the Regional Options tab selected. 2 Select the language and region in the Standards and formats section, and select your country in the Location section. A completed Regional Options tab is shown in Figure 8-1. Version Unica Confidential 185

186 Chapter 8: Configuring Affinium Campaign for a Non-English Language Figure 8-1 A completed Regional Options tab If the desired language is not available in the Standards and formats section, install supplemental language support as follows: a b c Select the Languages tab. If either of the checkboxes are unchecked, check them and then click OK. Windows prompts for the system installation CD, copies some files from it, and then reboots. After the reboot, return to the Regional and Language Options tab and complete the configuration. The language required should be available in the list at this point. A completed Languages tab is shown in Figure Unica Confidential Affinium Campaign Installation Guide

187 Configuring for a non-english language Figure 8-2 A configured Languages tab 3 Open the Control Panel and click Regional and Language Options. 4 If you do not want to accept the default keyboard language setting that Windows adds automatically, select the Languages tab and click the Details button to open a dialog box where you change the default setting. 5 Select the Advanced tab and choose the language and region in the Language for non-english programs section, as shown in Figure 8-3. The Code page conversion tables and Default user account settings sections do not need to be modified. Version Unica Confidential 187

188 Chapter 8: Configuring Affinium Campaign for a Non-English Language Figure 8-3 Advanced tab 6 Reboot Windows. After the reboot, the system is ready to use the desired language. Setting the language and region on Windows 2000 The following procedure describes how to configure language settings on Windows You may need your system installation CD to complete this task. For additional information see Unica Confidential Affinium Campaign Installation Guide

189 Configuring for a non-english language To set the language and region on Windows Open the Control Panel and click Regional Options. The Regional Options dialog box opens with the General tab selected. 2 Select the language and location in the Settings for the current user section and ensure that the appropriate checkboxes are selected in the Language settings for the system section. A completed General tab is shown in Figure 8-1 Figure 8-4 A completed General tab 3 Click Set default. The Select System Locale dialog box opens, as shown in Figure 8-5. Version Unica Confidential 189

190 Chapter 8: Configuring Affinium Campaign for a Non-English Language Figure 8-5 The Select System Locale dialog box 4 Set the same language and location as in the Settings for the current user section in the Regional Options dialog box, and click OK. The Select System Locale dialog box closes. 5 Click OK in the Regional Options dialog box. Windows may prompt for the installation CD and then copy files from it. 6 Reboot after the dialog box closes, even if Windows does not directly require it. This is essential. After the reboot, the system is ready to use the desired language. Task 2: Configure the browser language Internet Explorer is the only supported browser. On every machine that will access Campaign s web application, configure language settings for the browser. To configure the language in Internet Explorer 1 Start Internet Explorer and select Tools > Internet Options. The Internet Options dialog box appears, as shown in Figure Unica Confidential Affinium Campaign Installation Guide

191 Configuring for a non-english language Figure 8-6 The Internet Options dialog box 2 Click Languages. The Language Preference dialog box opens, as shown in Figure 8-7. Figure 8-7 The Language Preference dialog box If the desired language does not appear in the Language list, add it. See To add a new language on page 192 for details. 3 Move the desired language to the top of the list as follows: Version Unica Confidential 191

192 Chapter 8: Configuring Affinium Campaign for a Non-English Language a Select the desired language in the list. b Click Move Up until the language is at the top of the list. Campaign ignores all languages in this list except for the top one. 4 Click OK. 5 Click OK in the Internet Options dialog box. 6 Close the Internet Explorer window. 7 Open a new Internet Explorer window. The language preference does not fully take effect until a new browser window is started. To add a new language 1 Start Internet Explorer and select Tools > Internet Options. The Internet Options dialog box appears, as shown in Figure Click Languages. The Language Preference dialog box opens, as shown in Figure Click Add. The Add Language dialog box opens, as shown in Figure Unica Confidential Affinium Campaign Installation Guide

193 Configuring for a non-english language Figure 8-8 The Add Language dialog box 4 Select the desired language from the list. Note that if the language is spoken in more than one region, you must be sure to select the correct language-region pair. 5 Click OK The dialog box closes and the new language is added to the bottom of the list in the Language Preference dialog. 6 Move the new language to the top of the list as follows: a Select the desired language in the list. b Click Move Up until the language is at the top of the list. Campaign ignores all languages in this list except for the top one. 7 Click OK. 8 Click OK in the Internet Options dialog box. Version Unica Confidential 193

194 Chapter 8: Configuring Affinium Campaign for a Non-English Language 9 Close the Internet Explorer window. 10 Open a new Internet Explorer window. The language preference does not fully take effect until a new browser window is started. Task 3: Configure the Campaign server and web application To configure the Campaign server and web application for non-english languages, you must: Set the values of some Campaign configuration parameters that control how Campaign reads and writes data in text files and log files, how Campaign reads and writes date fields and text fields within the database, and how Campaign handles text it receives from the database. Define three environment variables (necessary only if your version of Campaign has been translated). Both of these tasks are described in the following procedures. The configuration of the Campaign web application determines the language and region used both for translated Campaign messages (for example, text in the Campaign user interface) as well as the format of dates, numbers, and currency symbols on the application s web pages. It is also vital for allowing the flowchart to display non-english text, because the display language is used to initialize the flowchart editor. Setting the values of Campaign configuration parameters You must set Campaign parameters in the affinium_config.xml file to use the same date format and character encoding as the database client. Set the values of the parameters described in the following table. Recommended settings are not 194 Unica Confidential Affinium Campaign Installation Guide

195 Configuring for a non-english language guaranteed to work in all environments. See Appendix A, Properties in the Central Configuration File, on page 217 for complete descriptions. Campaign supports non-english column names, table names, and database names; however, it does not support NCHAR, NVARCHAR, etc columns. These are treated by Campaign as if they were regular text fields. To set the values of Campaign configuration parameters Set the values of the required Campaign configuration parameters as described in the following table. Parameter Recommended value partition1 > server > dataprocessing > comparecasesensitive partition1 > server > logging > logginglevels partition1 > server > encoding > stringencoding applications > Campaign > unicaaclistener > logstringencoding applications > Campaign > unicaaclistener > systemstringencoding partition1 > DataSources > EnableSelectOrderBy partition1 > DataSources > DateFormat no Optional. You may want to set the value to ALL during configuration and testing, then set to a lower level. Any supported encoding. See Appendix B, Internationalization and Encodings, on page 299 for a list of encodings. Any supported encoding. See Appendix B, Internationalization and Encodings, on page 299 for a list of encodings. Always use native on Windows. Do not use native on UNIX. Instead, use any supported encoding. See Appendix B, Internationalization and Encodings, on page 299 for a list of encodings. FALSE Same as database client date format, and often same as DateOutputFormatString Version Unica Confidential 195

196 Chapter 8: Configuring Affinium Campaign for a Non-English Language Parameter partition1 > datasources > DateOutputFormatString partition1 > datasources > StringEncoding partition1 > datasources > SuffixOnCreateDateField applications > Campaign > supportedlocales applications > Campaign > currencylocale applications > Campaign > defaultlocale Recommended value Same as database client date format, and same as dateformat WIDEUTF-8 You may use any supported encoding, although WIDEUTF-8 is recommended for most cases. See Appendix B, Internationalization and Encodings, on page 299 for a list of encodings. For Teradata only: FORMAT 'YYYY-MM-DD' See table in DateFormat description in Appendix A, Properties in the Central Configuration File, on page 217 The value of this property (and currencylocale and defaultlocale as well) almost always matches the languages listed in Internet Explorer's Language configuration. However, there are two critical differences: When a language-locale pair is used, the language and locale are separated by a hyphen (-) in Internet Explorer, but you must separate them by an underscore (_) in the affinium_config.xml file. When a pair is used, Internet Explorer shows the second part (the locale) in lowercase. In the affinium_config.xml file, it must be in capital letters. See supportedlocales. See supportedlocales. Defining the required environment variables You must define the UNICA_TEXTDOMAIN, UNICA_TEXTDOMAINDIR, and LANG environment variables if Campaign has been translated. To define the 196 Unica Confidential Affinium Campaign Installation Guide

197 Configuring for a non-english language environment variables in the Campaign startup script, use the procedure below that is appropriate for your operating system (Windows or UNIX). To define the required environment variables in UNIX 1 Open the setenv.sh file in a text editor. The file is located in the bin directory under your Campaign server installation. 2 Set the UNICA_TEXTDOMAIN environment variable as follows: UNICA_TEXTDOMAIN=Campaign export UNICA_TEXTDOMAIN 3 Set the UNICA_TEXTDOMAINDIR environment variable to the path to the bin/uac_locale directory of your Campaign installation. For example: UNICA_TEXTDOMAINDIR=/home/Affinium/Campaign/bin/uac_locale export UNICA_TEXTDOMAINDIR 4 Set the LANG environment variable to the UNIX equivalent of the value you configured in Task 2: Configure the browser language. Verify that the language is supported. To determine if the desired language is supported on an AIX, HP, or Solaris machine, use this command: # locale -a The command returns all supported locales on the system. If you need to add language support, see Setting the language and region on UNIX on page 184 for links to useful information. 5 Save and close the setenv.sh file. To define the required environment variables in Windows If the Campaign server is installed as a Windows service, you ll need to set the environment variables through the System Properties dialog box on the machine where the Campaign server is installed. Version Unica Confidential 197

198 Chapter 8: Configuring Affinium Campaign for a Non-English Language 1 Open the cmpserver.bat file in a text editor. The file is located in the Affinium\Campaign\bin directory. 2 Set the UNICA_TEXTDOMAIN environment variable as follows: set UNICA_TEXTDOMAIN=Campaign 3 Set the UNICA_TEXTDOMAINDIR environment variable to the path to the bin\uac_locale directory of your Campaign installation. For example: set UNICA_TEXTDOMAINDIR=C:\Affinium\Campaign\bin\uac_locale 4 Set the LANG environment variable to the same value you configured in Task 2: Configure the browser language. For example, if you configured the browser to use zh-tw: set LANG=zh-tw 5 Save and close the cmpserver.bat file. Task 4: Task 5: Un-map and re-map system tables Configuring system tables can be difficult if any language-sensitive parameter is not set correctly when you map them in the Administration area of Campaign. The best practice is to set all parameters, then unmap ALL tables in the data source, log out, log in again, and then map all the tables again. Campaign retains its existing settings for a data source until the data source is no longer used (i.e., unmapped). Test your database configuration Get the database access working perfectly before investing any time in creating non-english campaigns. Use the View data source access panel in the Campaign Administration page (or within the Admin menu in the flowchart editor) to verify that Campaign is using exactly the desired affinium_config.xml settings. If not, the data source probably needs to be unmapped and mapped again. Remember that both flowcharts and catalog files use affinium_config.xml settings. 198 Unica Confidential Affinium Campaign Installation Guide

199 Configuring for a non-english language Use the browsing capability of the system table mapping page to test the stringencoding parameter. The browse function should show dates in the database client's format. Test offers before testing campaigns. Offer names are stored in the database, and thus test the affinium_config.xml stringencoding parameter very well. Watch for "iconv" errors in flowchart log files. These are indicative of a character encoding problem occurring when accessing the database. When text data in the database is not in the same encoding as the declared encoding (for example, Hebrew in an ISO database), set the database client encoding to the declared encoding of the database. Then set the stringencoding parameter in the affinium_config.xml file to the actual encoding of the stored data. Task 6: Test Campaign There are two good diagnostics to ensure that the web application has been configured correctly. These tests are applicable to both pre-configured and manually-configured languages. They are recommended in all cases. To test Campaign 1 Log in to Campaign 2 All dates in database fields (listed when you browse system tables in Campaign) should appear in format of the dateformat setting in affinium_config.xml. 3 Test a language-sensitive image for correct URL, as follows: a b Create a Campaign Financial Report. Locate the expand all label. This label is actually an image (the text in this image may be in English, or it may be translated). The image is shown outlined in red in Figure 8-9. Version Unica Confidential 199

200 Chapter 8: Configuring Affinium Campaign for a Non-English Language Figure 8-9 The expand all image c d Right-click on the expand all image and select Properties from the drop-down menu. The Properties dialog box opens. Check the URL, which is shown in Figure 8-10 outlined in red. The URL should contain the xx_yy directory, where xx_yy is the desired language and region setting. If it contains en_us (and the defaultlocale property in the affinium_config.xml file was set to en_us as recommended), something is not configured correctly. 200 Unica Confidential Affinium Campaign Installation Guide

201 Configuring for a non-english language Figure 8-10 The Properties dialog box This is an exceptionally reliable test. If it fails, the flowchart editor will probably not operate correctly. 4 Test a process box with English Campaign name and English flowchart name, as follows: a b c Create a campaign named in English, then a flowchart named in English, and then edit the flowchart. Place a process box and name it using the desired language. Verify that the name displays correctly in the process box (not just in the process configuration dialog box). 5 Test date formats, decimal number format, and the currency symbol. Version Unica Confidential 201

202 Chapter 8: Configuring Affinium Campaign for a Non-English Language 6 Re-test database access as described in Test your database configuration on page 198. Sample configurations The following samples are provided in this section: French German Traditional Chinese Hebrew Thai Japanese Korean These sample configurations should never be used in a production setting without understanding the full implication of each setting. Each sample configuration assumes: You have read and understood this chapter, including the process overview and all of the configuration steps. You have some experience with configuring Campaign. You are using a new installation no user data or system tables exist. The system tables have not been mapped in yet, or system tables are not required to be in the desired language (needed for campaign names, flowchart names, or any other language-sensitive data that is stored in the system tables). The ODBC data source has been configured with the Use regional settings when outputting currency, numbers, dates, and times setting unchecked. Note that the configuration will change according to server operating system and database. Each sample in this section assumes the following configuration: Affinium Campaign version and above Windows XP or Windows Windows 2000 may work as well. Weblogic 8.1 Express 202 Unica Confidential Affinium Campaign Installation Guide

203 Sample configurations SQL Server 2000 with a new database created after the Regional and Language options are configured Remember that all configuration values are case-sensitive. French To configure for French 1 Change Regional Settings to use French, France 2 In Internet Explorer's language setup, add language for French (fr). 3 In applications > Campaign <supportedlocales> list includes fr <defaultlocale>en_us</defaultlocale> <currencylocale>fr_fr</currencylocale> 4 In applications > Campaign > unicaaclistener <systemstringencoding>native</systemstringencoding> <logstringencoding>native</logstringeverifyncoding> 5 In applications > Campaign > partitions > partition_name > server > encoding <stringencoding>cp1252</stringencoding> 6 In applications > Campaign > partitions > partition_name > datasources > UA_SYSTEM_TABLES: <stringencoding>cp1252</stringencoding> <DateFormat>DELIM_Y_M_D/<DateFormat> <DateOutputFormatString>%Y/%m/%d</DateOutputFormatString> Notes On Windows with Microsoft SQL Server, all encodings use the ANSI code page for French. Version Unica Confidential 203

204 Chapter 8: Configuring Affinium Campaign for a Non-English Language All dates in web pages appear in European date format: dd/mm/yyyy German To configure for German 1 Change Regional Settings to use German, Germany 2 In Internet Explorer's language setup, add language for German (de). 3 In applications > Campaign <supportedlocales> list includes "de" <defaultlocale>en_us</defaultlocale> <currencylocale>de_de</currencylocale> 4 In applications > Campaign > unicaaclistener <systemstringencoding>native</systemstringencoding> <logstringencoding>native</logstringencoding> 5 In applications > Campaign > partitions > partition_name > server > encoding <stringencoding>cp1252</stringencoding> 6 In applications > Campaign > partitions > partition_name > datasources > UA_SYSTEM_TABLES: <stringencoding>cp1252</stringencoding> <DateFormat>DELIM_Y_M_D</DateFormat> <DateOutputFormatString>%Y/%m/%d</DateOutputFormatString> 204 Unica Confidential Affinium Campaign Installation Guide

205 Sample configurations Traditional Chinese To configure for Chinese 1 Change Regional Settings to use Chinese, Taiwan 2 In Internet Explorer's language setup, add language for Traditional Chinese (zhtw). 3 In applications > Campaign <supportedlocales> list includes zh_tw <defaultlocale>en_us</defaultlocale> <currencylocale>zh_tw</currencylocale> 4 In applications > Campaign > unicaaclistener <systemstringencoding>native</systemstringencoding> <logstringencoding>utf-8</logstringencoding> 5 In applications > Campaign > partitions > partition_name > server > encoding <stringencoding>cp950</stringencoding> 6 In applications > Campaign > partitions > partition_name > datasources > UA_SYSTEM_TABLES <stringencoding>cp950</stringencoding> <DateFormat>DELIM_Y_M_D</DateFormat> <DateOutputFormatString>%Y/%m/%d</DateOutputFormatString> Sample text Using a "Traditional Chinese (Phonetic)" IME: type "5", type "6", click "1", click "1". Notes Chinese is typed phonetically. A Chinese keyboard has keys for each of the sounds (or syllables) in the language. Version Unica Confidential 205

206 Chapter 8: Configuring Affinium Campaign for a Non-English Language Hebrew 1 In Internet Explorer's language setup, use the pre-defined setting (he). 2 In applications > Campaign <currencylocale>he</currencylocale> 3 In applications > Campaign > unicaaclistener <systemstringencoding>native</systemstringencoding> <logstringencoding>utf-8</logstringencoding> 4 In applications > Campaign > partitions > partition_name > server > encoding <stringencoding>cp1255</stringencoding> 5 In applications > Campaign > partitions > partition_name > datasources > UA_SYSTEM_TABLES <stringencoding>cp1255</stringencoding> <DateFormat>DELIM_Y_M_D</DateFormat> <DateOutputFormatString>%Y/%m/%d</DateOutputFormatString> Sample text "shareware" is typed "ua,pv" (type the comma literally) Notes Hebrew is a right-to-left language. Take some time to get used to working with it, especially when combining Hebrew and non-hebrew text. On the right-hand side of the keyboard, type control-shift to reverse input fields. Typing in Hebrew is more intuitive this way. Type control-shift on the right-hand side of the keyboard to switch back. Also, text in Hebrew tends to be smaller than English for the same font point size. 206 Unica Confidential Affinium Campaign Installation Guide

207 Sample configurations Thai To configure for Thai 1 In Internet Explorer's language setup, add language for Thai (th). 2 In applications > Campaign <currencylocale>th_th</currencylocale> 3 In applications > Campaign > unicaaclistener <systemstringencoding>native</systemstringencoding> <logstringencoding>utf-8</logstringencoding> 4 In applications > Campaign > partitions > partition_name > server > encoding <stringencoding>cp874</stringencoding> 5 In applications > Campaign > partitions > partition_name > datasources > UA_SYSTEM_TABLES <stringencoding>cp874</stringencoding> <DateFormat>DELIM_Y_M_D</DateFormat> <DateOutputFormatString>%Y/%m/%d</DateOutputFormatString> Sample text "promise" is "felyppk" in a Thai Kedamanee input locale. Notes Thai characters are comprised of between one and three keystrokes. Notice that in the above phrase, there are more keystrokes than actual characters. Also note that Thai text is very small in any Windows application, not just Campaign. Version Unica Confidential 207

208 Chapter 8: Configuring Affinium Campaign for a Non-English Language Japanese To configure for Japanese 1 In Internet Explorer's language setup, add language for Japanese (ja). 2 Follow the steps for Manually Configuring a Language, using ja for the language code. 3 In applications > Campaign <currencylocale>ja_jp</currencylocale> 4 In applications > Campaign > unicaaclistener <systemstringencoding>native</systemstringencoding> <logstringencoding>utf-8</logstringencoding> 5 In applications > Campaign > partitions > partition_name > server > encoding <stringencoding>cp932</stringencoding> 6 In applications > Campaign > partitions > partition_name > datasources > UA_SYSTEM_TABLES <stringencoding>cp874</stringencoding> <DateFormat>DELIM_Y_M_D</DateFormat> <DateOutputFormatString>%Y/%m/%d</DateOutputFormatString> Sample text The Japanese word for the Japanese language is "nihongo". Notes Typing Japanese text is easy. Take any Japanese word or brand name (Kawasaki, Suzuki, Tokyo) and type it into the language input. It is converted into soundcharacters, and then into Kanji. Learn about half-width Katakana to anticipate questions by customers. Information is available at any internet search engine. 208 Unica Confidential Affinium Campaign Installation Guide

209 Sample configurations Korean To configure for Korean 1 Change Regional Settings to use Korean, Korea 2 In Internet Explorer's language setup, add language for Korean (ko). 3 In applications > Campaign <currencylocale>ko_ko</currencylocale> 4 In applications > Campaign > unicaaclistener <systemstringencoding>native</systemstringencoding> <logstringencoding>utf-8</logstringencoding> 5 In applications > Campaign > partitions > partition_name > server > encoding <stringencoding>cp949</stringencoding> 6 In applications > Campaign > partitions > partition_name > datasources > UA_SYSTEM_TABLES: <stringencoding>cp949</stringencoding> <DateFormat>DELIM_Y_M_D/<DateFormat> <DateOutputFormatString>%Y/%m/%d</DateOutputFormatString> Sample text To type "tree" in Korean, use the "Korean Input System (IME 2002)" input in Han mode (the one without an A) on a US English Keyboard, type "skah", which looks like this:. Typing something like a space is necessary to de-select the second character. Notes Korean uses a simple alphabet which stacks together consonants and vowels. See for a good introduction. Version Unica Confidential 209

210 Chapter 8: Configuring Affinium Campaign for a Non-English Language 210 Unica Confidential Affinium Campaign Installation Guide

211 9 REPAIRING AND UNINSTALLING AFFINIUM CAMPAIGN This chapter describes how to run the Affinium Campaign installer in repair mode, and how to uninstall Affinium Campaign. This chapter includes the following topics: Repairing Affinium Campaign with the installer Uninstalling Affinium Campaign Repairing Affinium Campaign with the installer The Affinium Campaign installer automatically runs in repair mode when you run the installer and select a root directory where the same version of the product Affinium Campaign Installation Guide Unica Confidential 211

212 Chapter 9: Repairing and Uninstalling Affinium Campaign has previously been installed. You may want to do this if you think some files have been deleted or are damaged. If Affinium Campaign users encounter error messages when they try to access pages with Active X controls, see Appendix C, Active X Cleanup Utility, on page 315 for details about a utility designed to resolve these errors. Backups The repair installer allows you to specify whether you want to back up your original installation of Affinium Campaign. If you choose to create a backup, you can specify a backup directory. Configuration and user data The repair installer overwrites the binary program files, and provides options that allow you to overwrite all or some of the user data and configuration files in the directories under Affinium/Campaign. The options are described in the following table. Option Replace files, but leave my configuration and user data alone Replace files, but prompt if modified Replace all files Action Only program files are replaced. Configuration and user data files are untouched. The installer asks whether you want to replace any configuration or user data file that has a timestamp newer than the timestamp of the same file bundled with the installer. The installer replaces all files. You can use this option to repair a broken install without having to uninstall first. Note that the existing user data and configuration are lost. When you choose the second and third options shown in the table, the repair installer provides the same configuration options that a new install offers, as 212 Unica Confidential Affinium Campaign Installation Guide

213 Uninstalling Affinium Campaign described in chapters 2 and 3 of this Guide. If you did not overwrite your configuration, the configuration options you previously selected are selected by default. Perform the following procedure to repair Affinium Campaign. Repairing Affinium Campaign Perform the following procedure to repair Affinium Campaign. To repair Affinium Campaign 1 Undeploy the Affinium Campaign web application from WebSphere or WebLogic. 2 Verify that Affinium Manager is deployed and running, as the uninstaller requires this in order to unregister Affinium Campaign in Affinium Manager. 3 Run the Affinium Campaign installer and select a root directory where the same version of Affinium Campaign has previously been installed. The installer automatically runs in repair mode. 4 Follow the directions in the wizard. 5 Re-start WebSphere or WebLogic and re-deploy the Affinium Campaign web application. Uninstalling Affinium Campaign You may need to uninstall Affinium Campaign if you are doing the following: Retiring a machine. Removing Affinium Campaign from your machine. Freeing up space on a machine. Running the Affinium Campaign uninstaller ensures that all configuration files, InstallShield registry information, and user data are removed from the system. If Version Unica Confidential 213

214 Chapter 9: Repairing and Uninstalling Affinium Campaign you manually remove the files in your installation directory instead of running the uninstaller, the result may be an incomplete new installation if you later reinstall Affinium Campaign. Note that the uninstaller does not remove: Any files installed by the installer but edited Any files added by the system as a result of using Affinium Campaign, for example log files Affinium Manager requirement The uninstaller must be able to connect with Affinium Manager to unregister Affinium Campaign. If you uninstall without connecting to Affinium Manager, you must run the Affinium Manager regapp utility as described in the Affinium Manager Installation Guide to unregister Affinium Campaign with Affinium Manager. Uninstalling Affinium Campaign Perform the following procedure to uninstall Affinium Campaign. To uninstall Affinium Campaign 1 Undeploy the Affinium Campaign web application from WebSphere or WebLogic. 2 Verify that Affinium Manager is running. 3 If you want to preserve any changes you may have made to the Affinium Reports Campaign model, make a backup of the reports/model directory under your Campaign installation. 4 Run the Affinium Campaign uninstaller and follow the directions in the wizard. The uninstaller is located in the Affinium/Campaign/_uninst directory. 214 Unica Confidential Affinium Campaign Installation Guide

215 Uninstalling Affinium Campaign On UNIX, Unica recommends that you run the uninstaller in console mode. For example:./campaign_uninstaller.bin -console Version Unica Confidential 215

216 Chapter 9: Repairing and Uninstalling Affinium Campaign 216 Unica Confidential Affinium Campaign Installation Guide

217 A PROPERTIES IN THE CENTRAL CONFIGURATION FILE This chapter describes how to use the Affinium Suite configuration file, affinium_config.xml, to configure Affinium products. All Campaign administrative work should be done when users are not working with Campaign. This chapter includes the following topics: Overview of the Affinium configuration file Properties in the suite category Properties in the applications category Properties in the partition1 category Affinium Campaign Installation Guide Unica Confidential 217

218 : Overview of the Affinium configuration file The Affinium configuration file, affinium_config.xml, includes properties whose settings apply globally across all products in the Affinium Suite, as well as properties that are specific to individual products. Properties moved from other configuration files With the 7.0 release of the Affinium Suite, some configuration properties have moved from product-specific configuration files (located under the product installation directory) to the affinium_config.xml file. This section details these changes. Affinium Campaign In Affinium Campaign version 7.0, properties that were formerly contained in three separate files have been moved to the affinium_config.xml file, as follows: unica_aclsnr.cfg The properties in this file have been moved to the applications > Campaign > unicaaclistener category. unica_udisvr.cfg The properties in this file have been moved to the applications > Campaign > unicaudisvr category. dbconfig.lis The properties in this file have been moved to the partitions > partition1 > datasources category. Hierarchy of categories and properties The affinium_config.xml file contains a hierarchy of XML elements. If you open the file in an Internet Explorer browser window, the XML hierarchy is easy to navigate. When you view the file in an Internet Explorer browser window, you can click the plus sign to expand a category and view its properties and subcategories. 218 Unica Confidential Affinium Campaign Installation Guide

219 Overview of the Affinium configuration file The organization of the list of properties in this chapter reflects the hierarchy of categories and properties in the affinium_config.xml file. The root element is Affinium, which contains three top-level categories, suite, applications, and templates. The suite category contains the security categories and sub-categories with properties that specify login modes. These properties are configured by the person who installs Affinium Manager. See Properties in the suite category on page 220 for descriptions of the properties in the suite category. The applications category contains detailed product-specific categories and sub-categories. For example, the applications > Campaign category contains the majority of Campaign-related properties and sub-categories. See Properties in the applications category on page 221 for descriptions of the properties in the applications category, except for properties in the Campaign > partitions category, which are listed in their own section, Properties in the partition1 category on page 234. The templates category contains sub-categories and properties that are used internally, when you create a new Campaign data source through Affinium Manager. File location The affinium_config.xml file is located in the confdata directory of the Affinium Manager installation. Configuring property values Configure properties in the suite category by opening the file in a text or XML editor and entering the values manually. Configure properties in the applications category by logging in to Affinium Manager and using the Configuration Manager. In UNIX, all file and directory names are case-sensitive. The case of any file and folder name you enter must match the case of the file or folder name on the UNIX machine. Version Unica Confidential 219

220 : Reading your changes into the system If you change the value of certain properties in the affinium_config.xml file after Affinium Campaign is deployed and running, you must take the action described in the following table before Campaign will pick up the changes. If you change these properties... Properties in applications > Campaign Properties in applications > Campaign > unicaaclistener serverport in applications > Campaign > unicaaclistener You need to take this action.. Shut down and re-start the Campaign Listener (except for the unicaaclistener category) Close and re-open your Campaign flowcharts (except for serverport in this category) Shut down and re-start the web application server Properties in the suite category This section describes the properties in the suite category, as follows: partitions > partition1 partitions > partition1 > proxy partitions > partition1 The properties in this category set permissions for the pseudo-default partition (partition1) in Affinium Campaign. You can configure additional partitions: see Chapter 4, Configuring Multiple Partitions, on page 119 for details. allowallusers The allowallusers property specifies whether all Affinium users can access the partition. Valid values are true and false. If the value is true (the default), all Affinium users can access the partition, and Campaign ignores any values entered in the allowgroups property. If the value is false, only users who are 220 Unica Confidential Affinium Campaign Installation Guide

221 Properties in the applications category members of the groups specified in the allowgroups property can access the partition. allowgroups The allowgroups property specifies which Affinium groups (created in Affinium Manager) are allowed to access the partition. Use commas to separate multiple groups. For example: <property name="allowgroups">group_name</property> or <property name="allowgroups">group_name1,group_name2</property> This property is undefined by default. partitions > partition1 > proxy The properties in the partitions > partition1 > proxy category specify settings relating to browser proxy server settings. proxyignorebrowsersettings The proxyignorebrowsersettings property specifies whether Campaign s ActiveX component ignores or reads Internet Explorer s proxy settings. By default, this property is set to No. If proxyignorebrowsersettings is set to Yes, Campaign s ActiveX component ignores the browser s proxy settings. This provides compatibility with Campaign versions prior to If proxyignorebrowsersettings is set to No, Campaign s ActiveX component reads the browser s proxy settings and directs its communications appropriately. Properties in the applications category The applications category contains sub-categories with properties specific to the various products in the Affinium Suite. This section contains descriptions of Version Unica Confidential 221

222 : properties in the following sub-categories of the applications category for Affinium Campaign only: Campaign Campaign > navigation Campaign > logging Campaign > ProductReindex Campaign > caching Campaign > server Campaign > unicaaclistener Campaign > monitoring Report Scheduler Properties in the Campaign > partitions > partition1 sub-category are described in Properties in the partition1 category on page 234. Campaign Properties in the applications > Campaign category specify the locales that your installation of Affinium Campaign supports. supportedlocales The supportedlocales property specifies the locales or language-locale pairs that Affinium Campaign supports. If multiple values are specified, use a commaseparated list with no spaces, in any order. When you add locale resource files to Campaign, add the appropriate locale string to the value of this property (for example, zh_tw for Chinese-Taiwan). The way you specify language-locale pairs in the supportedlocales property differs slightly from the way they appear in Internet Explorer: In Internet Explorer, the language and locale are separated by a hyphen (-), but you must separate them by an underscore (_) when you enter a value for the supportedlocales property. 222 Unica Confidential Affinium Campaign Installation Guide

223 Properties in the applications category Internet Explorer shows the second part (the locale) in lowercase, but you must use all upper case when you enter a value for the supportedlocales property. For example, a language-locale pair that appears in Internet Explorer as zh-tw would be entered as zh_tw in the supportedlocales property. The default value is en_us. currencylocale The currencylocale property controls how currency is displayed in the Affinium Campaign web application, regardless of the language displayed. Unlike the supportedlocales and defaultlocale properties, this tag always requires both a language and a locale. See supportedlocales for the correct format for language-locale pairs, which differs from the way they appear in Internet Explorer. For example, to use Chinese as spoken in Taiwan, the currencylocale should be set to zh_tw. In most cases, when a locale is omitted from the language-locale pair in Internet Explorer, the language can also be used as the locale. This must be a valid Java Locale ID, as specified in Sun's Java documentation ( You may specify only one value, and an empty value is not allowed. The default value is en_us. defaultlocale The defaultlocale property specifies which of the locales specified in the supportedlocales property is considered the default locale. You may specify only one value, and an empty value is not allowed. Affinium Campaign matches the browser's first language with the members of the supportedlocales list and uses the matching language. If it can not find a match for the browser's first language preference in the supportedlocales list, it uses the language in the defaultlocale property. The defaultlocale property can be set to any single value in the supportedlocales tag, but it is useful to leave it as en_us until the configuration has been tested. See supportedlocales for the correct format for language-locale pairs, which differs from the way they appear in Internet Explorer. Version Unica Confidential 223

224 : The default value is en_us. Campaign > navigation Properties in the applications > Campaign category configure the Affinium drop-down menu that exists in the GUI of each Affinium product s web application, and provide some values that are used internally and should not be changed. displayname The displayname property specifies the link text used for the Campaign link in the Affinium drop-down menu that exists in the GUI of each Affinium product. The default value is Campaign. serverurl The serverurl property specifies the URL used for the Affinium Campaign link in the Affinium drop-down menu that exists in the GUI of each Affinium product. If your installation of Affinium Campaign has a URL that is different from the default, you should edit the value as follows: The default value is seedname type The seedname property is used internally by Affinium applications. You should not change this value. The type property is used internally by Affinium applications. You should not change this value. 224 Unica Confidential Affinium Campaign Installation Guide

225 Properties in the applications category welcomepageuri The welcomepageuri property is used internally by Affinium applications. It specifies the Uniform Resource Identifier of the Campaign index page. You should not change this value. campaigndetailpageuri The campaigndetailpageuri property is used internally by Affinium applications. It specifies the Uniform Resource Identifier of the Affinium Campaign detail page. You should not change this value. Campaign > logging The property in the applications > Campaign > logging category specifies the location of the Campaign log properties file. log4jconfig The log4jconfig property specifies the location of the Affinium Campaign log properties file, campaign_log4j.properties. Specify the complete path, including the file name. Use forward slashes (/) for UNIX and backslashes (\) for Windows. In the version of Campaign the property is undefined by default. In the 7.0 version of Campaign the default value is:.\conf\campaign_log4j.properties Campaign > ProductReindex The creator of an offer can specify the products that are associated with that offer. When list of products available for association with offers changes, the offer/product associations must be updated. Properties in the applications > Campaign > ProductReindex category specify the frequency of these updates and the time of day that the first update runs. Version Unica Confidential 225

226 : interval The interval property specifies the time, in minutes, between updates of offer/product associations. The update occurs for the first time at the time specified in the starttime parameter, on the day after the Campaign server is started. The default interval value is 3600 (60 hours). starttime The starttime property specifies the time of day when offer/product associations are updated for the first time. The first update occurs on the day after the Campaign server is started, and subsequent updates occur at intervals specified in the interval parameter. The format is HH:mm:ss, using a 24-hour clock. The default start time value is 12:00:00 (noon). Campaign > caching Properties in the applications > Campaign > caching category specify the length of time that cached data for channels, initiatives, campaigns, sessions, and offers is retained. channeldatattlseconds The channeldatattlseconds property specifies the length of time, in seconds, that the system retains the Channel cache data (Time to Live, or TTL). An empty value means the cache data is never purged. This property is available in the version of Affinium Campaign, but not in the 7.0 version. The default value is 600 (10 minutes). 226 Unica Confidential Affinium Campaign Installation Guide

227 Properties in the applications category initiativedatattlseconds The initiativedatattlseconds property specifies the length of time, in seconds, that the system retains the Initiative cache data (Time to Live). An empty value means the cache data is never purged. The default value is 600 (10 minutes). campaigndatattlseconds The campaigndatattlseconds property specifies the length of time, in seconds, that the system retains the Campaign cache data (Time to Live). An empty value means the cache data is never purged. The default value is 600 (10 minutes). sessiondatattlseconds The sessiondatattlseconds property specifies the length of time, in seconds, that the system retains the Session cache data (Time to Live). An empty value means the cache data is never purged. The default value is 600 (10 minutes). Campaign > server The property in the applications > Campaign > server category specifies a URL that is used internally, and does not need to be changed. fullcontextpath The fullcontextpath property is used internally, and specifying a value is optional. It specifies the URL that the ActiveX control uses to communicate to the application server Listener proxy. This property is undefined by default, which causes the system to determine the URL dynamically. Version Unica Confidential 227

228 : Campaign > unicaaclistener Properties in the applications > Campaign > unicaaclistener category specify logging levels, certain access privileges, language encodings, number of operating system threads, and the protocol, host, and port of the Affinium Campaign listener. These properties need to be set only once per instance of Campaign; they do not need to be set for every partition. Note that the unica_aclsnr.cfg file, which earlier versions of Campaign used for configuring the Campaign listener, no longer exists. Parameters from the unica_aclsnr.cfg file have been moved to this section of the affinium_config.xml file. usessl The usessl property specifies whether to use Secure Sockets Layer for communications between the Campaign listener and the Campaign web application. Valid values are yes and no. The default value is no. serverhost The serverhost property specifies the name or IP address of the machine where the Campaign listener is installed. If the Campaign listener is not installed on the same machine where Affinium Manager is installed, change the value to the machine name or IP address of the machine where the Campaign listener is installed. The default value is localhost. serverport The serverport property specifies the port where the Campaign listener is installed. The default value is Unica Confidential Affinium Campaign Installation Guide

229 Properties in the applications category logstringencoding The logstringencoding property controls the encoding of the unica_aclsnr.log, ac_web.log, and all flowchart log files. You can set this property to any convenient encoding, although UTF-8 is the best setting for purposes of diagnostics. If you change this value, you should empty or remove all affected log files to prevent writing multiple encodings into a single file. The default value is native. systemstringencoding The systemstringencoding property specifies the encoding used to interpret values coming into Campaign from the operating system (file system paths and filenames, for example), as well as the encoding in which Campaign presents values back to the operating system. The default value is native, which should always be used with Windows. On UNIX platforms, do not use native. See the specific UNIX documentation to determine the exact encoding(s) used for a given language. Note that any directory name or filename with an encoding that is incompatible with the systemstringencoding setting will probably be unreadable to Campaign. One effect of this is that modifying this property after any languagesensitive file (such as a campaign, session, or catalog file) has been created may cause Campaign to be unable to access that file again. Also, note that in some DOS windows, telnet clients, or terminal emulators, characters may not display correctly, even when the value of this property is set correctly. If the value is undefined or set to ASCII or UTF-8, no transcoding takes place. logmaxfilesize The logmaxfilesize property specifies the maximum size, in bytes, that the log file can reach before rolling into the backup file. The default value is , which is 10 MB. Version Unica Confidential 229

230 : logmaxbackupindex The logmaxbackupindex property specifies how many backup files can exist before the oldest one is deleted. If you set this property to 0 (zero), Affinium Campaign does not create any backup files and the log file stops logging when it reaches the size you specified in the logmaxfilesize property. If you specify a number (N) for this property, when the log file (File) reaches the size you specified in the logmaxfilesize property, Affinium Campaign renames the existing backup files (File.1... File.N-1) to File.2... File.N, renames the current log file File.1, closes it, and and starts a new log file named File. The default value is 1, which creates one backup file. maxreusethreads The maxreusethreads property sets the number of operating system threads cached by the Campaign listener process (unica_aclsnr) for reuse. Unica recommends that you use the cache when you want to reduce the overhead of thread allocation, or with operating systems that can exhibit an inability to release threads when asked to do so by an application. The default value is 0 (zero), which disables the cache. logginglevels The logginglevels property controls the amount of detail written to the log file. Valid values are LOW, MEDIUM, and HIGH. The default value is MEDIUM. sungetpasswordexe The sungetpasswordexe property is specific to Sun/Solaris platforms, and must be set to the absolute path of the sunspw program that Campaign calls to retrieve a user's password. The sunspw program is located in Campaign s bin directory. Campaign uses this program to work around Sun's file descriptor limitation. Although Campaign can be configured to use more than 255 file descriptors, some Sun/Solaris library calls fail if more than 255 file descriptors are in use. 230 Unica Confidential Affinium Campaign Installation Guide

231 Properties in the applications category The value is undefined by default. enablewindowseventlogging The enablewindowseventlogging property controls logging to the Windows event log. Set this property to TRUE to log to the Windows event log. The default value is FALSE. windowseventlogginglevels The windowseventlogginglevels property controls the amount of detail written to the Windows event log file based on severity. Valid values are LOW, MEDIUM, HIGH, and ALL. The ALL level includes trace messages intended for diagnostic purposes. The default value is MEDIUM. Campaign > monitoring Properties in the applications > Campaign > monitoring category specify whether the Operational Monitoring feature is enabled, the URL of the Operational Monitoring server, and caching behavior. Operational Monitoring displays and allows you to control active flowcharts. serverurl The serverurl property specifies the URL of the Operational Monitoring server. This is a mandatory setting: modify the value if the Operational Monitoring server URL is not the default: Report Properties in the applications > Report category enable reporting in the Affinium Suite, and specify authentication and authorization details and the URLs for the Cognos tools and servlet. Version Unica Confidential 231

232 : reportsenabled The reportsenabled property specifies whether reports are enabled in the Affinium Suite. The default value is false. portalurl The portalurl property specifies the URL of the Cognos Connection portal. Use a fully qualified host name, including the domain (specified in the domain property). For example: You can find the URL in Cognos Configuration: Local Configuration > Environment > Cognos Portal Services. The default value is ME]/crn/cgi-bin/cognos.cgi dispatchurl The dispatchurl property specifies the URL of the Cognos dispatcher. Use a fully qualified host name, including the domain (specified in the domain property). For example: You can find the URL in Cognos Configuration: Local Configuration > Environment > Cognos Portal Services. The default value is ME]:9300/p2pd/servlet/dispatch authenticationmode The authenticationmode property specifies whether authentication should allow anonymous access (anyone can access Cognos ReportNet) or requires authentication (through the Affinium Authentication provider). Valid values are authenticated and anonymous. The default value is anonymous. 232 Unica Confidential Affinium Campaign Installation Guide

233 Properties in the applications category enableformauthentication The enableformauthentication property specifies whether form-based authentication is enabled. If users are not allowed to have cookies enabled in their browsers, set this value to true. If the value is true, the login to Cognos Connection passes the login name and password in clear text and therefore is not secure. Unica strongly recommends that you enable SSL communication for Cognos if cookies are not allowed. The default value is false. authenticationnamespace Do not change the value of the authenticationnamespace property, which is used internally. The default value is Affinium. username The username property specifies the data source login name created in Affinium Manager for the Cognos system user when Affinium Reports is installed. The default value is cognos_admin. datasourcename The datasourcename property specifies the data source name created in Affinium Manager for the Cognos system user when Affinium Reports is installed. The default value is Cognos. domain The domain property specifies the company domain on which your ReportNet server is running. The default value is [CHANGE ME].com. Version Unica Confidential 233

234 : Scheduler host port Properties in the Scheduler category specify basic configuration for a command-line utility that runs Affinium Campaign flowcharts or any other executable supported by the operating system. Additional configuration criteria are specified in the Scheduler s XML file, which is bundled in the Scheduler.jar file. The host property specifies the machine name or IP address of the machine where the Campaign server is installed. This property is undefined by default. The port property specifies the port on which the Campaign server listens. This property is undefined by default. username The username property is for future use. password The password property is for future use. secured The secured property is for future use. Properties in the partition1 category The applications > Campaign > partitions > partition1 category contains all of the sub-categories and properties used to configure the pseudo-default partition, which is named partition1. This section describes the properties in 234 Unica Confidential Affinium Campaign Installation Guide

235 Properties in the partition1 category the following sub-categories of the partition1 category. If you configure additional partitions, you use the same sub-categories and properties described in this section. See Chapter 4, Configuring Multiple Partitions, on page 119 for details on configuring multiple partitions. reports validation datasources > UA_SYSTEM_TABLES systemtablemapping offercodegenerator server > dataprocessing server > encoding server > filedialog server > flowchartconfig server > flowchartrun server > flowchartsave server > internal server > logging server > optimization server > permissions server > profile server > systemcodes server > timeout reports Properties in the applications > Campaign > partitions > partition1 > reports category specify the location of various folders that contain Affinium Campaign report specifications. These properties are available in Affinium Campaign 7.x only. analysissectionfolder The analysissectionfolder property specifies the location of the root folder where report specifications are stored. The path is specified using XPath notation. Version Unica Confidential 235

236 : The default value is Campaign']. campaignanalysistabcachedfolder The campaignanalysistabcachedfolder property specifies the location of the folder that contains the specification for bursted campaign reports listed on the Analysis tab when you reach it by clicking the Analysis link on the navigation pane. The path is specified using XPath notation. The default value is Campaign - Object Specific Reports']/folder[@name='campaign']/folder[@name='cached']. campaignanalysistabondemandfolder The campaignanalysistabondemandfolder property specifies the location of the folder that contains the specification for on-demand campaign reports listed on the Analysis tab of a campaign. The path is specified using XPath notation. The default value is /content/folder[@name='affinium Campaign - Object Specific Reports']/folder[@name='campaign']/folder[@name='other']. offeranalysistabcachedfolder The offeranalysistabcachedfolder property specifies the location of the folder that contains the specification for bursted offer reports listed on the Analysis tab when you reach it by clicking the Analysis link on the navigation pane. The path is specified using XPath notation. The default value is /content/folder[@name='affinium Campaign - Object Specific Reports']/folder[@name='offer']/folder[@name='cached']. offeranalysistabondemandfolder The offeranalysistabondemandfolder property specifies the location of the folder that contains the specification for on-demand offer reports listed on the Analysis tab of an offer. The path is specified using XPath notation. 236 Unica Confidential Affinium Campaign Installation Guide

237 Properties in the partition1 category The default value is Campaign - Object Specific Reports']/folder[@name='offer']/folder[@name='other']. segmentanalysistabondemandfolder The segmentanalysistabcachedfolder property specifies the location of the folder that contains the specification for bursted segment reports listed on the Analysis tab when you reach it by clicking the Analysis link on the navigation pane. The path is specified using XPath notation. The default value is /content/folder[@name='affinium Campaign - Object Specific Reports']/folder[@name='segment']/folder[@name='other']. segmentanalysistabcachedfolder The campaignanalysistabondemandfolder property specifies the location of the folder that contains the specification for on-demand segment reports listed on the Analysis tab of a segment. The path is specified using XPath notation. The default value is /content/folder[@name='affinium Campaign - Object Specific Reports']/folder[@name='segment']/folder[@name='cached']. validation The Affinium Validation Plugin Development Kit (PDK), delivered with Campaign, allows third parties to develop custom validation logic for use in Campaign. Properties in the partition1 > validation category specify the classpath and class name of the custom validation program, and an optional configuration string. validationclasspath The validationclasspath property specifies the path to the class used for custom validation in Campaign. You may specify the path as follows: Version Unica Confidential 237

238 : The value may be either full path or a relative path. If the path is not an absolute path, the behavior depends on the application server that is running Campaign. WebLogic uses the path to the domain work directory which by default is c:\bea\user_projects\domains\mydomain. If the path ends in a slash (forward slash / for UNIX or backslash \ for Windows), then Campaign assumes the path is to a directory that contains the Java plug-in class that should be used. If the path does not end in a slash, then Campaign assumes that it is the name of a jar file that contains the java class. For example: The value /opt/affinium/campaign/pdk/lib/validation.jar is the path on a UNIX platform that would point to the jar file that comes out of the box with the plug-in developer kit. This property is undefined by default, which causes the property to be ignored. See validationclass on page 238 for information on designating the class to use. validationclass The validationclass property specifies the name of the class used for validation in Campaign. The path to the class is specified in the validationclasspath property. The class must be fully qualified with its package name. For example: com.unica.campaign.core.validation.samples.simplecampaignvalidator indicates the SimpleCampaignValidator class from the sample code. This property is undefined by default, which causes Campaign to perform no custom validation. validationconfigstring The validationconfigstring property specifies a configuration string that is passed into the validation plugin when Campaign loads it. The use of the configuration string may vary, depending on the plugin used. This property is undefined by default. 238 Unica Confidential Affinium Campaign Installation Guide

239 Properties in the partition1 category datasources Properties in the partition1 > datasources category configure the way Affinium Campaign interacts with databases, including its own system tables. These properties specify the databases Campaign can access and many aspects of how queries are formed. Note that the dbconfig.lis file, which earlier versions of Affinium Campaign used for configuring database interactions, no longer exists. Parameters from the dbconfig.lis file have been moved to this section of the affinium_config.xml file. See the basic installation chapter for UNIX or Windows for details on configuring Campaign data sources. templatepath The templatepath property specifies the location within the affinium_config.xml file of the template used to create the data source specifications in this datasource category. This property is used internally, and you should not change this value. The default value is Campaign/DataSources/6.7. datasources > UA_SYSTEM_TABLES Properties in the partition1 > datasources > UA_SYSTEM_TABLES category configure the way Affinium Campaign interacts with its system table database. These properties control many aspects of how queries are formed. A UA_SYSTEM_TABLES category must exist for every partition. JndiName The JndiName property is used only when configuring the Campaign system tables (not for other data sources, such as customer tables). Set its value to the Java Naming and Directory Interface (JNDI) data source that is defined in the application server (Websphere or WebLogic). The default value is campaignpartition1ds. Version Unica Confidential 239

240 : Type The type property specifies the type of database used by Campaign as a data source. Valid values for system tables are: SQLServer DB2, DB2ODBC ORACLE ORACLE8 ORACLE9 Valid values for customer tables are: ORACLE ORACLE8 ORACLE9 SYBASE SQLServer DB2, INFORMIX7 INFORMIX8 INFORMIX9 TERADATA DB2ODBC NETEZZA SAS SASDB The default value is SQLServer. AliasPrefix The AliasPrefix property specifies the way Campaign forms the alias name that Campaign creates automatically when using a dimension table and writing to a new table. The default value is A. 240 Unica Confidential Affinium Campaign Installation Guide

241 Properties in the partition1 category Note that each database has a maximum identifier length; check the documentation for the database you are using to be sure that the value you set does not exceed the maximum identifier length for your database. AllowSegmentUsingSQLCase The AllowSegmentUsingSQLCase property specifies whether the Campaign Segment process consolidates multiple SQL statements into a single SQL statement, when specific configuration conditions are met. Setting this property to TRUE results in significant performance improvements when all of the following conditions are met: Segments are mutually exclusive. All segments come from a single table. Criteria for each segment are based on the Affinium macro language. In this case, Campaign generates a single SQL CASE statement to perform segmentation, followed by segment-by-field processing on the Campaign application server. The default value is TRUE. AllowTempTables The AllowTempTables property specifies whether Affinium Campaign creates temporary tables in the database. Creating temporary tables can significantly improve the performance of campaigns. When the value is TRUE, temporary tables are enabled. When temporary tables are enabled, each time a query is issued against the database (for example, by the Segment process), the resulting IDs are written in a temporary table in the database. When an additional query is issued, Affinium Campaign may use that temporary table to retrieve rows from the database. If temporary tables are not enabled, Affinium Campaign retains the selected IDs in the server memory. The additional query retrieves IDs from the database and matches them to the IDs in server memory. Version Unica Confidential 241

242 : For more information on controlling temporary table joins, see MaxTempTableJoinPctSelectAll on page 259 and MaxTempTableJoinPctWithCondition on page 260. The default value is TRUE. You must have appropriate privileges to write in the database to use temporary tables. This is determined by the database login you provide when you connect to the database. ASMSaveDBAuthentication The ASMSaveDBAuthentication property specifies whether, when you log in to Affinium Campaign and map a table in a data source you have not previously logged in to, Affinium Campaign saves your user name and password in Affinium Manager. If you set this property to TRUE, Affinium Campaign does not prompt you for a user name and password when you subsequently log in to the data source. If you set this property to FALSE, Affinium Campaign prompts you for a user name and password each time you log in to the data source. The default value is TRUE. ASMUserForDBCredentials The asmuserfordbcredentials property specifies the Affinium Manager user name assigned to the Campaign system user (required for accessing the Campaign system tables). For details, see one of the following: If Campaign is installed on Windows, see Task 11: Store system table database credentials, on page 50. If Campaign is installed on UNIX, see Task 11: Store system table database credentials, on page 99. This property is undefined by default. 242 Unica Confidential Affinium Campaign Installation Guide

243 Properties in the partition1 category BulkInsertBlockSize The BulkInsertBlockSize property defines the maximum size of a data block, in number of records, that Campaign passes to the database at a time. The default value is 100. BulkReaderBlockSize The BulkReaderBlockSize property defines the size of a data block, in number of records, that Campaign reads from the database at a time. The default value is ConnectionCacheSize The ConnectionCacheSize property specifies the number of connections that Campaign maintains in a cache for each data source. By default (N=0), Campaign establishes a new connection to a data source for each operation; if Campaign maintains a cache of connections and a connection is available for reuse, Campaign uses the cached connection rather than establishing a new connection. If the setting is not 0, once a process is done with a connection, Campaign keeps up to the specified number of connections open for an amount of time specified by the InactiveConnectionTimeout property. After this time expires, the connections are removed from the cache and closed. The default value is 0 (zero). DateFormat Campaign uses the DateFormat property to determine how to parse data of the type date when using the Campaign macro language or when interpreting data from date columns. Set the value of the DateFormat property to the format in which the database returns date information to Campaign. (Note that Campaign reformats the date information to display to the user according to the format configurations set on your web application.) Version Unica Confidential 243

244 : The DateFormat property may be set to any of the formats specified in the DATE macro. The default value is DELIM_Y_M_D. For all possible values see Formats for DateFormat on page 295. When configuring for a non-english language, if it is possible for the database client to use an all-numeric date format (for example, instead of July 12, 2005), it is advisable to do so..to determine the date format your database uses, select a date from the database as described in Table A-1. Table A-1 Selecting a date by database Database To determine the correct setting... DB2 Informix Netezza Oracle Connect to the database from a machine running the Campaign server. Use db2test, located in the Campaign\bin directory, to connect and issue the following command: values current date Informix has different formats for writing and selecting from the database. Connect to the database from a machine running the Campaign server. Use odbctest, located in the Campaign\bin directory, to connect and issue the following command: select today from informix.systables where tabid=1; Connect to the database from a machine running the Campaign server. Use odbctest, located in the Campaign\bin directory, to connect and issue the following command: CREATE TABLE date_test (f1 DATE); INSERT INTO date_test values (current_date); SELECT f1 FROM date_test; Another way to select date format is to run following command: SELECT current_date FROM ANY_TABLE limit 1; where ANY_TABLE is the name of any existing table Log into the database from the machine running the Campaign server. Use SQL *Plus to connect and issue the following command: SELECT sysdate FROM dual The current date is returned in NLS_DATE_FORMAT for that client. 244 Unica Confidential Affinium Campaign Installation Guide

245 Properties in the partition1 category Database To determine the correct setting... SQL Server Sybase Connect to the database from a machine running the Campaign listener. Use odbctest, located in the Campaign\bin directory, to connect and issue the following command: SELECT getdate() Connect to the database from a machine running the Campaign server. Use odbctest, located in the Campaign\bin directory, to connect and issue the following command: select today(*) from sys.dummy; Additional considerations Note the following database-specific instructions. Teradata Teradata allows you to define the date format on a per-column basis. In addition to dateformat and dateoutputformatstring, you need to set SuffixOnCreateDateField. To be consistent with our system table settings, use: SuffixOnCreateDateField = FORMAT 'YYYY-MM-DD' DateFormat = DELIM_Y_M_D DateOutputFormatString = %Y-%m-%d SQL Server The date format is fixed when the Use regional settings when outputting currency, numbers, dates, and times setting is not checked in the ODBC data source configuration. It is generally easier to leave this setting unchecked to prevent the date format configuration from changing for each language. DateOutputFormatString The DateOutputFormatString property specifies the format of any date, such as a campaign start or end date, that Campaign sends in a SQL query to the database. Set the value of the DateOutputFormatString property to a format that the data source expects for columns of the type date. The DateOutputFormatString property may be set to any of the formats specified for format_str in the DATE_FORMAT macro. Note that the Version Unica Confidential 245

246 : DATE_FORMAT macro accepts two different kinds of formats. One is an identifier (for example, DELIM_M_D_Y, DDMMMYYYY, the same as accepted by the DATE macro), while the other is a format string. The value of the DateOutputFormatString property must be a format string - it must not be one of the DATE macro identifiers. For all valid values see Formats for DateOutputFormatString on page 297. Typically, you would use one of the delimited formats. The default value is %Y/%m/%d. You can verify whether you have selected the correct format by creating a table and inserting a date in the format you selected, as described in the following procedure. To verify DateOutputFormatString 1 Connect to the database using the appropriate tool, as described in Table A-1. Do not use the query tools that come with the database (such as SQL Server s Query Analyzer) to verify that dates are being sent to the database correctly. These query tools may convert the date format to something other than what Campaign actually sent to the database. 2 Create a table and insert a date in the format you selected. For example, if you selected %m/%d/%y: CREATE TABLE date_test (F1 DATE) INSERT INTO date_test VALUES ('03/31/2004') If the database allows the INSERT command to complete successfully, then you have selected the correct format. DateTimeFormat Campaign uses the DateTimeFormat property to determine how to parse data of the type datetime and timestamp when using the Campaign macro language or when interpreting data from datetime and timestamp columns. Set the value of the DateTimeFormat property to the format in which the database returns datetime or timestamp information to Campaign. Only delimited formats are supported, as follows: DT_DELIM_M_D 246 Unica Confidential Affinium Campaign Installation Guide

247 Properties in the partition1 category DT_DELIM_M_D_Y DT_DELIM_Y_M DT_DELIM_Y_M_D DT_DELIM_M_Y DT_DELIM_D_M DT_DELIM_D_M_Y Typically, you should set the DateTimeFormat by prepending your DateFormat value with DT_ after determining the DateFormat value as described in Table A- 1. The default value is DT_DELIM_Y_M_D. DateTimeOutputFormatString The DateTimeOutputFormatString property specifies the format of any datetime, such as a campaign start or end date, that Campaign sends in a SQL query to the database. Set the value of the DateTimeOutputFormatString property to a format that the data source expects for datetime columns. For all valid values see Formats for DateOutputFormatString on page 297. See DateOutputFormatString for a method for verifying that the format you select is correct. The default value is %Y/%m/%d %H:%M:%S. DefaultScale The DefaultScale property determines floating point precision when a Campaign Snapshot process exports numeric fields to a table. When the value is 0 (zero), the default, Campaign preserves the floating point precision in the field being exported. You can limit the floating point precision by changing this property. For example, if you set the value at 3, floating point precision would be three places (0.NNN). DeleteAsRecreate The DeleteAsRecreate property specifies whether, when a Snapshot process is configured to REPLACE TABLE and if TRUNCATE is not supported, Campaign drops and recreates or only deletes from the table. Version Unica Confidential 247

248 : When the value is TRUE, Campaign drops the table and recreates it. When the value is FALSE, Campaign executes a DELETE from the table. The default value is FALSE. DisallowTempTableDirectCreate DSN The DisallowTempTableDirectCreate property specifies the way Campaign adds data to a temp table. If the value is FALSE, Campaign performs its direct CREATE and INSERT SQL on the database in one command. If the value is TRUE, Campaign brings all the IDs down to the server and lets either bulk insert or the loader push them into the temp table. Unica recommends that you set this property to TRUE only if a database load utility is configured. This parameter was added because in some cases it is faster to use a loader than a direct CREATE and INSERT statement. The default value is FALSE. The DSN property allows you to specify an alias for a Campaign data source, so that you can specify multiple logical data sources that refer to the same physical data source. Example 1 For example, you might want two instances of the same data source, one with AllowTempTables = TRUE and another with AllowTempTables = FALSE. In the definition of each data source instance, you set the dsn parameter to an alias for the data source, as follows: <category name="datasources"> <category name="mydb_tt"> <property name="type">oracle</property> <property name="allowtemptables >TRUE</property> <property name="dsn >MyDB</property> 248 Unica Confidential Affinium Campaign Installation Guide

249 Properties in the partition1 category </category> <category name="mydb_nott"> <property name="type">oracle</property> <property name="dsn >MyDB</property> <property name="allowtemptables >FALSE</property> </category> </category> Example 2 This functionality can also be used to create flowcharts in a development environment using a development database and then easily migrate them to a production environment pointing to a production database. In the development environment, the entry under the datasources category would look like the following. <category name="datasources"> <category name="mydb"> <property name="type">oracle</property> <property name="allowtemptables >TRUE</property> <property name="dsn >MyDB_dev</property> </category> </category> In the production environment, the entry under the datasources category would look like the following.: <category name="datasources"> <category name="mydb"> <property name="type">oracle</property> <property name="allowtemptables >TRUE</property> <property name="dsn >MyDB_prod</property> </category> </category> Version Unica Confidential 249

250 : This value is undefined by default. DSNUsingOSAuthentication The DSNUsingOSAuthentication property applies only when a Campaign data source is SQL Server. Set the the value to TRUE when the DSN is configured to use Windows Authentication mode. The default value is FALSE. EnableSelectDistinct The EnableSelectDistinct property specifies whether Campaign s internal lists of IDs are de-duplicated by the Campaign server or by the database. When the value is TRUE, the database performs de-duplication, and SQL queries generated against the database then have the form (when appropriate): SELECT DISTINCT key FROM table When the value is FALSE, the Campaign server performs de-duplication, and SQL queries generated against the database have the form: SELECT key FROM table You should leave the default value of FALSE if: Your database is constructed so that unique identifiers (primary keys of base tables) are already guaranteed to be de-duped. You want the Campaign application server to perform de-duplication to reduce resource consumption/burden on the database. Regardless of what value you specify for this property, Campaign automatically ensures that keys are de-duplicated as required. This property merely controls where the de-duplication effort occurs (on the database or on the Campaign server). The default value is FALSE. EnableSelectOrderBy The EnableSelectOrderBy property specifies whether Campaign s internal lists of IDs are sorted by the Campaign server or by the database. 250 Unica Confidential Affinium Campaign Installation Guide

251 Properties in the partition1 category When the value is TRUE, the database performs the sorting, and SQL queries generated against the database have the form: SELECT <key> FROM <table> ORDER BY <key> When the value is FALSE, the Campaign server performs the sorting, and SQL queries generated against the database have the form: SELECT <key> FROM <table> Regardless of what value you specify for this property, Campaign automatically ensures that keys are sorted as required. This parameter merely controls where the sorting effort occurs (on the database or on the Campaign application server). You should set this property to FALSE if: You are using a database containing non-english data. Your database is slow. Your database does not have sufficient resources to sort large lists (for example, when out of temp space or memory errors occur). The default value is TRUE. ExcludeFromTableDisplay The ExcludeFromTableDisplay parameter allows you to limit the database tables that are displayed during table mapping in Campaign. Table names matching the specified patterns are not displayed. For example, if you set the value of this parameter to sys.*, tables with names that begin with sys are not displayed. You may enter this parameter multiple times within a database configuration section to specify multiple patterns to exclude. For example: <property name="excludefromtabledisplay"> SysAdmin.* </property> <property name="excludefromtabledisplay"> SystemFe.* </property> <property name="excludefromtabledisplay"> Sys_Calendar.* </property> Version Unica Confidential 251

252 : <property name="excludefromtabledisplay"> UAC_* </property> Note that the values are case-sensitive. The default value is UAC_*, which excludes temp tables and Extract tables, when the ExtractTablePrefix property s value is the default, UAC. ExtractTablePrefix The ExtractTablePrefix property specifies a string that is automatically prepended to all Extract table names in Campaign. In Campaign version 7.0 the default value is UAC_EX. In Campaign 6.4x the default value is UAC, and you should change this value because it is the same as the default value for TempTablePrefix. ForceNumeric The ForceNumeric property specifies whether Campaign retrieves numeric values as the data type double. When the value is set to TRUE, Campaign retrieves all numeric values as the data type double. The default value is FALSE. InactiveConnectionTimeout The InactiveConnectionTimeout property specifies the number of seconds an inactive Campaign database connection is left open before it is closed. Setting the value to 0 disables the timeout, leaving the connection open. The default value is 120. InsertLogSize The InsertLogSize property specifies when a new entry is entered in the log file while the Campaign Snapshot process is running. Every time the number of records written by the Snapshot process reaches a multiple of the number specified in the InsertLogSize property, a log entry is written. The log entries 252 Unica Confidential Affinium Campaign Installation Guide

253 Properties in the partition1 category can help you determine how far a running Snapshot process has progressed. Note that setting this value too low may create large log files. Valid values are integers. The default value is (one hundred thousand records). LoaderCommand The LoaderCommand property specifies the command issued to invoke your database load utility in Campaign. If you set this parameter, Campaign enters the database loader utility mode for all output files from the Snapshot process that are used with the replace all records settings. This parameter also invokes the database loader utility mode when Campaign uploads ID lists into temp tables. The valid value for this property is any full path name either to the database load utility executable or to a script that launches the database load utility. Using a script allows you to perform additional setup before invoking the load utility (for example, moving files to a database server first or invoking ISQL to use the load command in Sybase IQ). Most database load utilities require several arguments to be launched successfully. These arguments can include specifying the data file and control file to load from and the database and table to load into. Campaign supports the following tokens, which are replaced by the specified elements when the command is run. Consult your database load utility documentation for the correct syntax to use when invoking your database load utility. This parameter is undefined by default. Version Unica Confidential 253

254 : Tokens available to LoaderCommand are described in the following table: Token Description <CONTROLFILE> <DSN> <DATABASE> <DATAFILE> <NUMFIELDS> <PASSWORD> <TABLE> <TABLENAME> <USER> This token is replaced with the full path and filename to the temporary control file that Campaign generates according to the template that is specified in the LoaderControlFileTemplate parameter. This token is replaced with the value of the DSN property. If the DSN property is not set, the <DSN> token is replaced by the data source name used in the category name for this data source (the same value used to replace the <DATABASE> token). This token is replaced with the name of the data source that Campaign is loading data into. This is the same data source name used in the category name for this data source. This token is replaced with the full path and filename to the temporary data file created by Campaign during the loading process. This file is in the Campaign Temp directory, UNICA_ACTMPDIR.. This token is replaced with the number of fields in the table. This token is replaced with the database password from the current flowchart connection to the data source. This token is obsolete, but is supported for backward compatibility. See <TABLENAME>, which replaced <TABLE> as of version This token is replaced with the database table name that Campaign is loading data into. This is the target table from your Snapshot process or the name of the Temp Table being created by Campaign. This token is replaced with the database user from the current flowchart connection to the data source. LoaderCommandForAppend The LoaderCommandForAppend parameter specifies the command issued to invoke your database load utility for appending records to a database table in Campaign. If you set this parameter, Campaign enters database loader utility 254 Unica Confidential Affinium Campaign Installation Guide

255 Properties in the partition1 category mode for all output files from the Snapshot process that are used with the append records settings. This parameter is specified as a full path name either to the database load utility executable or to a script that launches the database load utility. Using a script allows you to perform additional setup before invoking the load utility (for example, moving files to a database server first or invoking ISQL to use the load command in Sybase IQ). Most database load utilities require several arguments to be successfully launched. These can include specifying the data file and control file to load from and the database and table to load into. The tokens are replaced by the specified elements when the command is run. Consult your database load utility documentation for the correct syntax to use when invoking your database load utility. This parameter is undefined by default. Tokens available to LoaderCommandForAppend are the same as those described for LoaderCommand. LoaderControlFileTemplate The LoaderControlFileTemplate property specifies the full path and filename to the control file template that has been previously configured in Campaign. When this parameter is set, Campaign dynamically builds a temporary control file based on the template that you specify here. The path and name of this temporary control file is available to the <CONTROLFILE> token that is available to the LoaderCommand parameter. Before you use Campaign in the database loader utility mode, you must configure the control file template that is specified by this parameter. The control file template supports the following tokens, which are dynamically replaced when the temporary control file is created by Campaign. For the correct syntax required for your control file, please see your database loader utility documentation. This parameter is undefined by default. Version Unica Confidential 255

256 : Tokens available to LoaderControlFileTemplate are the same as those described for LoaderCommand, plus the following special tokens, which are repeated once for each field in the outbound table. Token <DBCOLUMNNUMBER> <FIELDLENGTH> <FIELDNAME> <FIELDNUMBER> <FIELDTYPE> <NATIVETYPE> <xyz> <~xyz> <!xyz> Description This token is replaced with the column ordinal in the database. This token is replaced with the length of the field being loaded into the database. This token is replaced with the name of the field being loaded into the database. This token is replaced with the number of the field being loaded into the database. This token is replaced with the literal "CHAR( )". The length of this field is specified between the (). If your database happens to not understand the field type, CHAR, you can manually specify the appropriate text for the field type and use the <FIELDLENGTH> token. For example, for SQLSVR and SQL2000 you would use "SQLCHAR(<FIELDLENGTH>)" This token is replaced with the actual database type that this field is loaded into. This token places the specified character(s) on all fields being loaded into the database, except the last. A typical use is <,> which repeats a comma all fields except the last. This token places the specified characters only on the last repeated line. This token places the specified character(s), including the angle brackets < >, on all lines. LoaderControlFileTemplateForAppend The LoaderControlFileTemplateForAppend property specifies the full path and filename to the control file template that has been previously configured in Campaign. When this parameter is set, Campaign dynamically builds a temporary control file based on the template that is specified here. The path and name of this temporary control file is available to the <CONTROLFILE> token that is available to the LoaderCommandForAppend parameter. 256 Unica Confidential Affinium Campaign Installation Guide

257 Properties in the partition1 category Before you use Campaign in the database loader utility mode, you must configure the control file template that is specified by this parameter. The control file template supports the following tokens, which are dynamically replaced when the temporary control file is created by Campaign. See your database loader utility documentation for the correct syntax required for your control file. This parameter is undefined by default. Tokens available to your control file template are the same as those described in LoaderControlFileTemplate. LoaderDelimiter The LoaderDelimiter property specifies whether the temporary data file is a fixed-width or delimited flat file, and, if it is delimited, the characters Campaign uses as delimiters. If the value is undefined, Campaign creates the temporary data file as a fixed width flat file. If you specify a value, it is used when the loader is invoked to populate a table that is known to be empty. Campaign creates the temporary data file as a delimited flat file, using the value of this property as the delimiter. Valid values are characters, which you may enclose in double quotes, if desired. This property is undefined by default. LoaderDelimiterForAppend The LoaderDelimiterForAppend property specifies whether the temporary Campaign data file is a fixed-width or delimited flat file, and, if it is delimited, the character or set of characters used as delimiters. If the value is undefined, Campaign creates the temporary data file as a fixed width flat file. If you specify a value, it is used when the loader is invoked to populate a table that is not known to be empty. Campaign creates the temporary data file as a delimited flat file, using the value of this property as the delimiter. Valid values are characters, which you may enclose in double quotes, if desired. Version Unica Confidential 257

258 : This property is undefined by default. LoaderDelimiterAtEnd Some external load utilities require that the data file be delimited and that each line end with the delimiter (for example, Informix's dbaccess using External Tables). To accommodate this requirement, set the LoaderDelimiterAtEnd value to TRUE, so that when the loader is invoked to populate a table that is known to be empty, Campaign uses delimiters at the end of each line. The default value is FALSE. LoaderDelimiterAtEndForAppend Some external load utilities require that the data file be delimited and that each line end with the delimiter (for example, Informix's dbaccess using External Tables). To accommodate this requirement, set the LoaderDelimiterAtEndForAppend value to TRUE, so that when the loader is invoked to populate a table that is not known to be empty, Campaign uses delimiters at the end of each line. The default value is FALSE. MaxQueryThreads The MaxQueryThreads property specifies the upper limit on the number of simultaneous queries allowed to run against each database source from a single Campaign flowchart. Campaign executes database queries using independent threads. Since Campaign processes run in parallel, it is common to have multiple queries executing simultaneously against a single data source. If the number of queries to be run in parallel exceeds the value specified by this property, the Campaign server automatically limits the number of simultaneous queries to this value. The maximum value is unlimited. Note that the maxreusethreads property should be set to a value greater than or equal to the value of MaxQueryThreads. The default value varies depending on the database. 258 Unica Confidential Affinium Campaign Installation Guide

259 Properties in the partition1 category MaxRowFetchRecords When the selected number of IDs is less than the value specified by the MaxRowFetchRecords property, Campaign passes the IDs to the database, one at a time in a separate SQL query. This process may be very time-consuming. If the number of selected IDs is greater than the value specified by this parameter, Campaign uses temporary tables (if allowed against the database source), or it pulls down all the values from the table, not including any unnecessary values. For performance reasons, it is recommended to keep this number low. The default value is 100. MaxTempTableJoinPctSelectAll When a query is issued, Campaign creates a temporary table on the database containing the exact list of IDs, as a result of the query. When an additional query that selects all records is issued against the database, the MaxTempTableJoinPctSelectAll property specifies whether a join is performed with the temporary table. If the relative size of the temporary table (specified as a percentage) is greater than the value of MaxTempTableJoinPctWithCondition, no join is performed. All records are selected first, then unwanted records are discarded. If the relative size of the temporary table (specified as a percentage) is less then or equal to the value of MaxTempTableJoinPctWithCondition, the join is performed with the temporary table first, and then the resulting IDs are retrieved to the server. Valid values are integers between A value of 0 means temporary table joins are never used; a value of 100 means that table joins are always used, regardless of the size of the temporary table. The default value is 90. This property is applicable only if the value of AllowTempTables is TRUE. Example Assume that MaxTempTableJoinPctSelectAll is set to 90. First, you might want to select customers (CustID) with account balances (Accnt_balance) greater than $1,000 from the database table (Customer). Version Unica Confidential 259

260 : The corresponding SQL expression generated by the Select process may look like this: SELECT CustID FROM Customer WHERE Accnt_balance > 1000 The Select process may retrieve 100,000 IDs from the total table size of 1,000,000, which is 10%. If temporary tables are allowed, Campaign writes the selected IDs (TempID) into a temporary table (Temp_table) in the database. Then, you might want to snapshot the selected IDs (CustID) together with the actual balance (Accnt_balance). Since the relative size of the temporary table (Temp_table) is less than 90 percent (MaxTempTableJoinPctSelectAll), the join is done with the temporary table first. The SQL expression generated by the Snapshot process may look like this: SELECT CustID, Accnt_balance FROM Customer, Temp_table WHERE CustID = TempID If the Select process retrieves more than 90 percent the subsequent Snapshot process retrieves all the records, and matches them with the first set of IDs, discarding the unnecessary ones. The SQL expression generated by the Snapshot process may look like this: SELECT CustID, Accnt_balance FROM Customer MaxTempTableJoinPctWithCondition When a query is issued, Campaign creates a temporary table on the database containing the exact list of IDs, as a result of the query. When an additional query, selecting records with limitation conditions is issued against the database, the MaxTempTableJoinPctWithCondition property specifies whether a join should be performed with the temporary table. If the relative size of the temporary table (specified as a percentage) is greater than the value of MaxTempTableJoinPctWithCondition, no join is performed. This avoids the overhead in the database where it may not be needed. In this case, the query is issued against the database, the resulting list of IDs retrieved, and then unwanted records are discarded as they are matched to the list in server memory. 260 Unica Confidential Affinium Campaign Installation Guide

261 Properties in the partition1 category If the relative size of the temporary table (in percentage) is less than or equal to the value of MaxTempTableJoinPctWithCondition, the join is done with the temporary table first, and then the resulting IDs are retrieved to the server. Valid values are integers between A value of 0 means temporary table joins are never used; a value of 100 means that table joins are always used, regardless of the size of the temporary table. The default value is 20. This property is applicable only if the value of AllowTempTables is TRUE. NumberOfRetries The NumberOfRetries property specifies the number of times Campaign automatically retries a database operation on failure. Campaign automatically resubmits queries to the database this number of times before reporting a database error or failure. The default value is 0. OwnerForTableDisplay The OwnerForTableDisplay property, when set to a particular database user ID, causes Campaign to display only those tables owned by that user. You may enter this parameter multiple times within a database configuration section to specify multiple users. For example: <property name="ownerfortabledisplay">user1</property> <property name="ownerfortabledisplay">user2</property> <property name="ownerfortabledisplay">user3</property> This property is undefined by default. PadTextWithSpaces When set to TRUE, the PadTextWithSpaces property causes Campaign to pad text values with spaces until the string is the same width as the database field. The default value is FALSE. Version Unica Confidential 261

262 : PostTempTableCreateRunScript The PostTempTableCreateRunScript property specifies a script or executable Campaign runs after a temp table has been created and populated. This property is undefined by default. PrefixOnSelectSQL The PrefixOnSelectSQL property specifies a string that is automatically prepended to all SELECT SQL expressions generated by Campaign. This property applies only to SQL generated by Campaign, and does not apply to SQL in raw SQL expressions used in the Select process. The value may contain a user token (<USER>) to substitute the Campaign user name of the user running the flowchart. This property is automatically added to the SELECT SQL expression without checking its syntax. If you use this property, make sure it is a legal expression. This property is undefined by default. QueryThreadSleep The QueryThreadSleep property affects the CPU utilization of the Campaign server process (UNICA_ACSVR). When the value is TRUE, the thread that the Campaign server process uses to check for query completion sleeps between checks. When the value is FALSE, the Campaign server process checks continuously for query completion. The default value is TRUE. ReaderLogSize The ReaderLogSize parameter defines when Campaign makes a new entry in the log file when reading data from the database. Every time the number of records read from the database reaches a multiple of the number defined by this parameter, a log entry is written in the log file. This parameter can help you determine how far a process has progressed in its run. Setting this value too low may create large log files. 262 Unica Confidential Affinium Campaign Installation Guide

263 Properties in the partition1 category Valid values are integers. The default value is (one million records). ShareConnection The ShareConnection property controls the number of connections Campaign uses for database operations. When the value is FALSE each database operation is performed on a new connection. When the value is TRUE a single connection is used to execute all database operations. The default value is FALSE. SQLOnConnect The SQLOnConnect property defines a complete SQL statement that Campaign executes immediately after each database connection. The value may contain a user token (<USER>) to substitute the Campaign user name of the user running the flowchart. The SQL statement generated by this property is automatically passed to your database without checking its syntax. If you use this property, make sure it is a legal expression. The string may be enclosed in quotes, but this is not required. This property is undefined by default. StringEncoding The StringEncoding property specifies the character encoding of the database. When Campaign retrieves data from the database, the data is transcoded from the encoding specified to the internal encoding of Campaign (UTF-8). Likewise, when Campaign sends a query to the database, character data is transcoded from Campaign's internal encoding to the encoding specified in the StringEncoding property. If you leave the value for this StringEncoding property blank, the server > stringencoding property is used as a default. To avoid confusion, always specify the the value for this StringEncoding property. For most of the databases that Campaign supports, you can use an iconv encoding. See Appendix B, Internationalization and Encodings, on page 299. Version Unica Confidential 263

264 : These encodings apply to all operating systems except AIX, where Campaign uses the system-provided iconv library for transcoding. See below for important exceptions and additional considerations. Database-specific considerations For DB2, or SQL Server, you should use a code page rather than an iconv encoding. For Teradata, you should override some default behavior. This section describes set the correct value for the StringEncoding property with these databases. DB2 To determine the correct value for the StringEncoding property with a DB2 database, look up the code page that corresponds to the regional settings of the server's operating system. To set the value of the StringEncoding property for a DB2 database, add this command to the Campaign server startup script: db2set DB2CODEPAGE=CPIBM_code_page For example, to use Code Page (7-bit Netherlands): db2set DB2CODEPAGE=CP10019 See Useful links on page 311 for a link to the IBM code pages. This affects all DB2 data sources and may affect other running programs. SQL Server To determine the correct the value for the StringEncoding property with a SQL Server database, look up the code page that corresponds to the regional settings of the server's operating system. For example, to use Code Page 932 (Japanese Shift-JIS): StringEncoding=CP932 See Useful links on page 311 for a link to the Microsoft ANSI code pages. Teradata Note that Teradata supports per-column character encoding, while Campaign supports only per-data source encoding. UTF-8 cannot be used with Campaign 264 Unica Confidential Affinium Campaign Installation Guide

265 Properties in the partition1 category due to a bug in the Teradata ODBC driver. Teradata sets a default character encoding for each login. You can override this using a parameter in the ODBC data source configuration on Windows or in the odbc.ini on UNIX platforms as follows: CharacterSet=UTF8 The default encoding for a Teradata table is LATIN. Teradata has very few builtin encodings, but it supports user-defined encodings. The default value of the StringEncoding property is ASCII. For many situations, we recommend that you use the WIDEUTF-8 pseudoencoding, described below. WIDEUTF-8 Campaign is normally responsible for transcoding between its internal encoding, UTF-8, and the encoding of the database. When the database is encoded in UTF- 8, the value UTF-8 can be specified for StringEncoding (regardless of the operating system), and no transcoding will be needed. Traditionally, these have been the only viable models for Campaign to access non-english data within a database. In the 7.0 version of Campaign, a new database encoding called WIDEUTF-8 was introduced as a valid value for the StringEncoding property. By using this encoding, Campaign still uses UTF-8 to communicate with the database client, but allows the client to perform the task of transcoding between UTF-8 and the encoding of the actual database. There are two good reasons to do this: Simplicity. It is not necessary to find the right encoding for the data in the database; all database interaction is performed in UTF-8. This greatly reduces the complexity of the database configuration. Responsibility: When the database client performs transcoding, it assumes the responsibility of converting between encodings and preventing invalid character data from being stored in the database. Note that Oracle does not support transcoding through the client. Note that this pseudo-encoding may be used only in the database configuration. It should not be used for any other purpose. This enhanced version of UTF-8 is Version Unica Confidential 265

266 : needed to alter the widths of table column mappings so that they will be wide enough for transcoded text. SuffixOnAllOtherSQL The SuffixOnAllOtherSQL property specifies a string that is automatically appended to every SQL expression, generated by Campaign, which are not covered by the SuffixOnInsertSQL, SuffixOnSelectSQL, SuffixOnTempTableCreation, SuffixOnUserTableCreation, or SuffixOnUserBaseTableCreation properties. This property applies only to SQL generated by Campaign, and does not apply to SQL in raw SQL expressions used in the Select process. SuffixOnAllOtherSQL is used for the following expression types, when generated by Campaign: TRUNCATE TABLE table DROP TABLE table DELETE FROM table [WHERE...] UPDATE table SET... The value may contain a user token (<USER>) to substitute the Campaign username of the user running the flowchart. This property is automatically added to the SQL expression without checking its syntax. If you use this parameter, make sure it is a legal expression. The string may be enclosed in quotes, but this is not required. This property is undefined by default. SuffixOnCreateDateField The SuffixOnCreateDateField property specifies a string that Campaign automatically appends to any DATE fields in the CREATE TABLE SQL statement. For example, you might set this property as follows: SuffixOnCreateDateField = FORMAT 'YYYYMMDD If this property is undefined (the default), the CREATE TABLE command is unchanged. 266 Unica Confidential Affinium Campaign Installation Guide

267 Properties in the partition1 category SuffixOnInsertSQL The SuffixOnInsertSQL property specifies a string that is automatically appended to all INSERT SQL expressions generated by Campaign. This property applies only to SQL generated by Campaign, and does not apply to SQL in raw SQL expressions used in the Select process. SuffixOnInsertSQL is used for the following expression type, when generated by Campaign: INSERT INTO table... The value may contain a user token (<USER>) to substitute the Campaign user name of the user running the flowchart. This property is automatically added to the SQL expression without checking its syntax. If you use this property, make sure it is a legal expression. The string may be enclosed in quotes, but this is not required. This property is undefined by default. SuffixOnSelectSQL The SuffixOnSelectSQL property specifies a string that is automatically appended to all SELECT SQL expressions generated by Campaign. This property applies only to SQL generated by Campaign, and is does not apply to SQL in raw SQL expressions used in the Select process. The value may contain a user token (<USER>) to substitute the Campaign user name of the user running the flowchart. This property is automatically added to the SQL expression without checking its syntax. If you use this property, make sure it is a legal expression. The string may be enclosed in quotes, but this is not required. This property is undefined by default. SuffixOnTempTableCreation The SuffixOnTempTableCreation property specifies a string that is automatically appended to the SQL expression, generated by Campaign, when a temp table is created. This happens only on data sources that are configured with the AllowTempTables property set to TRUE. This property applies only to SQL Version Unica Confidential 267

268 : generated by Campaign, and does not apply to SQL in raw SQL expressions used in the Select process. You may want to use tokens to substitute the table name and the column name(s) (<TABLENAME> and <KEYCOLUMNS>) in this SQL statement, since these are generated dynamically during the execution of the campaign. The value may also contain a user token (<USER>) to substitute the Campaign user name of the user running the flowchart. This property is automatically added to the SQL expression without checking its syntax. If you use this property, make sure it is a legal expression. The string may be enclosed in quotes, but this is not required. This property is undefined by default. SuffixOnUserBaseTableCreation The SuffixOnUserBaseTableCreation property specifies a string that is automatically appended to the SQL expression that Campaign generates when a user creates a Base table (for example, in an Extract process). This property applies only to SQL generated by Campaign, and does not apply to SQL in raw SQL expressions used in the Select process. You may want to use tokens to substitute the table name and the column name(s) (<TABLENAME> and <KEYCOLUMNS>) in this SQL statement, since these are generated dynamically during the execution of the campaign. The value may also contain a user token (<USER>) to substitute the Campaign user name of the user running the flowchart. This property is automatically added to the SQL expression without checking its syntax. If you use this property, make sure it is a legal expression. The string may be enclosed in quotes, but this is not required. This property is undefined by default. SuffixOnUserTableCreation The SuffixOnUserTableCreation property specifies a string that is automatically appended to the SQL expression that Campaign generates, when a user creates a General table (for example, in a Snapshot process). This property applies only to SQL generated by Campaign, and does not apply to SQL in raw SQL expressions used in the Select process. 268 Unica Confidential Affinium Campaign Installation Guide

269 Properties in the partition1 category This property is automatically added to the SQL expression without checking its syntax. If you use this property, make sure it is a legal expression. The string may be enclosed in quotes, but this is not required. This property is undefined by default. SystemTableSchema Specifies the DB2 schema used for Affinium Campaign system tables. Set this this value only if Campaign does not map the system tables automatically (system tables should map automatically when a user with Admin permissions first logs in to Campaign). This property applies to DB2 only. The default value is blank. If you need to set this value, set it to the schema name of the system tables, which is usually the login of the user who created the tables. TempTablePostExecutionSQL The TempTablePostExecutionSQL property specifies a complete SQL statement that is executed immediately after the creation of a temporary table by Campaign. This happens only on data sources that are configured with the AllowTempTables property set to TRUE. You may want to use tokens to substitute the table name and the column name(s) (<TABLENAME> and <KEYCOLUMNS>) in this SQL statement, since these are generated dynamically during the execution of the campaign. You may use the user token (<USER>) to substitute the Campaign user name of the user running the flowchart. This property is automatically added to the SQL expression without checking its syntax. If you use this property, make sure it is a legal expression. The string may be enclosed in quotes, but this is not required. This property is undefined by default. TempTablePrefix The TempTablePrefix parameter specifies a string that is automatically prepended to the names of all temporary tables created by Campaign. Unica recommends that you use this parameter to help you identify and manage your Version Unica Confidential 269

270 : temp tables. You also can use this property to cause temp tables to be created in a particular location. The value may contain a user token (<USER>) to substitute the Campaign username of the user running the flowchart. If the user token corresponds to a schema, you can set TempTablePrefix="<USER>" and all temp tables will be created in the schema of whatever user is connected to the data source. The default value is UAC. UseSQLToProfile The UseSQLToProfile property allows you to configure Campaign to submit the SQL query GROUP BY to the database to compute profiles (using SELECT field, count(*) FROM table GROUP BY field ), rather than fetching records. A value of FALSE (the default) causes Campaign to profile a field by retrieving the field's value for all records in the table and to track the count of each distinct value. A value of TRUE causes Campaign to profile a field by issuing a query similar to the following: SELECT field, COUNT(field) FROM table GROUP BY field which pushes the burden to the database. The default value is FALSE. systemtablemapping Properties in the partition1 > systemtablemapping category are populated automatically if you remap any system tables or map Contact or Response history tables. You should not edit properties in this category. 270 Unica Confidential Affinium Campaign Installation Guide

271 Properties in the partition1 category offercodegenerator Properties in the partition1 > offercodegenerator category specify the class, classpath, and configuration string for the Campaign offer code generator, and also the cell code generator used to assign a contact-style process to a to a Target Control Spreadsheet cell. offercodegeneratorclass The offercodegeneratorclass property specifies the name of the class Campaign uses as its offer code generator. The class must be fully qualified with its package name. The default value is com.unica.campaign.core.codegenerator.samples.executablecodegen erator. offercodegeneratorclasspath The offercodegeneratorclasspath property specifies the path to the class Campaign uses as its offer code generator. It can be either a full path or a relative path. If the path ends in a slash (forward slash / for UNIX or backslash \ for Windows), Campaign assumes it to be a path to a directory that contains the Java plug-in class that should be used. If the path does not end in a slash, Campaign assumes it is the name of a jar file that contains the Java class. If the path is relative, Campaign assumes it is relative to the Campaign application home directory. The default codegenerator.jar file is packaged in the Campaign.war file. The default value is.\campaign\tools\codegeneratorapi\lib\codegenerator.jar. offercodegeneratorconfigstring The offercodegeneratorconfigstring property specifies a string that is passed into the offer code generator plug-in when it is loaded by Campaign. By default, the ExecutableCodeGenerator (shipped with Campaign) uses this Version Unica Confidential 271

272 : property to indicate the path (relative to Campaign application home directory) to the executable to run. The default value is.\campaign\tools\codegeneratorapi\bin. defaultgenerator The defaultgenerator property specifies the generator for the cell codes that appear in contact-style process boxes and are used to assign cells to Target Control Spreadsheet cells. The Target Control Spreadsheet manages cell and offer mappings for campaigns and flowcharts. The default value is uacoffercodegen.exe. server > dataprocessing Properties in the partition1 > server > dataprocessing category specify how Campaign handles string comparisons and empty fields in flat files, and the behavior of the macro STRING_CONCAT. comparecasesensitive The comparecasesensitive property specifies whether Campaign's data comparisons are sensitive to alphabetic case (UPPER vs. lower). When the value is no, Campaign ignores case differences when comparing data values and sorts textual data in a binary, case-insensitive manner. This setting is strongly recommended when English data is used. When the value is yes, Campaign distinguishes data values based on case differences, performing a true binary-value comparison of each character. This setting is strongly recommended when non-english data is used. Valid values are yes and no. The default value is no. 272 Unica Confidential Affinium Campaign Installation Guide

273 Properties in the partition1 category fileallspacesisnull The fileallspacesisnull property controls how Campaign interprets an empty field in a mapped flat file by specifying whether an all-spaces value in a flat file should be considered to be a NULL value. When the value is yes, an all-spaces value is considered to be a NULL value. Campaign matches queries such as <field> is null, but fails queries such as <field> = "". When the value is no, an all-spaces value is treated as a non-null empty string. Campaign matches queries such as <field> = "", but fails <field> is null. The default value is yes. performcaseinsensitivecomparisonas The performcaseinsensitivecomparisonas property specifies how Campaign compares data values when the comparecasesensitive property is set to no (that is, during case-insensitive comparisons). This property is ignored if the value of comparecasesensitive is yes. When the value is UPPER, Campaign converts all data to upper case before comparing. When the value is LOWER, Campaign converts all data to lower case before comparing. The default value is LOWER. stringconcatwithnullisnull The stringconcatwithnullisnull property controls the behavior of the Campaign macro STRING_CONCAT. When the value is yes, STRING_CONCAT returns NULL if any of its inputs is NULL. When the value is no, STRING_CONCAT returns the concatenation of all of its non- NULL properties; in this case, STRING_CONCAT returns NULL only if all of its inputs are NULL. The default value is yes. Version Unica Confidential 273

274 : likeallowsdate The likeallowsdate property specifies whether the LIKE database function allows a DATE/DATETIME parameter, and therefore whether the operation may be performed in the database or must be performed by the Campaign server. Set the value to yes if the database is SQL Server or Oracle. The LIKE function in these databases allows a DATE/DATETIME parameter. Set the value to no if the database is DB2, Teradata, Sybase, or Informix. The LIKE function in these databases does not allow a DATE/DATETIME parameter. Note that this setting is global, not per data source. If a value of no is recommended for any data source in use, set the value to no. If a value of yes is recommended for all data sources in use, set the value to yes. Valid values are yes and no. The default value is yes. lowerallowsdate The lowerallowsdate property specifies whether the LOWER database function allows a DATE/DATETIME parameter, and therefore whether the operation may be performed in the database or must be performed by the Campaign server. Set the value to yes if the database is SQL Server or Oracle. The LOWER function in these databases allows a DATE/DATETIME parameter. Set the value to no if the database is DB2, Teradata, Sybase, or Informix. The LOWER function in these databases does not allow a DATE/DATETIME parameter. Note that this setting is global, not per data source. If a value of no is recommended for any data source in use, set the value to no. If a value of yes is recommended for all data sources in use, set the value to yes. Typically, only one database type is in use at a customer site, but there are some installations in which multiple database types are in use. Valid values are yes and no. The default value is yes. ltrimallowsdate The ltrimallowsdate property specifies whether the LTRIM database function allows a DATE/DATETIME parameter, and therefore whether the operation may be performed in the database or must be performed by the Campaign server. 274 Unica Confidential Affinium Campaign Installation Guide

275 Properties in the partition1 category Set the value to yes if the database is SQL Server, Oracle, or Teradata. The LTRIM function in these databases allows a DATE/DATETIME parameter. Set the value to no if the database is DB2, Sybase, or Informix. The LTRIM function in these databases does not allow a DATE/DATETIME parameter. Note that this setting is global, not per data source. If a value of no is recommended for any data source in use, set the value to no. If a value of yes is recommended for all data sources in use, set the value to yes. Typically, only one database type is in use at a customer site, but there are some installations in which multiple database types are in use. Valid values are yes and no. The default value is yes. rtrimallowsdate The rtrimallowsdate property specifies whether the RTRIM database function allows a DATE/DATETIME parameter, and therefore whether the operation may be performed in the database or must be performed by the Campaign server. Set the value to yes if the database is SQL Server, Oracle, or Teradata. The RTRIM function in these databases allows a DATE/DATETIME parameter. Set the value to no if the database is DB2, Sybase, or Informix. The RTRIM function in these databases does not allow a DATE/DATETIME parameter. Note that this setting is global, not per data source. If a value of no is recommended for any data source in use, set the value to no. If a value of yes is recommended for all data sources in use, set the value to yes. Valid values are yes and no. The default value is yes. substrallowsdate The substrallowsdate property specifies whether the SUBSTR/SUBSTRING database function allows a DATE/DATETIME parameter, and therefore whether the operation may be performed in the database or must be performed by the Campaign server. Set the value to yes if the database is Oracle or Teradata. The SUBSTR/SUBSTRING function in these databases allows a DATE/DATETIME parameter. Version Unica Confidential 275

276 : Set the value to no if the database is SQL Server, DB2, Sybase, or Informix. The SUBSTR/SUBSTRING function in SQL Server, DB2, and Sybase does not allow a DATE/DATETIME parameter. Informix SUBSTR does accept a DATE parameter, but the DATE is first converted to text, and the conversion changes the format. So SUBSTR would return different results in the database compared with the Campaign server, so the best practice is to set substrallowsdate to no when the database is Informix. Note that this setting is global, not per data source. If a value of no is recommended for any data source in use, set the value to no. If a value of yes is recommended for all data sources in use, set the value to yes. Valid values are yes and no. The default value is yes. upperallowsdate The substrallowsdate property specifies whether the UPPER database function allows a DATE/DATETIME parameter, and therefore whether the operation may be performed in the database or must be performed by the Campaign server. Set the value to yes if the database is SQL Server or Oracle. The UPPER function in these databases allows a DATE/DATETIME parameter. Set the value to no if the database is DB2, Teradata, Sybase, or Informix. The UPPER function in these databases does not allow a DATE/DATETIME parameter. Note that this setting is global, not per data source. If a value of no is recommended for any data source in use, set the value to no. If a value of yes is recommended for all data sources in use, set the value to yes. Valid values are yes and no. The default value is yes. server > encoding The property in the partition1 > server > encoding category specifies the text encoding for values written to files, to support non-english data. stringencoding The stringencoding property specifies the text encoding for files, to support non-english data. 276 Unica Confidential Affinium Campaign Installation Guide

277 Properties in the partition1 category If the value is left unspecified (the default), no transcoding of text values takes place. If an encoding is specified text values are transcoded to the specified encoding when the values are written to a file (text values are transcoded to an internal encoding (UTF-8) when the values are read from a file). Note the following: It may be useful to set this property to the encoding of the files that will be used with Campaign. This is highly situation-dependent. If you do not set the value of the StringEncoding property for data sources in the datasources category, the value of this stringencoding property is used as the default value. This can cause unnecessary confusion always set the StringEncoding property in the datasources category. server > filedialog Properties in the partition1 > server > filedialog category specify the default directories for Campaign input and output data files. defaultinputdirectory The defaultinputdirectory property specifies the path used to initialize Campaign's File Selection dialog. The defaultinputdirectory property is used when an input data file is mapped into Campaign. If no value is specified, the path is read from the environment variable UNICA_ACDFDIR. defaultoutputdirectory The defaultoutputdirectory property specifies the path used to initialize Campaign's File Selection dialog. The defaultoutputdirectory property is used when an output data file is mapped into Campaign. If no value is specified, the path is read from the environment variable UNICA_ACDFDIR. Version Unica Confidential 277

278 : server > flowchartconfig Properties in the partition1 > server > flowchartconfig category specify the behavior of Campaign s ProcessName Affinium Generated Field, whether duplicate cell codes are allowed, and whether the Log to Contact History option defaults to enabled. agfprocessnameoutput The agfprocessnameoutput property specifies the output behavior of Campaign s ProcessName Affinium Generated Field (AGF) in the List, Optimize, Response, and Snapshot processes. Valid values are PREVIOUS and CURRENT. If the value is PREVIOUS, the ProcessName AGF contains the process name associated with the incoming cell. If the value is CURRENT, the ProcessName AGF holds the process name of the process in which it is used. The default value is PREVIOUS. allowduplicatecellcodes The allowduplicatecellcodes property specifies whether the cell codes in the Campaign Snapshot process can have duplicate values. If the value is no, the Campaign server enforces unique cell codes. If the value is yes, the Campaign server does not enforce unique cell codes. The default value is is yes. logtohistorydefault The logtohistorydefault property specifies whether the Log to Contact History and Tracking Tables option in the Log tab of Campaign s contact-style processes defaults to enabled. If the value is yes, the option is enabled. If the value is no, the option is disabled in any newly created contact-style process (mail list, call list, emessage, and recmmend processes). 278 Unica Confidential Affinium Campaign Installation Guide

279 Properties in the partition1 category The default value is yes. server > flowchartrun Properties in the partition1 > server > flowchartrun category specify how many errors are allowed in a Campaign Snapshot export, what files are saved when you save a flowchart, and the maximum number of IDs for each top-level process in a test run. maxdataerrorsallowed The maxdataerrorsallowed property specifies the maximum number of data conversion errors allowed in a Campaign Snapshot export. The default is 0 (zero), which allows no errors. saverunresults The saverunresults property specifies what files are saved when you save a Campaign flowchart. If the value is yes, the underscore files are saved and, if the value of useindboptimization is yes, database temp tables persist. If the value is no, only the.ses file is saved and you cannot view intermediate results if you reload the flowchart. The default value is yes. testrundefaultsize The testrundefaultsize property specifies the default maximum number of IDs for each top-level process in a Campaign test run. A value of 0 (zero) removes the limitation on the number of IDs. The default value is 0 (zero). Version Unica Confidential 279

280 : server > flowchartsave Properties in the partition1 > server > flowchartsave category specify the default settings for a new Campaign flowchart s auto-save and checkpoint properties. autosavefrequency The autosavefrequency property specifies the default setting for a new Campaign flowchart s auto-save property, configurable for each flowchart through the client-side Advanced Settings window. The auto-save function performs a forced save of flowcharts during editing and configuration. The following values are supported: 0 - Never 1-1 minute 2-5 minutes 3-10 minutes 4-30 minutes 5-1 hour 6-2 hours The default value is 0 (zero). checkpointfrequency The checkpointfrequency property specifies the default setting for a new Campaign flowchart s checkpoint property, configurable for each flowchart through the client-side Advanced Settings window. The checkpoint feature provides the ability to capture a snapshot of a running flowchart for recovery purposes. The following values are supported: 0 - Never 1-30 minutes 2-1 hour 3-2 hours 4-6 hours 5-12 hours 280 Unica Confidential Affinium Campaign Installation Guide

281 Properties in the partition1 category 6-1 day 7-1 week The default value is 0 (zero). server > internal Properties in the partition1 > server > internal category specify whether Affinium Campaign Optimize and Affinium Campaign emessage are installed, and Campaign s internalid upper and lower limits. acoinstalled The acoinstalled property specifies whether Affinium Campaign Optimize (ACO) is installed. Valid values are yes and no. When Affinium Campaign Optimize is installed and configured, set the value to yes, which causes the ACO process to be displayed in flowcharts. If the value is yes and ACO is not installed or configured, the process is displayed but disabled (grayed out). The default value is is no. emessageinstalled The emessageinstalled property specifies whether Affinium Campaign emessage is installed. Valid values are yes and no. When Affinium Campaign emessage is installed and configured, set the value to yes, which causes the emessage process to be displayed in flowcharts. If the value is yes and Affinium Campaign emessage is not installed or configured, the process is displayed but disabled (grayed out). The default value is is no. internalidlowerlimit The internalidupperlimit and internalidlowerlimit properties constrain Campaign s internal IDs to be within the specified range. Note that the values are Version Unica Confidential 281

282 : inclusive: that is, Campaign may use both the lower and upper limit. The default values for lower and upper limit are 0 (zero) and , respectively. internalidupperlimit The internalidupperlimit and internalidlowerlimit properties constrain Campaign s internal IDs to be within the specified range. Note that the values are inclusive: that is, Campaign may use both the lower and upper limit. The default values for lower and upper limit are 0 (zero) and , respectively. server > logging Properties in the partition1 > server > logging category specify, for the Campaign server, whether standard and Windows event logging are enabled, logging levels and categories, and other logging behavior. enablelogging The enablelogging property specifies whether Campaign server logging is turned on at session startup. If the value is yes, logging is turned on. If the value is no, logging is turned off. The default value is yes. enablewindowseventlogging The enablewindowseventlogging property enables or disables Campaign server logging to the Windows event log. If the value is yes, logging to the Windows event log is enabled. If the value is no, logging to the Windows event log is disabled. If disabled, the windowseventlogginglevel and windowseventloggingcategory settings are ignored. The default value is no. 282 Unica Confidential Affinium Campaign Installation Guide

283 Properties in the partition1 category keepflowchartlogopen The keepflowchartlogopen property specifies whether Campaign opens and closes the flowchart log file each time a line is written to the log file. If the value is no, Campaign opens and closes the flowchart log file. If the value is yes, Campaign opens the flowchart log file only once, and closes the flowchart log file only when the flowchart's server process exits. A value of yes may improve performance of real-time flowcharts. A side effect of using the yes setting is that recently-logged messages may not be immediately visible in the log file, as Campaign flushes the log messages to file only when its internal buffer becomes full or when the number of logged messages equals the value of the logfilebuffersize property. The default value is no. logfilebuffersize The logfilebuffersize property is used when the value of the keepflowchartlogopen property is yes. It sets an upper bound on the number of log messages after which the messages will be written to file. If the value is 1, every log message is written immediately to file, effectively disabling buffering but causing somewhat worse performance. This property is ignored if the value of keepflowchartlogopen is set to no. The default value is 5. loggingcategories The loggingcategories property specifies the category of messages written to the Campaign server log file. This works in conjunction with logginglevels, which determines which messages are logged based on severity (for all selected categories). You can specify multiple categories in a comma-separated list. The special category all provides a shorthand for specifying all logging categories. Supported categories are: ALL BAD_ORDER CELL_ACCESS Version Unica Confidential 283

284 : CONFIG DATA_ERRORS DBLOAD FILE_ACCESS GENERAL COMMANDS MEMORY PROCRUN QUERY SORT SYSQUERY TABLE_ACCESS TABLE_MAPPING TABLE_IO WEBPROC The default value is BAD_ORDER,DATA_ERRORS,MEMORY,QUERY. logginglevels The logginglevels property controls the amount of detail written to the Campaign server log file, based on severity. The supported values are LOW, MEDIUM, HIGH, and ALL. LOW represents the least detail (the most severe errors only), and ALL includes trace messages and is intended primarily for diagnostic purposes. You can adjust these settings from within a flowchart through the Tools >Logging Options menu. The default value is MEDIUM. You may want to set the logginglevels property to ALL during configuration and testing, to maximize the logging output from Campaign for diagnostic purposes. This setting generates a large amount of data and therefore may not be advisable for production operation. logmaxbackupindex The logmaxbackupindex property specifies the number of backup Campaign server log files that are kept before the oldest is erased. If the value is 0 (zero), no backup files are created, and the log file is truncated when it reaches the size specified by the logfilemaxsize property. 284 Unica Confidential Affinium Campaign Installation Guide

285 Properties in the partition1 category For a value of n, where n is greater than zero, the files {File.1,..., File.n-1} are renamed to {File.2,..., File.n}. Also, File is renamed File.1 and closed. A new File is created to receive further log output. The default value is 1, so there is one backup log file by default. logfilemaxsize The logfilemaxsize property specifies the maximum size, in bytes, that the Campaign server log file is allowed to reach before being rolled over to backup files. The default value is (1 MB). logprocessid The logprocessid property controls whether the process ID (pid) of the Campaign Server process is logged in the log file. If the value is yes, the process ID is logged. If the value is no, the process ID is not logged. The default value is yes. windowseventloggingcategories The windowseventloggingcategories property specifies the category of messages written to the Campaign server windows event log. This works in conjunction with windowseventlogginglevels, which determines which messages are logged based on severity (for all selected categories). You can specify multiple categories in a comma-separated list. The special category all provides a shorthand for specifying all logging categories. Supported categories are: ALL BAD_ORDER CELL_ACCESS CONFIG DATA_ERRORS DBLOAD Version Unica Confidential 285

286 : FILE_ACCESS GENERAL COMMANDS MEMORY PROCRUN QUERY SORT SYSQUERY TABLE_ACCESS TABLE_MAPPING TABLE_IO WEBPROC The default value is BAD_ORDER,DATA_ERRORS,MEMORY,QUERY. windowseventlogginglevels The windowseventlogginglevels property controls the amount of detail written to the Campaign server windows event log based on severity. The supported values are LOW, MEDIUM, HIGH, and ALL. LOW represents the least detail (the most severe errors only), and ALL includes trace messages and is intended primarily for diagnostic purposes. The default value is MEDIUM. server > optimization Properties in the partition1 > server > optminization category specify the number of operating system threads that Campaign caches for reuse, the default setting for a new flowchart s Affinium Virtual Memory Usage property, and whether in-database optmization is enabled. maxreusethreads The maxreusethreads property specifies the number of operating system threads cached by the server process (unica_acsvr) for reuse. The default value is 0 (zero), which disables the cache. 286 Unica Confidential Affinium Campaign Installation Guide

287 Properties in the partition1 category Note that the maxreusethreads property should be set to a value greater than or equal to the value of MaxQueryThreads. Unica recommends that you use the cache when you want to reduce the overhead of thread allocation, or with operating systems that can exhibit an inability to release threads when asked to do so by an application. maxvirtualmemory The maxvirtualmemory property specifies a default setting for a new Campaign flowchart s Affinium Virtual Memory Usage property, configurable for each flowchart through the client-side Advanced Settings window. The units are in megabytes. The default value is 128. useindboptimization The useindboptimization property specifies whether Campaign tries to perform as many operations as possible in the database instead of in the Campaign server. If the value is no, Campaign maintains lists of IDs in the Campaign server at all times. If the value is yes, Campaign avoids pulling the ID lists if possible. The default value is no. server > permissions Properties in the partition1 > server > permissions category specify the permissions set on folders created by Campaign, and the UNIX group and permissions set on files contained in the profile directory. adminfilegroup (UNIX only) The adminfilegroup property specifies a UNIX admin group associated with files contained in the profile directory. This property is undefined by default. Version Unica Confidential 287

288 : adminfilepermissions (UNIX only) The adminfilepermissions property specifies a permission bit mask for the files contained in the profile directory. The default value is 660 (owner and group have read/write access only). catalogfolderpermissions The catalogfolderpermissions property specifies the permissions of directories created by Campaign through the Stored Table Catalogs > Create Folder window. The default value is 755 (owner has read/write/execute access, group and world have execute/read access). createfolderpermissions The createfolderpermissions property specifies the permissions of directories created by Campaign through the New Folder option on the File Selection window. The default value is 755 (owner has read/write/execute access, group and world have execute/read access). templatefolderpermissions The templatefolderpermissions property specifies the permissions of template directories created by Campaign through the Stored Templates > Create Folder window. The default value is 755 (owner has read/write/execute access, group and world have execute/read access). userfilegroup (UNIX only) The userfilegroup property specifies a group associated with user-generated Campaign files. The group will be set only if the user is a member of the specified group. This property is undefined by default. 288 Unica Confidential Affinium Campaign Installation Guide

289 Properties in the partition1 category userfilepermissions (UNIX only) The userfilepermissions property specifies a permission bit mask for user generated Campaign files (for example, log files, Summary files, exported flat files). The default value is 666 (everyone can read and write files created by Affinium in the server). server > profile Properties in the partition1 > server > profile category specify the maximum number of categories created during profiling for numeric and text values in Campaign. profilemaxnumbercategories The profilemaxnumbercategories and profilemaxtextcategories properties specify the maximum number of categories created in Campaign during profiling for numeric and text values, respectively. These values are different from the setting for the number of bins displayed to the user, which can be modified through the user interface. The default values of profilemaxnumbercategories and profilemaxtextcategories are 1024 and , respectively. profilemaxtextcategories The profilemaxtextcategories and profilemaxnumbercategories properties specify the maximum number of categories created in Campaign during profiling for text and numeric values, respectively. These values are different from the setting for the number of bins displayed to the user, which can be modified through the user interface. The default values of profilemaxnumbercategories and profilemaxtextcategories are 1024 and , respectively. Version Unica Confidential 289

290 : server > systemcodes Properties in the partition1 > server > systemcodes category specify, for Campaign, whether variable length codes are allowed, the format and generator of the campaign and cell codes, whether offer codes are displayed,a nd the offer code delimiter. allowvariablelengthcodes The allowvariablelengthcodes property specifies whether variable length codes are allowed in Campaign. If the value is yes, and if the trailing part of the code format is x, the length of the code can vary. For example, if the code format is nnnnxxxx, then the code can be from 4 to 8 characters long. This applies to campaign, offer, version, tracking, and cell codes. If the value is no, variable length codes are not allowed. The default value is no. campcodeformat The campcodeformat property is used by the campaign code generator to define the format of the campaign code that is automatically generated by the default Campaign code generator when you create a campaign. The possible values are as follows: A-Z or any symbol treated as a constant a random letters A-Z (upper case only) c random letters A-Z or numbers 0-9 n random digit 0-9 x any single ASCII character from 0-9 or A-Z. You can edit the generated campaign code and replace the ASCII character that Campaign substituted for the x with any ASCII character, and Campaign will use that character instead. The default value is Cnnnnnnnnn. 290 Unica Confidential Affinium Campaign Installation Guide

291 Properties in the partition1 category campcodegenprogfile The campcodegenprogfile property specifies the name of the campaign code generator, and if the generator is the default one supplied by Campaign, any supported options. Note that the properties that control the format of the code generated are set in the campcodeformat property. If you write your own campaign code generator, replace the default value with the absolute path of your custom program, including the file name and extension, and using forward slashes (/) for UNIX and backslashes (\) for Windows. For details about code generators, see the Affinium Campaign Administrator s Guide. The default campaign code generator can be called with the following options: -y -m -d -n -o -u -f -i Year (four integers) Month (one or two integers, cannot exceed value of twelve) Day (one or two integers, cannot exceed value of 31) Campaign name (any string, cannot exceed 64 characters) Campaign owner (any string, cannot exceed 64 characters) Campaign code (any integer). Allows you to specify the exact campaign ID rather than having the application generate one for you. Code format if overriding the default. Takes the values specified in campcodeformat. Other integer. Version Unica Confidential 291

292 : -s Other string. The default value is uaccampcodegen, the code generator supplied by Campaign. cellcodeformat The cellcodeformat property is used by the campaign code generator to define the format of the cell code that is automatically created by the default Campaign cell code generator. For a list of valid values, see campcodeformat on page 290. The default value is Annn. cellcodegenprogfile The cellcodegenprogfile property specifies specifies the name of the Campaign cell code generator, and if the generator is the default one supplied by Campaign, any supported options. Note that the properties that control the format of the code generated are set in the cellcodeformat property. See campcodegenprogfile for a list of supported options. If you write your own cell code generator, replace the default value with the absolute path of your custom program, including the file name and extension, and using forward slashes (/) for UNIX and backslashes (\) for Windows. For details about custom code generators, see the Affinium Campaign Administrator s Guide. The default value is uaccampcodegen, the code generator supplied by Campaign. displayoffercodes The displayoffercodes property specifies whether to show offer codes beside their names in the Campaign GUI. If the value is yes, offer codes are displayed. If the value is no, offer codes are not displayed. The default value is no. 292 Unica Confidential Affinium Campaign Installation Guide

293 Properties in the partition1 category offercodedelimiter The offercodedelimiter property is used internally to concatenate multiple code parts (for example, to output the OfferCode field in Affinium Generated Fields) and for incoming offer codes in the Campaign Response process, to split the offer code into multiple parts. The value must be only a single character. Note that in this version of Campaign, the NumberOfOfferCodesToUse parameter no longer exists. This value now comes from the offer template (every offer template can have different number of offer codes). The default value is -. server > timeout Properties in the partition1 > server > timeout category specify the number of seconds a Campaign flowchart waits, after the user has disconnected and all runs have completed, before exiting, and the Campaign server process waits for a response from external servers before reporting an error. delayexittimeout The delayexittimeout property specifies the number of seconds a Campaign flowchart waits, after the user has disconnected and all runs have completed, before exiting. Setting this property to a non-0 value enables subsequent Campaign flowcharts to make use of existing instances rather than starting a new instance. The default value is 6. urlrequesttimeout The urlrequesttimeout property specifies the number of seconds the Campaign server process waits for a response from external servers. Currently, this applies to requests to Affinium Security Manager and Affinium Campaign emessage servers. If the Campaign server process does not receive a response within this period, a communication timeout error is reported. Version Unica Confidential 293

294 : The default value is 60. waitforgracefuldisconnect The waitforgracefuldisconnect property specifies whether the Campaign server process continues to run until the user gracefully disconnects, or exits regardless of whether the user intended to disconnect. If the value is yes, the default, the server process continues to run until it can determine that the user wants it to exit. This option prevents changes from being lost, but can result in server porcesses accumulating. If the value is no, the server process shuts down and server processes are prevented from accumulating, but users can lose work if a network interruption occurs or if they do not follow the recommended sequence of actions to exit gracefully. The following scenario illustrates how a user might fail fo exit gracefully: The user opens a flowchart for editing. The user works in another area of Campaign while the flowchart is in edit mode. This causes a separate window to appear. The user edits another flowchart in the separate window. The user goes back to the first flowchart, finishes editing it, and logs out. This closes the HTTP session, causing the separate window's flowchart to be disconnected, although the window remains open. At this point, the user can no longer use the separate window to edit the flowchart, and any unsaved work on that flowchart is lost. In the preceding scenario, if the value of waitforgracefuldisconnect is yes, the server process would continue to run. If the value is no, the server process would shut down. The default value is yes. Date format reference The formats of the DateFormat and DateOutputFormatString parameters are documented in this section. Note that the language used and expected by 294 Unica Confidential Affinium Campaign Installation Guide

295 Date format reference Campaign for language-sensitive month names is dependent on the Language and Regional Settings of the server. Formats for DateFormat The DateFormat parameter may be set to any of the formats specified in the DATE macro, as shown in the following table. Format Description Example(s) MM 2-digit month 01, 02, 03,..., 12 MMDD 2-digit month and 2-digit day March 31 is 0331 MMDDYY MMDDYYYY DELIM_M_D DELIM_M_D_Y DELIM_Y_M DELIM_Y_M_D YYMMM YYMMMDD 2-digit month, 2-digit day, and 2-digit year 2-digit month, 2-digit day, and 4-digit year Any delimited month followed by day Any delimited month, day, and year Any delimited year followed by month Any delimited year, month, and day 2-digit year and 3-letter month 2-digit year, 3-letter month, and 2-digit day March 31, 1970 is March 31, 1970 is March 31, 3/31, or March 31, 1970 or 3/31/70 March, 70; 3-70; or 3/ Mar 31 or 70/3/31 70MAR 70MAR31 YY 2-digit year 70 YYMM 2-digit year and 2-digit month 7003 YYMMDD 2-digit year, 2-digit month, and 2-digit day Version Unica Confidential 295

296 : Format Description Example(s) YYYYMMM YYYYMMMDD 4-digit year and 3-letter month 4-digit year, 3-letter month, and 2-digit day 1970MAR 1970MAR31 YYYY 4-digit year 1970 YYYYMM 4-digit year and 2-digit month YYYYMMDD DELIM_M_Y DELIM_D_M DELIM_D_M_Y 4-digit year, 2-digit month, and 2-digit day Any delimited month followed by year Any delimited day followed by month Any delimited day, month, and year , 3/70, Mar 70, March , 31/3, 31 March 31-MAR-70, 31/3/1970, DD 2-digit day 31 DDMMM 2-digit day and 3-letter month 31MAR DDMMMYY DDMMMYYYY 2-digit day, 3-letter month, and 2-digit year 2-digit day, 3-letter month, and 4-digit year 31MAR70 31MAR1970 DDMM 2-digit day and 2-digit month 3103 DDMMYY DDMMYYYY 2-digit day, 2-digit month, and 2-digit year 2-digit day, 2-digit month, and 4-digit year MMYY 2-digit month and 2-digit year 0370 MMYYYY 2-digit month and 4-digit year MMM 3-letter month MAR 296 Unica Confidential Affinium Campaign Installation Guide

297 Date format reference Format Description Example(s) MMMDD 3-letter month and 2-digit day MAR31 MMMDDYY MMMDDYYYY MMMYY MMMYYYY MONTH WEEKDAY WKD 3-letter month, 2-digit day, and 2-digit year 3-letter month, 2-digit day, and 4-digit year 3-letter month and 2-digit year 3-letter month and 4-digit year Month of the year Day of the week Abbreviated day of the week MAR3170 MAR MAR70 MAR1970 January, February, March, and so on or Jan, Feb, Mar, and so on Sunday, Monday, Tuesday, and so on (Sunday = 0) Sun, Mon, Tues, and so on (Sun = 0) Formats for DateOutputFormatString The DateOutputFormatString parameter may be set to any of the formats specified for format_str in the DATE_FORMAT macro, as listed below. %a Abbreviated weekday name %A Full weekday name %b Abbreviated month name %B Full month name %c Date and time representation appropriate for locale %d Day of month (01-31) %H Hour in 24-hour format (00-23) %I Hour in 12-hour format (01-12) Version Unica Confidential 297

298 : %j Day of year ( ) %m Month (01-12) %M Minute (00-59) %p Current locale's AM/PM indicator for 12-hour clock %S Second (00-59) %U Week of year, with Sunday as first day of week (00-51) %w Weekday (0-6; Sunday is 0) %W Week of year, with Monday as first day of week (00-51) %x Date representation for current locale %X Time representation for current locale %y 2-digit year (00-99) %Y 4-digit year %z, %Z Time zone name or abbreviation; no output if time zone is unknown %% Percent sign Characters that are part of the format and are not preceded by a percent sign (%) are copied unchanged to the output string. The formatted string must fit in 16 bytes or less. Use the # character to eliminate any leading 0. For example, %d produces 2-digit numbers in the range (01-31), while %#d produces 1- or 2-digit numbers as appropriate (1-31). Similarly, %m gives (01-12) while %#m gives (1-12). 298 Unica Confidential Affinium Campaign Installation Guide

299 B INTERNATIONALIZATION AND ENCODINGS This appendix provides background information on character encodings and language-sensitive database considerations, and lists the data encodings supported by Affinium Campaign. For complete details on configuring Affinium Campaign to work with a non-english language, see Chapter 8, Configuring Affinium Campaign for a Non-English Language, on page 181. This appendix includes the following topics: About character encodings The language-sensitive database Supported encodings Useful links Useful links Affinium Campaign Installation Guide Unica Confidential 299

300 : About character encodings A character encoding is the means by which human language is represented on a computer. Many different encodings are used to represent different languages. In order to configure Campaign to work with non-english languages, you need to understand the character encodings used to store textual data in both files and databases. Throughout this Appendix, character encodings are referred to as encodings. There are other phrases in use that mean the same thing as a character encoding, such as charset, character set, codeset, and coded character set. Encoding uses Character encodings are used far more than one might guess. The following list illustrates some common uses for character encodings: Text in an ordinary text file. Environment variables Web pages The names of files and directories Fonts Database text storage, such as in a VARCHAR column. Internationalization and localization Character encodings are closely tied to the concepts of internationalization (I18N) and localization (L10N). The abbreviations are named for the first and last letters in the words and the number of letters in between. Internationalization is the process of making software capable of functioning with data in any language, while localization is the process of making software use the language, date formats, paper size, etc. that are common for users who speak different languages and follow different customs. It it not necessary to deeply understand these concepts in order to configure Campaign, but they may be mentioned in the tutorials referenced in the section Encoding tutorials on page 301. The goal of understanding this material is to be able to configure the relevant parameters in the Campaign configuration files and the database client. 300 Unica Confidential Affinium Campaign Installation Guide

301 About character encodings Encoding tutorials There are many good tutorials and references about character encodings on the Internet. The links below are intended to be a starting point for those who are unfamiliar with the concepts of character encodings. A working understanding of encodings is fairly important for most Campaign configuration scenarios. In more complex scenarios, a strong understanding of character encodings is essential. One concept that should be understood is transcoding, or converting between different character encodings. The following links may prove useful: Oracle's globalization manuals provide a good introduction. They are available on the Oracle Technology Network web site: A tutorial on character code issues provides a fairly technical tutorial: Wikipedia's entry about Character Encodings: Unicode Unicode is mentioned in most tutorials and is important to understand. However, it is particularly important to be aware of UTF-8, as this is the internal encoding used by Campaign. This is absolutely vital knowledge. For more information see: The Unicode home page: The Unicode FAQ: The UTF-8 questions: Version Unica Confidential 301

302 : Encodings available in Campaign On most operating systems, Campaign uses the GNU iconv library. See Supported encodings on page 305 for a list of these encodings. The only platform where GNU iconv is not used is AIX. On this platform, Campaign uses the iconv library ( gd/nlsgdrf/iconv.htm) provided by the operating system. See the AIX National Language Support Guide and Reference ( aix.doc/aixprggd/nlsgdrf/mastertoc.htm) for complete documentation. See Useful links on page 311 for a brief list of links to character encoding references. UNIX ODBC log The ODBC log is available on UNIX. Here is a sample odbc.ini file: [ODBC] InstallDir=/usr/odbc Trace=0 TraceDll=/usr/odbc/lib/odbctrac.so TraceFile=/tmp/trace.log TraceAutoStop=0 MaxRespSize=65477 Set Trace=1 to enable highly verbose logging. The language-sensitive database This section provides an overview of the Campaign-related details to consider when you configure Campaign to operate with a non-english database. This section covers the following topics: Communicating with the database 302 Unica Confidential Affinium Campaign Installation Guide

303 The language-sensitive database The database client Date formats Character encoding Bulk loaders Communicating with the database When an application communicates with a database, several language-sensitive things need to be understood between them: The format of a time or date field. The sorting order expected when using the ORDER BY clause of a SQL SELECT statement. The encoding of text within character-based fields. The database client When Campaign (or any other application) communicates with a database, it does so through a database client that must be installed on the Campaign server: Campaign communicates directly with the database client and the client communicates with the database. Each database client varies in how it handles language-sensitive data. The ability and mechanism for configuring the client varies as well. For example, SQL Server's ODBC driver is configured through the Control Panel applet. A database client s date format may be languagesensitive or it may be language-neutral, but the formats are pre-defined. Oracle allows custom date formats which may be configured through environment variables. Specific characteristics about each database that will be used with Campaign must be determined and configured within the affinium_config.xml file. Version Unica Confidential 303

304 : Date formats The format of a date field has several characteristics, including: Order of the day, month, and year Delimiters between the above fields Type of calendar (Gregorian or Julian) Numeric month or month name If month is a name, the language of the name (sometimes abbreviated) Date formats can appear in SQL statements as well as in the data returned by the database (called a resultset). Some database clients support or require different formats between SQL statements (output) and resultsets (input). Campaign can accommodate this: the affinium_config.xml file includes two parameters (DateFormat and DateOutputFormatString) for the two different formats. Character encoding Bulk loaders Data in CHAR, VARCHAR, and other text-based fields have a specific character encoding. When databases are created, they may specify the encoding that will be used throughout the database. Campaign can be configured to use one of many different character encodings on a database-wide scale. Per-column encodings are not supported. One feature that is common in modern databases is that the database client will transcode between the encoding of the database and the encoding that an application uses. This is common when an application uses some form of Unicode, but the database uses a language-specific encoding. A bulk loader is technically another type of database client. Bulk loaders may be subject to the same language-sensitive settings as an ordinary client. 304 Unica Confidential Affinium Campaign Installation Guide

305 Supported encodings Supported encodings The encodings in the following list are valid values for the following configuration parameters, found in the affinium_config.xml file: logstringencoding systemstringencoding There is an exception for the systemstringencoding parameter. For Windows, always use the default value of native. stringencoding StringEncoding Note that for the StringEncoding parameter, the pseudo-encoding WIDEUTF-8 is the recommended value in some cases, although you can use one of the encodings listed in this section. Also, If your database is DB2 or SQL Server, you should use a code page rather than one of the encodings in this list. See StringEncoding on page 263 for details. About this list The following international encodings are in groups. Each bullet within an encoding is a space-separated list of different names for the same encoding. Each name in a bullet with multiple names is an alias for the other encodings in the group. You can set the Campaign configuration parameters equal to any of the values in the group, depending on how your system uses the encodings. Special cases: ASCII and UTF-8 Campaign treats the ASCII and UTF-8 encodings slightly differently than other encodings. Both are case-sensitive. They have slightly different behaviors for column widths during table mappings and for transcoding operations. Encodings list The following is a list of supported inconv encodings. Version Unica Confidential 305

306 : Unicode encodings ISO UCS-2 UCS-2 CSUNICODE UCS-2BE UNICODE-1-1 UNICODEBIG CSUNICODE11 UCS-2LE UNICODELITTLE ISO UCS-4 UCS-4 CSUCS4 UTF-8 UCS-4BE UCS-4LE UTF-16 UTF-16BE UTF-16LE UTF-32 UTF-32BE UTF-32LE UNICODE-1-1-UTF-7 UTF-7 CSUNICODE11UTF7 UCS-2-INTERNAL UCS-2-SWAPPED UCS-4-INTERNAL UCS-4-SWAPPED JAVA C99 Arabic ARABIC ASMO-708 ECMA-114 ISO ISO-IR-127 ISO ISO_ ISO_8859-6:1987 CSISOLATINARABIC CP1256 MS-ARAB WINDOWS-1256 MACARABIC CP864 IBM864 CSIBM864 Armenian ARMSCII-8 Baltic Rim CP1257 WINBALTRIM WINDOWS-1257 CP775 IBM775 CSPC775BALTIC 306 Unica Confidential Affinium Campaign Installation Guide

307 Supported encodings ISO ISO-IR-179 ISO ISO_ L7 LATIN7 Celtic ISO ISO-CELTIC ISO-IR-199 ISO ISO_ ISO_ :1998 L8 LATIN8 Central Europe ISO ISO-IR-101 ISO ISO_ ISO_8859-2:1987 L2 LATIN2 CSISOLATIN2CP1250 MS-EE WINDOWS-1250 MACCENTRALEUROPE 852 CP852 IBM852 CSPCP852 MACCROATIAN Chinese (unsorted) CN GB_ ISO-IR-57 ISO646-CN CSISO57GB1988 CHINESE GB_ ISO-IR-58 CSISO58GB CN-GB-ISOIR165 ISO-IR-165 CN-GB EUC-CN EUCCN GB2312 CSGB2312 CP936 GBK GB18030 ISO-2022-CN CS ISO2022CNISO-2022-CN-EXT Chinese Simplified HZ HZ-GB-2312 Chinese Traditional EUC-TW EUCTW CSEUCTWB IG-5 BIG-FIVE BIG5 BIGFIVE CN-BIG5 CSBIG5 CP950 BIG5-HKSCS BIG5HKSCS Version Unica Confidential 307

308 : Cyrillic CYRILLIC ISO ISO-IR-144 ISO ISO_ ISO_8859-5:1988 CSISOLATINCYRILLIC CP1251 MS-CYRL WINDOWS-1251 MACCYRILLIC KOI8-R CSKOI8R KOI8-U KOI8-RU KOI8-T 866 CP866 IBM866 CSIBM CP855 IBM855 CSIBM855 CP1125 ("PC, Cyrillic, Ukrainian") MACUKRAINE English ANSI_X ANSI_X ASCII CP367 IBM367 ISO-IR-6 ISO646-US ISO_646.IRV:1991 US US-ASCII CSASCII 437 CP437 IBM437 CSPC8CODEPAGE437 Georgian GEORGIAN-ACADEMY GEORGIAN-PS Greek CP1253 MS-GREEK WINDOWS-1253 ECMA-118 ELOT_928 GREEK GREEK8 ISO ISO-IR-126 ISO ISO_ ISO_8859-7:1987 CSISOLATINGREEK MACGREEK CP CP-GR CP 869 IBM869 CSIBM869 Hebrew HEBREW ISO ISO-IR-138 ISO ISO_ ISO_8859-8:1988 CSISOLATINHEBREW 308 Unica Confidential Affinium Campaign Installation Guide

309 Supported encodings CP1255 MS-HEBR WINDOWS CP862 IBM862 CSPC862LATINHEBREW MACHEBREW Iceland MACICELAND 861 CP-IS CP861 IBM861 CSIBM861 Japanese JISX JIS_X0201 X0201 CSHALFWIDTHKATAKANA ISO-IR-87 JIS0208 JIS_C JIS_X0208 JIS_X JIS_X X0208 CSISO87JISX0208 ISO-IR-159 JIS_X0212 JIS_X JIS_X X0212 CSISO159JISX EUC-JP EUCJP EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE CSEUCPKDFMTJAPANESE MS_KANJI SHIFT-JIS SHIFT_JIS SJIS CSSHIFTJI ISO-IR-14 ISO646-JP JIS_C RO JP CSISO14JISC6220RO CP932 ISO-2022-JP CSISO2022JP ISO-2022-JP-1 ISO-2022-JP-2 CSISO2022JP2 Korean Lao EUC-KR EUCKR CSEUCKR CP949 UHC ISO-IR-149 KOREAN KSC_5601 KS_C_ KS_C_ CSKSC CP1361 JOHAB ISO-2022-KR CSISO2022KR Note that Lao is similar to Thai; it uses the same alphabet. MULELAO-1 CP1133 IBM-CP1133 Version Unica Confidential 309

310 : Northern Europe ISO ISO-IR-110 ISO ISO_ ISO_8859-4:1988 L4 LATIN4 CSISOLATIN4 ISO ISO-IR-157 ISO ISO_ ISO_ :1992 L6 LATIN6 CSISOLATIN6 Romanian MACROMANIA Southern Europe Thai ISO ISO-IR-109 ISO ISO_ ISO_8859-3:1988 L3 LATIN3 CSISOLATIN3 CP853 MACTHAI ISO-IR-166 TIS-620 TIS620 TIS620-0 TIS TIS TIS CP874 WINDOWS-874 Turkish CP1254 MS-TURK WINDOWS-1254 MACTURKISH 857 CP857 IBM857 CSIBM857 ISO ISO-IR-148 ISO ISO_ ISO_8859-9:1989 L5 LATIN5 CSISOLATIN5 Vietnamese CP1258 WINDOWS-1258 TCVN TCVN-5712 TCVN TCVN5712-1:1993 VISCII VISCII1.1-1 CSVISCII 310 Unica Confidential Affinium Campaign Installation Guide

311 Useful links Western Europe CP819 IBM819 ISO ISO-IR-100 ISO ISO_ ISO_8859-1:1987 L1 LATIN1 CSISOLATIN1 CP1252 MS-ANSI WINDOWS CP850 IBM850 CSPC850MULTILINGUAL MAC MACINTOSH MACROMAN CSMACINTOSH NEXTSTEP HP-ROMAN8 R8 ROMAN8 CSHPROMAN8 Miscellaneous ISO ISO-IR-203 ISO ISO_ ISO_ :1998 ISO ISO-IR-226 ISO ISO_ ISO_ :2000 CP858 (IBM: "Multilingual with euro") 860 CP860 IBM860 CSIBM860 (IBM: "Portugal - Personal Computer") 863 CP863 IBM863 CSIBM863 (IBM: "Canadian French - Personal Computer") 865 CP865 IBM865 CSIBM865 (IBM: "Nordic - Personal Computer") Useful links This section provides links to internet resources on the following topics: Character encodings Languages Internationalization (general) Java-specific Character encodings ISO-8859, used with UNIX variants Version Unica Confidential 311

312 : EUC encodings sometimes used for large Asian languages Microsoft localized operating system list This is very useful for finding the code page used for a specific language. ANSI code pages are used in regular Windows applications. OEM code pages are used in DOS windows. Microsoft ANSI code page charts Remember that all Microsoft products (operating systems, databases, etc) use these code pages. IBM code pages 1.ibm.com/servers/eserver/iseries/softwareglobalization/codepa ges.html Some IBM code page numbers intersect with Microsoft numbers, but most don't. DB2 uses IBM code pages. See db2set DB2CODEPAGE. Unicode Consortium I18N Gurus Character Encoding section General references Wikipedia ( is a good source of information about the more widely-used encodings. A general search engine like Google ( is a last resort, but it's not bad. Languages Thai English to Thai dictionary Unica Confidential Affinium Campaign Installation Guide

313 Useful links Basic Concept of Thai Language An annotated reference to the Thai implementations (old, but still useful) i18n Gurus Hebrew i18n Gurus Website with many Hebrew words Korean An Introduction to Korean Internationalization (general) Microsoft GlobalDev This site is good for: MS Input Method Editors (IMEs) Keyboard layouts The AppLocale tool The Microsoft-centric view of international development CJKV, the ultimate I18N book. Contains far more than you ever wanted to know. Also see the author's home page ( errata and updates to links. Version Unica Confidential 313

314 : Java-specific Note that links to Java API documentation expire frequently because they are version-specific. Java SimpleDateFormat class (for setting the DatePattern resource) Locale IDs for Java: This is a link to the page you reach by following this path: JDK docs home -> Internationalization link -> Supported Locales link 314 Unica Confidential Affinium Campaign Installation Guide

315 C ACTIVE X CLEANUP UTILITY This appendix provides information on the Affinium Campaign Active X cleanup utility. This appendix includes the following topics: Overview of the Active X cleanup utility Utility usage Overview of the Active X cleanup utility The Affinium Campaign Active X cleanup utility, uacflchk.exe, is designed to resolve Object not Loaded / Object does not support this property or method errors when a user tries to access Campaign pages with Active X controls. This problem most often occurs when the files needed to run Active X are not downloaded to the Windows Downloaded Program Files directory. Affinium Campaign Installation Guide Unica Confidential 315

316 : The utility runs in two modes: check and clean. You should run the utility in check mode first, to ensure that you take any necessary action before running the tool in clean mode. Affinium Campaign installs with a number of other utilities. For a complete description of these utilities, see the Affinium Campaign Administrator s Guide. Location of the utility The uacflchk.exe file is located in the tools\win32 directory under your Affinium Campaign installation. Prerequisites for running the utility Utility usage The utility must have access to the file system and registry of the machine where you want to perform the cleanup. Copy it to the machine where you want to perform the cleanup or run it from a mapped drive. You must close all browser windows before running the tool. This section describes the syntax and options for running the uacflchk utility. Syntax uacflchk uacflchk /clean uacflchk /clean /q 316 Unica Confidential Affinium Campaign Installation Guide

317 Utility usage Options No option (check mode) Returns a listing of the relevant registry entries, dependencies, conflicting files, and missing files. These messages tell you where the problem lies, so you can take the appropriate action. You should run the utility in check mode first, to ensure that you take any necessary action before running the tool in clean mode. Possible messages and the actions you should take are listed in the following table. Message This means Do this Message This means Do this Message This means Do this Message This means Do this Message This means Do this Control not yet downloaded. The Active X control is not in the IE View Objects list. Do nothing. Found <file> as <path>. The file is registered in the path noted. Run the tool in cleanup mode. Found conflicting files in <path>. An installed file was found in an unexpected location. This will probably not cause a problem but is reported for your information. Could not delete file/directory. A file or directory delete operation could not be performed. Either the user does not have sufficient privileges to delete the file/directory, or the file/directory is in use. Ensure that the user has sufficient privileges for the operation and shut down any application that may be accessing the file. Could not obtain download information. An attempt to query the registry for download information failed. Ensure that the user has sufficient privileges to access the registry and that the registry is not corrupt. Version Unica Confidential 317

318 : Message This means Do this Found wrong dependency. A previous download was found but contained unexpected files. Contact Unica Technical Support. See Unica technical support on page 14 for details. /clean Search for Active X components in the Windows registry entries and file system. Asks whether to delete registry entries and files under %WINDIR\Downloaded Program Files. Other files will be reported but not deleted as they probably will not cause any problems. When used with the /q option, deletes without prompts. /q Delete files and registry entries without prompting. Used with the \clean option. 318 Unica Confidential Affinium Campaign Installation Guide

319 GLOSSARY A ACO Affinium Campaign Affinium Campaign Collaborate Affinium Campaign emessage Affinium Campaign Interact Affinium Campaign Optimize See Affinium Campaign Optimize. Software that provides a complete set of campaign management capabilities that allow marketers to create, test, optimize, deploy and analyze multi-wave, crosschannel marketing campaigns quickly and easily. Marketing campaigns can be simulated before execution, enabling a marketer to project anticipated ROI results. Software that enables marketing organizations to distribute the execution of centrally managed marketing campaigns throughout the enterprise to agents, branch managers, field sales, etc. It also allows organizations to ensure that corporate business rules and best practices are enforced while allowing execution and controlled customization. An application that enables marketers to create, preview, test, execute, and track personalized communications. It provides reports on key measurements such as click-throughs, opt-outs, and undeliverable messages. With emessage, marketing can be coordinated with other marketing efforts. A real-time personalization application that allows marketers to utilize data from all customer interactions to provide the right level of personalization and most effective offer, content, or service to individuals across all real-time channels. It combines predictive analysis, current interaction context and business objectives and rules to deliver powerful personalization. A world-class optimization application that enables marketers to determine the optimal interaction strategy for each customer over time. It looks across selected marketing campaigns, offers, and touch points to respect customer privacy, limit Affinium Campaign Installation Guide Unica Confidential 319

320 Chapter : contact fatigue, prevent conflicting offers, meet channel or inventory capacity limitations, and maximize marketing ROI and profitability. Affinium Model Affinium Plan Affinium Manager AM Unica s award-winning data-mining and predictive analysis application that provides segmentation and profiling, valuation, response modeling, and cross selling features to solve specific marketing problems. It is the only data-mining product that automates the model building and optimization process. This capability allows you to very quickly create very accurate predictive models. A marketing planning application which empowers the entire marketing team to define, coordinate, resolve, automate, simulate, and monitor various marketing plans, programs and tasks across initiatives. Affinium Plan eases organizational collaboration and provides real-time visibility into all marketing activities within an organization. This means marketers achieve improved decision making, collaboration program management, enhanced financial management, and increased productivity and performance. Software that provides centralized management and control of authentication and security for the Affinium suite. It is a repository that stores information such as user passwords, user group privileges, and data source credentials. See Affinium Manager. C campaign channel Collaborate command contact A related selection and execution of activities to achieve marketing communication or sales objectives. A means of contacting, being contacted by, or interacting with a customer or prospect as part of a campaign. Examples include direct mail, telemarketing, fax, customer service or support, point-of-sale, , and Web sites. See Affinium Campaign Collaborate. Typed instructions used to run a piece of software. Commands are typed into a command-line interface and used instead of clicking or double-clicking an icon. A customer or prospect interaction via a channel during a campaign. Examples might include receiving a direct-mail item, getting a telemarketing call, receiving a fax, being told of a special coupon offer at a point of sale, phoning technical support, etc. 320 Unica Confidential Affinium Campaign Installation Guide

321 cross-selling Identifying customers who are the best prospects for the purchase of additional products and services and for upgrading their existing products and services. The goal is to increase share of wallet. Revenue can increase immediately, but loyalty is typically enhanced as well due to increased customer involvement. D data data mart data model data source Values collected through record keeping or by polling, observing, or measuring, typically organized for analysis or decision-making. More simply, data are facts, transactions, and figures. A subset of a data warehouse that focuses on one or more specific areas. The data usually is extracted from the data warehouse and further de-normalized and indexed to support intense usage in support of a specific application, such as campaign management or analytics. The structure in which a piece of software stores information. In a relational database, data models are built from tables. A data model shows what kinds of information an application can store and process. Any system for storing and delivering very large quantities of data. E EMM Enterprise Marketing Management See Enterprise Marketing Management. EMM software applications enable you to realize more effective and efficient marketing efforts by touching on all the key areas of marketing, including customer relationship management, brand and product management, strategic planning, and resource management. O offer An offer is the entire package that a customer may buy. It may include guarantees, bonuses, price reductions, or other incentives. Version Unica Confidential 321

322 Chapter : P path A filename that is fully specified relative to the root directory (as opposed to the current directory). For example, C:\affinium\bin. This is also called a pathname. S T transcoding Transcoding means converting between different character encodings. In Affinium Campaign, transcoding is performed for many different reasons. For example, transcoding may take place when the database encoding is different from Affinium Campaign s internal encoding (UTF-8), or when log files need to be written in a language other than English. U UDI Universal Dynamic Interconnect V valuation variable See Universal Dynamic Interconnect. Universal Dynamic Interconnect, or UDI, is a technology that provides simultaneous connectivity to existing databases and flat files. Data from multiple sources can be used together within a single campaign, as long as a common identifier or translation is available. Predicting the monetary value and profitability of a particular customer over time, enabling organizations to target desirable customers and allocate marketing resources strategically and cost-effectively A symbol that can hold different values at different times. For example, the variable username may contain the value cgrant when Cary Grant is working with the software, and later may contain bjones when Brigitte Jones logs in. 322 Unica Confidential Affinium Campaign Installation Guide

323 Index A acoinstalled 281 Active X cleanup 315 adminfilegroup 287 adminfilepermissions 288 agfprocessnameoutput 278 allowallusers 220 allowduplicatecellcodes 278 allowgroups 221 AllowSegmentUsingSQLCase 241 AllowTempTables 241 allowvariablelengthcodes 290 analysissectionfolder 235 ASMSaveDBAuthentication 242 ASMUserForDBCredentials 242 authenticationmode 232 authenticationnamespace 233 autosavefrequency 280 B BulkInsertBlockSize 243 BulkReaderBlockSize 243 C Campaign server, starting 62 64, 113 Campaign system user, adding 50 51, campaignanalysistabcachedfolder 236 campaignanalysistabondemandfolder 236 campaigndatattlseconds 227 campaigndetailpageuri 225 campcodeformat 290 campcodegenprogfile 291 catalogfolderpermissions 288 cellcodeformat 292 cellcodegenprogfile 292 channeldatattlseconds 226 checkpointfrequency 280 comparecasesensitive 272 ConnectionCacheSize 243 createfolderpermissions 288 currencylocale (Campaign) 223 D datasourcename 233 DateOutputFormatString 245 DateTimeFormat 246 DateTimeOutputFormatString 247 defaultgenerator 272 defaultinputdirectory 277 defaultlocale (Campaign) 223 defaultoutputdirectory 277 DefaultScale 247 delayexittimeout 293 DeleteAsRecreate 247 deployment 64 65, on WebLogic console 65, 115 on WebSphere 64, 114 DisallowTempTableDirectCreate 248 dispatchurl 232 displayname 224 displayofferversioncodes 292 domain 233 DSN 248 DSNUsingOSAuthentication 250 E emessageinstalled 281 enableformauthentication 233 enablelogging 282 EnableSelectDistinct 250 Affinium Campaign Installation Guide Unica Confidential 323