Home
Integration Module
Unica Plan Integration Services combines the Unica Plan Integration Webservice, SOAP API procedures, and triggers to extend business capabilities.
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.
Design
The procedure implementation class uses the Unica Plan API to read and update Unica Plan components, start services, and so on. Other Java™ packages can be used to do other tasks.

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.
- 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.
  - Assumptions
    The procedure implementation classes are packaged into a separate classes tree or JAR file and made available to Unica Plan through a URL path.
  - Configuration parameters
    When you install the Unica Plan Integration Module, the installer sets three configuration properties. You can modify the configuration properties to customize the behavior of the Integration Module.
  - Design
    The procedure implementation class uses the Unica Plan API to read and update Unica Plan components, start services, and so on. Other Java™ packages can be used to do other tasks.
  - Procedure lifecycle
    Each procedure runs through a complete lifecycle.
  - Key Java classes
    The supplied integration developer's kit contains a set of Javadoc for the public Unica Plan API and supporting classes.
  - Data locking
    Unica Plan uses a pessimistic edit locking scheme; that is, only one user is granted update access to component instances at a time. For the GUI user, this locking is done at the visual tab level. In some cases, data is locked for a subset of an instance, for example, a project summary tab. In other cases, data is locked across many instances, for example, the workflow tab. After a user acquires a lock, all other users are restricted to read-only access to the related data.
  - Procedure transactions
    The procedure execution manager automatically wraps execution of the procedure with a database transaction, committing or rolling it back based on the outcome of the procedure execution.
  - Communicating results
    The execute() method of a procedure returns an integer status code to the Unica Plan procedure audit table. The execute() method of a procedure can also return zero or more messages to the procedure audit table, which are logged and persisted.
  - Procedure logging
    Unica Plan has a separate log file for procedures: <Plan_Home>\logs\system.log
  - Procedure plug-in definition file
    The procedure plug-in definition file defines implementation class, metadata, and other information about the custom procedures to be hosted in Unica Plan.
- About the Plan API
  The Unica Plan SOAP API is a façade that provides a client view of a running Unica Plan instance.

Design

The procedure implementation class uses the Unica Plan API to read and update Unica Plan components, start services, and so on. Other Java™ packages can be used to do other tasks.

In your design, focus on producing a single unit of work that operates atomically. Ideally, a procedure performs some series of tasks that can be scheduled asynchronously to run at some later time. This "fire and forget" integration model results in the least load on both systems.

Note: Only the documented classes and methods will be supported in future releases of Unica Plan. Consider all other classes and methods in Unica Plan to be off-limits.

After you code and compile the procedure implementation classes, you make them available to Unica Plan. The build scripts that are supplied with the Unica Plan Integration Services place the compiled procedures in the default location. The final development step is to update the custom procedure plug-in definition file that is used by Unica Plan to discover the custom procedures.

The procedure must implement the com.unica.publicapi.plan.plugin.procedure.IProcedure interface and have a parameter-less constructor (usual JavaBeans model). Coding and compilation of each procedure is done in a Java™ IDE of the customer's choice, such as Eclipse, Borland JBuilder, or Idea. Sample code is provided with Unica Plan as developer toolkits, in the following location:

<Plan_Home>/devkits/integration/examples/src/procedure

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.