Home
Developer Guides
Validation PDK Guide
Developing validation plug-ins for Campaign
A plug-in is a Java™ class that is loaded at startup time and called whenever a campaign or offer is validated.
Creating a validator
Follow these instructions to create a validation plug-in that is much like the SimpleCampaignValidator, but prevents the creation of campaigns that are called "badCampaign2."

Developer Guides
- Validation PDK Guide
  - Unica Validation Plug-in Developer's Kit (PDK) overview
    Use the Validation Plug-in Developer's Kit (PDK) to develop custom validation logic for use in Unica Campaign.
  - Developing validation plug-ins for Campaign
    A plug-in is a Java™ class that is loaded at startup time and called whenever a campaign or offer is validated.
    - Setting up your environment to use the Validation PDK
      To use the Validation PDK with Unica Campaign, you must modify your path and set the JAVA_HOME environment variable.
    - Building the validator
      The Unica Campaign Validation PDK supplies an Ant script that can build all of the code in the sample files.
    - Configuring Unica Campaign to use a validation plug-in
      To configure Unica Campaign to use a validation plug-in, use the configuration settings at Unica Campaign > partitions > partition[n] > validation.
    - Testing the validator configuration
      After building the validator.jar file that contains the SimpleCampaignValidator class and making the necessary configuration changes, you can test and use the plug-in.
    - Creating a validator
      Follow these instructions to create a validation plug-in that is much like the SimpleCampaignValidator, but prevents the creation of campaigns that are called "badCampaign2."
    - Example validation scenario: prevent campaign edits
      This example explains how to use validation to prevent specific edits to a campaign.
  - Calling an application to handle validation
    The Validation PDK includes a sample validator, ExecutableCampaignValidator, which runs an executable, validate.sh, from the command line, to perform validation.
- Macros for HCL Unica
  Macros can be used in Unica Campaign and Unica Interact to enhance your flowcharts.

Creating a validator

Follow these instructions to create a validation plug-in that is much like the SimpleCampaignValidator, but prevents the creation of campaigns that are called "badCampaign2."

Procedure

Make a copy of the sample validator SimpleCampaignValidator.java in <HCL_Unica_Home\Campaign_Home>\devkits\validation\src\com \unica\campaign\core\validation\samples. Name the copy MyCampaignValidator.java and leave it in the same directory as the source. For example:

C:\HCL\Unica\Campaign\devkits\validation\src\com \unica\campaign\core\validation\samples\MyCampaignValidator.java
Open MyCampaignValidator.java in an editor. Find the word "badCampaign" in the document and replace it with the word "badCampaign2."
Save the file and close the editor.
Build the validators again. For details, see Building the validator. If your application server locks the validate.jar file while in use, stop the server before you build the validators.
Reconfigure campaign_config.xml to use your new class: <property name="validationClass" value="com.unica.campaign.core.validation.samples.MyCampaignValidator">
Test the validator. For details, see Testing the validator configuration.

What to do next

Confirm that the validator works: You should not be able to save campaigns named "badCampaign2."

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.