Represents a product extension to the core FileNet P8 Content Engine components. These extensions consist of properties and/or classes to support a specific feature. Add-ons can be non-FileNet products that are compatible with FileNet P8, or they can be FileNet-supplied and provide additional functionality.

You can create an AddOn object by calling CreateInstance on the Factory.AddOn class. Creating an add-on automatically registers it in the FileNet P8 Global Configuration Data (GCD) database. A registered add-on can then be:

  • Installed during new object store creation.
  • Installed on an existing object store.

The following tables list the members exposed by IAddOn.

Public Properties

 NameDescription
Public propertyAddOnTypeSpecifies whether the addon is optional or recommended for installation into an object store. During object store creation, Enterprise Manager selects for installation those addons having a type of recommended. Therefore, you should define an addon as recommended only if the functionality it provides is very likely to be required in most installations. The majority of addons should be defined as optional and must be explicitly selected for installation. Note that although the default Enterprise Manager behavior is to install recommended addons, this is not required; you can deselect a recommended addon if you do not need the functionality it provides.
Public propertyCreatorIndicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public propertyDateCreatedIndicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Public propertyDateLastModifiedIndicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public propertyDescriptiveTextUser-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

  • ClassDescription
  • PropertyDescription*
  • ClassDefinition
  • PropertyTemplate*
  • PropertyDefinition*
Public propertyDisplayNameThe user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
Public propertyIdA representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Public propertyLastModifierIndicates the name of the user who last modified the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Public propertyPrerequisitesSpecifies a list of IDs corresponding to the prerequisite add-ons that must be installed prior to the installation of this add-on or upgrade add-on.
Public propertyScriptTypeSpecifies the language in which the pre- or post-import scripts are written. This property's value must be set to JavaScript.
Public propertySupersededAddOnIdsThe IDs of IAddOn objects superseded by this IAddOn.

Although present on the IAddOn object and, by inheritance, the IUpgradeAddOn object, this property has no use on the IUpgradeAddOn object..

A newer version IAddOn must specify in this property the IDs of the prior version IAddOn objects that it functionally replaces, allowing an application with a dependency on that replaced (superseded) functionality to determine whether the functionality is available through the superseding IAddOn. (See also the IsAddOnInstalled helper method.)

Top

Public Methods

 NameDescription
Public methodAccessImportDataStreamObtains access to the import data via a stream. The underlying Java InputStream object.
Public methodAccessPostImportScriptStreamObtains access to the post-import script via a stream. The underlying Java InputStream object.
Public methodAccessPreImportScriptStreamObtains access to the pre-import script via a stream. The underlying Java InputStream object.
Public methodSetImportDataStreamSpecifies the data stream containing the import data for this AddOn object.
Public methodSetPostImportScriptStreamSpecifies the data stream containing the post-import script for this AddOn object.
Public methodSetPreImportScriptStreamSpecifies the data stream containing the pre-import script for this AddOn object.
Top

See Also