About Remote Publisher APIs
The IDK's remote Publisher API (com.plumtree.remote.prc.content)
provides programmatic access to many of the objects stored within
AquaLogic Interaction Publisher. Use this remote programming interface
to embed Publisher components and functions into any web application
delivered through the ALI framework.
You can publish simple HTML pages by creating and publishing either
content items or Presentation Templates. The published HTML content
is managed by Publisher—which stores the published pages in your portal's
subnet, controls who can access them, and makes them searchable.
You can create published content portlets, which provide access
to content items from within a portal page. The following portlet
types can be created using the Publisher portlet templates and the
Published Content Web Service:
- Announcement portlets display a formatted text message that Community
Managers (or any user with an Editor or higher role for the folder)
can edit and publish. The portlet can display one or more content
items that include images, links to Web sites, or other content.
- News portlets display a list of links to published content items
(articles). The articles themselves, which can be accessed by clicking
a link in the News portlet, are launched on individual article pages.
- Community Directory portlets display articles in a folder structure.
For details on using remote Publisher APIs, see
the following topics:
For details on Publisher functionality, see the Administrator
Guide for AquaLogic Interaction Publisher and the Publisher online
help.
- About Remote Publisher Folder OperationsFolders are containers that enable you to access and manage Publisher objects. The IDK remote Publisher API (com.plumtree.remote.prc.content.folder) allows you to query, create, or modify folders.
- About Remote Publisher Content Item OperationsPublisher content items are the primary publishable objects of Publisher. Content items can be objects created from a Data Entry Template, or they can be imported files and images. Content items can be created and managed remotely using the IDK remote Publisher API.
- About Remote Publisher Data Entry Template OperationsData Entry Templates consist of a set of properties that define the fields available for creating a content item. The IDK remote Publisher API (com.plumtree.remote.prc.content.dataentrytemplate) allows you to create and manage Data Entry Templates, add and remove properties, and attach and detach Presentation Templates.
- About Remote Publisher Presentation Template OperationsPresentation Templates define how content items are formatted and displayed when they are previewed or published. Presentation Templates can be created and managed remotely using the IDK remote Publisher API.
- About Publisher Properties and Remote Property OperationsProperties categorize data into types (such as text, integer, or date). Properties are used to represent variables in Data Entry Templates and Presenation Templates that are processed to create content items.
- Publisher Remote API ExceptionsThe IDK remote Publisher API (com.plumtree.remote.prc.content) throws six types of exceptions.
- Publisher RolesPublisher security is role-based and assigned by folder. The IDK remote Publisher API can be used to query role information but does not provide programmatic access to modify roles.