Module 9: Introduction to parameter and action extension points

Edit online

This module explores the capabilities of CARMA extension points in providing customization to parameters and actions that are associated with a custom action on a particular RAM.

This module updates and uses the Sample PDS RAM to create a HowTo custom action and associate four parameters to it.

Learning objectives

After completing the lessons in this module you should be able to:

Create an Eclipse plug-in project
Create and define actionValidators, parameterValidators, and customParameterControl extension points
Create and develop the necessary classes to add the enhanced functionality to the custom actions
Run and debug the plug-in project
Understand the end-result in the plug-in project of using each of the extension points

Time required

This module should take approximately 60 minutes to complete.

Prerequisites

To successfully complete the lessons in this module, you should have:

Access to modify the Sample PDS RAM on your host system or a systems administrator who can do this for you
Basic understanding of RAM Development, found in the CARMA Developer's Guide
Basic understanding of C coding and debugging is recommended
Experience submitting JCL jobs to REPRO files

Lesson 1.0: Configure the Sample PDS RAM on the host
The extension points used in this sample ensures that the input is in the permitted format, ensures that the input will not cause errors, and modifies the view of the custom actions pertaining to a particular RAM. For this sample, you use the PDS RAM. However, because there are no custom actions that are already integrated into the Sample PDS RAM, you have to configure the RAM with a new custom action and its four parameters.
Lesson 2: Define the dependency and extensions for the plug-in project
In this lesson, you define the dependencies and the three extension points: actionValidators, parameterValidators, and customParameterControl.
Lesson 3: Configure the com.ibm.carma.ui.parameterValidators Extension
In this lesson, you configure the parameterValidator extension that you defined in the previous lesson for the plug-in project.
Lesson 4: Configure the com.ibm.carma.ui.actionValidators extension
In this lesson, you configure the actionValidator extension that you defined for this plug-in project.
Lesson 5: Configure the com.ibm.carma.ui.customParameterControl extension point
In this lesson, you configure the customParameterControl extension that you defined for this plug-in project.
Lesson 6: Create the appropriate Java classes to handle the verification and validation
In the previous lessons you configured the extension points; now you create the Java™ classes that are needed to handle the validation of the parameters and actions.
Lesson 7: Create the code for the ValueParamValidator class
The ValueParamValidator class handles the verification of the Value parameter in the HowTo action. This lesson describes in detail how to create the code to demonstrate the parameter verification and validation features of the com.ibm.carma.ui.parameterValidators extension point.
Lesson 8: Create the code for the ActionValidator class
The ActionValidator class verifies that at least one of the string parameters has a value, but not both. You will also make the Value parameter a required parameter, and codes the ActionValidator class to mark the parameter with an asterisk.
Lesson 9: Create the code for the CheckboxOptionControl class
The CheckboxOptionControl class changes the CARMA default text field to a checkbox on the Option parameter. Since this parameter is a yes or no parameter, a checkbox is more convenient for the user.
Summary: Module 9
In this module, you have created a plug-in project that demonstrates the use of the actionValidators, parameterValidators, and customParameterControl extension points.