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.
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.

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.

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.

Configuration properties for the Integration Module are under Plan | umoConfiguration | integrationServices.

The enableIntegrationServices configuration property to turns the Integration Services module on and off.
The integrationProcedureDefinitionPath parameter contains the full file path to the custom procedure definition XML file.
The default value is <HCL_Unica_Home><Plan_Home>/devkits/integration/ examples/src/procedure/procedure-plugins.xml/.
The integrationProcedureClasspathURL parameter contains the URL to the class path for custom procedures.
The default value is file:///<HCL_Unica_Home><Plan_Home>/devkits/ integration/examples/classes/.
Note: The '/' at the end of the integrationProcedureClasspathURL path is required for loading procedure classes correctly.

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.