A Keyword Reference

This appendix lists the keywords and objects used to specify component code in Oracle Flow Builder. It contains the following sections:

A.1 Keywords and Objects

The following table lists the Keywords and valid objects available to use to specify component code.

Table A-1 Keywords and Objects Reference

Keywords Description Valid Objects

ACTIVATE

Activate the specified object.

The following objects are valid:

  • ALERT

  • CHOICEBOX

  • WINDOW

APPROVE

Approve the specified object.

The following objects are valid:

  • ALERT

  • CHOICEBOX

  • WINDOW

CALGETDATE

Get the Calendar date of the object.

The following objects are valid:

  • MISC

CALSETDATE

Set the Calendar date of the object.

The following objects are valid:

  • MISC

CANCEL

Cancel the specified object.

The following objects are valid:

  • ALERT

  • CHOICEBOX

  • FLEXWINDOW

CHECK

Check a checkbox object.

The following objects are valid:

  • CHECKBOX

CLICK

Click the specified object.

The following objects are valid:

  • ALERTBUTTON

  • BUTTON

  • CHOICEBOXBUTTON

  • EDIT

  • FLEXCANCEL

  • FLEXCOMBINATION

  • FLEXOK

  • IMAGE

  • LINK

  • TAB

  • TOOLBAR

CLOSE

Close the specified window object.

The following objects are valid:

  • WINDOW

COLLAPSE

Collapse the specified tree object.

The following objects are valid:

  • TREE

COLLAPSENODE

Close the specified tree node object.

The following objects are valid:

  • TREE

  • TREELIST

ENDCATCH

Specify the end of a Catch Keyword set. Used with STARTCATCH.

No objects required.

ENDGROUP

Specify the end of a Group Keyword set. Used with STARTGROUP.

No objects required.

ENDITERATE

Specify the end of an iterate Keyword set. Used with STARTITERATE.

No objects required.

ENDKEY

Specify the end of a Key Keyword set. Used with STARTKEY.

No objects required.

ENDOPTIONAL

Specify the end of an Optional Keyword set. Used with STARTOPTIONAL.

No objects required.

ENDRECOVERY

Specify the end of a Recovery Keyword set. Used with STARTRECOVERY.

No objects required.

ENDTAB

Specify the end of a Tab Keyword set. Used with STARTTAB.

No objects required.

ENDXLTBLVERIFY

Specify the end of an Excel table verify Keyword set. Used with STARTXLTBLVERIFY.

No objects required.

ENDXLVERIFY

Specify the end of an Excel verify Keyword set. Used with STARTXLVERIFY.

No objects required.

EXISTS

Check if the specified object exists.

The following objects are valid:

  • ALERT

  • BUTTON

  • CHOICEBOX

  • IMAGE

  • LINK

  • LIST

  • LOV

  • RADIOBUTTON

  • SPREADTABLE

  • TEXTAREA

  • WINDOW

EXPANDNODE

Expand the specified tree node object.

The following objects are valid:

  • TREE

  • TREELIST

FIREEVENTBLUR

Fire the Blur event on the specified object.

The following objects are valid:

  • CHECKBOX

  • EDIT

  • LIST

  • LISTBOX

  • RADIOBUTTON

  • TEXTAREA

FIREEVENTONCHANGE

Fire the OnChange event on the specified object.

The following objects are valid:

  • CHECKBOX

  • EDIT

  • LIST

  • LISTBOX

  • RADIOBUTTON

  • TEXTAREA

FUNCTIONCALL

Call a function from the specified function library.

The following libraries are valid:

  • cRMLIB

  • eBSLibrary

  • fINLIB

  • gENLIB

  • hRMSLIB

  • pRJTBLVERIFYLIB

  • pROCLIB

  • pROJLIB

  • sCMLIB

  • tELNETLIB

  • wEBTABLELIB

GET

Get the specified object.

The following objects are valid:

  • ALERT

  • CHOICEBOX

  • EDIT

  • FIELD

  • LINK

  • LIST

  • LISTBOX

  • SPREADCELL

  • STATUS

  • TEXT

  • TEXTAREA

GETATTRIBUTE

Get the attributes of the specified object.

The following objects are valid:

  • BUTTON

  • EDIT

  • CHECKBOX

  • LIST

  • LOV

  • RADIOBUTTON

  • WINDOW

GETCELLDATA

Get the cell data of the specified table object.

The following objects are valid:

  • TABLE

GETITEMVALUE

Get the value of the specified list object.

The following objects are valid:

  • LIST

INVOKESOFTKEY

Invoke the soft key on the specified object.

The following objects are valid:

  • EDIT

  • SPREADTABLE

LAUNCH

Launch the specified browser object.

The following objects are valid:

  • BROWSER

MAXIMIZE

Maximize the specified window object.

The following objects are valid:

  • WINDOW

MAXVISIBLELINES

Set the maximum number of visible lines in a table object.

No objects required.

MENUSELECT

Select the specified menu object.

The following objects are valid:

  • CONTEXTMENU

  • MAINMENU

  • TREE

MINIMIZE

Minimize the specified window object.

The following objects are valid:

  • WINDOW

NAVIGATE

Navigate to the specified URL.

No objects required.

PRESSTABKEY

Perform a tab key press on the specified object.

The following objects are valid:

  • EDIT

SEARCHBYDYNAMICCOLUMN

Search by dynamic column.

No objects required.

SEARCHCOLUMN

Search by column.

No objects required.

SEARCHEMPTY

Search for an empty column.

No objects required.

SELECT

Perform a select action on the specified object.

The following objects are valid:

  • EDIT

  • LIST

  • LISTBOX

  • RADIOBUTTON

  • TREELIST

SELECTALLROWS

Perform a select all rows action on the specified spreadtable object.

The following objects are valid:

  • SPREADTABLE

SELECTLOV

Perform a select action on the LOV object.

No objects required.

SELECTNODE

Perform a select node action on the specified tree object.

The following objects are valid:

  • TREE

SELECTROW

Perform a select row action on the specified spreadtable object.

The following objects are valid:

  • SPREADTABLE

SENDKEY

Perform a send key action on the specified edit object.

The following objects are valid:

  • EDIT

SETAPPTYPE

Set the application type. This is typically the first keyword specified in the component code.

The following application types are valid:

  • FORMFLEX

  • FORMS

  • JTT

  • TELNET

  • WEB

SETCURRENTROW

Set the current row.

No objects required.

SETFOCUS

Set the focus on the specified object.

The following objects are valid:

  • EDIT

  • FIRSTRECORD

  • TEXTAREA

  • TREELIST

SETLINE

Set the current line.

No objects required.

SETSPREADTABLE

Set the spreadtable.

No objects required.

SETTABLENAME

Set the table name.

No objects required.

SETTEXT

Set the text on the specified object.

The following objects are valid:

  • DYNAMICEDIT

  • EDIT

  • FIELD

  • PASSWORD

  • TEXTAREA

SETWINDOW

Set the window.

No objects required.

STARTCATCH

Specify the start of a Catch Keyword set. Used with ENDCATCH.

No objects required.

STARTGROUP

Specify the start of a Group Keyword set. Used with ENDGROUP.

No objects required.

STARTITERATE

Specify the start of an Iterate Keyword set. Used with ENDITERATE.

No objects required.

STARTKEY

Specify the start of a Key Keyword set. Used with ENDKEY.

No objects required.

STARTOPTIONAL

Specify the start of an Optional Keyword set. Used with ENDOPTIONAL.

No objects required.

STARTRECOVERY

Specify the start of a Recovery Keyword set. Used with ENDRECOVERY.

No objects required.

STARTTAB

Specify the start of a Tab Keyword set. Used with ENDTAB.

No objects required.

STARTXLTBLVERIFY

Specify the start of an Excel table verify Keyword set. Used with ENDXLTBLVERIFY.

No objects required.

STARTXLVERIFY

Specify the start of an Excel verify Keyword set. Used with ENDXLVERIFY.

No objects required.

UNCHECK

Uncheck the specified checkbox object.

The following objects are valid:

  • CHECKBOX

VERIFY

Verify the specified object.

The following objects are valid:

  • CHECKBOX

  • CHOICEBOX

  • EDIT

  • IMAGE

  • LINK

  • LIST

  • LISTBOX

  • RADIOBUTTON

  • SPREADCELL

  • STATUSBAR

  • TEXT

  • TEXTAREA

WAIT

Wait for the specified object.

The following objects are valid:

  • BUTTON

  • EDIT

  • IMAGE

  • LINK

  • LIST

  • LISTBOX

  • NORMAL

  • TEXTAREA

  • WINDOW