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

ACTIVITYEVENT

Specify an Activity Event.

No objects required.

APPROVE

Approve the specified object.

The following objects are valid:

  • ALERT

  • CHOICEBOX

  • FLEXWINDOW

  • RESPONSEBOX

CALENDAREVENT

Specify a Caenadar Event.

No objects required.

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

  • RESPONSEBOX

CHECK

Check a checkbox object.

The following objects are valid:

  • CHECKBOX

CLICK

Click the specified object.

The following objects are valid:

  • ADFBUTTON

  • ADFCOMMANDMENU

  • ADFTOOLBARBUTTON

  • ALERTBUTTON

  • BUTTON

  • CHOICEBOXBUTTON

  • EDIT

  • FLEXCANCEL

  • FLEXCOMBINATION

  • FLEXOK

  • IMAGE

  • LINK

  • MENU

  • TAB

  • TOOLBAR

CLICKBUTTONK

Click the specified button object.

The following objects are valid:

  • DIALOG

CLICKICON

Click the specified icon object.

No objects required.

CLICKSEARCHICON

Click the specified search icon object.

No objects required.

CLOSE

Close the specified window object.

The following objects are valid:

  • ADFPANELWINDOW

  • DIALOG

  • WINDOW

COLLAPSE

Collapse the specified tree object.

The following objects are valid:

  • ADFPANELACCORDIAN

  • ADFPANELBOX

  • ADFPANELSPLITTER

  • TOOLBAR

  • TREE

COLLAPSENODE

Close the specified tree node object.

The following objects are valid:

  • TREE

  • TREELIST

  • TREETABLE

DISPLAYCHANGE

Display the specified change.

No objects required.

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:

  • ADFBUTTON

  • ADFCOMBOLOV

  • ADFCOMMANDMENU

  • ADFMANYCHECKBOX

  • ADFMANYLISTBOX

  • ADFNAVIGATIONITEM

  • ADFNAVIGATIONPANE

  • ADFOUTPUTTEXT

  • ADFPANELACCORDIAN

  • ADFPANELBOX

  • ADFPANELHEADER

  • ADFPANELLABEL

  • ADFPANELSPLITTER

  • ADFPANELWINDOW

  • ADFTOOLBARBUTTON

  • ADFUPLOADFILE

  • ALERT

  • BUTTON

  • CHECKBOX

  • CHOICEBOX

  • DATE

  • DIALOG

  • EDIT

  • IMAGE

  • LINK

  • LIST

  • LISTBOX

  • LOV

  • MENU

  • RADIOBUTTON

  • SPREADTABLE

  • TAB

  • TABLE

  • TEXTAREA

  • TOOLBAR

  • TREE

  • TREETABLE

  • WINDOW

EXPAND

Expand the specified ADF object.

The following objects are valid:

  • ADFPANELACCORDIAN

  • ADFPANELBOX

  • ADFPANELSPLITTER

  • TOOLBAR

EXPAND/COLLAPSE

Expand the specified ADF object.

The following objects are valid:

  • TABLE

EXPANDNODE

Expand the specified tree node object.

The following objects are valid:

  • TREE

  • TREELIST

FILTER

Filter the specified ADF object.

The following objects are valid:

  • TABLE

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

FOCUS

Focus on the specified ADF object.

The following objects are valid:

  • ADFBUTTON

  • ADFCOMBOLOV

  • ADFCOMMANDMENU

  • ADFMANYCHECKBOX

  • ADFMANYLISTBOX

  • ADFNAVIGATIONITEM

  • ADFNAVIGATIONPANE

  • ADFOUTPUTTEXT

  • ADFPANELACCORDIAN

  • ADFPANELBOX

  • ADFPANELHEADER

  • ADFPANELLABEL

  • ADFPANELSPLITTER

  • ADFPANELWINDOW

  • ADFTOOLBARBUTTON

  • ADFUPLOADFILE

  • CHECKBOX

  • DATE

  • DIALOG

  • IMAGE

  • LINK

  • LIST

  • LISTBOX

  • MENU

  • RADIOBUTTON

  • TAB

  • TABLE

  • TOOLBAR

  • TREE

  • TREETABLE

FOCUSSHOW

Focus on and show the specified ADF object.

The following objects are valid:

  • MENU

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

  • TAB

  • TEXT

  • TEXTAREA

GETATTRIBUTE

Get the attributes of the specified object.

The following objects are valid:

  • ADFBUTTON

  • ADFCOMBOLOV

  • ADFCOMMANDMENU

  • ADFMANYCHECKBOX

  • ADFMANYLISTBOX

  • ADFNAVIGATIONITEM

  • ADFNAVIGATIONPANE

  • ADFOUTPUTTEXT

  • ADFPANELACCORDIAN

  • ADFPANELBOX

  • ADFPANELHEADER

  • ADFPANELLABEL

  • ADFPANELSPLITTER

  • ADFPANELWINDOW

  • ADFTOOLBARBUTTON

  • ADFUPLOADFILE

  • BUTTON

  • CHECKBOX

  • DATE

  • DIALOG

  • EDIT

  • IMAGE

  • LINK

  • LIST

  • LISTBOX

  • LOV

  • MENU

  • RADIOBUTTON

  • TAB

  • TABLE

  • TOOLBAR

  • TREE

  • TREETABLE

  • WINDOW

GETCELLDATA

Get the cell data of the specified table object.

The following objects are valid:

  • TABLE

  • TREETABLE

GETCELLDATABYROWINDEX

Get the cell data of the specified ADF table object by row index.

The following objects are valid:

  • TABLE

  • TREETABLE

GETCOLUMNCOUNT

Get the column count of the specified ADF table object.

The following objects are valid:

  • TABLE

  • TREETABLE

GETCOLUMNHEADER

Get the column header of the specified ADF table object.

The following objects are valid:

  • TABLE

  • TREETABLE

GETITEMVALUES

Get the value of the specified list object.

The following objects are valid:

  • LIST

GETROWCOUNT

Get the row count of the specified ADF table or tree object.

The following objects are valid:

  • TABLE

  • TREE

  • TREETABLE

GETROWKEY

Get the row key of the specified ADF tree or treetable object.

The following objects are valid:

  • TREE

  • TREETABLE

GETSELECTEDTAB

Get the selected tab index of the specified ADF object.

The following objects are valid:

  • ADFNAVIGATIONPANE

  • TAB

GETVISIBLEROWCOUNT

Get the row count of the visible rows of the specified ADF table or tree object.

The following objects are valid:

  • TABLE

  • TREE

  • TREETABLE

GETVISIBLESTARTROWINDEX

Get the index of the starting visible row of the specified ADF table or tree object.

The following objects are valid:

  • TABLE

  • TREE

  • TREETABLE

HIDE

Hide the specified ADF menu object.

The following objects are valid:

  • MENU

INVOKESOFTKEY

Invoke the soft key on the specified object.

The following objects are valid:

  • EDIT

  • SPREADTABLE

ISVISIBLE

Determines if the specified ADF dialog object is visible.

The following objects are valid:

  • DIALOG

LAUNCH

Launch the specified browser object.

The following objects are valid:

  • BROWSER

LEFTCLICK

Perform a left mouse click on the specified ADF tree or treetable object.

The following objects are valid:

  • TREE

  • TREETABLE

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

MOVE

Perform a move action on the current object.

No objects required.

MOVEALL

Perform a move action on the current object.

No objects required.

NAVIGATE

Navigate to the specified URL.

No objects required.

POPUP

Perform a tab key press on the specified object.

The following objects are valid:

  • DATE

PRESSENTER

Perform a press Enter key action on the specified ADF object.

The following objects are valid:

  • ADFNAVIGATIONPANE

  • EDIT

  • IMAGE

PRESSTABKEY

Perform a tab key press on the specified object.

The following objects are valid:

  • EDIT

REMOVE

Remove the current ADF object.

No objects required.

REMOVEALL

Remove the all ADF objects.

No objects required.

RIGHTCLICK

Perform a right mouse click on the specified ADF tree or treetable object.

The following objects are valid:

  • TREE

  • TREETABLE

SCROLL

Scroll the specified ADF table or tree object.

The following objects are valid:

  • TABLE

  • TREE

  • TREETABLE

SCROLLTOROW

Scroll the specified ADF table or tree object.

The following objects are valid:

  • TABLE

  • TREE

  • TREETABLE

SEARCHBYDYNAMICCOLUMN

Search by dynamic column.

No objects required.

SEARCHCOLUMN

Search by column.

No objects required.

SEARCHEMPTYROW

Search for an empty column.

No objects required.

SELECT

Perform a select action on the specified object.

The following objects are valid:

  • ADFLOV

  • ADFMANYLISTBOX

  • ADFNAVIGATIONPANE

  • LIST

  • LISTBOX

  • RADIOBUTTON

  • SEARCHLIST

  • TAB

  • TREELIST

SELECTALLROWS

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

The following objects are valid:

  • ADFMANYCHECKBOX

  • ADFMANYLISTBOX

  • 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

  • TREETABLE

SELECTROW

Perform a select row action on the specified spreadtable object.

The following objects are valid:

  • SPREADTABLE

  • TABLE

  • TREETABLE

SELECTTAB

Perform a select tab action on the specified ADF object.

The following objects are valid:

  • TAB

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:

  • ADF

  • 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:

  • ADFUPLOADFILE

  • DATE

  • DYNAMICEDIT

  • EDIT

  • FIELD

  • PASSWORD

  • RESPONSEBOX

  • TEXTAREA

SETEXTAUTOCOMPLETE

Set the text on the specified edit object with auto complete.

The following objects are valid:

  • EDIT

SETVALUE

Set the value of the specified ADF combo list of values object.

The following objects are valid:

  • ADFCOMBOLOV

SETWINDOW

Set the window.

No objects required.

SHOW

Show the specified ADF PanelAccordian object.

The following objects are valid:

  • ADFPANELACCORDIAN

SHOWDROPDOWN

Show the specified ADF PanelAccordian object.

The following objects are valid:

  • ADFCOMBOLOV

SORT

Sort the specified ADF table object.

The following objects are valid:

  • TABLE

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

UNSELECT

Unselect the specified listbox object.

The following objects are valid:

  • ADFMANYLISTBOX

  • LIST

  • LISTBOX

UNSELECTTALL

Unselect all of the the specified checkbox or listbox objects.

The following objects are valid:

  • ADFMANYCHECKBOX

  • ADFMANYLISTBOX

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

WAITFORPAGE

Wait for the specified ADF object.

The following objects are valid:

  • ADFBUTTON

  • ADFCOMBOLOV

  • ADFCOMMANDMENU

  • ADFMANYCHECKBOX

  • ADFMANYLISTBOX

  • ADFNAVIGATIONITEM

  • ADFNAVIGATIONPANE

  • ADFOUTPUTTEXT

  • ADFPANELACCORDIAN

  • ADFPANELBOX

  • ADFPANELHEADER

  • ADFPANELLABEL

  • ADFPANELSPLITTER

  • ADFPANELWINDOW

  • ADFTOOLBARBUTTON

  • ADFUPLOADFILE

  • CHECKBOX

  • DATE

  • DIALOG

  • EDIT

  • IMAGE

  • LINK

  • LIST

  • LISTBOX

  • MENU

  • RADIOBUTTON

  • TAB

  • TABLE

  • TOOLBAR

  • TREE

  • TREETABLE