Home
Administrator Guide
Unica Interact provides documentation and help for users, administrators, and developers.
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.
IGateway interface
The Gateway API is contained in the interface IGateway. This interface receives offers from Unica Interact and sends the offers to their destination.
validate
The validate method validates candidate offers in the IGateway interface.

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.
  - IAffiniumExternalCallout interface
    The ExternalCallout API is contained in the interface IAffiniumExternalCallout. You must implement the IAffiniumExternalCallout interface to use the EXTERNALCALLOUT macro.
  - ExternalCallout API example
    This example creates an external callout that gets a credit score.
  - IInteractProfileDataService interface
    The Profile Data Services API is contained in the interface iInteractProfileDataService. This interface allows you to import hierarchical data into an Unica Interact session via one or more external data sources (such as a flat file, web service, and so on) at the time the Unica Interact session starts or the audience ID of an Unica Interact session changes.
  - IParameterizableCallout interface
    The Parameterizable Callout API is contained in the interface IParameterizableCallout.
  - ITriggeredMessageAction interface
    The Triggered Message Action API is contained in the interface ITriggeredMessageAction. This interface allows you to get and set the name of this instance.
  - IChannelSelector interface
    The Channel Selector API is contained in the interface IChannelSelector. This interface allows you to selects the outbound channels based on the offer to be sent and session attributes.
  - IDispatcher interface
    The Dispatcher API is contained in the interface IDispatcher. This interface sends offers to targeted gateways.
  - IGateway interface
    The Gateway API is contained in the interface IGateway. This interface receives offers from Unica Interact and sends the offers to their destination.
    - deliver
      The deliver method is called to send the offer or offers to a destination in the IGateway interface.
    - validate
      The validate method validates candidate offers in the IGateway interface.
- 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.
- 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.

validate

The validate method validates candidate offers in the IGateway interface.

java.util.Collection<com.unicacorp.interact.api.Offer> validate
    (com.unicacorp.interact.treatment.optimization.
     IInteractSessionData sessionData,
           java.util.Collection<com.unicacorp.interact.api.Offer> candidateOffers,
           java.util.Map<java.lang.String,java.lang.Object> parameterMap,
           java.lang.String channel)

The Unica Interact engine invokes this method to validate the candidate offers. The implementation of this method should check the offers, offer attributes, and session attributes against the requirements of the destination to determine which offer or offers can be sent through this gateway. In addition, it may add necessary parameters into the passed-in map, which is passed back to deliver method.

The validate method requires the following parameters:

sessionData - the attributes currently stored in the associated Unica Interact session
candidateOffers - the offers Unica Interact selected based on the offer selection method, its parameters, and other factors. These offers are eligible to be delivered from the perspective of Unica Interact, but still subject to the gateway.
parameterMap - a map the implementation of this method should use to pass parameters to its deliver method
channel - the outbound channel these offers will be sent to

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.