IBM FileNet P8, Version 5.2.1            

Publishing Extensions

Publishing Extensions contains classes and properties that support the publishing process, including the Publish Key, Publish Request, Publish Style Template, and Publish Transformation Engine. Most of the data required to support the publishing process is provided through the use of this add-on feature, including:

Display Name
Release Publishing Extensions
XML Script Name
PublishingExtensions.xml
Installation Type
Recommended
Predecessors
  • Base Content Engine Extensions
  • Process Engine Extensions
  • Base Application Extensions
Required By
  • Workplace Access Roles Extensions
  • Workplace Base Extensions
  • Workplace E-mail Extensions
  • Workplace Templates Extensions

Publishing Extensions provides property templates and implements custom classes, objects, and properties in the following areas:

Publishing Extensions provides classes and properties that support ready-to-use behavior for the publishing process, including the Publish Key, Publish Request, Publish Style Template, and Publish Transformation Engine. Do not modify the values for properties on object instances created by FileNet® ready-to-use applications; changing these values can cause application behavior issues with FileNet applications and add-on features. In addition, do not use other software applications to extend the classes. The descriptions included in this section are provided for informational purposes only.

Property templates

The following property templates are added by Publishing Extensions and implemented by various feature add-ons.

Property Template Type Implementations Description
Dependent Documents Object Document class Contains a list of all dependent documents that are to be deleted when the published document is deleted (this is a publishing option specified in the Publishing Designer).
Input Formats String Publish Style Template class Specifies a list of input MIME formats supported for this style template.
Output Format String Publish Style Template class Specifies the MIME type of output documents produced by the transformation engine when using this style template.
Owner Document Object Document class Represents the published document and returns a reference to the Document object that represents the owner document associated with the published document.
PDF Master Password String Publish Style Template class Encrypted strings representing PDF master and user passwords on PDF publication. They are Adobe PDF document features used for password-protecting the document. They are optional for a PublishStyleTemplate. If specified (via PublishStyleTemplate Manager), the passwords are applied to the resultant PDF document.
PDF User Password String Publish Style Template class Encrypted strings representing PDF master and user passwords on PDF publication. They are Adobe PDF document features used for password-protecting the document. They are optional for a PublishStyleTemplate. If specified (via PublishStyleTemplate Manager), the passwords are applied to the resultant PDF document.
Provider ID String Publish Style Template class Specifies a string that identifies the Publishing Plug-in that registered the style template. For example, com.filenet.cee.publishing.HTML.plugin.
Publication Info Binary Document class Specifies information about a publication, such as the IDs of the original output folder, the style template, the publish template, and the version series of the publish template. The information is presented in a binary format that can be accessed in the PublicationRecord through the Content Engine COM API.
Publication Source Object Document class Points to the source document from within a publication document.
Publications Object Document class Contains a list of all publications that utilize this document as the source document.
Publishing Subsidiary Folder Object Document class Points to subsidiary folder object that contains the subsidiary documents (such as images, sound, icons, style sheet) of an HTML publication.
Style Template Object Publish Template classes Specifies the style template that is to be used in the processing of the publish request or publish template.
Title String Publish Style Template class Workplace Base Extensions —Related Items class Specifies a title for the style template.
Transformation Options Binary Publish Style Template class Stores transformation engine options, such as those required for working with PDF files, including user and master passwords, or print and copy options.

Properties of Document Class and Subclasses

The following properties are added to the Document Class by Publishing Extensions.

Property Type Modifiable Description
Dependent Documents Object No Used as a reflective property for the Owner Document property, it contains a list of all dependent documents that are to be deleted when the published document is deleted (this is a publishing option specified in the Publishing Designer). A reflective property is the association property in another class that has a relationship with this association property.
Owner Document Object No Used as a reflective property for the Dependent Documents property, it is the published document and returns a reference to the Document object that represents the owner document associated with the published document.
Publication Info Binary No Specifies information about a publication, such as the IDs of the original output folder, the style template, the publish template, and the version series of the publish template. The information is presented in a binary format that can be accessed in the PublicationRecord through the Content Engine COM API. This property is empty if the document is not a publication.
Publication Source Object No Used as a reflective property for the Publications property, within a publication document this points to the source document. A reflective property is the association property in another class that has a relationship with this association property.
Publications Object No Used as a reflective property for the Publication Source property, it contains a list of all publications that utilize this document as the source document.
Publishing Subsidiary Folder Object No Points to subsidiary folder object that contains the subsidiary documents (such as images, sound, icons, style sheet) of an HTML publication.

Custom Subclasses Added to the Document Class

The following subclasses are derived from the Document Class by Publishing Extensions.

Subclass Modifiable Description
Publish Template No Describes the Publish Template that is created by the Publishing Designer from the Advanced section of the Authoring selection in Workplace.

Publish Template, Subclass of Document Class

The following properties are added to the Publish Template subclass by Publishing Extensions.

Property Type Modifiable Description
Description String No Provides a description for the template, or an empty string if none exists. This property is an implementation of the Description property template, which is added by Base Application Extensions.
Style Template Object No When the source document is to be transformed to HTML or PDF, specifies the Publish Style Template that is to be used.

Custom Subclasses of Custom Object

The following subclasses are derived from the Custom Object by Publishing Extensions.

Subclass Modifiable Description
Publish Style Template No Contains the input and output MIME types and custom options to apply to a transformation during publishing, and specifies a transformation engine that determines which implementation of a Publishing Plug-in will be used. The default installation consists of three objects of this subclass: Default HTML Style Template, Default PDF Style Template, and Case Management PDF Style Template.

Publish Style Template, Subclass of Custom Object

The following properties are added to the Publish Style Template subclass by Publishing Extensions.

Property Type Modifiable Description
Custom Object Type String Yes (Hidden) Specifies the type of a custom object and is used to determine which icon to display for the object in Workplace. The specified string value should exist in the customobjecticon.properties file (located at the root level of the tree) and the appropriate icon to display for the object type should be located in the images/customobject directory.

For more information about this property, see the description of the Custom Object Type property template in the Workplace Base Extensions section.

Description String No Provides a contextual description for the style template, or an empty string if none exists. This property is an implementation of the Description property template, which is added by Base Application Extensions.
Input Formats String No Specifies a list of input MIME formats supported for this style template.
Output Format String No Specifies the MIME type of output documents produced by the transformation engine when using this style template.
PDF Master Password String Yes Encrypted strings representing PDF master and user passwords on PDF publication. They are Adobe PDF document features used for password-protecting the document. They are optional for a PublishStyleTemplate. If specified (via PublishStyleTemplate Manager), the passwords are applied to the resultant PDF document.
PDF User Password String Yes Encrypted strings representing PDF master and user passwords on PDF publication. They are Adobe PDF document features used for password-protecting the document. They are optional for a PublishStyleTemplate. If specified (via PublishStyleTemplate Manager), the passwords are applied to the resultant PDF document.
Provider ID String No Specifies a string that identifies the Publishing Plug-in that registered the style template. For example, com.filenet.cee.publishing.HTML.plugin.
Title String No Specifies a title for the style template.
Transformation Options Binary No Stores transformation engine options, such as those required for working with PDF files, including user and master passwords, or print and copy options.


Last updated: March 2016
_start_here_pub.htm

© Copyright IBM Corporation 2016.