Home
Integration Module
Unica Plan Integration Services combines the Unica Plan Integration Webservice, SOAP API procedures, and triggers to extend business capabilities.
About the Plan API
The Unica Plan SOAP API is a façade that provides a client view of a running Unica Plan instance.
Contents of the Plan API
The com.unica.publicapi.plan.api package delivers the Unica Plan SOAP API.
Common exceptions
Common exceptions that are thrown by the SOAP API include NotFoundException, AuthorizationException, DataException, InvalidExecutionContextException, and NotLockedException.

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.
- About the Plan API
  The Unica Plan SOAP API is a façade that provides a client view of a running Unica Plan instance.
  - Contents of the Plan API
    The com.unica.publicapi.plan.api package delivers the Unica Plan SOAP API.
    - API Interfaces
      The Unica Plan SOAP application programming interface (API) includes IPlanAPI and IExecutionContext.
    - Common exceptions
      Common exceptions that are thrown by the SOAP API include NotFoundException, AuthorizationException, DataException, InvalidExecutionContextException, and NotLockedException.
    - Handles
      A handle is special URL object that references a particular object instance in an Unica Plan instance. Handles include the component type, internal data identifier, and an instance base URL.
    - Attribute Map
      The AttributeMap class is a Java™ map that contains only attributes. The attribute <Name> is the map entry key, and the attribute <values> array (note plural) is the map entry value.
    - Enumerated data types
      The Unica Plan SOPA API supports the following enumerated data types and values.

SOAP API common exceptions

Common exceptions that are thrown by the SOAP API include NotFoundException, AuthorizationException, DataException, InvalidExecutionContextException, and NotLockedException.

The following list explains why these common exceptions might occur.

<object type>NotFoundException: The system is unable to return the specified item or object.
AuthorizationException: The user who is associated with the execution context is not authorized for the requested operation. This exception can be thrown by any API method, so is undeclared.
DataException: An exception occurred in the underlying database layer in Unica Plan. Check the SQL log for details.
InvalidExecutionContextException: There is a problem with an execution context passed to an API method (for example, the method was not initialized correctly). This exception can be thrown by any API, so is undeclared.
NotLockedException: Attempt to update component data without first acquiring the required lock. See the acquireLock() method of the IExecutionContext interface.

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.