IBM Support

Feature category always shown as uncategorized using an Update Site with an IBM Eclipse-based product

Troubleshooting


Problem

There is a piece of functionality missing from the Eclipse version delivered with IBM Rational Software Architect 7.5 to 7.5.2. This functionality allows the user to specify categories for plugins that have been developed. Any defined categories are ignored and all features appear under a category entitled "uncategorized" This only affects the version of Eclipse using the Equinox P2 software update mechanism.

Symptom

Features are always listed under the uncategorized category, as in the Software Updates and Add-ons screenshot:

Cause

This issue has been identified as a product defect and has been logged under APAR PK85420.

Diagnosing The Problem

Note that if any of the following projects types are unavailable then you will need to install the plug-in development features of the product by running the Installation manager and modifying the install to include the feature(s).

Steps to reproduce:

i) Create simple plugin project with default values for all fields
- Select File > New > Other… menu
- Type plug-in into the wizard filter test field and select Plug-in Project. Click Next.
- Give the project a name, for example, TestPlugin. Click Next. Click Finish.

ii) Create Feature project for this plugin
- Select File > New > Other… menu
- Type in feature into the wizard filter test field and select Feature Project. Click Next.
- Give the project a name, for example, TestPluginFeature. Click Next.
- Select the plug-in project created above in the Reference Plug-ins and Fragments dialogue (probably the last in the list). Click Finish.

iii) Create update site project for the above and create a category for the plugin
- Select File > New > Other… menu
- Type in update into the wizard filter test field and select Update Site Project. Click Next.
- Give the project a name, for example, TestPluginUpdateSite. Click Finish.
- Click on NewCategory on the site.xml Site Map tab .
- Click on the new category in the tree and click Add Feature…
- Select the feature created above (probably the last in the list).

iv) Build the site and try and install it
- Click on Build from the Site Map tab of the site.xml file in the update site project.
- Select Help > Software Updates…
- Go to the Available Software tab
- Click Add Site…
- Click Local…
- Select the directory where the Plugin Update Site project is (should be <WORKSPACE DIR>/TestUpdateSite1 and click OK

v) Remove the update site by clicking Manage Sites…, highlighting the TestPluginUpdateSite and clicking Remove. Close the Software Update dialogue.


The category appears as uncategorized in Step iv.

Resolving The Problem

Add the following text (suitably modified with the feature name, version, category name etc. for the plug-in) to the contents.xml file just before the
</units> tag at the end of the file.

 <unit id='Category1' version='0.0.0'>
 <properties size='2'>
  <property name='org.eclipse.equinox.p2.name' value='New Category 1'/>
  <property name='org.eclipse.equinox.p2.type.category' value='true'/>
 </properties>
 <provides size='1'>
  <provided namespace='org.eclipse.equinox.p2.iu' name='Category1' version='0.0.0'/>
 </provides>
 <requires size='1'>
   <required namespace='org.eclipse.equinox.p2.iu' name='TestPluginFeature.feature.group' range='[1.0.0,1.0.0]'/>
 </requires>
 <touchpoint id='null' version='0.0.0'/>
</unit>

[{"Product":{"code":"SSCLKU","label":"Rational Software Modeler"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Extensibility","Platform":[{"code":"PF033","label":"Windows"},{"code":"PF016","label":"Linux"}],"Version":"7.5;7.5.1;7.5.2;7.5.3","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}},{"Product":{"code":"SS4JE2","label":"Rational Software Architect Standard Edition"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":null,"Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"7.5;7.5.1;7.5.2;7.5.3","Edition":"","Line of Business":{"code":"LOB36","label":"IBM Automation"}},{"Product":{"code":"SS4JCV","label":"Rational Software Architect for WebSphere Software"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":null,"Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"7.5;7.5.1;7.5.2;7.5.3","Edition":"","Line of Business":{"code":"LOB15","label":"Integration"}}]

Document Information

Modified date:
29 September 2018

UID

swg21385395