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.
Building the validator
The Unica Campaign Validation PDK supplies an Ant script that can build all of the code in the sample files.

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.

Building the validator

The Unica Campaign Validation PDK supplies an Ant script that can build all of the code in the sample files.

The default behavior for the script is to create a jar that contains the validation classes. Optionally, it can also create Javadoc™ and run tests against the validators to ensure that they work in Unica Campaign before trying to use the plug-in in production.

To build the validator:

Change to the PDK directory <HCL_Unica_Home\Unica Campaign_Home>\devkits\validation\build
For example: C:\HCL\Unica\Campaign\devkits\validation\build
This directory contains the Ant script, build.xml.
Run the Ant jar at the command line.
- To create the plug-in without doing any unit tests, use the ant jar command.
- To create the plug-in and also do unit testing, use the ant run-test command.
Ant runs the script and produces a JAR file called validator.jar in the lib subdirectory. For example:
C:\HCL\Unica\Campaign\devkits\validation\build\lib

You now have a custom validator that can be used in Unica Campaign. Your next step is to configure Unica Campaign to use this validator.

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.