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.
validatorConfigString
The validatorConfigString is passed into the validator plug-in when it is loaded by Unica Campaign.

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.

validatorConfigString

The validatorConfigString is passed into the validator plug-in when it is loaded by Unica Campaign.


Property	Description
Description	A string that is passed into the validator plug-in when it is loaded by Unica Campaign.
Details	How the plug-in uses this string is up to the designer. You can use it to send a configuration string into your plug-in when the system loads it. For example, the `ExecutableCampaignValidator` (from the sample executable plug-in included with the PDK) uses this property to indicate the executable to run.
Example	To run the sample Bourne shell script as the validation script, set `validatorConfigString` to `/opt/unica/campaign/devkits/validation/src/com/unica/campaign /core/validation/samples/validate.sh`
Default	By default, no path is set: `<property name="validatorConfigString" />`

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.