Registering an add-on feature

Before you can install an add-on feature to an object store, you must first register it in the global configuration database (GCD) of the FileNet® P8 domain. When you register an add-on feature, you can associate VBScript or JScript import scripts to run before or after the installation process.

About this task

  • To register an add-on feature, you must have domain-level write permission.
  • There are two methods to register an add-on in the GCD, depending on how the add-on is constructed. One method requires manual entry of the configuration values for the add-on. The other method uses a descriptor, a file with pre-set configuration values that are automatically imported into the GCD.

    To install an add-on that uses a descriptor, the descriptor file (.desc) and associated files must first be placed on a local file system. Associated files are a required import data set (.xml) and optional pre-import and post-import scripts, which can be copied from the installation media.

    For example, for the addOn that implements support for a Hadoop storage device, the Content Platform Engine installation media contains a folder named Hadoop that contains the .desc and .xml files needed to run the New Add-ons wizard.

    Important: All of the add-on files from the installation media must be extracted to the same directory on the local file system. These files must not be altered.

Procedure

To register an add-on feature:

  1. Start the New Add-On wizard in the administration console:
    1. In the domain navigation pane, navigate to Global Configuration > Data Design > Add-ons.
    2. Right-click the Add-ons node and click New Add-On.
  2. In the New Add-On tab, click the method to install the add-on and click Next.

    If you choose the descriptor method, you are prompted to enter the path to the add-on's descriptor file, which has an extension of .desc.

    If you choose the manual-entry method, you must enter the configuration values for the add-on.

  3. Complete the wizard.

What to do next

After the add-on is registered in the GCD, it is ready to be installed to an object store.