The widget's extension.xml file will contain an install manifest installfeature snippet with a pointer to the update site and specifications on how to install or update the feature. You can simplify the process described here by using the Features and Plugins wizard in Notes®.

About this task

Perform these steps to create the widget's extension.xml attachment file that you will use to call the update site and provision the feature to users.

Note: TheStart Configuring Widgets toolbar button contains a Features and Plugins option. This option launches a wizard sequence designed to simplify the process of creating a Notes client plug-in deployment widget. The wizard guides you through the widget definition and extension.xml creation process. For details, see How do I configure a Features and Plugins deployment widget?in Notes user help.

Following are some sample XML definitions:

Items in the first section of anextension.xml file are described.

This example references asite.xml file in an NSF-based update site.

By default, only public update sites that do not require authentication are available for feature deployment using widgets. However, you can use accounts to configure access to update sites that require user authentication.

Provided that shared="true" is set in the install manifest of the widget's .XML, the plug-in is installed toNotes_install_dir\framework\shared\eclipse. If there is no write access to that directory, the plug-in is installed toNotes_install_dir\data\workspace\applications.

Note: You can obtain the sample extension.xml file used in this example; see the related information links.

• xml version = internal setting, use exactly as specified in the sample
• encoding = internal setting, use exactly as specified in the sample
• webcontextConfiguration version = internal setting, use exactly as specified in the sample
• palleteItem id = internal ID setting, this must adhere to the namespace/ID format as specified in the sample - this value must be unique for each pallette item
• imageURL = URL at which the widget graphic that appears in the My Widgets sidebar resides, if no value is specified a default graphic is used
• providerID = states the widget's intent, for widgets that deploy features you must use exactly as specified in the sample
• title = widget name that appears in the My Widgets sidebar panel
• url = pointer by which the update site and site.xml are located. You can specify a URL value using NRCP protocol if the update site resides in an NSF-based update site (for example, updateSite.nsf) on a Domino® server or using an HTTP protocol if the update site exists on an HTTP server.

Items in the first section of anextension.xml file are described.

This example references asite.xml file in an NSF-based update site.

By default, only public update sites that do not require authentication are available for feature deployment using widgets. However, you can use accounts to configure access to update sites that require user authentication.

Provided that shared="true" is set in the install manifest of the widget's .XML, the plug-in is installed toNotes_install_dir\framework\shared\eclipse. If there is no write access to that directory, the plug-in is installed toNotes_install_dir\data\workspace\applications.

Note: You can obtain the sample extension.xml file used in this example; see the related information links.

• xml version = internal setting, use exactly as specified in the sample
• encoding = internal setting, use exactly as specified in the sample
• webcontextConfiguration version = internal setting, use exactly as specified in the sample
• palleteItem id = internal ID setting, this must adhere to the namespace/ID format as specified in the sample - this value must be unique for each pallette item
• imageURL = URL at which the widget graphic that appears in the My Widgets sidebar resides, if no value is specified a default graphic is used
• providerID = states the widget's intent, for widgets that deploy features you must use exactly as specified in the sample
• title = widget name that appears in the My Widgets sidebar panel
• url = pointer by which the update site and site.xml are located. You can specify a URL value using NRCP protocol if the update site resides in an NSF-based update site (for example, updateSite.nsf) on a Domino® server or using an HTTP protocol if the update site exists on an HTTP server.

Create the extension.xml file. Use the following XML sample as a guide.

Sample XML

The items in bold are the fields you need to customize for your own feature.

<?xml version="1.0" encoding="UTF-8"?> <webcontextConfiguration version="1.1"> <palleteItem id="com.mycompany.xyz.extensions.featureABX" imageUrl="" providerId="com.ibm.rcp.toolbox.prov.provider.ToolboxProvisioning" title="Comp XYZ Custom Plugin" url="nrpc://WidgetCatalogServer.abx.com/updatesite.nsf/site.xml"> <preferences> </preferences> <data> <installManifest> <![CDATA[ <install> <installfeature description="Comp XYZ Custom Plugin" id="Test_Feature_ABX" name="Test Feature ABX"> <requirements> <feature download-size="10" id="Test_Feature_ABX" match="perfect" shared="true" size="10" version="1.0"/> <requirements> </installfeature> </install> ]]> </installManifest> </data> </palleteItem> </webcontextConfiguration>

Parent topic: Deploying client plug-ins with widgets and the widget catalog
Previous topic: Create an NSF-based update site and import the Eclipse updateSite content
Next topic: Preparing for using widgets in the Notes client

Related concepts
Widget catalog options and access
Understanding the Eclipse update site

Related tasks
Deploying client plug-ins with widgets and the widget catalog
Creating and using an NSF-based update site
Assigning NOTES.INI or location document settings using a desktop policy
Assigning Eclipse preference settings using a desktop policy

Help on Help

All Help Contents

Help on Help