Creating a Lookup View Extension

It is possible to include user specified code explanations in the ADFz Lookup View.

This is accomplished by creating an Eclipse plug-in that extends the ADFzCC lookup view explanation provider extension point.

This guide details the steps required to create a new plug-in that contributes code explanations to the Lookup view, using the IBM Fault Analyzer IDIHUSRM message file format.

Install IBM Application Delivery Foundation Common Components Feature

  1. Click Help, Install New Software
  2. Select the IBM Explorer for z/OS and wait for it to load...
  3. Select the Application Delivery Foundation Common Components Feature, Click Next >
  4. On the Install Details Page, Click Next >
  5. On the Review Licenses, accept the license, Click Finish
  6. If prompted accept the warning about Unsigned plug-ins, Click OK
  7. Complete the installation by restarting IBM Explorer for z/OS

Back to top

Set the target platform to the Running Platform

  1. Click Window, Preferences
  2. In the preferences dialog, select Plug-in Development, Target Platform. Ensure that Running Platform is checked, Click Apply, then Click OK

Open the Plug-in Perspective

  1. Click on Window, Open Perspective, Other...
  2. Select the Plug-in Perspective

Back to top

Create a new Plug-in Project

  1. Create a new Plug-in Project
  2. Specify a project name, Click Next >
  3. Specify a name and Vendor, Click Next >
  4. Un-check "Create a plug-in using one of the templates", Click Finish
  5. The new plug-in opens and the overview tab is shown
  6. Select the Dependencies tab and click add required plug-in.
    In the filter type com.ibm.pdtools , select plug-in com.ibm.pdtools.common.component.lookup (version 14.1.600 or newer ), Click OK
  7. Save the plug-in editor
  8. Select the Extensions Tab, Click Add...
    Select pdtools.user.code.explanation.providers , Click Finish
  9. The extension is added to the plug-ins extension list
  10. Select the added extension, Right Click, Click New, IDIHUSRMProvider
  11. Specify the filename for the explanations file, save the plug-in editor.
  12. Create a new file in the project
  13. Specify the same name as used in the explanation extension, Click Finish
  14. On the build tab, specify that the file is included in binary builds of the plug-in
  15. Add any user explanations from the IDIHUSRM member on the host to the local explanations file. Save the explanations file.

Back to top

Create a Feature that includes the new Lookup Extension Plug-in

  1. Click File, New, Feature Project
  2. Specify the project name, Click Next >
  3. Add the lookup extension plug-in as a referenced plug-in, click Finish

Back to top

Create an Update Site to allow the feature to be installed into IBM Explorer for z/OS

  1. Click File, New, Other...
  2. Select Plug-in Development, Update Site Project, Click Next >
  3. Specify Project name, Click Finish
  4. Click New Category, specify a category ID and Name. The Explanation Extensions feature will appear in this category when being installed.
  5. Click Add Feature..., in the Feature Selection dialog, select the Lookup Explanation Extension Feature, Click OK
  6. Save the Update Site Editor
  7. Click Build All.
  8. The feature and plug-in will be built and appear in the update project.

Back to top

Install the Explanation Extension feature

  1. Click Help, Install New Software...
  2. Add the Update site that was created above as a 'Local' Update Site
  3. Expand the category and select the Explanations Feature, Click Next >
  4. On Install Details page, Click Next >
  5. Accept the license agreement, Click Finish
  6. If prompted accept the warning about Unsigned plug-ins, Click OK
  7. Restart IBM Explorer for z/OS to complete the installation.

Back to top

Confirm that the user code Explanations appear in Lookup view

  1. Click Window, Show View, Other...
  2. In the View selection dialog, Expand ADFz, select Lookup Click OK
  3. The Lookup View Opens, the new messages should appear in the USER category.
  4. Search supports user codes, if they are installed too

Back to top

Disabling User Explanation extensions

If required user explanation extensions can be disabled:
  1. Click Window, Preferences
  2. Expand the ADFz Category, select Lookup View.

  3. Un-check 'Enable user Code Explanations' to disable all user explanation extensions. Click Apply, then OK.
  4. The user category no longer appears in the Lookup View.

Back to top

Supported file formats for User Code Explanations

There are a number of supported formats for User code explanation message data.

The following example shows how each type of user code explanation extension can be specified in plugin.xml files:

<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
   <extension point="pdtools.user.code.explanation.providers">
      <dynamicProvider class="common.component.lookup.extension.sample.SampleMessageProviderImplementation" category="OTHERS" />
      <staticProvider file="sample.mappings.properties" category="OTHERS" type="PROPERTIES" />
      <staticProvider file="sample.mappings.xml" category="OTHERS" type="PROPERTIES_XML" />
      <staticProvider file="sample.mappings.json" category="OTHERS" type="JSON" />
      <staticProvider file="sample.mappings.csv" category="OTHERS" type="CSV" />
      <IDIHUSRMProvider file="sample.mappings.idihusrm" />
   </extension>
</plugin>