Specifies how to upgrade a set of existing add-ons to a new set of add-ons. An UpgradeAddOn object has the following characteristics:
  • It has import data, a pre-import script, and a post-import script, and is installed using the same API method (ObjectStore.InstallAddOn) as a normal add-on.
  • It identifies the old add-on version(s) (FromVersions property) and the new add-on version(s) (ToVersions property).
  • When an add-on has been successfully upgraded, the older version's AddOnInstallationRecord object is replaced with an installation record for the newer version.
  • It can upgrade one or more add-ons of older versions to one or more add-ons of newer versions via a single UpgradeAddOn object. For example, when an UpgradeAddOn object with a FromVersions value of [A1, A2, A3] and a ToVersions value of [A4, A5] is installed on an object store, the AddOnInstallationRecord objects for A1, A2, and A3 are removed and replaced with AddOnInstallationRecord objects for A4 and A5.

Namespace:  FileNet.Api.Admin
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface IUpgradeAddOn _
	Implements IAddOn, IIndependentlyPersistableObject, IIndependentObject, IEngineObject,  _
	ICloneable
C#
public interface IUpgradeAddOn : IAddOn, 
	IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
Visual C++
public interface class IUpgradeAddOn : IAddOn, 
	IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
JavaScript
FileNet.Api.Admin.IUpgradeAddOn = function();
FileNet.Api.Admin.IUpgradeAddOn.createInterface('FileNet.Api.Admin.IUpgradeAddOn');

ToggleRemarks

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: AddOn

ToggleSee Also