The add-on feature properties describe each add-on feature
and determine how the add-on feature is processed when it is imported
into an object store.
- Display Name/Name
- The name that is used when the add-on feature is displayed. The
name of each built-in add-on feature is prefixed with the release
number. The display name can contain up to 256 alphanumeric characters.
- Import File
- The name of the XML import script that contains the custom metadata
and data for the add-on feature.
- ID
- The ID of add-on features that have been superseded by this add-on.
An older application might need to determine if the functionality
it requires has simply been created, or if it is created and installed,
in the FileNet® P8 domain.
The application can check the list of superseded add-on IDs. Therefore,
it is important to populate this list when adding new versions of
existing add-on features. The value for this property is necessary
if the new add-on feature is compatible with the previous add-on feature.
- Descriptive Text
- A description of the add-on feature's functionality. If you create
custom add-on features, you can enter a description to help consumers
of your add-on decide whether to install that functionality.
- Superceded IDs
- The list of IDs of add-on features that have been superseded by
this add-on feature.
- Prerequisites
- An add-on feature might be dependent on other add-on features,
called prerequisites, which must be installed before the dependent
add-on. To successfully install a dependent add-on to an object store,
its prerequisite add-on features must be installed first. If you specify
a prerequisite that is not already installed on the object store,
the installation of the add-on generates an error and fails. The order
in which you install prerequisite add-on features does not matter
when you have a single dependent add-on with multiple prerequisites,
as long as you install the dependent add-on last. However, the order
you install the prerequisites is important if you have multiple dependent
add-on features, each with one or more prerequisite add-on features.
You must install the prerequisite add-on features in a sequence that
guarantees that they will already be installed so that the dependent
add-on features that identify them as prerequisites will find them
available and installed.
- Installation Type
- Determines whether installation of the add-on feature is optional
or recommended when creating a new object store. In general, you should
specify as optional those add-on features that are not required for
your system or that deal with specialized, niche functionality. A
recommended add-on feature is one that is typically installed as part
of most systems.
- Pre- and Post- Import Scripts
- The name of the script to run before or after the add-on feature
is imported into an object store. When you install an add-on feature
to an object store, the objects defined in the import file are imported
into the object store. You can optionally run pre- and post-import
scripts when you install an add-on feature. For example, you might
run a script to modify security or to add users and groups before
importing objects. A script must be written in JavaScript. Java™ code
can be directly called from within JavaScript.
You can configure an add-on to use a pre-import script, a post-import
script, or both. Import scripts are invoked within the same transaction
as the add-on's import file, so keeping operations to a minimum is
advised.