Home
Administrator Guides
Administrator Guide
HCL Unica configuration properties
This section describes the configuration properties found on the Settings & Configuration page.
Unica Campaign configuration properties
The configuration properties for Unica Campaign are located at Settings > Configuration.
Campaign | FlowchartEvents
The properties in this category pertain to Unica Director.
Campaign | FlowchartEvents
The properties in this category pertain to Unica Director.

Administrator Guides
- Administrator Guide
  - Unica Platform features
    Unica Platform provides security, configuration, notification, and dashboard features for Unica products.
  - HCL Unica user account management
    You can manage the attributes of user accounts created using Unica Platform user interface, which we refer to as internal accounts. This is in contrast to external user accounts, which are imported from an external system such as an LDAP server or web access control system.
  - Security management
    Unica Platform supports roles and permissions to control user access to objects and features in Unica applications.
  - Configuration management
    When Unica is first installed, the Configuration page shows only the properties used to configure Unica Platform and some global configuration properties. When you install additional Unica applications, the properties used to configure these applications are registered with Unica Platform. These properties are then shown on the Configuration page, where you can set or modify their values.
  - Dashboard management
    Dashboards are configurable pages that contain information useful to groups of users who fill various roles within your company. The components that make up dashboards are called portlets. Dashboards can contain pre-defined portlets or portlets that you create.
  - The HCL Unica Scheduler
    The Unica Scheduler enables you to configure a process to run at intervals that you define.
  - SAML 2.0 based federated authentication
    Unica Platform implements a SAML 2.0 based Identity Provider (IdP) that enables a single sign-on federation among Unica products or between Unica products and third party applications.
  - SAML 2.0 single sign-on
    Unica Platform supports SAML 2.0 based single sign-on.
  - Configuring JWT authentication between applications
    JSON web token (JWT) authentication is used for Journey Designer+Unica Campaign. JWT authentication allows single sign-on between applications.
  - Single sign-on between HCL Unica and IBM Digital Analytics
    If your organization uses IBM Digital Analytics, you can enable single sign-on between Digital Analytics and Unica.
  - Integration between HCL Unica and Windows Active Directory
    Unica Platform can be configured to integrate with Windows™ Active Directory server or another LDAP (Lightweight Directory Access Protocol) server. By integrating Unica with a directory server, you can maintain users and groups in one centralized location. Integration provides a flexible model for extending the enterprise authorization policies into Unica applications. Integration reduces support costs and the time needed to deploy an application in production.
  - Integration between HCL Unica and LDAP servers
    Unica Platform can be configured to integrate with Windows™ Active Directory server or another LDAP (Lightweight Directory Access Protocol) server. By integrating Unica with a directory server, you can maintain users and groups in one centralized location. Integration provides a flexible model for extending the enterprise authorization policies into Unica applications. Integration reduces support costs and the time needed to deploy an application in production.
  - Integration with web access control platforms
    Organizations use web access control platforms to consolidate their security systems, which provide a portal that regulates user access to web sites. This section provides an overview of Unica integration with web access control platforms.
  - Alert and notification management
    Unica Platform provides support for system alerts and user notifications sent by Unica products.
  - Implementation of one-way SSL
    This section describes one-way SSL in Unica.
  - Security framework for HCL Unica APIs
    Unica Platform provides the security framework for the APIs implemented by Unica products.
  - Data filter creation and management
    Data filters make it possible to restrict the customer data that an Unica user can view and work with in Unica applications. You can think of the data you secure with a data filter as a data set defined by the fields in your customer tables that you specify.
  - Audit event tracking in HCL Unica
    You can configure which audit events are tracked and assign a severity level to each tracked event.
  - The Unica Platform system log
    You should check the system log first if the Unica Platform application malfunctions. The system log is independent of the security audit information, which is stored in the system tables. While the system log tracks some of the same information contained in the security audit reports, it also contains information useful in troubleshooting Unica Platform.
  - Unica Platform utilities
    This section provides an overview of the Unica Platform utilities, including some details that apply to all the utilities and which are not included in the individual utility descriptions.
  - HCL Unica configuration properties
    This section describes the configuration properties found on the Settings & Configuration page.
    - Unica Platform configuration properties
      This section describes the Unica Platform configuration properties on the Configuration page.
    - Digital Analytics configuration properties
      This section describes the Digital Analytics configuration properties on the Configuration page.
    - Report configuration properties
      The report configuration properties for Unica are at Settings > Configuration > Reports.
    - Unica Plan configuration properties
      This section describes the Unica Plan configuration properties on the Settings > Configuration page.
    - Unica Campaign configuration properties
      The configuration properties for Unica Campaign are located at Settings > Configuration.
      - Campaign
        To specify the locales and component applications that your installation supports, choose Settings > Configuration, then click the Unica Campaign category.
      - Campaign | FlowchartEvents
        The properties in this category pertain to Unica Director.
        Campaign | FlowchartEvents
        The properties in this category pertain to Unica Director.
      - Campaign | collaborate
        The properties in this category pertain to Unica Collaborate configuration.
      - Campaign | navigation
        Some of the properties in this category are used internally and should not be changed.
      - Campaign | caching
        Certain objects, such as offers, are cached in the web application server to improve response times in the Unica Campaign user interface. The Campaign|caching configuration properties specify the length of time that cached data is retained. Smaller values result in more frequent cache updates, which can adversely affect performance by consuming processing resources on both the web server and the database.
      - Campaign | partitions
        This category contains properties to configure Unica Campaign partitions, including the default partition, which is named partition1.
      - Campaign | partitions | partition[n] | eMessage
        Define properties in this category to define characteristics of recipient lists and specify the location of resources that upload the lists to IBM Hosted Services.
      - Campaign | partitions | partition[n] | Unica Deliver | contactAndResponseHistTracking
        Use the properties in this category to configure IBM eMessage offer integration with Unica Campaign for the current partition.
      - Campaign | partitions | partition[n] | Engage
        These properties control authentication and data exchange between Unica Campaign and Engage if the products are integrated.
      - Campaign | partitions | partition[n] | Engage | contactAndResponseHistTracking
        These properties specify the ETL of events that are downloaded from UBX in the Unica Campaign history tables.
      - Campaign | partitions | partition[n] | UBX
        These properties control authentication and data exchange between Unica Campaign, Engage, and UBX if the products are integrated.
      - Campaign | partitions | partition[n] | UBX | Event Download Schedule
        These properties specify the schedule for when events are downloaded from UBX into Unica Campaign.
      - Campaign | partitions | partition[n] | Coremetrics
        The properties in this category specify integration settings for Digital Analytics and Unica Campaign for the selected partition.
      - Campaign | partitions | partition[n] | reports
        The Campaign | partitions | partition[n] | reports property defines the different types of folders for reports.
      - Campaign | partitions | partition[n] | validation
        The Validation Plugin Development Kit (PDK), delivered with Unica Campaign, allows third parties to develop custom validation logic for use in Unica Campaign. Properties in the partition[n] > validation category specify the classpath and class name of the custom validation program, and an optional configuration string.
      - Campaign | partitions | partition[n] | audienceLevels | audienceLevel
        Do not edit properties in this category. These properties are created and populated when a user creates audience levels on the Administration page in Unica Campaign.
      - Campaign | partitions | partition[n] | audienceLevels | audienceLevel | field[n]
      - Campaign | partitions | partition[n] | dataSources
        The properties in Campaign|partitions|partition[n]|dataSources determine how Unica Campaign interacts with databases, including its own system tables, for the specified partition.
      - Campaign | partitions | partition[n] | systemTableMapping
        Properties in the 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.
      - Campaign | partitions | partition[n] | server
        This category contains properties to configure the Unica Campaign server for the selected partition.
      - Campaign | partitions | partition[n] | server | systemCodes
        Properties in this category specify, for Unica Campaign, whether variable length codes are allowed, the format and generator of the campaign and cell codes, whether offer codes are displayed, and the offer code delimiter.
      - Campaign | partitions | partition[n] | server | encoding
      - Campaign | partitions | partition[n] | server | timeout
      - Campaign | partitions | partition[n] | server | collaborate
        This category applies to Unica Collaborate.
      - Campaign | partitions | partition[n] | server | spss
        Properties in this category affect IBM SPSS Modeler Advantage Enterprise Marketing Management Edition integration for the specified partition in Unica Campaign.
      - Campaign | partitions | partition[n] | server | permissions
        The properties in this category specify the permissions for folders that are created by Unica Campaign and the UNIX™ group and permissions for files in the profile directory.
      - Campaign | partitions | partition[n] | server | flowchartConfig
        Properties in this category specify the behavior of the Unica Campaign Generated Field, whether duplicate cell codes are allowed, and whether the Log to Contact History option defaults to enabled.
      - Campaign | partitions | partition[n] | server | flowchartSave
        The properties in this category specify the default settings for the auto-save and checkpoint properties of a new Unica Campaign flowchart.
      - Campaign | partitions | partition[n] | server | dataProcessing
        Properties in this category specify how Unica Campaign handles string comparisons and empty fields in flat files, and the behavior of the macro STRING_CONCAT.
      - Campaign | partitions | partition[n] | server | optimization
        Properties in this category control Unica Campaign server optimization for each partition.
      - Campaign | partitions | partition[n] | server | logging
        Properties in this category affect flowchart logging behavior for the specified partition on the Unica Campaign server.
      - Campaign | partitions | partition[n] | server | flowchartRun
        Properties in this category specify how many errors are allowed in a Unica 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.
      - Campaign | partitions | partition[n] | server | profile
        Properties in this category specify the maximum number of categories that are created during profiling for numeric and text values in Unica Campaign.
      - Campaign | partitions | partition[n] | server | internal
        Properties in this category specify integration settings and the internalID limits for the selected Unica Campaign partition. If your Unica Campaign installation has multiple partitions, set these properties for each partition that you want to affect.
      - Campaign | partitions | partition[n] | server | fileDialog
        Properties in this category specify the default directories for Unica Campaign input and output data files.
      - Campaign | partitions | partition[n] | offerCodeGenerator
        Properties in this category specify the class, classpath, and configuration string for the offer code generator, and also the cell code generator used to assign a contact process to a Target Cell Spreadsheet cell.
      - Campaign | monitoring
        Properties in the this 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.
      - Campaign | ProductReindex
        The creator of an offer can specify the products that are associated with that offer. When the list of products available for association with offers changes, the offer/product associations must be updated. Properties in the Unica Campaign > ProductReindex category specify the frequency of these updates and the time of day that the first update runs.
      - Campaign | unicaACListener
        If you are configuring a single-node listener cluster, use this category, and only this category, to define configuration settings for your non-clustered listener. For clustered listeners, the properties in this category pertain to all of the listener nodes in the cluster, except for the following properties, which are ignored: serverHost, serverPort, useSSLForPort2, serverPort2. (Instead, set these properties for each individual node, under Campaign|unicaACListener|node[n].)
      - Campaign | unicaACListener | node [n]
        A non-clustered listener configuration should not have any nodes under this category. Nodes are created and used only for clustered listener configurations. For a clustered listener configuration, configure an individual child node for each listener in the cluster.
      - Campaign | campaignClustering
        Set these properties if you have a clustered listener configuration. Set these properties once per instance of Unica Campaign; you do not need to set them for every partition.
      - Campaign | unicaACOOptAdmin
        These configuration properties define settings for the unicaACOOptAdmin tool.
      - Campaign | server
        The property in this category specifies a URL that is used internally, and does not need to be changed.
      - Campaign | logging
        This category specifies the location of the Unica Campaign log4jConfig properties file.
      - Campaign | proxy
        The Unica Campaign, Engage, and UBX integration is supported with outbound proxy connections.
    - Unica Deliver configuration properties
    - Unica Interact configuration properties
    - Unica Optimize configuration properties
      This section describes the Unica Optimize configuration properties that are found on the Configuration page.
    - Distributed Marketing configuration properties
      This section describes the Unica Collaborate configuration properties on the configuration page.
    - IBM SPSS Modeler Advantage Enterprise Marketing Management Edition configuration properties
      Properties in this category specify values that are used to configure Unica for single sign-on with IBM SPSS Modeler Advantage Enterprise Marketing Management Edition.
    - Opportunity Detect and Unica Interact Advanced Patterns configuration properties
      This section describes the Opportunity Detect and Unica Interact Advanced Patterns configuration properties on the Configuration page.
    - Unica Centralized Offer Management configuration properties
    - Unica Asset Picker configuration properties
      To use Asset Picker in Unica Centralized Offer Management, you must configure it in Unica Platform.
    - BIRT Reports configuration properties
  - Customization of stylesheets and images in the HCL Unica user interface
    You can customize the appearance of the user interface where most Unica product pages appear. By editing a cascading style sheet and providing your own graphics, you can change many of the images, fonts, and colors in the user interface.
  - Adding internal user accounts
    Use this procedure to add internal user accounts.
  - Deleting internal user accounts
    Use this procedure to delete internal user accounts.
  - Changing internal user password expiration dates
    Use this procedure to change password expiration dates for internal users.
  - Resetting internal user passwords
    Use this procedure to reset internal user passwords.
  - Adding internal user data sources
    Use this procedure to add data sources for internal users.
  - Changing internal user account properties
    Use this procedure to change the properties of internal user account.
  - Changing internal user system status
    Use this procedure to change the system status of internal users.
  - Deleting internal user data sources
    Use this procedure to delete internal user data sources.
  - The user management pages
    Refer to this table if you need help completing the fields on the Users page.
  - Resetting internal user passwords
    Use this procedure to reset internal user passwords.
  - Changing internal user data sources internal user data sources
    Use this procedure to change data source passwords or login names.
  - Locale preference
    You can set the locale for both internal and external users. This setting affects the display of language, time, numbers, and dates in Unica applications.
  - The default user locale preference
    Unica Platform contains a default locale attribute that applies to all Unica applications that implement it.
  - restoreAccess
    The restoreAccess utility allows you to restore access to Unica Platform if all users with PlatformAdminRole privileges have been inadvertently locked out or if all ability to log in to the Unica Platform has been lost.
  - Cross-partition administration privileges
    In a multi-partition environment, at least one user account with the PlatformAdminRole role in Unica Platform is required, to enable you to administer security for Unica users across all partitions.
  - Types of groups: internal and external
    When Unica is integrated with an external server (such as a supported LDAP server or a web access control system), it supports two types of groups: internal and external.
  - Partitions and security management
    Partitions in Unica Campaign and related products provide a way to secure the data associated with different groups of users. With partitioning, a user's partition appears as if it were a separate running instance of Unica Campaign, with no indication that other partitions are running on the same system. This section describes special security management considerations in a multi-partition environment.
  - Pre-configured users and roles
    When Unica is first installed, three users are pre-configured and are assigned system-defined roles in Unica Platform and Unica Campaign, as described in this section.
  - Overview of managing user application access in Unica Platform
    Using Unica Platform security administration features to manage user application access is a multi-step process. The following procedure provides an overview of the basic process, which is described in detail in the remainder of this guide.
  - Adding an internal group
    Use this procedure to add an internal group.
  - Adding a subgroup
    Use this procedure to add an internal subgroup.
  - Deleting a group or subgroup
    Remember, when you delete a group or subgroup, members of the group lose the roles assigned to that group, and any parents of that group also lose those role assignments, unless the roles are also explicitly assigned to the parents.
  - Assigning a group to a partition
    This procedure is necessary only if multiple partitions are configured for Unica Campaign. Only an account with the PlatformAdminRole role, such as the platform_admin user, can perform this task.
  - Adding a user to a group or subgroup
    Use this procedure to add a user to a group or subgroup.
  - Removing a user from a group or subgroup
    Use this procedure to remove a user from a group or subgroup.
  - Changing a group or subgroup description
    Use this procedure to change a group or subgroup description.
  - The user group management pages
    These are the fields you use to configure user groups.
  - Creating a role
    You should create new roles only for products that have detailed permissions. The reporting function and some Unica products have only basic permissions available, so there is no need to create additional roles for these products.
  - Modifying role permissions
    Use this procedure to modify role permissions.
  - Removing a role from the system
    Use this procedure to remove a role from Unica.
  - Assigning a role to or removing a role from a group
    If you add a role to a group or remove a role from a group, members of that group acquire or lose that role.
  - Assigning a role to or removing a role from a user
    Use the Edit roles window to assign a role to or to remove a role from a user.
  - Definitions of permission states
    For each role, you can specify which permissions are granted, not granted, or denied. You set these permissions on the Settings > User roles and permissions page.
  - Permissions for products that use only basic roles
    The following table describes the functional definitions of the roles available for the Unica products that use only the basic roles. See the product documentation for additional information.
  - Permissions for Unica Platform
    The following table describes the permissions you can assign to roles in Unica Platform.
  - Permissions for Opportunity Detect
    The following table describes permissions that you can assign to roles in Opportunity Detect.
  - HCL Unica configuration properties
    This section describes the configuration properties found on the Settings & Configuration page.
  - Configuration management
    When Unica is first installed, the Configuration page shows only the properties used to configure Unica Platform and some global configuration properties. When you install additional Unica applications, the properties used to configure these applications are registered with Unica Platform. These properties are then shown on the Configuration page, where you can set or modify their values.
  - Templates for duplicating categories
    The properties for an Unica application are registered with Unica Platform when the application is installed. When an application requires users to create duplicate categories for configuration purposes, a category template is provided.
  - Category naming restrictions
  - Creating a category from a template
    Use this procedure to create a category from a template on the Configuration page.
  - Navigating to a category
    Use this procedure to navigate to a category on the Configuration page.
  - Editing property values
    Use this procedure to modify a property value on the Configuration page.
  - Templates for duplicating categories
    The properties for an Unica application are registered with Unica Platform when the application is installed. When an application requires users to create duplicate categories for configuration purposes, a category template is provided.
  - Category naming restrictions
  - Assigning or changing a dashboard administrator
    Use this procedure to assign or change a dashboard administrator.
  - The dashboard administrator
    If you have been designated a dashboard administrator, you are responsible for managing the membership, layout, and content of that dashboard. This section describes how to manage dashboard membership.
  - Pre-defined portlets
    Unica provides two types of pre-defined dashboard portlets, which you can enable and then add to any dashboard you create.
  - Custom portlet types and availability
    You can create portlets from the following types of Unica pages.
  - Adding a pre-defined portlet to a dashboard
    Use this procedure to add a pre-defined portlet to a dashboard.
  - Adding a custom portlet to a dashboard
    Perform this procedure to add a custom portlet to a dashboard.
  - Scheduling a dashboard report
    To schedule a dashboard report (either a pre-defined or user-created portlet), you must first create a view and schedule it, and then configure the portlet as described here.
  - Adding a pre-defined portlet to a dashboard
    Use this procedure to add a pre-defined portlet to a dashboard.
  - Dashboards and partitions
    If you are administering dashboards in a multi-partition environment, read this section to understand how multiple partitions affect dashboards.
  - Partitions and security management
    Partitions in Unica Campaign and related products provide a way to secure the data associated with different groups of users. With partitioning, a user's partition appears as if it were a separate running instance of Unica Campaign, with no indication that other partitions are running on the same system. This section describes special security management considerations in a multi-partition environment.
  - Dashboard management
    Dashboards are configurable pages that contain information useful to groups of users who fill various roles within your company. The components that make up dashboards are called portlets. Dashboards can contain pre-defined portlets or portlets that you create.
  - Custom portlets
    Topics in this section describe how to create and use custom portlets.
  - Enabling or disabling pre-defined portlets
    Perform this task before you begin to create dashboards. You should enable only those portlets that reference Unica products that you have installed.
  - Creating a pre-assembled dashboard
    Use this procedure to create a pre-assembled dashboard.
  - Single sign-on between HCL Unica and IBM Digital Analytics
    If your organization uses IBM Digital Analytics, you can enable single sign-on between Digital Analytics and Unica.
  - Implementation of one-way SSL
    This section describes one-way SSL in Unica.
  - Preparing the URL from a Digital Analytics report
    Use this procedure for Digital Analytics reports.
  - The Create Custom Portlet page
    Refer to this table if you need help completing the fields on the Custom Portlet page.
  - Dynamic tokens
    When you define a custom dashboard portlet, you can use pre-defined tokens that are replaced with the values stored in Unica Platform for the current user when the portlet is invoked.
  - The dashboard administrator
    If you have been designated a dashboard administrator, you are responsible for managing the membership, layout, and content of that dashboard. This section describes how to manage dashboard membership.
  - Granting or removing dashboard membership
    Use this procedure to grant or remove dashboard membership.
  - Adding a pre-defined portlet to a dashboard
    Use this procedure to add a pre-defined portlet to a dashboard.
  - The Manage Portlets page
    Refer to this table if you need help completing the fields in the Manage Portlets page.
  - Dashboards and partitions
    If you are administering dashboards in a multi-partition environment, read this section to understand how multiple partitions affect dashboards.
  - Enabling or disabling pre-defined portlets
    Perform this task before you begin to create dashboards. You should enable only those portlets that reference Unica products that you have installed.
  - Creating a dashboard that is not pre-assembled
    Use this procedure to create a dashboard that is not pre-assembled
  - Creating a pre-assembled dashboard
    Use this procedure to create a pre-assembled dashboard.
  - Overview of working with dashboards in a multi-partition environment
    When you have multiple partitions configured, follow these guidelines when you set up dashboards.
  - Quick link portlets
    Quick links are pre-defined links to Unica products. Some quick links enable users to perform basic actions in the Unica product within the dashboard, without navigating to the product. You can configure portlets that contain a set of quick links that you choose.
  - Creating a quick link portlet
    Use this procedure create a quick link portlet.
  - Preparing the URL from a Digital Analytics for On Premises report
    Use this procedure for reports in a Digital Analytics for On Premises installation.
  - Preparing the URL from an IBM Cognos dashboard report
    The format of an IBM® Cognos® dashboard portlet URL is as follows.
  - Preparing the URL from a Digital Analytics report
    Use this procedure for Digital Analytics reports.
  - Adding a custom portlet to a dashboard
    Perform this procedure to add a custom portlet to a dashboard.
  - Overview of the portlet creation process
    This section provides an overview of the steps for creating a portlet, which are described in detail elsewhere in this guide.
  - Scheduling a dashboard report
    To schedule a dashboard report (either a pre-defined or user-created portlet), you must first create a view and schedule it, and then configure the portlet as described here.
  - Preparing the URL from an IBM Cognos dashboard report
    The format of an IBM® Cognos® dashboard portlet URL is as follows.
  - Difference between the Unica Campaign Schedule process and HCL Unica Scheduler
    Starting with the 8.0 release of Unica Platform, the Unica Scheduler is intended to replace the Unica Campaign Schedule process for scheduling runs of an entire flowchart. The Unica Scheduler is more efficient, as it does not consume any server system resources when the flowchart is not actually running.
  - The HCL Unica Scheduler
    The Unica Scheduler enables you to configure a process to run at intervals that you define.
  - Schedule triggers that are sent from an external script
    The Unica Scheduler can respond to triggers sent by an external application. The scheduler_console_client utility enables this feature. This utility issues triggers that can launch one or more schedules set up to listen for that trigger.
  - scheduler_console_client
    Jobs configured in the Unica Scheduler can be listed and kicked off by this utility if they are set up to listen for a trigger.
  - Scheduler throttling
    Throttling is used to manage performance when a large number of processes are likely to place high demands on the system. Throttling is based on scheduler groups that you set up on the Settings > Configuration page. You assign a throttling threshold to a group, and associate schedules with that group.
  - Setting up throttling for the HCL Unica Scheduler
    You must set up a throttling group for each type of object being scheduled.
  - Whitelist prerequisite for external tasks (with FixPack 10.0.0.1 only)
    Only if you have applied Unica Platform FixPack 10.0.0.1, a whitelist prerequisite applies to any external tasks that you create to schedule API calls or scripts.
  - Adding an API to whitelist
    Only if you have applied Unica Platform FixPack 10.0.0.1, perform this procedure before you create any external tasks that schedule an API call.
  - Adding a script to the whitelist
    Only if you have applied Unica Platform FixPack 10.0.0.1, perform this procedure before you create any external tasks that schedule a script.
  - Time zone support
    You can schedule runs to occur in the context of any one of a large number of worldwide time zones.
  - Schedules that depend on completion of multiple runs
    You can configure a schedule to run only when multiple other schedules have finished their runs by using the On completion of other tasks option in the When to start drop down list.
  - To create a schedule wizard
    This section describes in detail the pages you use when you create a schedule.
  - Schedule management
    You can manage all schedules from the Settings > Schedule management page. You must have the Administer Scheduled tasks page permission in Unica Platform to manage schedules.
  - The Schedule management pages
    You access the scheduler management pages by selecting Settings > Schedule Management or by selecting View when scheduled from a flowchart's Run menu.
  - scheduler_console_client
    Jobs configured in the Unica Scheduler can be listed and kicked off by this utility if they are set up to listen for a trigger.
  - Schedule triggers that are sent from an external script
    The Unica Scheduler can respond to triggers sent by an external application. The scheduler_console_client utility enables this feature. This utility issues triggers that can launch one or more schedules set up to listen for that trigger.
  - Creating a category from a template
    Use this procedure to create a category from a template on the Configuration page.
  - Setting up throttling for the HCL Unica Scheduler
    You must set up a throttling group for each type of object being scheduled.
  - SAML 2.0 single sign-on
    Unica Platform supports SAML 2.0 based single sign-on.
  - Setting SAML 2.0 configuration properties
    To configure SAML 2.0 single sign-on, set properties on the Configuration > Settings page.
  - Platform | Security | Login method details | SAML 2.0
    Properties in this category configure single sign-on through a SAML 2.0 IdP server.
  - Setting configuration properties on the Configuration page
    Set configuration properties on the Settings > Configuration page to configure federated authentication in Unica.
  - Platform | Security | Federated authentication
    The properties in this category are used in implementing SAML (Security Assertion Markup Language) 2.0 based federated authentication, which enables single sign-on among diverse applications.
  - Platform | Security | Federated authentication | partitions | partition[n]
    The properties in this category are used in implementing SAML (Security Assertion Markup Language) 2.0 based federated authentication between Unica applications and other and third party applications.
  - Configuring JWT authentication between applications
    JSON web token (JWT) authentication is used for Journey Designer+Unica Campaign. JWT authentication allows single sign-on between applications.
  - Platform | Security | JWT authentication
    JWT authentication is used for Journey Designer+Unica Campaign. JWT authentication allows single sign-on between applications.
  - Setting up single sign-on between HCL Unica and Digital Analytics using manual user account creation
    Use this procedure to set up single sign-on between Unica and Digital Analytics using manual user account creation.
  - Configuring WebLogic for single sign-on between Digital Analytics and HCL Unica
    Perform the procedure below in the WebLogic domain where Unica Platform is deployed to ensure that users can view Digital Analytics reports in dashboards without having to log in.
  - Configuring WebSphere for single sign-on between Digital Analytics and HCL Unica
    Perform the procedure below in WebSphere® cell and node where Unica Platform is deployed to ensure that users can view Digital Analytics reports in dashboards without having to log in.
  - Next steps
    After you install the custom proxy server and import the Digital Analytics certificate, your next steps are to enable single sign-on and configure integration between Digital Analytics and Unica Campaign.
  - Campaign | partitions | partition[n] | Coremetrics
    The properties in this category specify integration settings for Digital Analytics and Unica Campaign for the selected partition.
  - Setting up single sign-on between HCL Unica and Digital Analytics using automatic user account creation
    Use this procedure to set up single sign-on between Unica and Digital Analytics using automatic user account creation.
  - Setting up single sign-on between HCL Unica and Digital Analytics using manual user account creation
    Use this procedure to set up single sign-on between Unica and Digital Analytics using manual user account creation.
  - Digital Analytics configuration properties
    This section describes the Digital Analytics configuration properties on the Configuration page.
  - About Distinguished Names
    To enable directory server integration in Unica, you must determine the Distinguished Name (DN) for a user and for groups. The DN of an object on the directory server is the complete path through the directory server tree structure to that object.
  - Obtaining required information
    Obtain the required information about the directory server with which you want to integrate. You use this information during the configuration process, to store directory server credentials and to set configuration property values.
  - Configuration process roadmap: Active Directory integration
    Use this configuration process roadmap to scan the tasks required to integrate Unica with Windows™ Active Directory. The Topic column provides links to the topics that describe the tasks in detail.
  - The user management pages
    Refer to this table if you need help completing the fields on the Users page.
  - Active Directory integration features
    Unica Platform integration with Windows™ Active Directory provides the features described in this section.
  - Forcing synchronization of external users
    Use this procedure to force synchronization of users when Unica is integrated with an LDAP server or web access control system.
  - LDAP integration features
    Unica Platform integration with LDAP provides the features described in this section.
  - Storing directory server credentials in Unica Platform
    If your directory server does not allow anonymous access, you must configure an Unica user account to hold the user name and password of a directory server user, as described in the following procedure.
  - Unica Platform | Security | Login method details | LDAP
    Properties in this category are used to configure LDAP integration.
  - Setting LDAP login method connection properties in HCL Unica
    LDAP login method properties specify connection details the system uses to connect to the directory server.
  - Setting LDAP synchronization properties
    LDAP synchronization properties specify details that the system uses to log into the directory server and identify users to import. Some of these properties also control the frequency and other details of the automatic synchronization process.
  - Platform | Security | LDAP synchronization
    LDAP synchronization properties specify details that the system uses to log into the directory server and identify users to import. Some of these properties also control the frequency and other details of the automatic synchronization process.
  - Setting user attributes map properties
    These properties specify the user attributes that the system imports from the directory server.
  - Configuration process roadmap: LDAP integration
    Use this configuration process roadmap to scan the tasks required to integrate Unica with LDAP. The Topic column provides links to the topics that describe the tasks in detail.
  - Platform | Security | LDAP synchronization | LDAP reference to Unica Platform group map
    Properties in this category are used to configure LDAP integration.
  - Mapping LDAP groups to HCL Unica groups
    Users who belong to the directory server groups you map here are imported and made members of the Unica Platform group or groups specified here.
  - Adding an internal group
    Use this procedure to add an internal group.
  - If you add a role to a group or remove a role from a group, members of that group acquire or lose that role.
  - Adding a user to a group or subgroup
    Use this procedure to add a user to a group or subgroup.
  - Setting up an Active Directory user with PlatformAdminRole permissions
    When NTLMv2 authentication is enabled, you can not log in to Unica as platform_admin, so you must perform the following procedure in order to have administrator access to Unica Platform.
  - Platform | Security | Login method details | Web access control
    Properties in this category are used to configure integration with web access control software.
  - Setting the security mode to enable NTLMv2 authentication
    Only if you want to enable NTLMv2 authentication, set configuration properties as described in this procedure.
  - Platform | Security | Login method details | Web access control
    Properties in this category are used to configure integration with web access control software.
  - HCL Unica | General | Navigation
    Properties in this category specify values that are used internally to navigate among Unica products.
  - Setting web access control connection properties in HCL Unica
    To configure web access control integration, you set some configuration properties.
  - Implementation of one-way SSL
    This section describes one-way SSL in Unica.
  - Configuring integration with an SSL type of WebSEAL junction
    Follow this procedure to configure Unica Platform integration with IBM Security Access Manager using an SSL type of WebSEAL junction.
  - Configuring SiteMinder for HCL Unica products
    Unprotect objects in SiteMinder as described in this procedure to enable correct functioning of your Unica products.
  - Enabling single logouts with SiteMinder
    To enable a logout of SiteMinder when a user logs out of an Unica application, configure SiteMinder as follows.
  - Two ways to create data filters: automatic generation and manual specification
    Unica Platform provides a utility, datafilteringScriptTool, that processes XML to create the data filters in the Unica Platform system tables. Depending on how you write the XML, you can use this utility in two ways: automatic generation and manual specification.
  - datafilteringScriptTool
    The datafilteringScriptTool utility reads an XML file to populate the data filtering tables in the Unica Platform system table database.
  - ManagerSchema_PurgeDataFiltering.sql
    The ManagerSchema_PurgeDataFiltering.sql script removes all data filtering data from the Unica Platform system tables without removing the data filter tables themselves. This script removes all data filters, data filter configurations, audiences, and data filter assignments from Unica Platform.
  - Populating the data filter system tables
    Run the datafilteringScriptTool utility, which uses your XML to populate the data filter system tables.
  - Creating the XML to specify data filters
    Create the XML file that specifies the customer data used as criteria in each data filter. In the next step you will run a utility that populates the system tables with these specifications.
  - Data filter XML reference
    This section describes the XML elements for which you must provide values.
  - Example: Manually specifying data filters
    Jim needs to create a set of data filters based on sales territories.
  - Example: Automatically generating a set of data filters
    Jim needs to create a set of data filters based on countries, cities, and states.
  - Setting required data filter configuration properties
    Set required configuration properties to enable data filtering.
  - Optional configuration property to improve data filter performance
    You can turn the data filter cache on for better performance.
  - HCL Unica | General | Data filtering
    Properties in this category specify values used when data filtering is implemented.
  - Two ways to assign users and groups: in the user interface and in the XML
    You have two options for assigning users and groups to data filters: through the user interface or in the XML you use to create the data filters. Assigning users in the XML is a useful method when you have many users, each of whom requires a separate filter.
  - Assigning users and groups to data filters
    If you do not assign users or groups within the XML that you create, use the Unica data filter user interface to perform searches for users, groups, and data filters and then select items from the search results and assign them.
  - About assigning users and groups in the XML
    You can assign users or groups to data filters in the XML, as an alternative to doing this through the user interface. Assigning users and groups to data filters in the XML is available only when you use manual specification to create the data filters.
  - About assigning user and groups though the user interface
    You can assign users and groups to data filters on the Settings > Data filters pages.
  - Optional configuration property to improve data filter performance
    You can turn the data filter cache on for better performance.
  - HCL Unica | General | Data filtering
    Properties in this category specify values used when data filtering is implemented.
  - Schedule notifications
    You can set up notifications for any schedule, to alert you to the status of scheduled runs. In addition, users with Administrator permissions in Unica Platform can set up groups to which notifications are sent.
  - Configuring email notifications in HCL Unica
    Follow this procedure to configure the Unica Platform to send system alert and notification emails to users. You must have an email server set up before you start.
  - Alert and notification management
    Unica Platform provides support for system alerts and user notifications sent by Unica products.
  - HCL Unica | General | Communication | Email
    Properties in this category are used to configure the Unica Platform to send emails to users for system alerts and notifications.
  - Platform | Notifications
    Properties in this category control system behavior for notifications that Unica products can send to users.
  - Configure your web application servers for SSL
    On every application server on which an Unica application is deployed, configure the web application server to use the certificates you have decided to employ.
  - SSL in HCL Unica
    Many application components can act as both server and client during normal operations, and some components are written in Java™ and some in C++. These facts determine the format of the certificates you use. You specify the format when you create a self-signed certificate or purchase one from a CA.
  - Configuring SSL in Unica Platform
    Follow this procedure to configure SSL in Unica Platform.
  - Configuring SSL in Unica Platform with LDAP integration
    Follow this procedure to configure SSL in Unica Platform.
  - Configuring SSL in Unica Platform with data filters
    When Unica Platform is deployed with SSL and you plan to use the data filtering feature, you must perform this procedure to add the SSL options that perform hand shaking.
  - Security framework for HCL Unica APIs
    Unica Platform provides the security framework for the APIs implemented by Unica products.
  - Platform | Security | API management | [Product] | (API configuration template)
    Use the templates in this category to configure authentication for Unica APIs. You can block access, require HTTPS, or require authentication for APIs.
  - Security framework for HCL Unica APIs
    Unica Platform provides the security framework for the APIs implemented by Unica products.
  - SAML 2.0 based federated authentication
    Unica Platform implements a SAML 2.0 based Identity Provider (IdP) that enables a single sign-on federation among Unica products or between Unica products and third party applications.
  - Configuring which audit events appear in the report
    To specify the audit events that are available in the audit report and their severity, you set properties on the Settings > Configuration page.
  - Platform | Audit Events
    The property on this page determines whether audit events are tracked.
  - Platform | Audit Events | Audit events configuration
    The events you select on this page are available in the security audit reports.
  - Platform | Audit Events | Audit events severity configuration
    The severity level you specify for each event on this page appears in the Audit Events report. You can use the severity level to sort and filter the report data. The events are identical to those in the Platform | Audit Events | Audit events configuration category.
  - Archived audit events
    You can configure backups of audit events by setting the value of configuration properties in the Unica Platform | Audit Events | Audit Events Configuration category on the Settings > Configuration page.
  - Platform | Audit Events | Audit events configuration
    The events you select on this page are available in the security audit reports.
  - Configuring audit backup notifications
    To notify users of the status of audit event backup, make them members of a group that you specify in a configuration property.
  - Configuring which audit events appear in the report
    To specify the audit events that are available in the audit report and their severity, you set properties on the Settings > Configuration page.
  - Modifying the audit report content and display
    You can add and remove events and columns, rearrange and sort the columns, set the time span, specify which tracked events are shown in the report, and filter the information.
  - Fields in the Report Parameters window
    Use the fields on the Report Parameters page to configure the way the audit report is displayed.
  - configTool
    The properties and values on the Configuration page are stored in the Unica Platform system tables. You can use the configTool utility to import and export configuration settings to and from the system tables.
  - Configuration management
    The Configuration page provides access to the central configuration properties for Unica applications.
  - Unica Platform utilities
    This section provides an overview of the Unica Platform utilities, including some details that apply to all the utilities and which are not included in the individual utility descriptions.
  - encryptPasswords
    The encryptPasswords utility is used to encrypt and store either of two passwords that Unica Platform uses internally.
  - partitionTool
    Partitions are associated with Unica Campaign policies and roles. These policies and roles and their partition associations are stored in the Unica Platform system tables. The partitionTool utility seeds the Unica Platform system tables with basic policy and role information for partitions.
  - ManagerSchema_DeleteAll.sql
    The Manager_Schema_DeleteAll.sql script removes all data from the Unica Platform system tables without removing the tables themselves. This script removes all users, groups, security credentials, data filters, and configuration settings from Unica Platform.
  - SQL scripts for creating system tables
    Use the scripts described in the following table to create Unica Platform system tables manually when your company policy does not allow you to use the installer to create them automatically.
  - populateDb
    The populateDb utility inserts default (seed) data in the Unica Platform system tables.
  - ManagerSchema_DropAll.sql
    The ManagerSchema_DropAll.sql script removes all Unica Platform system tables from a database. This script removes all tables, users, groups, security credentials, and configuration settings from Unica Platform.
  - Preparing your corporate theme
    Follow these guidelines to create your corporate theme for the Unica frameset.
  - Applying your corporate theme
    Follow this procedure to apply your corporate theme to the Unica user interface.
- System Tables

Campaign | FlowchartEvents | ActiveMQ

The properties in this category pertain to Unica Director.

url

Configuration category: Affinium|Campaign|FlowchartEvents|ActiveMQ

Description: Specify the activeMQ listener url.
Default value: None

Platform User with Data Sources for ActiveMQ Credentials

Configuration category: Affinium|Campaign|FlowchartEvents|ActiveMQ

Description: Specify the Unica Platform user name that contains the datasource with the name specified under the configuration property ActiveMQ.
Default value: None

Data Source For ActiveMQ message broker credentials

Configuration category: Affinium|Campaign|FlowchartEvents|ActiveMQ

Description: Specify the name of the dataSource that holds the credentials.
Default value: ACTIVEMQ_CRED_DS

queueName

Configuration category: Affinium|Campaign|FlowchartEvents|ActiveMQ

Description: This mentions the queue name used to publish the flowchart information from Campaign. Please do not modify this.
Default value: flowchartInfo-campaign

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.