Note The Lotus Notes install manifest DTD differs somewhat from the standard Eclipse or IBM® Lotus® Expeditor install or provisioning manifest DTD described in the Eclipse and Expeditor documentation. Open and reference the Lotus Notes-supplied INSTALL.XML for correct file formatting and content information. For example, the Lotus Notes install manifest allows you to do partial installs; the Expeditor manifest does not. The Notes install manifest contains at least four unique attributes that the Expeditor manifest does not. They are "required," "default," "show," and "description."

The Lotus Notes install manifest uses a unique DTD that adheres to Eclipse conventions but is non-standard. The Expeditor install manifest adheres to the DTD conventions described in the Assembling and Deploying Lotus Expeditor Applications help in "Provisioning manifest DTD" and the "Install manifest" section of "Customizing provisioned components" in Lotus Expeditor help below:

• http://publib.boulder.ibm.com/infocenter/ledoc/v6r11/topic/com.ibm.rcp.tools.doc.admin/manifestDTD.htm
• http://publib.boulder.ibm.com/infocenter/ledoc/v6r11/topic/com.ibm.rcp.tools.doc.admin/optionalfeatures.html

The attributes that determine if the "installfeature" name appears on the Lotus Notes feature installation panel are "default," "required," and "show."

The required attributes for each "installfeature" element are described below:

• default -- Specifies whether the "installfeature" name is shown selected for installation. If set to true, the "installfeature" name is selected on the feature installation panel. If set to false, the "installfeature" name is not selected on the feature installation panel.

  Note The "default" attribute is ignored when re-running the installer and is ignored on upgrade unless the "installfeature" did not exist in the previously installed offering. This allows the installer to display the state (installed or not installed) of the "installfeature" that was available in the previously installer offering.

• id -- Specifies a unique ID for the feature to be installed. There is currently no validation check for ID field uniqueness; therefore, the developer must specify a unique value.
• name -- Specifies the "installfeature" name as it will appear on the Lotus Notes feature installation panel.
• required -- Specifies whether the "installfeature" must be installed. If set to true, the feature is installed. If set to false, and show is set to true, the feature name appears on the Lotus Notes feature installation panel and the user can select the option.
• show -- Specifies whether the "installfeature" name appears on the Lotus Notes feature installation panel. If set to true, the "installfeature" name is visible. If set to false, the "installfeature" name is not visible.
• version -- Specifies a numeric value suffix to the install version "installfeature."

The required attributes for each "feature" element are described below:

• download size -- Specifies the temporary disk space required to install this feature.
• id -- Specifies the unique ID that identifies this specific feature and that matches the ID naming convention used in features.xml for that feature.
• match -- Specifies a feature action dependency on the version attribute value and is used to specify a desired match rule.

  Note A version value can consist of four parts -- major.minor.service.qualifier.

• The options are:
  • GreaterOrEqual -- All parts of the version must be greater or equal. The dependent version must be at least at the version specified, or at a higher service, minor or major level.
  • compatible -- Major must match and others must be greater or equal. The dependent plug-in version must be at least at the version specified, or at a higher service level or minor level (major version level must equal the specified version).
  • equivalent -- Major and minor must match and the last parts, for example, service.qualifier, must be greater or equal. The dependent version must be at least at the version specified, or at a higher service level (major and minor version levels must equal the specified version).
  • perfect -- All parts of the version must match.The dependent version must exactly match the specified version.
  
  For example, the following attributes allow installation only if the version value in the update site and SITE.XML file is 3.0.0.

  version="version="3.0.0" match="perfect"

• size -- Specifies the disk space needed for the installed feature.
• url -- Specifies the location from which to obtain the "installfeature" during install and initial provisioning.
• version -- Specifies the version of the feature to be installed and provisioned.

  This is a three or four part value associated with the feature to be installed. It has dependency with the "match" value in determining whether to install the feature. It also has future dependency on the match value when determining whether to update the installed feature.

  The version attribute holds these main values -- major.minor.service release.qualifier. The following example shows version 3.0.0 with the "20070309-1700" qualifier representing a named build or other qualifier value:

  version="3.0.0.20070300-1700"

A sample custom feature block is shown below.

<installfeature default="false" id="ISVExample1" name="YourToolA" required="false" show="true" version "3.0.0.20070309-1700">

                                       <requirements>

<feature download-size="72457" id="com.abx.yourtoolabxz.tools.feature" match="perfect" size="227855" url="${installer.root}/updateSite.zip" version="3.0.0.20070309-1700"/>

See also

Customizing the Notes install manifest to add or modify access to Eclipse features
Customizing the installer process

Glossary