Home
Integration Module
Unica Plan Integration Services combines the Unica Plan Integration Webservice, SOAP API procedures, and triggers to extend business capabilities.
What is Plan Integration Services?
Unica Plan Integration Services combines the Unica Plan Integration Webservice, SOAP API procedures, and triggers to extend business capabilities.
Getting started with Plan Integration Services
You use Unica Plan Integration Services to create custom procedures. You can use these procedures to trigger external events when certain events occur within Unica Plan. You can use these procedures to run Unica Plan functions from external systems or programs.
Software developer kit contents
The software developer kit contains documentation containing all publicapi classes and interfaces, and example code.

Integration Module
Unica Plan Integration Services combines the Unica Plan Integration Webservice, SOAP API procedures, and triggers to extend business capabilities.
- What is Plan Integration Services?
  Unica Plan Integration Services combines the Unica Plan Integration Webservice, SOAP API procedures, and triggers to extend business capabilities.
  - What are the requirements for Plan Integration Services?
    Unica Plan Integration Services has the following requirements.
  - Getting started with Plan Integration Services
    You use Unica Plan Integration Services to create custom procedures. You can use these procedures to trigger external events when certain events occur within Unica Plan. You can use these procedures to run Unica Plan functions from external systems or programs.
    - Installing Integration Services
      The Unica Plan Integration Services module is a separate, paid component. If you purchase the Integration Services module, you must install it.
    - Software developer kit contents
      The software developer kit contains documentation containing all publicapi classes and interfaces, and example code.
  - Hosted JavaDocs
    For specific information about the public API methods, refer to the iPlanAPI class in the JavaDocs API documentation files.
  - For more information
    Different people in your organization use Unica Plan to accomplish different tasks. Information about Unica Plan is available in a set of guides, each of which is intended for use by team members with specific objectives and skill sets.
- About Plan Integration Webservice
  The webservice provides a client view of the Unica Plan Integration Services, which is part of the deployment of the Unica Plan server. The service is used concurrently with Unica Plan web users.
- Plan procedures
  A "procedure" is a custom or standard Java™ class hosted by Unica Plan that does some unit of work. Procedures provide a way for customers and Professional Services to extend business logic in arbitrary ways.
- About the Plan API
  The Unica Plan SOAP API is a façade that provides a client view of a running Unica Plan instance.

Software developer kit contents

The software developer kit contains documentation containing all publicapi classes and interfaces, and example code.

For the SOAP API, all the Unica Plan Integration Services components are installed under a folder labeled devkits.

Example code is installed in the following folders.

The build folder contains scripts to build and deploy custom procedures.
The Classes folder contains the compiled procedure classes.
Users must deploy the compiled classes of their custom procedures at the path that is specified by the configuration parameter integrationProcedureClasspathURL. Then, the Unica Plan Procedure Manager loads them as specified in the procedure-plugins.xml configuration file.
The lib folder contains the necessary libraries for developing and compiling custom procedures.
The src folder contains source files for custom procedures. Users can place custom procedures to be started as triggers or web-services here. Only the SOAP API supports custome procedures.
- The src/procedure folder contains procedure-plugins.xml configuration file. Every custom procedure that runs as a trigger based an event or through an external web-service must have an entry in this file. The entries must contain a fully qualified class path of procedure and required initialization parameters.
- The src/procedure folder also contains some sample procedures that are included with Unica Plan. These procedures can be used to understand and develop your custom procedures.
  
  Place custom procedures under the src directory in a new folder structure, such as com/<mycompany>/<mypackage>. Do not place custom procedures in the sample procedures folder.
- The src/soap folder contains sample web service clients that are developed in Java. Use these samples as a starting point for developing web service-based clients for Integration Services. This folder also contains binary scripts to start sample clients over the command line.

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.