Installing an Add-on into an object store

An add-on that is registered in the Global Configuration Database (GCD) can be installed on an object store with the Content Engine APIs.

To install an add-on, you must have domain-level write permission. In addition, to import the data set on the add-on and to perform the operations in the pre-import and post-import scripts, you must have whatever additional access rights are required for those operations.

To install an add-on to an object store, call the ObjectStore.installAddOn method. Input to the method is the AddOn or UpgradeAddOn object to install. Objects that are installed through the installAddOn method take on the default instance permissions, even if permissions are defined within the XML import data set. If permissions for the objects exist in the data set, they are ignored. After installation completes successfully, and before you attempt to access the add-on objects, use an approach of your choice to modify the security on the objects.

When you call the installAddOn method, an InstallAddOn object is created. When you save the ObjectStore object, an AddOnInstallationRecord object is created. You can retrieve the AddOnInstallationRecord object to get installation-related information about the add-on, such as the installation status of the add-on (Installed or InstallationFailure), an installation report if the installation failed, and the ID of the user who installed the add-on. You can also retrieve the AddOn object, if it was successfully installed.