Home
Administrator Guide
Unica Interact provides documentation and help for users, administrators, and developers.
Interact runtime environment configuration properties
This section describes all the configuration properties for the Unica Interact runtime environment.
Interact | services
The configuration properties in this category define settings for all the services which manage collecting contact and response history data and statistics for reporting and writing to the runtime environment system tables.
Interact | services | eventPattern | advancedPatterns
The configuration properties in this category control whether integration with Unica Interact Advanced Patterns is enabled, and they define the timeout intervals for connections with Unica Interact Advanced Patterns.
Interact | services | eventPattern | advancedPatterns | autoReconnect
The configuration properties in this category specify parameters for the automatic reconnection feature in the integration with Unica Interact Advanced Patterns.

Administrator Guide
Unica Interact provides documentation and help for users, administrators, and developers.
- Administering Interact
  When you administer Unica Interact you configure and maintain users and roles, data sources, and optional product features. You also monitor and maintain the design and runtime environments. Product-specific application programming interfaces (APIs) are available for you to use.
- Security Management
  Access to the Unica Interact runtime User Interface requires authentication. Only the Login IDs defined in Unica Platform and having Unica Interact admin role can access the pages.
- Configuring users
  Unica Interact requires you to configure two sets of users, runtime environment users and design environment users.
- Managing Unica Interact data sources
  Unica Interact requires several data sources to function properly. Some data sources contain the information Unica Interact requires to function, other data sources contain your data.
- Offer serving
  You can configure Unica Interact in many ways to enhance how it selects offers to present. The following sections describe these optional features in detail.
- Understanding the Interact API
  Unica Interact serves offers dynamically to a wide variety of touchpoints. For example, you can configure the runtime environment and your touchpoint to send messages to your call center employees informing them of the best up sell or cross sell prospects for a customer who has called with a specific type of service inquiry. You can also configure the runtime environment and your touchpoint to provide tailored offers to a customer (visitor) who has entered a particular area of your Web site.
- Managing the Unica Interact API
  Whenever you use the startSession method, you create a Unica Interact runtime session on the runtime server. You can use configuration properties to manage the sessions on a runtime server.
- Classes and methods for the Unica Interact API
  The following sections list requirements and other details you should know before you work with the Unica Interact API.
- Classes and methods for the Interact JavaScript API
  The following sections list requirements and other details you should know before you work with the Unica Interact JavaScript API.
- About the ExternalCallout API
  Unica Interact offers an extensible macro, EXTERNALCALLOUT, for use with your interactive flowcharts. This macro enables you to perform custom logic to communicate with external systems during flowchart runs. For example, if you want to calculate the credit score of a customer during a flowchart run, you can create a Java™ class (a callout) to do so and then use the EXTERNALCALLOUT macro in a Select process in your interactive flowchart to get the credit score from your callout.
- Unica Interact utilities
  This section describes the administrative utilities available with Unica Interact.
- About the Learning API
  Unica Interact offers a learning module which uses a naive-bayesian algorithm to monitor visitor actions and propose optimal offers (in terms of acceptance). You can implement the same Java™ interface with your own algorithms using the Learning API to create your own learning module.
- Interact WSDL
  The Unica Interact installation includes two WDSL (Web Services Description Language) XML files that describe the available web services and how to access them. You can view these files in your Unica Interact home directory, and an example is shown here.
- Interact runtime environment configuration properties
  This section describes all the configuration properties for the Unica Interact runtime environment.
  - Interact | general
    These configuration properties define general settings for your runtime environment environment, including the default logging level and the locale setting.
  - Interact | flowchart
    This section defines configuration settings for interactive flowcharts.
  - Interact | monitoring
    This set of configuration properties enables you to define JMX monitoring settings. You need to configure these properties only if you are using JMX monitoring. There are separate JMX monitoring properties to define for the contact and response history module in the configuration properties for Unica Interact design environment.
  - Interact | profile
    This set of configuration properties control several of the optional offer serving features, including offer suppression and score override.
  - Interact | offerserving
    These configuration properties define the generic learning configuration properties. If you are using built-in learning, to tune your learning implementation, use the configuration properties for the design environment.
  - Interact | services
    The configuration properties in this category define settings for all the services which manage collecting contact and response history data and statistics for reporting and writing to the runtime environment system tables.
    - Affinium|interact|services|contactHist|treatmentStoreReference
      This configuration parameter is the root node for the settings related to the data store of recently served treatments.
    - daysBackForXSessContact
      The number of days a served treatment is kept in the data store for cross session lookup. If the value is non-positive or zero, the cross session contact tracking feature is disabled.
    - Interact | services | contactHist
      The configuration properties in this category define the settings for the service that collects data for the contact history staging tables.
    - Interact | services | contactHist | cache
      The configuration properties in this category define the cache settings for the service that collects data for the contact history staging table. Note: When contactHist or responseHist is configured to use memoryCache, you can optionally create a data source systemTablesDataSource and configure the settings under Affinium|interact|general|systemTablesDataSource|loaderProperties. When this is done, the contact/response history staging records will be persisted into files in directory as set by Affinium|interact|services|externalLoaderStagingDirectory if the persistence into database fails. Otherwise, an INFO entries will be logged at initialization saying failover is not enabled.
    - Interact | services | contactHist | contactStatusCodes
      The configuration properties in this category defines the settings for the custom contact status type which can be passed into Interact together with contact events..
    - Interact | services | contactHist | fileCache
      The configuration properties in this category define the cache settings for the service that collects contact history data if you are using a database loader utility. Prerequisite: For Configuration Affinium|interact|services|externalLoaderStagingDirectory set loaderStagingData.
    - Interact | services | defaultedStats
      The configuration properties in this category define the settings for the service that collects the statistics regarding the number of times the default string for the interaction point was used.
    - Interact | services | defaultedStats | cache
      The configuration properties in this category define the cache settings for the service that collects the statistics regarding the number of times the default string for the interaction point was used.
    - Interact | services | eligOpsStats
      The configuration properties in this category define the settings for the service that writes the statistics for eligible offers.
    - Interact | services | eligOpsStats | cache
      The configuration properties in this category define the cache settings for the service that collects the eligible offer statistics.
    - Interact | services | eventActivity
      The configuration properties in this category define the settings for the service that collects the event activity statistics.
    - Interact | services | eventActivity | cache
      The configuration properties in this category define the cache settings for the service that collects the event activity statistics.
    - Interact | services | eventPattern
      The configuration properties in the eventPattern category define the settings for the service that collects the event pattern activity statistics.
    - Interact | services | eventPattern | userEventCache
      The configuration properties in the userEventCache category define the settings that determine when event activity is moved from the cache to persist in the database.
    - Interact | services | eventPattern | advancedPatterns
      The configuration properties in this category control whether integration with Unica Interact Advanced Patterns is enabled, and they define the timeout intervals for connections with Unica Interact Advanced Patterns.
      - Interact | services | eventPattern | advancedPatterns | autoReconnect
        The configuration properties in this category specify parameters for the automatic reconnection feature in the integration with Unica Interact Advanced Patterns.
    - Interact | services | customLogger
      The configuration properties in this category define the settings for the service that collects custom data to write to a table (an event which uses the UACICustomLoggerTableName event parameter).
    - Interact | services | customLogger | cache
      The configuration properties in this category define the cache settings for the service that collects custom data to a table (an event which uses the UACICustomLoggerTableName event parameter).
    - Interact | services | responseHist
      The configuration properties in this category define the settings for the service that writes to the response history staging tables.
    - Interact | services | responseHist | cache
      The configuration properties in this category define the cache settings for the service that collects the response history data. Note: When contactHist or responseHist is configured to use memoryCache, you can optionally create a data source systemTablesDataSource and configure the settings under Affinium|interact|general|systemTablesDataSource|loaderProperties. When this is done, the contact/response history staging records will be persisted into files in directory as set by Affinium|interact|services|externalLoaderStagingDirectory if the persistence into database fails. Otherwise, an INFO entries will be logged at initialization saying failover is not enabled.
    - Interact | services | response Hist | responseTypeCodes
      The configuration properties in this category define the settings for the response history service.
    - Interact | services | responseHist | fileCache
      The configuration properties in this category define the cache settings for the service that collects the response history data if you are using a database loader utility.
    - Interact | services | crossSessionResponse
      The configuration properties in this category define general settings for the crossSessionResponse service and the xsession process. You only need to configure these settings if you are using Unica Interact cross-session response tracking.
    - Interact | services | crossSessionResponse | cache
      The configuration properties in this category define the cache settings for the service that collects cross-session response data.
    - Interact | services | crossSessionResponse | OverridePerAudience | [AudienceLevel] | TrackingCodes | byTreatmentCode
      The properties in this section define how cross-session response tracking matches treatment codes to contact and response history.
    - Interact | services | crossSessionResponse | OverridePerAudience | [AudienceLevel] | TrackingCodes | byOfferCode
      The properties in this section define how cross-session response tracking matches offer codes to contact and response history.
    - Interact | services | crossSessionResponse | OverridePerAudience | [AudienceLevel] | TrackingCodes | byAlternateCode
      The properties in this section define how cross-session response tracking matches a user-defined alternate code to contact and response history.
    - Interact | services | threadManagement | contactAndResponseHist
      The configuration properties in this category define thread management settings for the services which collect data for the contact and response history staging tables.
    - Interact | services | threadManagement | allOtherServices
      The configuration properties in this category define the thread management settings for the services which collect the offer eligibility statistics, event activity statistics, default string usage statistics, and the custom log to table data.
    - Interact | services | threadManagement | flushCacheToDB
      The configuration properties in this category define the thread management settings for the threads that write collected data in cache to the runtime environment database tables.
    - Interact | services | threadManagement | eventHandling
      The configuration properties in this category define the thread management settings for the services which collect data for event handling.
    - Interact | services | configurationMonitor
      The configuration properties in this category allow you to enable or disable integration with Unica Interact Advanced Patterns without having to restart Unica Interact real time, and they define the interval for polling the property value that enables the integration.
    - Interact | services | CampaignSegments
  - Interact | cacheManagement
    This set of configuration properties defines settings for selecting and configuring each of the supported cache managers that you can use to improve the performance of Unica Interact, such as EHCache or Ignite, which is built-in to your Unica Interact installation. Use the Unica Interact | cacheManagement | Cache Managers configuration properties to configure the cache manager you want to use. Use the Unica Interact | cacheManagement | caches configuration properties to specify which cache manager Unica Interact should use to improve performance.
  - Interact | triggeredMessages
    The configuration properties in this category define settings for all triggered messages and offer channel delivery.
  - Interact | activityOrchestrator
    The activity orchestrator category specifies the receivers and gateways for your Unica Interact inbound gateway activity.
  - Interact | ETL | patternStateETL
    The configuration properties in this category define the settings for the ETL process.
- Unica Interact Simulator
  This section describes all the configuration properties for the Unica Interact simulator.
- Interact design environment configuration properties
  This section describes all the configuration properties for Unica Interact design environment.
- Real-time offer personalization on the client side
  There may be situations where you want to provide real-time offer personalization without implementing low-level Java™ code or SOAP calls to the Unica Interact server. For example, when a visitor initially loads a web page where Javascript content is your only extended programming available, or when a visitor opens an email message where only HTML content is possible. Unica Interact provides several connectors that provide real-time offer management in situations where you have control only over the web content that is loaded on the client side, or where you want to simplify your interface to Unica Interact.
- JVM parameters
- Unica Interact and Digital Recommendations integration
  Unica Interact can integrate with IBM Digital Recommendations to provide Unica Interact-driven product recommendations. Both products can provide product recommendations for offers, but using different methods. Digital Recommendations uses a visitor's web behavior (collaborative filter) to build correlations between visitors and recommended offers. Unica Interact is based on customer's past behavior, attributes, history, and less on view-level offers, learning which offers best match a customer's behavior profile (based on demographics and other information about the customer). Offer acceptance rates help to build a predictive model through self-learning. Using the best of both products, Unica Interact can use a personal profile to define offers that will pass a category ID to Digital Recommendations and retrieve recommended products based on popularity (the "wisdom of the crowds") for display to the visitor as part of the selected offers. This can provide better recommendations for customers that will result in more click-throughs and better outcomes than either product acting alone.
- Interact and DDX integration
  With Digital Data Exchange, your website can link to Unica Interact to provide a powerful omni-channel execution engine that delivers the best offers to the optimum channels and evolves (learns) from the offer feedback to continuously increase marketing effectiveness.
- Unica Interact and Unica Journey integration
- Unica Interact and Unica Deliver integration
- Configure gateways
  Use triggered message gateways to send offer information from outbound channels.

Interact | services | eventPattern | advancedPatterns | autoReconnect

The configuration properties in this category specify parameters for the automatic reconnection feature in the integration with Unica Interact Advanced Patterns.

enable

Description: Determines whether the system to reconnects automatically if connection problems occur between the Unica Interact real time environment and Unica Interact Advanced Patterns. The default value of True enables this feature.
Default value: True
Valid Values: True | False

durationInMinutes

Description: This property specifies the time interval, in minutes, during which the system to evaluates repeated connection problems occurring between the Unica Interact real time environment and Unica Interact Advanced Patterns.
Default value: 10

numberOfFailuresBeforeDisconnect

Description: This property specifies the number of connection failures allowed during the specified time period before the system automatically disconnects from Unica Interact Advanced Patterns.
Default value: 3

consecutiveFailuresBeforeDisconnect

Description: Determines whether the automatic reconnection feature evaluates only consecutive failures of the connection between the Unica Interact real time environment with Unica Interact Advanced Patterns. If you set this value to False, all failures within the specified time interval are evaluated.
Default value: True

sleepBeforeReconnectDurationInMinutes

Description: The system waits the number of minutes specified in this property before reconnecting after the system disconnects due to repeated failures as specified in the other properties in this category.
Default value: 5

sendNotificationAfterDisconnect

Description: This property determines whether the system sends an email notification when a connection failure occurs. The notification message includes the Unica Interact real time instance name for which failure occurred and the amount of time before reconnection occurs, as specified in the sleepBeforeReconnectDurationInMinutes property. The default value of True means that notifications are sent.
Default value: True

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.