Adapter Configuration |
There are three categories of Robot-defined options:
When the user starts recording, the Session Record floating tool bar appears (see below, left side), from which the Session Insert tool bar (right side) can be opened.
Options on these tool bars allow users to insert time-stamped data into an annotations file. If your Custom Recorder Adapter enables these options, the associated Custom Script Generator Adapter, in order to script the preferences, must interpret the annotations file entries and synchronize them with the session file. API Script Generator Adapters must support these options.
The following table lists the argument strings that enable the features on the Session Record and Session Insert dialog boxes. If your Custom Recorder Adapter does not include these argument strings in response to GetOptions()
, the corresponding icon is dimmed. The icons are always enabled during API recording and so should be supported by API Script Generator Adapters.
Start Application
RECORD_START_APP
Split Script
RECORD_SPLIT
Insert Timer start/stop
RECORD_TIMER
Insert Comment
RECORD_COMMENT
Insert Block start/stop
RECORD_BLOCK
The Generator tab of the Session Record Options dialog box displays script generation options that Custom Script Generator Adapters and API Script Generator Adapters can enable or disable. The following figure shows the GUI options and the argument strings you use to enable the options. If your script generator adapter does not include these argument strings in response to GetOptions()
, the corresponding checkbox or entry box is shaded. See GetOptions() (Custom Script Generator Adapters) or GetOptions() (API Script Generator Adapters) for the exact configuration arguments to use in order to enable these options.
One other script generation option, relevant only for Custom Recorder Adapters, appears on the General tab. If Prompt for application name on start recording is checked, the user is prompted to name an application to be started at the outset of recording. The argument string that enables this checkbox is GENERAL_START_APP_PROMPT
.
The following table describes the argument strings for non-GUI configuration options and names the type of adapter that can specify the argument in response to GetOptions()
. These option arguments describe how your adapters work internally or how adapters communicate with one another or the Robot user.
CONFIGURATION
,name
,value
,description
[,value1
, value2
...] Custom Recorder Adapter, Custom Script Generator Adapter, Generator Filter Adapter, API Script Generator Adapter
Specifies an adapter-defined option. See Adapter-Defined Configuration Options.
CONFIGURATION
, USE_CUSTOM_UI
Custom Recorder Adapter, Custom Script Generator Adapter, Generator Filter Adapter, API Script Generator Adapter
Specifies that the adapter supplies a custom GUI for displaying and editing of adapter-defined configuration settings. See Using a Custom UI for Custom Options.
DEFAULT_SCRIPT
_GENERATOR Custom Recorder Adapter
Specifies the display name of the corresponding Custom Script Generator Adapter. If not specified, the user must select the adapter from the Script Generator box on the Method tab. If a Custom Recorder Adapter can be used with only one Custom Script Generator Adapter, remove ambiguity for the user by assigning them the same display name..
SESSION_FILES,
type
Custom Recorder Adapter
Specifies the internal format (Rational binary format, XML, or custom) of the session file(s). This option must be specified.
TEST_SCRIPT_TYPE,
type
Custom Script Generator Adapter, Generator Filter Adapter
Specifies the language (Java, Visual Basic, or VU) of the generated script. This option must be specified.
USE_SCRIPTGEN
_PROGRESS Custom Script Generator Adapter
Specifies that an adapter supplies progress information so that the waiting user can see the status in a progress dialog box.
Session Recording Extensibility Reference | Rational Software Corporation |
Copyright (c) 2003, Rational Software Corporation | http://www.rational.com support@rational.com info@rational.com |