Publishing Publisher Content Items Using IDK Remote APIs
To preview or publish an existing content item, use the IContentItemManager interface in the IDK.
When you publish a content item, Publisher formats the content
according to the associated Presentation Template and saves the formatted
files to the server directory specified in the publishing target.
You can publish one content item at a time or multiple content items
simultaneously. Publishable Presentation Templates can be published
without a content item.
To preview or publish a content item,
the following conditions must be met:
- The Data Entry Template from which the content item was created
must have an attached Presentation Template.
- The folder in which the content item resides must have a configured
previewing and/or publishing target. The target is the location on
the web server where the processed content item will reside. Targets
must be configured in Publisher Explorer and cannot be modified using
the remote Publisher API.
- The user must have an Editor role or higher for the folder in
which the content item resides (required for publication only).
Once a content item or Presentation Template has been published,
it can be removed from the publishing target through expiration. When
you set a content item to expire, Publisher removes the published
content files and all included images and files from the publishing
target and from the Knowledge Directory and search index. Any published
content items that reference the expired content item are refreshed
and republished. The content item itself is not deleted from Publisher.
For more information about publication and expiration, see the Administrator Guide for AquaLogic Interaction Publisher or the
Publisher online help.
The options below also apply to publishable
Presentation Templates; the associated methods can be found in the IPresentationTemplateManager interface.
- To preview a content item, use IContentItemManager.previewContentItem and pass in the content item object. To retrieve the preview URL,
use IContentItem.getPreviewURL.
- To publish a single content item use IContentItemManager.publishContentItem and pass in the content item object. (To check if a content item
has an associated Presentation Template and is ready for publication,
use IContentItem.isContentItemPublishable.) To
retrieve the publication URL, use IContentItem.getPublishURL.
- To publish all the content items in folder, use IContentItemManager.publishContentItems and pass in the
folder object. If subfolders should also be published, set a second
parameter to true. If a content item in a folder fails to publish,
it does not cause complete failure. Publisher will publish all the
content items in the folder except for the ones with errors. If any
content items contained in the specified folder are not published,
an exception will be thrown.
- To expire a content item, use IContentItemManager.expireContentItem and pass in the content item object.
- To expire a folder, use IContentItemManager.expireContentItems and pass in the folder object.
- To republish expired content item, use IContentItemManager.unexpireContentItem and pass in the content item object.
