Jump to main content
HCL Logo Help Center
HCL TECHNOLOGIES ABOUT US PRODUCTS & SOLUTIONS RESOURCES CONTACT US
HCL® Opportunity Detect v9.1.1 documentation
Welcome to the HCL® Opportunity Detect v9.1.1 documentation, where you can find information about how to administer and use HCL Opportunity Detect.
About HCL® Opportunity Detect
HCL® Opportunity Detect enables you to look for specified customer behaviors and patterns in your customer data. You define the transactions and patterns that Opportunity Detect looks for, and you specify the data that is written to the database or web servlet when those criteria are met.
Opportunity Detect roles and permissions
The permissions assigned to users in Opportunity Detect determine what areas of the application they can access and the actions they can perform.
Data source setup in Opportunity Detect
To set up data sources for HCL® Opportunity Detect, you configure them in the user interface, including setting up connections to the databases that hold run detail, State History, and Outcome data.
Automating tasks using the RemoteControlCLI utility
The Opportunity Detect command line utility, RemoteControlCLI (CLI), allows you to automate the management of deployment configurations and batch runs. You can use the CLI to perform the same actions you can perform on the Deployment & Batch Run tab of a workspace.
Real time processing in Opportunity Detect
The type of data source connectors that you use for your workspace determines whether it is processed in batch or real time mode. For real time mode, use a Queue or Web Service type of data source connector for transaction and Outcome data. Queue data source connectors are available if you have applied Fix Pack 9.1.1.2 for HCL® Opportunity Detect and HCL Interact Advanced Patterns.
Web Service connectors for input and output in Opportunity Detect
You can use a Web Service Connector for incoming transaction data, for Outcome data, or for both.
Opportunity Detect configuration properties
This section describes the Opportunity Detect configuration properties on the Configuration page.
Permissions for Opportunity Detect
The following table describes permissions that you can assign to roles in Opportunity Detect.
Built-in roles in Opportunity Detect
Four built-in roles are included with Opportunity Detect.
Fields on the Server Groups page
If you are unsure of how to complete the fields on the Server Groups page, use the information provided here.
Web Service connectors for input and output in Opportunity Detect
You can use a Web Service Connector for incoming transaction data, for Outcome data, or for both.
About data source connectors
Data source connectors enable the system to connect to the transaction, profile, State History, and Outcome data sources that you have defined. The types of data source connectors are described in this section.
Fields on the Server Groups page
If you are unsure of how to complete the fields on the Server Groups page, use the information provided here.
About data source connectors
Data source connectors enable the system to connect to the transaction, profile, State History, and Outcome data sources that you have defined. The types of data source connectors are described in this section.
Configuring server groups and data source connections
Use this procedure to define server groups and connect them to data sources you have configured.
Fields on the Server Groups page
If you are unsure of how to complete the fields on the Server Groups page, use the information provided here.
Audience level codes
Audience codes represent the various audience levels defined in your data. Opportunity Detect groups data sources based on the audience code associated with them.
Configuring audience level codes
Use this procedure to specify audience level codes in Opportunity Detect.
Data source setup in Opportunity Detect
To set up data sources for HCL® Opportunity Detect, you configure them in the user interface, including setting up connections to the databases that hold run detail, State History, and Outcome data.
Real time processing in Opportunity Detect
The type of data source connectors that you use for your workspace determines whether it is processed in batch or real time mode. For real time mode, use a Queue or Web Service type of data source connector for transaction and Outcome data. Queue data source connectors are available if you have applied Fix Pack 9.1.1.2 for HCL® Opportunity Detect and HCL Interact Advanced Patterns.
Creating queue connectors
Follow this procedure to create a queue connector.
Mapping queue connectors to data sources
Follow this procedure to map a queue connector to a data source in a deployment configuration.
Web Service connectors for input and output in Opportunity Detect
You can use a Web Service Connector for incoming transaction data, for Outcome data, or for both.
Transaction message example for the sending program
This section describes the data in the message that your sending program must produce when you use a queue data source connector for transaction data. It also provides a code sample for creating a transaction message in the required format.
Outcome message example
This section describes the data in the message that the system produces when you use a queue data source connector for Outcomes.
Real time processing in Opportunity Detect
The type of data source connectors that you use for your workspace determines whether it is processed in batch or real time mode. For real time mode, use a Queue or Web Service type of data source connector for transaction and Outcome data. Queue data source connectors are available if you have applied Fix Pack 9.1.1.2 for HCL® Opportunity Detect and HCL Interact Advanced Patterns.
Setting up the database connection for the Opportunity Detect CLI
You edit the RemoteControlCLI.xml file to enable the CLI to connect with the Opportunity Detect design time database.
RemoteControlCLI XML reference
The values you enter in the RemoteControlCLI.xml file enable the CLI to connect with your Opportunity Detect design time database.
About HCL® Opportunity Detect
HCL® Opportunity Detect enables you to look for specified customer behaviors and patterns in your customer data. You define the transactions and patterns that Opportunity Detect looks for, and you specify the data that is written to the database or web servlet when those criteria are met.
Opportunity Detect roles and permissions
The permissions assigned to users in Opportunity Detect determine what areas of the application they can access and the actions they can perform.
Creating workspaces
You build trigger systems in workspaces. This procedure provides the basic steps for setting up workspaces. Details on adding and using components are provided elsewhere in this guide.
Adding and deleting components
There are three ways to add components to workspaces: by creating a component from the Component Palette, by copying a component within a workspace, and by using a component reference to share a component across workspaces.
Deploying and running workspaces
You can create and run deployment configurations and view deployment and batch run history on the Workspaces page.
Outcome data in Opportunity Detect
Opportunity Detect generates one outcome record for every set of transactions that meets the criteria specified in the trigger system.
Component types in Opportunity Detect
Components are the basic building blocks for trigger systems in Opportunity Detect.
Common features of components
You build expressions and configure incoming events and time spans when you work with several types of components. In addition, all component editors have a left panel where you configure or view basic attributes. Read this section to understand these commonly used component attributes.
Building expressions using the Expression Builder
The Expression Builder is used throughout Opportunity Detect to compare strings and numbers, perform math operations, and apply database functions.
Date, Math, and Boolean expression components
Expression components evaluate customer data and return a value that can be used by other components. You can create similar logic by using inline expressions within components, but creating an expression component for frequently used calculations allows you to re-use this logic.
Simple components
Trigger systems in HCL® Opportunity Detect all have Simple components as their basic building block. Simple is the only component type that is triggered by incoming transactions in the transaction data feed, and not by an event produced by another component. This is why every trigger system requires at least one Simple component.
Action components
The purpose of an Action component is to send a notification that a specified behavior has occurred by writing data to a database or sending the data to a web service. Like all event components, an Action component fires and writes its outcome when it receives an incoming event from another event component.
Select components
Select components perform operations that are similar to the SQL SELECT database query with optional WHERE clauses. A Select component holds a set of records that you define, and on which you can perform further operations.
Container and Container Manipulator components
Container components store data that you define for a specified length of time. Container components depend on Container Manipulator components to feed them the data that they store.
Pattern components
You can use Pattern components to test whether one or more events for a given customer occur over a period of time. A Pattern component collects events that match its criteria and stores these events in the customer's state history. When the specified pattern of events is met, the pattern drops those events from state history and fires a positive event.
Backward Inactivity and Forward Inactivity components
You use a Backward Inactivity component when you want to verify that some event did not occur within a specified period of time prior to an incoming event. You use a Forward Inactivity component to set a timer when it receives an incoming event, and optionally to specify another event that turns off the timer.
Artificial transactions in Opportunity Detect
An artificial transaction (ATX) is a system-generated event that you can use as an incoming event in an event component.
Ancestor and descendent relationships among components
Components in a trigger system can be said to have ancestor and descendent relationships with each other. Ancestor and descendent relationships affect many aspects of component behavior.
Data Dependencies
The Data Dependencies panel contains a read-only list of transaction data sources that are allowed and used in this component and the audience level associated with these data sources. The fields update as you configure a component.
About component references
You can share a component in multiple workspaces by using component references.
Deleting components
Use this procedure to delete components from workspaces in Opportunity Detect.
Time constants and time units
When you configure a calendar time span or an effective window, you use time constants and time units. Time constants, the starting points of time units, and the end points of irregular time units have specific definitions within Opportunity Detect.
About trigger systems
To create your business logic, you configure sets of components called trigger systems. Some components send events that activate other components, while others perform operations on data and make the results available to other components.
About component references
You can share a component in multiple workspaces by using component references.
Time Spans
Time spans are used throughout Opportunity Detect to specify time periods.
Rolling time span in Forward Inactivity components
You can set either a calendar or rolling time span in Forward Inactivity components.
Calendar time span in Forward Inactivity components
You can set either a calendar or rolling time span in Forward Inactivity components.
Calendar time span in Pattern components
You specify the calendar time span for the pattern using the Time Span section of the component editor.
Rolling time span in Pattern components
You specify the rolling time span for the pattern using the Time Span section of the component editor.
Time constants and time units
When you configure a calendar time span or an effective window, you use time constants and time units. Time constants, the starting points of time units, and the end points of irregular time units have specific definitions within Opportunity Detect.
Firing Frequency
Fields where you set a limit on how often an event component produces its event. Optional.
Time Spans
Time spans are used throughout Opportunity Detect to specify time periods.
Effective Window
Fields where you can set a start and end date during which an event component is active. Optional.
Artificial transactions in Opportunity Detect
An artificial transaction (ATX) is a system-generated event that you can use as an incoming event in an event component.
Time constants and time units
When you configure a calendar time span or an effective window, you use time constants and time units. Time constants, the starting points of time units, and the end points of irregular time units have specific definitions within Opportunity Detect.
Effective Window
Fields where you can set a start and end date during which an event component is active. Optional.
Firing Frequency
Fields where you set a limit on how often an event component produces its event. Optional.
Rolling time span in Forward Inactivity components
You can set either a calendar or rolling time span in Forward Inactivity components.
Calendar time span in Forward Inactivity components
You can set either a calendar or rolling time span in Forward Inactivity components.
Creating workspaces
You build trigger systems in workspaces. This procedure provides the basic steps for setting up workspaces. Details on adding and using components are provided elsewhere in this guide.
Adding components to workspaces from the Component Palette
Use this procedure to add components to workspaces from the Component Palette in Opportunity Detect.
Sharing components across workspaces using component references
Use this procedure to share a component across workspaces.
Adding components within workspaces by saving a copy
Use this procedure to add a component within a workspace by saving a copy of a component using a new name.
Fields and buttons in the Workspace List
In the Workspace List, you can create, delete, and modify the basic properties of workspaces.
Running workspaces
Use this procedure to run a workspace for test or production purposes.
About component references
You can share a component in multiple workspaces by using component references.
Sharing components across workspaces using component references
Use this procedure to share a component across workspaces.
About trigger systems
To create your business logic, you configure sets of components called trigger systems. Some components send events that activate other components, while others perform operations on data and make the results available to other components.
Outcome data in Opportunity Detect
Opportunity Detect generates one outcome record for every set of transactions that meets the criteria specified in the trigger system.
Running workspaces
Use this procedure to run a workspace for test or production purposes.
About data source connectors
Data source connectors enable the system to connect to the transaction, profile, State History, and Outcome data sources that you have defined. The types of data source connectors are described in this section.
Outcome format with the Expanded Outcome data source connector
When the Expanded Outcome data source connector is used for Outcome data, the system writes the data in a form that can be used by HCL® Campaign or an external system.
About batch notifications
The Opportunity Detect engine can run batch files when it completes a run. You can use these files to issue different notifications for each successful and failed engine run.
Fields and buttons on the Deployment tab
On the Deployment tab of a workspace, you can create deployment configurations for workspaces, map data source connectors within the deployment configuration, deploy the configurations, stop and restart deployments, and view deployment history.
Fields and buttons on the Batch Run tab
On the Batch Run tab, you can manage run parameters, run deployed workspaces, see the status of the most recent batch runs, and stop and start ongoing runs.
Fields on the Batch History tab
On the Batch History tab, you can see details about past runs, filtered by deployment and a date range.
About data source connectors
Data source connectors enable the system to connect to the transaction, profile, State History, and Outcome data sources that you have defined. The types of data source connectors are described in this section.
Data source connector mapping
Data source connectors can be mapped to different data sources in each deployment configuration, which provides flexibility for testing and ramp-up operations.
Fields and buttons on the Batch Run tab
On the Batch Run tab, you can manage run parameters, run deployed workspaces, see the status of the most recent batch runs, and stop and start ongoing runs.
Fields on the Batch History tab
On the Batch History tab, you can see details about past runs, filtered by deployment and a date range.
Fields and buttons on the Batch Run tab
On the Batch Run tab, you can manage run parameters, run deployed workspaces, see the status of the most recent batch runs, and stop and start ongoing runs.
Artificial transactions in Opportunity Detect
An artificial transaction (ATX) is a system-generated event that you can use as an incoming event in an event component.
Creating workspaces
You build trigger systems in workspaces. This procedure provides the basic steps for setting up workspaces. Details on adding and using components are provided elsewhere in this guide.
Deploying and running workspaces
You can create and run deployment configurations and view deployment and batch run history on the Workspaces page.
Creating and deploying a deployment configuration
Use this procedure to create and deploy a deployment configuration.
Running workspaces
Use this procedure to run a workspace for test or production purposes.
Functions in Opportunity Detect
Functions perform some additional processing on a record set returned by a Container or Select component. Functions allow you to apply commonly used database functions to the records.
Container components
Container components provide a way to create a data structure similar to a database table in your trigger systems. You use the Container to define the table that holds the data inserted by a Container Manipulator.
Select components
Select components perform operations that are similar to the SQL SELECT database query with optional WHERE clauses. A Select component holds a set of records that you define, and on which you can perform further operations.
Time constants and time units
When you configure a calendar time span or an effective window, you use time constants and time units. Time constants, the starting points of time units, and the end points of irregular time units have specific definitions within Opportunity Detect.
Backward Inactivity components
When a customer withdraws $10,000 from her account, you might want to determine whether she has made any other withdrawals larger than $5,000 within the past two months. For this, you would use a Backward Inactivity component.
Calendar time span in Forward Inactivity components
You can set either a calendar or rolling time span in Forward Inactivity components.
Rolling time span in Forward Inactivity components
You can set either a calendar or rolling time span in Forward Inactivity components.
Date, Math, and Boolean expression components
Expression components evaluate customer data and return a value that can be used by other components. You can create similar logic by using inline expressions within components, but creating an expression component for frequently used calculations allows you to re-use this logic.
Building expressions using the Expression Builder
The Expression Builder is used throughout Opportunity Detect to compare strings and numbers, perform math operations, and apply database functions.
Calendar time span in Pattern components
You specify the calendar time span for the pattern using the Time Span section of the component editor.
Rolling time span in Forward Inactivity components
You can set either a calendar or rolling time span in Forward Inactivity components.
Time constants and time units
When you configure a calendar time span or an effective window, you use time constants and time units. Time constants, the starting points of time units, and the end points of irregular time units have specific definitions within Opportunity Detect.
Negative event modes in Pattern components
By default, a Pattern fires a positive event when its criteria are met, but it does not fire a negative event when the aging out of an event creates a negative condition. However, you can configure the behavior to include negative events.
Pattern Behavior fields
Pattern behavior options allow you to enable the pattern to fire a negative event (by default patterns fire only positive events). They also allow you to delay firing the negative event.
Container components
Container components provide a way to create a data structure similar to a database table in your trigger systems. You use the Container to define the table that holds the data inserted by a Container Manipulator.
Container Manipulator components
You use Container Manipulator components to add and delete data in Container components.
Artificial transactions in Opportunity Detect
An artificial transaction (ATX) is a system-generated event that you can use as an incoming event in an event component.
Fields and buttons on the Deployment tab
On the Deployment tab of a workspace, you can create deployment configurations for workspaces, map data source connectors within the deployment configuration, deploy the configurations, stop and restart deployments, and view deployment history.
About the integration between HCL® Interact and HCL® Interact Advanced Patterns
The integration between HCL® Interact and HCL Interact Advanced Patterns provides advanced pattern recognition capabilities for your Interact implementation.
Installation overview
An installation of Opportunity Detect or Interact Advanced Patterns is complete when you install, configure, and deploy the product.
Planning the Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler installation
When you plan your Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler installation, you must ensure that you have set up your system correctly, and that you have configured your environment to deal with any failures.
Preparing data sources for Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler
The Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler runtime environment uses data sources to store user and interaction data.
Installing Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler
You must run the IBM® EMM installer to start the installation of Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM SPSS® Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler. The IBM EMM installer starts the Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM SPSS Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler installers during the installation process. Make sure that the IBM EMM installer and the product installer are saved at the same location.
Completing a manual installation of Opportunity Detect
If you select manual database set up when you install Opportunity Detect, you must complete the tasks in this section after you run the IBM® EMM and the Opportunity Detect installer.
Deploying Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition
To deploy Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition, you must deploy Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM SPSS Modeler Advantage Enterprise Marketing Management Edition Design Time by using an EAR or WAR file.
Configuring Opportunity Detect and HCL® InfoSphere Streams after deploying Opportunity Detect
After you deploy Opportunity Detect, perform the additional configuration tasks described in this chapter.
Configuring Opportunity Detect in a cluster
Opportunity Detect can be installed and deployed in a cluster.
Uninstalling Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler
Run the Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler uninstallers to uninstall Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM SPSS Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler. When you run the Marketing PlatformCampaignDistributed MarketingeMessageContact OptimizationInteractLeadsOpportunity DetectDigital Analytics for On PremisesCustomerInsightPredictiveInsightMarketing OperationsInteraction HistoryAttribution ModelerIBM SPSS Modeler Advantage Enterprise Marketing Management Edition and Attribution Modeler uninstallers, the files that were created during the installation process are removed. For example, files such as configuration files, installer registry information, and user data are removed from the computer.
configTool
The properties and values on the Configuration page are stored in the Marketing Platform system tables. You can use the configTool utility to import and export configuration settings to and from the system tables.
Opportunity Detect configuration properties
This section describes the Opportunity Detect configuration properties on the Configuration page.
Setting Opportunity Detect or Interact Advanced Patterns configuration properties
You must set the configuration properties for Opportunity Detect or Interact Advanced Patterns.
Detect | System | Streams Remote Control Web Service
The property in this category specifies the URL for the HCL® InfoSphere Streams remote control web service.
Detect | System | Real Time Connector
The property in this category specifies the URL for the web service used when Interact is integrated with Interact Advanced Patterns or when the Web Service connector is used for input data.
Detect | logging
The property in this category specifies the location of the Opportunity Detect log file.
Before you contact technical support
If you encounter a problem that you cannot resolve by consulting the documentation, your company's designated support contact can log a call with technical support. Use these guidelines to ensure that your problem is resolved efficiently and successfully.