Adapter Configuration |
Adapters may define custom configuration options (except for API Recorder Adapters, which do not support custom options). Adapter-defined options are comma-separated name-value-description triplets that are known only to the adapter.
These options are defined with this argument string:
CONFIGURATION
,name
,value
,description
[,value1
, value2
...]
Robot users may specify adapter-defined configuration options. If you supply optional value arguments to define all valid settings for an option, instead of having to enter a value, the user selects from a predefined list of values. This prevents typographical errors and eliminates the need to parse user selections.
By default, custom options returned from a Custom Recorder Adapter in response to the GetOptions()
call appear on the Method: Custom tab (illustrated below).
The following fragment shows the response to GetOptions()
by a Custom Recorder Adapter that would result in the display shown above.
CONFIGURATION,EJBName,KMHello,EJB to Record; CONFIGURATION,ServerUsername,system,WebLogic Server User Name; CONFIGURATION,ServerPassword,Weblogic,WebLogic Server Password
The triplet grid shown above appears on a different tab depending on the type of adapter:
Your adapter can provide a custom GUI for options it defines. This choice is controlled by the option:
If your adapter specifies this option, the Configure button at the bottom of the options grid (see the previous figure) is enabled. If the user clicks this button, you start the GUI.
If your adapter provides a custom GUI, your response to GetOptions()
is not required to include custom options or to adhere to the Robot-defined triplet format for custom options. If your GetOptions()
response does include custom options, the Robot user can use both the triplet grid and the custom GUI.
If your adapter provides a custom GUI, you are responsible for any necessary user documentation and for conveying a user's choices to the adapter.
Session Recording Extensibility Reference | Rational Software Corporation |
Copyright (c) 2003, Rational Software Corporation | http://www.rational.com support@rational.com info@rational.com |