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.
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.
validationClasspath
The validationClasspath tells Unica Campaign the location of the class to use for validation with a Validation PDK plug-in.

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.
      - validationClass
        The validationClass tells Unica Campaign the name of the class to use for validation with a Validation PDK plug-in.
      - validationClasspath
        The validationClasspath tells Unica Campaign the location of the class to use for validation with a Validation PDK plug-in.
      - validatorConfigString
        The validatorConfigString is passed into the validator plug-in when it is loaded by Unica Campaign.
    - 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.

validationClasspath

The validationClasspath tells Unica Campaign the location of the class to use for validation with a Validation PDK plug-in.


Property	Description
Description	The path to the class that is used for custom validation.
Details	Use either a full path or a relative path. If the path is relative, the behavior depends on the application server that is running Unica Campaign. WebLogic uses the path to the domain work directory, which by default is `c:\bea\user_projects\domains\mydomain`. If the path ends in a slash (/ for UNIX™ or \ for Windows™), Unica Campaign assumes that it points to the location of the Java™ plug-in class to be used. If the path does not end in a slash, Unica Campaign assumes that it is the name of a .jar file that contains the Java™ class, as shown in the following example. If the path is not set, Unica Campaign does not attempt to load a plug-in.
Example	`/<CAMPAIGN_HOME>/devkits/validation/lib/validator.jar` This is the path on a UNIX™ platform that points to the JAR file that is packaged with the plug-in developer's kit.
Default	By default, no path is set: `<property name="validationClasspath" />`
See also	See validationClass for information about designating the class to use.

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.