5 Oracle EBS/Forms Load Module

This chapter provides a complete listing and reference for the methods in the OpenScript FormsService Class of Forms Load Module Application Programming Interface (API).

5.1 FormsService ENUM Reference

The following section provides an alphabetical listing of the enums in the OpenScript FormsService API.

5.1.1 Alphabetical Enum Listing

The following table lists the FormsService Enums in alphabetical order.

Table 5-1 List of FormsService Enums

Enum	Description
NcaSource	Specify which part of the contents to find the source data.

5.2 FormsService API Reference

The following section provides an alphabetical listing of the methods in the OpenScript FormsService API.

5.2.1 Alphabetical Command Listing

The following table lists the FormsService API methods in alphabetical order.

Table 5-2 List of FormsService Methods

Method	Description
nca.alertDialog	Identifies an Oracle Forms alertDialog object by its handler name.
nca.application	Initializes the Oracle Forms Application specified by its handler name.
nca.assertStatusBarText	Searches the status bar contents for the specified text pattern.
nca.assertText	Searches the text of selected source type for the specified text pattern.
nca.blockScroller	Identifies an Oracle Forms blockScroller object by its handler name.
nca.button	Identifies an Oracle Forms Button object by its handler name.
nca.cancelQueryDialog	Identifies an Oracle Forms cancelQueryDialog object by its recorded ID and handler name.
nca.canvas	Identifies an Oracle Forms canvas object by its recorded ID and handler name.
nca.cfmOLE	Identifies an Oracle Forms cfmOLE object by its recorded ID and handler name.
nca.cfmVBX	Identifies an Oracle Forms cfmVBX object by its recorded ID and handler name.
nca.checkBox	Identifies an Oracle Forms CheckBox object by its handler name.
nca.choiceBox	Identifies an Oracle Forms choiceBox object by its handler name.
nca.comboBox	Identifies an Oracle Forms comboBox object by its recorded ID and handler name.
nca.connect	Connects to an Oracle Forms server.
nca.disconnect	Disconnects from Oracle Forms Server.
nca.displayErrorDialog	Identifies an Oracle Forms displayErrorDialog object by its recorded ID and handler name.
nca.displayList	Identifies an Oracle Forms displayList object by its recorded ID and handler name.
nca.editBox	Identifies an Oracle Forms editBox object by its handler name.
nca.editorDialog	Identifies an Oracle Forms editorDialog object by its recorded ID and handler name.
nca.flexWindow	Identifies an Oracle Forms flexWindow object by its handler name.
nca.genericClient	Identifies an Oracle Forms genericClient object by its handler name.
nca.getLastKnownContents	Returns the string version of contents for the specified ContentSource that was last retrieved for this virtual user.
nca.getStatusBarText	Gets the contents of the last known status bar text.
nca.helpDialog	Identifies an Oracle Forms helpDialog object by its handler name.
nca.image	Identifies an Oracle Forms image object by its recorded ID and handler name.
nca.infoBox	Identifies an Oracle Forms infoBox object by its handler name.
nca.jContainer	Identifies an Oracle Forms jContainer object by its handler name.
nca.list	Identifies an Oracle Forms PopList object by its handler name.
nca.listOfValues	Identifies an Oracle Forms List Of Values object by its handler name.
nca.logon	Identifies an Oracle Forms Logon Dialog object by its handler name.
nca.menuParametersDialog	Identifies an Oracle Forms menuParametersDialog object by its recorded ID and handler name.
nca.popupHelp	Identifies an Oracle Forms popupHelp object by its recorded ID and handler name.
nca.promptList	Identifies an Oracle Forms promptList object by its handler name.
nca.radioButton	Identifies an Oracle Forms RadioButton object by its handler name.
nca.registerProperty	Registers a property for any object.
nca.responseBox	Identifies an Oracle Forms responseBox object by its handler name.
nca.send	Sends an Oracle Forms Message to the Oracle Forms server.
nca.sendMessages	Sends raw Oracle Forms Messages to the Oracle Forms server.
nca.sendTerminal	Sends an Oracle Forms Terminal Message request to the Oracle Forms server.
nca.solve	Parses a value from the source of latest action and store it as a variable.
nca.statusBar	Identifies an Oracle Forms statusBar object by its recorded ID and handler name.
nca.tab	Identifies an Oracle Forms TabControl object by its handler name.
nca.tableBox	Identifies an Oracle Forms tableBox object by its recorded ID and handler name.
nca.textField	Creates a reference to a text field object in the Forms applet by handler name.
nca.timer	Identifies an Oracle Forms timer object by its handler name.
nca.tree	Identifies an Oracle Forms Tree object by its handler name.
nca.treeList	Identifies an Oracle Forms TreeList object by its handler name.
nca.unRegisterProperty	Unregister a property that was previously registered using `registerProperty`.
nca.verifyStatusBarText	Searchs the status bar contents for the specified text pattern and performs a verify only matching test.
nca.verifyText	Searches the text of selected source type for the specified text pattern performing a verify only text match.
nca.window	Identifies an Oracle Forms FormWindow object by its handler name.

The following sections provide detailed reference information for each method and enum in the FormsService Class of Forms Load Module Application Programming Interface.

nca.alertDialog

Identifies an Oracle Forms alertDialog object by its handler name.

Format

The nca.alertDialog method has the following command format(s):

nca.alertDialog(handlerName);

nca.alertDialog(recid, handlerName);

Command Parameters

recid: Optional. The ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the alertDialog. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTAlertDialog object.

Example

Performs an action on an Oracle Forms alertDialog object specified by its recorded ID and handler name.

nca.window(436, "GROUPS_DETAIL").activate("");
nca.alertDialog(437, "Forms").clickButton(2, "12");
nca.textField(438, "GROUPS_EXPENDITURE_GROUP_0").select(0, 4, 4, "1");

nca.application

Initializes the Oracle Forms Application specified by its handler name.

Format

The nca.application method has the following command format(s):

nca.application(handlerName);

nca.application(recid, handlerName);

Command Parameters

recid: Optional. The ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the Form Application. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTRunForm object.

Example

Performs an action on an Oracle Forms Application specified by its recorded ID and handler name.

nca.application(161, "Oracle Applications").sendMessage(
 "<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"1\" mHandlerId=\"1\">\r\n" +
 <Property actionString=\"HEARTBEAT\" action=\"517\" " +
   "type=\"null\" />\r\n</Message>\r\n", "1");

nca.assertStatusBarText

Searchs the status bar contents for the specified text pattern.

If the test fails, always fail the script unless the status bar text test error recovery setting specifies a different action such as Warn or Ignore. If any part of the status bar text matches textToAssert, the assertion succeeds.

Format

The nca.assertStatusBarText method has the following command format(s):

nca.assertStatusBarText(testName, textToAssert, matchOption);

nca.assertStatusBarText(recId, testName, textToVerify, matchOption);

Command Parameters

recId: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
testName: a String specifying the test name.
textToVerify: a String specifying the Text to match on the page, or not match on the page if TextPresence is set as PassIfPresent.
matchOption: a MatchOption enum specifying how the text to match should be searched on the page, such as using a regular expression, wildcard, or exact match.
textToAssert: a String specifying the Text to match on the page, or not match on the page if TextPresence is set as PassIfPresent.

Throws

AbstractScriptException: on any other failure when attempting to assert the text.
MatchException: if the assertion fails.

Example

Verifies the specified text matches exactly.

nca.assertStatusBarText(161, "Assert StatusBar Text" +
 "text value", "FRM-40400: Transaction complete: " +
 "1 records applied and saved.", MatchOption.Exact);

nca.assertText

Searches the text of selected source type for the specified text pattern.

If the test fails, always fail the script unless the text matching test error recovery setting specifies a different action such as Warn or Ignore.

If any part of the source text matches textToAssert, the assertion succeeds.

Format

The nca.assertText method has the following command format(s):

nca.assertText(testName, textToAssert, sourceType, textPresence, matchOption);

Command Parameters

testName: a String specifying the test name.
textToAssert: a String specifying the Text to match on the page, or not match on the page if TextPresence is set as PassIfPresent.
sourceType: a NcaSource enum specifying where to match the text, i.e. in the Object Details, Request and Response, or Status Bar text.
textPresence: a TestPresence enum specifying either PassIfPresent or FailIfPresent, depending on if you want the test to pass or fail if the text to match is present or not.
matchOption: a MatchOption enum specifying how the text to match should be searched on the page, such as using a regular expression, wildcard, or exact match.

Throws

MatchException: if the assertion fails.
AbstractScriptException: on any other failure when attempting to assert the text.

Example

Adds Text Matching tests for Statu Bar text.

nca.assertText("myTextMatchingTest", "match this text string", 
 NcaSource.StatusBarText, TextPresence.PassIfPresent, MatchOption.Exact);

nca.blockScroller

Identifies an Oracle Forms blockScroller object by its handler name.

Format

The nca.blockScroller method has the following command format(s):

nca.blockScroller(handlerName);

nca.blockScroller(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the blockScroller. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTBlockScroller object.

Example

Performs an action on an Oracle Forms blockScroller object specified by its recorded ID and handler name.

nca.textField(571, "PROJECT_OPTIONS_OPTION_NAME_DISP_5")
 .select(0, 0, 0, "");
nca.textField(572, "PROJECT_OPTIONS_OPTION_NAME_DISP_6")
 .setFocus("1");
nca.application(573, "Oracle Applications")
 .sendMessage("<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"1\" mHandlerId=\"1\">\r\n" + 
   <Property actionString=\"HEARTBEAT\" action=\"517\" " +
   " type=\"null\" />\r\n</Message>\r\n", "1");
nca.textField(574, "PROJECT_OPTIONS_OPTION_NAME_DISP_6")
 .select(0, 27, 27, "");
nca.blockScroller(575, "COMPONENT_ID_478").scrollTo(0, 8, "1");
nca.blockScroller(575, "COMPONENT_ID_478").scrollPageUp(0, 1);
nca.blockScroller(575, "COMPONENT_ID_478").scrollPageDown(0, 1);
nca.textField(576, "PROJECT_OPTIONS_OPTION_NAME_DISP_7")
 .select(0, 18, 18, "");
nca.textField(577, "PROJECT_OPTIONS_OPTION_NAME_DISP_6")
 .clearFocus("");
nca.textField(578, "PROJECT_OPTIONS_OPTION_NAME_DISP_6")
 .select(0, 0, 0, "");
nca.textField(579, "PROJECT_OPTIONS_OPTION_NAME_DISP_7")
 .setFocus("");

nca.button

Identifies an Oracle Forms Button object by its handler name.

Format

The nca.button method has the following command format(s):

nca.button(handlerName);

nca.button(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the Button. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTButton object.

Example

Performs an action on an Oracle Forms Button object specified by its recorded ID and handler name.

nca.button(130, "FOLDER_QF_NEW_HEADER_0").setFocus("1");
nca.button(131, "FOLDER_QF_NEW_HEADER_0").click();

nca.cancelQueryDialog

Identifies an Oracle Forms cancelQueryDialog object by its recorded ID and handler name.

Format

The nca.cancelQueryDialog method has the following command format(s):

nca.cancelQueryDialog(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the cancelQueryDialog. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTCancelQueryDialog object.

Example

Identifies an Oracle Forms cancelQueryDialog object specified by its recorded ID and handler name.

nca.cancelQueryDialog(169, "cancelQueryDialog");

nca.canvas

Identifies an Oracle Forms canvas object by its recorded ID and handler name.

Format

The nca.canvas method has the following command format(s):

nca.canvas(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the canvas. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTCanvas object.

Example

Identifies an Oracle Forms canvas object specified by its recorded ID and handler name.

nca.canvas(169, "canvas");

nca.cfmOLE

Identifies an Oracle Forms cfmOLE object by its recorded ID and handler name.

Format

The nca.cfmOLE method has the following command format(s):

nca.cfmOLE(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the cfmOLE. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTCfmOLE object.

Example

Identifies an Oracle Forms cfmOLE object specified by its recorded ID and handler name.

nca.cfmOLE(169, "cfmole");

nca.cfmVBX

Identifies an Oracle Forms cfmVBX object by its recorded ID and handler name.

Format

The nca.cfmVBX method has the following command format(s):

nca.cfmVBX(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the cfmVBX. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTCfmVBX object.

Example

Identifies an Oracle Forms cfmVBX object specified by its recorded ID and handler name.

nca.cfmVBX(169, "cfmVBX");

nca.checkBox

Identifies an Oracle Forms CheckBox object by its handler name.

Format

The nca.checkBox method has the following command format(s):

nca.checkBox(handlerName);

nca.checkBox(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the CheckBox. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTCheckBox object.

Example

Performs an action on an Oracle Forms CheckBox object specified by its recorded ID and handler name.

nca.checkBox(289, "GROUPS_ALLOW_NEGATIVE_TR_0").setFocus();
nca.checkBox(291, "GROUPS_ALLOW_NEGATIVE_TR_0").check(true);
nca.checkBox(297, "GROUPS_ALLOW_NEGATIVE_TR_0").clearFocus();

nca.choiceBox

Identifies an Oracle Forms choiceBox object by its handler name.

Format

The nca.choiceBox method has the following command format(s):

nca.choiceBox(handlerName);

nca.choiceBox(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the choiceBox. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTChoiceBoxMessenger object.

Example

Performs an action on an Oracle Forms choiceBox object specified by its recorded ID and handler name.

nca.button(264, "GROUPS_SUBMIT_0").click("1");
nca.button(265, "GROUPS_SUBMIT_0").sendMessage(
 "<Message mActionString=\"MSG_GET\" mActionCode=\"4\" " +
   "mHandlerClassId=\"261\" mHandlerId=\"289\">\r\n" +
   <Property actionString=\"VISIBLERECT\" action=\"155\" " +
   "type=\"java.awt.Rectangle\" topleftx=\"0.0\" " +
   toplefty=\"0.0\" width=\"124.0\" height=\"28.0\"/>\r\n" +
 </Message>\r\n", "3");
nca.textField(266, "GROUPS_OPERATING_UNIT_0").select(0, 17, 17, "");
nca.button(267, "GROUPS_SUBMIT_0").clearFocus("");
nca.textField(268, "GROUPS_OPERATING_UNIT_0").setFocus("");
nca.window(269, "GROUPS_DETAIL").deactivate("11");
String alertMsg=nca.choiceBox(270, "Error").getAlertMessage();
info("alert message:"+alertMsg);
nca.choiceBox(270, "Error").clickButton(0);
nca.textField(271, "GROUPS_OPERATING_UNIT_0").select(0, 17, 17, "");

nca.comboBox

Identifies an Oracle Forms comboBox object by its recorded ID and handler name.

Format

The nca.comboBox method has the following command format(s):

nca.comboBox(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the comboBox. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTComboBox object.

Example

Identifies an Oracle Forms comboBox object specified by its recorded ID and handler name.

nca.comboBox(169, "comboBox");

nca.connect

Connects to an Oracle Forms server.

If already connected to an Oracle Forms server, this method quietly returns.

Format

The nca.connect method has the following command format(s):

nca.connect(connMode, formsServerHost, serverPort, formsUrl);

nca.connect(recId, connMode, formsServerHost, serverPort, formsUrl);

Command Parameters

recId: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
connMode: a ConnectMode enum specifing if the Forms server expects to use Socket or HTTP connection mode.
formsServerHost: a String specfying the server host. For ConnectMode.Socket, specify the host name or IP of the Oracle Forms server to connect to. For ConnectMode.HTTP, this parameter is ignored and should be null.
serverPort: a value specifying the server port. For ConnectMode.Socket, specify the port number on the Oracle Forms server to connect to. For ConnectMode.HTTP, this parameter is ignored and should be 0.
formsUrl: a String specifying the URL. For ConnectMode.HTTP, specify the Oracle Forms URL to which the Forms applet posts messages. This URL is specified in the Oracle Forms Applet loading web page. The Oracle Forms Recorder automatically records this URL and correlates it appropriately. For ConnectMode.Socket, this parameter is ignored and should be null.

Throws

AbstractScriptException: on a failure to connect to the Oracle Forms server.

Example

Connects to the specified Oracle Forms server.

nca.connect(90, ConnectMode.HTTP, null, 0, "http://example.com:8002
{{formsload.url,/forms/lservlet;jsessionid=" +
8c57166455fa6173d468e0ae4e09966886262ac3b5b3.e38ObheNbx4Ne38Qe0}}");

nca.disconnect

Disconnects from Oracle Forms Server.

If not connected to the Forms server, this method quietly returns.

IMPORTANT: No matter how Forms statements are programmed, nca.disconnect() must be the last statement to disconnect from the Forms server. In mulitple iterations if nca.connect() is called in each iteration, nca.disconnect() must be called before the end of each iteration.

Format

The nca.disconnect method has the following command format(s):

nca.disconnect( );

Throws

AbstractScriptException: represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Example

Disconnects from Oracle Forms Server.

nca.disconnect();

nca.displayErrorDialog

Identifies an Oracle Forms displayErrorDialog object by its recorded ID and handler name.

Format

The nca.displayErrorDialog method has the following command format(s):

nca.displayErrorDialog(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the displayErrorDialog. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTDisplayErrorDialog object.

Example

Identifies an Oracle Forms displayErrorDialog object specified by its recorded ID and handler name.

nca.displayErrorDialog(169, "displayErrorDialog");

nca.displayList

Identifies an Oracle Forms displayList object by its recorded ID and handler name.

Format

The nca.displayList method has the following command format(s):

nca.displayList(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the displayList. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTDisplayList object.

Example

Identifies an Oracle Forms displayList object specified by its recorded ID and handler name.

nca.displayList(169, "displayList");

nca.editBox

Identifies an Oracle Forms editBox object by its handler name.

Format

The nca.editBox method has the following command format(s):

nca.editBox(handlerName);

nca.editBox(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the editBox. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTEditBoxMessenger object.

Example

Performs an action on an Oracle Forms editBox object specified by its recorded ID and handler name.

nca.window(123, "GROUPS_DETAIL").activate("21");
nca.textField(124, "GROUPS_OPERATING_UNIT_0").select(0, 17, 17, "");
nca.window(125, "GROUPS_DETAIL").selectMenu(
 "HELP.ABOUT_ORACLE_APPLICATIONS", "1");
nca.window(126, "GROUPS_DETAIL").deactivate("1");
nca.editBox(127, "About Oracle Applications").clickOk("");
nca.textField(128, "GROUPS_OPERATING_UNIT_0").select(0, 17, 17, "");

nca.editorDialog

Identifies an Oracle Forms editorDialog object by its recorded ID and handler name.

Format

The nca.editorDialog method has the following command format(s):

nca.editorDialog(handlerName);

nca.editorDialog(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the editorDialog. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTEditorDialog object.

Example

Performs an action on an Oracle Forms editorDialog object specified by its recorded ID and handler name.

nca.textField(485, "GROUPS_EXPENDITURE_GROUP_0")
 .sendMessage("<Message mActionString=\"MSG_GET\" " +
   "mActionCode=\"4\" mHandlerClassId=\"257\" mHandlerId=\"272\">\r\n" +
   "<Property actionString=\"VISIBLERECT\" action=\"155\" " +
   "type=\"java.awt.Rectangle\" topleftx=\"0.0\" toplefty=\"0.0\" " 
   "width=\"173.0\" height=\"24.0\"/>\r\n</Message>\r\n", "3");
nca.window(486, "GROUPS_DETAIL").selectMenu("EDIT.EDIT_FIELD", "1");
nca.window(487, "GROUPS_DETAIL").deactivate("1");
nca.editorDialog(488, "Editor").setText("ABCD");
nca.textField(489, "GROUPS_EXPENDITURE_GROUP_0").setCursorPosition(4, "");

nca.flexWindow

Identifies an Oracle Forms flexWindow object by its handler name.

Format

The nca.flexWindow method has the following command format(s):

nca.flexWindow(handlerName);

nca.flexWindow(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the flexWindow. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTFlexWindowMessenger object.

Example

Performs an action on an Oracle Forms flexWindow object specified by its recorded ID and handler name.

nca.textField(141, "WORK_ORDER_PARAMETERS_0").setFocus("2");
nca.listOfValues(142, "Reporting Level").displayRows(1, 2, "1");
nca.listOfValues(143, "Reporting Level").selectByIndex(1, "1");
nca.application(144, "Oracle Applications").sendMessage(
 "<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"1\" mHandlerId=\"1\">\r\n" +
   "<Property actionString=\"HEARTBEAT\" action=\"517\" " +
   "type=\"null\" />\r\n</Message>\r\n","1");
nca.flexWindow(145, "Parameters").clickLOV(1, 0, "122");
nca.listOfValues(146, "Reporting Context").displayRows(1, 11, "1");
nca.listOfValues(147, "Reporting Context").clickCancel("1");
nca.flexWindow(148, "Parameters").focusField(2, 0, "1");
nca.flexWindow(149, "Services Accounting Flex").clickCancel("1");
nca.flexWindow(150, "Parameters").focusField(3, 0, "1");
nca.flexWindow(151, "Services Accounting Flex").clickClear("1");

nca.genericClient

Identifies an Oracle Forms genericClient object by its handler name.

Format

The nca.genericClient method has the following command format(s):

nca.genericClient(handlerName);

nca.genericClient(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the genericClient. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTGenericClientMessenger object.

Example

Performs an action on an Oracle Forms genericClient object specified by its recorded ID and handler name.

nca.genericClient(96, "COMPONENT_ID_54").sendGenericClientMessage();
nca.genericClient(96, "COMPONENT_ID_54").sendGenericClientMessage("", "1");

nca.getLastKnownContents

Returns the string version of contents for the specified ContentSource that was last retrieved for this virtual user.

Format

The nca.getLastKnownContents method has the following command format(s):

nca.getLastKnownContents(sourceType);

Command Parameters

sourceType: an NcaSource Enum specifying the portion of the contents to return as a String. If null, assumes NcaSource.ObjectDetails.

Throws

AbstractScriptException: represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

String version of the contents last retrieved by the client. Returns null if contents are null.

Example

Gets the specified last known contents.

String details = nca.getLastKnownContents(NcaSource.ObjectDetails);
info("Object Details " + details);
String reqresp = nca.getLastKnownContents(NcaSource.RequestsAndResponses);
info("Requests and Responses " + reqresp);
String statusbar = nca.getLastKnownContents(NcaSource.StatusBarText);
info("StatusBarText " + statusbar);

nca.getStatusBarText

Gets the contents of the last known status bar text.

This is useful when user wants to grab the last known value of the status bar within the script.

Format

The nca.getStatusBarText method has the following command format(s):

nca.getStatusBarText( );

Throws

AbstractScriptException: represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

String value for the last known text value of the status bar. If the server has never updated the status bar, this method returns an empty string. This method never returns null.

Example

Gets the contents of the last known status bar text.

String statusBarText1=nca.getStatusBarText();
info("exist status bar text:"+statusBarText1);

nca.helpDialog

Identifies an Oracle Forms helpDialog object by its handler name.

Format

The nca.helpDialog method has the following command format(s):

nca.helpDialog(handlerName);

nca.helpDialog(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the helpDialog. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTHelpDialog object.

Example

Performs an action on an Oracle Forms helpDialog object specified by its recorded ID and handler name.

nca.window(121, "GROUPS_DETAIL").activate("");
nca.textField(122, "GROUPS_OPERATING_UNIT_0").select(0, 17, 17, "");
nca.helpDialog(123, "Keys").clickCancel("1");

nca.image

Identifies an Oracle Forms image object by its recorded ID and handler name.

Format

The nca.image method has the following command format(s):

nca.image(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the image. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTImage object.

Example

Identifies an Oracle Forms image object specified by its recorded ID and handler name.

nca.image(169, "image");

nca.infoBox

Identifies an Oracle Forms infoBox object by its handler name.

Format

The nca.infoBox method has the following command format(s):

nca.infoBox(handlerName);

nca.infoBox(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the infoBox. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTInfoBoxMessenger object.

Example

Performs an action on an Oracle Forms infoBox object specified by its recorded ID and handler name.

nca.window(1033, "GROUPS_DETAIL").activate("1");
nca.window(1034, "GROUPS_DETAIL").selectMenu("HELP.RECORD_HISTORY",
 "1");
nca.window(1035, "GROUPS_DETAIL").deactivate("1");
nca.infoBox(1036, "About This Record").clickOk();

nca.jContainer

Identifies an Oracle Forms jContainer object by its handler name.

Format

The nca.jContainer method has the following command format(s):

nca.jContainer(handlerName);

nca.jContainer(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the jContainer. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTJavaContainer object.

Example

Performs an action on an Oracle Forms jContainer object specified by its recorded ID and handler name.

nca.window(9078, "FOLDER_INCIDENT_TRACKING").activate("2");
nca.textField(9079, "CREATE_TASK_PLANNED_END_DATE_UI_0")
 .select(0, 20, 20, "");
nca.button(9080, "CALENDAR_OK_0").clearFocus("");
nca.textField(9081, "CREATE_TASK_PLANNED_END_DATE_UI_0")
 .setFocus("1");
nca.window(9082, "Oracle Applications - Main Window")
 .resize(1364, 768, "1");
nca.textField(9083, "CREATE_TASK_PLANNED_END_DATE_UI_0")
 .clearFocus("");
nca.jContainer(9084, "SR_TASK_GRID_GRID_ITEM_0")
 .setFocus("");
nca.jContainer(9085, "SR_TASK_GRID_GRID_ITEM_0")
 .sendMessage("<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"271\" mHandlerId=\"496\">\r\n" +
   "<Property actionString=\"EVENT\" action=\"398\" " +
   "type=\"oracle.forms.engine.Message\" >\r\n" +
   "<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"271\" mHandlerId=\"496\">\r\n" +
   "<Property actionString=\"EVENTNAME\" action=\"399\" " +
   "type=\"java.lang.String\" value=\"focusChanged\"/>\r\n" +
   "<Property actionString=\"EVENT_ARGNAME\" action=\"400\" " +
   "type=\"java.lang.String\" value=\"currentColumn\"/>\r\n" +
   "<Property actionString=\"EVENT_ARGVALUE\" action=\"401\" " +
   "type=\"java.lang.String\" value=\" \"/>\r\n" +
   "<Property actionString=\"EVENT_ARGNAME\" action=\"400\" " +
   "type=\"java.lang.String\" value=\"currentRow\"/>\r\n" +
   "<Property actionString=\"EVENT_ARGVALUE\" action=\"401\" " +
   "type=\"java.lang.String\" value=\"2\"/>\r\n" +
   </Message>\r\n</Property>\r\n</Message>\r\n", "12");
nca.timer(9086, "COMPONENT_ID_1216").expired("1");
nca.window(9087, "FOLDER_INCIDENT_TRACKING").deactivate("1");

nca.list

Identifies an Oracle Forms PopList object by its handler name.

Format

The nca.list method has the following command format(s):

nca.list(handlerName);

nca.list(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the PopList. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTPopListItem object.

Example

Performs an action on an Oracle Forms PopList object specified by its recorded ID and handler name.

nca.list(120, "GROUPS_SYSTEM_LINKAGE_FUNCTION_0")
 .setFocus();
nca.list(121, "GROUPS_SYSTEM_LINKAGE_FUNCTION_0")
 .sendMessage("<Message mActionString=\"MSG_UPDATE\" " +
   "mActionCode=\"2\" mHandlerClassId=\"263\" " +
   "mHandlerId=\"274\">\r\n<Property actionString=\"MOUSEDOWN\" " +
   "action=\"180\" type=\"oracle.forms.engine.Message\" >\r\n" +
 "<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"263\" mHandlerId=\"274\">\r\n" +
 "<Property actionString=\"MOUSEDOWN_POS\" action=\"185\" " +
   "type=\"java.awt.Point\" pointx=\"185.0\" " +
   "pointy=\"11.0\"/>\r\n" + 
 "<Property actionString=\"MOUSEDOWN_MOD\" action=\"186\" " +
   "type=\"java.lang.Byte\" value=\"16\"/>\r\n" +
 "</Message>\r\n</Property>\r\n</Message>\r\n", "1");

nca.listOfValues

Identifies an Oracle Forms List Of Values object by its handler name.

Format

The nca.listOfValues method has the following command format(s):

nca.listOfValues(handlerName);

nca.listOfValues(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the List Of Values. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTListValuesDialog object.

Example

Performs an action on an Oracle Forms List Of Values object specified by its recorded ID and handler name.

nca.listOfValues(133, "Customers").searchByText("cus", "1");
nca.listOfValues(134, "Customers").displayRows(1, 1, "1");

nca.logon

Identifies an Oracle Forms Logon Dialog object by its handler name.

Format

The nca.logon method has the following command format(s):

nca.logon(handlerName);

nca.logon(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the Logon Dialog. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTLogonDialog object.

Example

Performs an action on an Oracle Forms Logon Dialog object specified by its recorded ID and handler name.

nca.logon(133, "Logon").connect("username", "password", "database");

nca.menuParametersDialog

Identifies an Oracle Forms menuParametersDialog object by its recorded ID and handler name.

Format

The nca.menuParametersDialog method has the following command format(s):

nca.menuParametersDialog(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the menuParametersDialog. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTMenuParametersDialog object.

Example

Identifies an Oracle Forms menuParametersDialog object specified by its recorded ID and handler name.

nca.menuParametersDialog(169, "menu");

NcaSource

The NcaSource has the following values:

Table 5-3 List of NcaSource Values

Value	Description
ObjectDetails	Retrieve the contents of Object Details.
StatusBarText	Retrieve the contents of StatusBarText.
RequestsAndResponses	Retrieve the contents of the last sent and received request/response pairs.

nca.popupHelp

Identifies an Oracle Forms popupHelp object by its recorded ID and handler name.

Format

The nca.popupHelp method has the following command format(s):

nca.popupHelp(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the popupHelp. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTPopupHelp object.

Example

Identifies an Oracle Forms popupHelp object specified by its recorded ID and handler name.

nca.popupHelp(169, "popupHelp");

nca.promptList

Identifies an Oracle Forms promptList object by its handler name.

Format

The nca.promptList method has the following command format(s):

nca.promptList(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the tpromptList. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTPromptList object.

Example

Identifies an Oracle Forms promptList object specified by its recorded ID and handler name.

nca.promptList(172, "promptList");

nca.radioButton

Identifies an Oracle Forms RadioButton object by its handler name.

Format

The nca.radioButton method has the following command format(s):

nca.radioButton(handlerName);

nca.radioButton(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the RadioButton. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTRadioButton object.

Example

Performs an action on an Oracle Forms RadioButton object specified by its recorded ID and handler name.

nca.radioButton(724, "JOBS_QF_WHICH_JOBS_ALL_MY_JOBS_0").setFocus("1");
nca.radioButton(725, "JOBS_QF_WHICH_JOBS_ALL_MY_JOBS_0")
 .sendMessage("<Message mActionString=\"MSG_UPDATE\" " +
   "mActionCode=\"2\" mHandlerClassId=\"267\" " +
   "mHandlerId=\"375\">\r\n<Property actionString=\"MOUSEUP\" " +
   "action=\"181\" type=\"oracle.forms.engine.Message\" >\r\n" +
   "<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"267\" mHandlerId=\"375\">\r\n" +
   "<Property actionString=\"MOUSEDOWN_POS\" action=\"185\" " +
   "type=\"java.awt.Point\" pointx=\"1.0\" pointy=\"8.0\"/>\r\n" +
   "<Property actionString=\"MOUSEDOWN_MOD\" action=\"186\" " +
   "type=\"java.lang.Byte\" value=\"16\"/>\r\n" +
   "</Message>\r\n</Property>\r\n</Message>\r\n", "");
nca.radioButton(726, "JOBS_QF_WHICH_JOBS_ALL_MY_JOBS_0").select("");
nca.radioButton(727, "JOBS_QF_WHICH_JOBS_ALL_MY_JOBS_0").unselect("");

nca.registerProperty

Registers a property for any object.

The property will be sent to the server in subsequent client request(s) in the following cases:

If the server asks the client for a specific property, the client responds with the property using a MSG_GET type message.
Whenever a client sends a MSG_UPDATE type message for an object, the client will send any registered properties in the message.

If a property is already registered, this method will overwrite its existing value.

If a property does not exist, this method will add the property.

Format

The nca.registerProperty method has the following command format(s):

nca.registerProperty(name, value, handlerId, options);

Command Parameters

name: a String specifying the name of the property to be registered.
value: a Property value in its Object form. The type of the object is inferred automatically when the property value is submitted to the server. For example, if a boolean true value is specified, then the property will be submitted to the server using type "java.lang.boolean".
handlerId: the specific object for which this property should be registered. The object does NOT have to exist at the time this method is invoked.
options: a RegisterPropertyOptions enum specifying the scenario in which to register the custom property, such as only when sending a MSG_GET message, or when sending a MSG_UPDATE message.

Throws

AbstractScriptException: represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.
NullPointerException: if the name is null.

Example

Example 1 Sends a WINSYS_REQUIREDVA_LIST property when the application is initialized.

Example 2 Registers a blank custom TITLE property for a window in case the server asks for the title later in the script.

//Example 1
nca.registerProperty("WINSYS_REQUIREDVA_LIST", "true", 1, 
 RegisterPropertyOptions.RegisterForMSG_UPDATE);
nca.application("ORACLE_APPLICATIONS").initialize(...);
//Example 2
nca.registerProperty("TITLE", "", 6, 
 RegisterPropertyOptions.RegisterForMSG_GET);

nca.responseBox

Identifies an Oracle Forms responseBox object by its handler name.

Format

The nca.responseBox method has the following command format(s):

nca.responseBox(handlerName);

nca.responseBox(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the responseBox. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTResponseBoxMessenger object.

Example

Performs an action on an Oracle Forms responseBox object specified by its recorded ID and handler name.

nca.window(263, "GROUPS_DETAIL").activate("2");
nca.textField(264, "GROUPS_OPERATING_UNIT_0").select(0, 17, 17, "");
nca.textField(265, "GROUPS_OPERATING_UNIT_0").setFocus("1");
nca.textField(266, "GROUPS_OPERATING_UNIT_0").select(0, 17, 17, "");
nca.window(267, "GROUPS_DETAIL").selectMenu(
 "PREFERENCES.CHANGE_PASSWORD", "1");
nca.textField(268, "GROUPS_OPERATING_UNIT_0").clearFocus("");
nca.window(269, "GROUPS_DETAIL").deactivate("1");
nca.responseBox(270, "Password Update").validate("F", 0, "sdfas,,",
 "1");
nca.responseBox(271, "Password Update").validate("F", 1,
 "sdfas,as,", "1");
nca.responseBox(272, "Password Update").validate("F", 2,
 "sdfas,as,as", "1");
nca.responseBox(273, "Password Update").validate("O", 2,
 "sdfas,as,as", "");
nca.responseBox(273, "Password Update").clickOk("", 1);

nca.send

Sends an Oracle Forms Message to the Oracle Forms server.

Format

The nca.send method has the following command format(s):

nca.send(strMessage);

nca.send(recId, strMessage);

Command Parameters

recId: Optionally specify a recorded element ID. Only used for comparison purposes in the results. May be null.
strMessage: a String specifying the Oracle Forms Message object in XML format.

Throws

AbstractScriptException: on any exception while sending the message to the Oracle Forms server.

Example

Sends the specified Oracle Forms Message.

nca.send(20,
 "<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
 "mHandlerClassId=\"1\" mHandlerId=\"1\">\r\n" +
 "<Property actionString=\"INITIAL_VERSION\" action=\"268\" " +
 "type=\"java.lang.Integer\" value=\"1012000\"/>\r\n" +
 "<Property actionString=\"INITIAL_RESOLUTION\" action=\"263\" " +
 "type=\"java.awt.Point\" pointx=\"96.0\" pointy=\"96.0\"/>\r\n" +
 "<Property actionString=\"INITIAL_DISP_SIZE\" action=\"264\" " +
 "type=\"java.awt.Point\" pointx=\"1364.0\" pointy=\"768.0\"/>\r\n" +
 "<Property actionString=\"INITIAL_CMDLINE\" action=\"265\" " +
 "type=\"java.lang.String\" value=\"server module=" +
 "{{formsload.module_1,/d1/oracle01/EBS/VIS/apps/apps_st/" +
 "appl/fnd/12.0.0/forms/US/FNDSCSGN}} fndnam=APPS record=names  " +
 "config='{{formsload.config_1,VIS}}' " +
 "icx_ticket='{{formsload.icx_ticket_11i_3,.jACpSETjvCOkvXLRX3StGA..}}' " +
 "resp='ONT/ORDER_MGMT_SUPER_USER' secgrp='STANDARD' " +
 "start_func='ONT_OEXOEORD_SUMMARY' other_params=''\"/>\r\n" +
 "<Property actionString=\"INITIAL_COLOR_DEPTH\" action=\"266\" " +
 "type=\"java.lang.Integer\" value=\"256\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"0\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"255\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"65535\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"4210752\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"8421504\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"65280\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"12632256\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16711935\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16762880\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16756655\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16711680\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16777215\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16776960\"/>\r\n" +
 "<Property actionString=\"FONT_NAME\" action=\"383\" " +
 "type=\"java.lang.String\" value=\"dialog\"/>\r\n" +
 "<Property actionString=\"FONT_SIZE\" action=\"377\" " +
 "type=\"java.lang.Integer\" value=\"900\"/>\r\n" +
 "<Property actionString=\"FONT_STYLE\" action=\"378\" " +
 "type=\"java.lang.Byte\" value=\"0\"/>\r\n" +
 "<Property actionString=\"FONT_WEIGHT\" action=\"379\" " +
 "type=\"java.lang.Byte\" value=\"0\"/>\r\n" +
 "<Property actionString=\"INITIAL_SCALE_INFO\" action=\"267\" " +
 "type=\"java.awt.Point\" pointx=\"7.0\" pointy=\"21.0\"/>\r\n" +
 "<Property actionString=\"WINSYS_REQUIREDVA_LIST\" action=\"291\" " +
 "type=\"java.lang.Boolean\" value=\"true\"/>\r\n" +
 "<Property actionString=\"SERVER_USER_PARAMS\" action=\"510\" " +
 "type=\"java.lang.String\" value=\"NLS_LANG='AMERICAN_AMERICA' " +
  "FORMS_USER_DATE_FORMAT='DD-MON-RRRR' " +
  "FORMS_USER_DATETIME_FORMAT='DD-MON-RRRR HH24:MI:SS' " +
  "NLS_DATE_LANGUAGE='AMERICAN' NLS_SORT='BINARY' " +
  "NLS_NUMERIC_CHARACTERS='.,'\"/>\r\n" +
 "<Property actionString=\"DEFAULT_LOCAL_TZ\" action=\"530\" " +
 "type=\"java.lang.String\" value=\"Asia/Shanghai\"/>\r\n" +
 "</Message>\r\n");

nca.sendMessages

Sends raw Oracle Forms Messages to the Oracle Forms server.

Format

The nca.sendMessages method has the following command format(s):

nca.sendMessages(description, strMessages);

nca.sendMessages(recId, description, strMessages);

Command Parameters

recId: Optionally specify a recorded element ID. Only used for comparison purposes in the results. May be null.
description: Optional a String specifying a human-readable description explaining what this message does. May be null.
strMessages: String containing Oracle Forms Messages in XML format.

Throws

AbstractScriptException: on any exception while sending the message to the Oracle Forms server.

Example

Sends the specified Oracle Forms Messages.

nca.sendMessages(20, "Message Description"
 "<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
 "mHandlerClassId=\"1\" mHandlerId=\"1\">\r\n" +
 "<Property actionString=\"INITIAL_VERSION\" action=\"268\" " +
 "type=\"java.lang.Integer\" value=\"1012000\"/>\r\n" +
 "<Property actionString=\"INITIAL_RESOLUTION\" action=\"263\" " +
 "type=\"java.awt.Point\" pointx=\"96.0\" pointy=\"96.0\"/>\r\n" +
 "<Property actionString=\"INITIAL_DISP_SIZE\" action=\"264\" " +
 "type=\"java.awt.Point\" pointx=\"1364.0\" pointy=\"768.0\"/>\r\n" +
 "<Property actionString=\"INITIAL_CMDLINE\" action=\"265\" " +
 "type=\"java.lang.String\" value=\"server module=" +
 "{{formsload.module_1,/d1/oracle01/EBS/VIS/apps/apps_st/" +
 "appl/fnd/12.0.0/forms/US/FNDSCSGN}} fndnam=APPS record=names  " +
 "config='{{formsload.config_1,VIS}}' " +
 "icx_ticket='{{formsload.icx_ticket_11i_3,.jACpSETjvCOkvXLRX3StGA..}}' " +
 "resp='ONT/ORDER_MGMT_SUPER_USER' secgrp='STANDARD' " +
 "start_func='ONT_OEXOEORD_SUMMARY' other_params=''\"/>\r\n" +
 "<Property actionString=\"INITIAL_COLOR_DEPTH\" action=\"266\" " +
 "type=\"java.lang.Integer\" value=\"256\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"0\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"255\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"65535\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"4210752\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"8421504\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"65280\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"12632256\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16711935\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16762880\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16756655\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16711680\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16777215\"/>\r\n" +
 "<Property actionString=\"WINSYS_COLOR_ADD\" action=\"284\" " +
 "type=\"java.lang.Integer\" value=\"16776960\"/>\r\n" +
 "<Property actionString=\"FONT_NAME\" action=\"383\" " +
 "type=\"java.lang.String\" value=\"dialog\"/>\r\n" +
 "<Property actionString=\"FONT_SIZE\" action=\"377\" " +
 "type=\"java.lang.Integer\" value=\"900\"/>\r\n" +
 "<Property actionString=\"FONT_STYLE\" action=\"378\" " +
 "type=\"java.lang.Byte\" value=\"0\"/>\r\n" +
 "<Property actionString=\"FONT_WEIGHT\" action=\"379\" " +
 "type=\"java.lang.Byte\" value=\"0\"/>\r\n" +
 "<Property actionString=\"INITIAL_SCALE_INFO\" action=\"267\" " +
 "type=\"java.awt.Point\" pointx=\"7.0\" pointy=\"21.0\"/>\r\n" +
 "<Property actionString=\"WINSYS_REQUIREDVA_LIST\" action=\"291\" " +
 "type=\"java.lang.Boolean\" value=\"true\"/>\r\n" +
 "<Property actionString=\"SERVER_USER_PARAMS\" action=\"510\" " +
 "type=\"java.lang.String\" value=\"NLS_LANG='AMERICAN_AMERICA' " +
  "FORMS_USER_DATE_FORMAT='DD-MON-RRRR' " +
  "FORMS_USER_DATETIME_FORMAT='DD-MON-RRRR HH24:MI:SS' " +
  "NLS_DATE_LANGUAGE='AMERICAN' NLS_SORT='BINARY' " +
  "NLS_NUMERIC_CHARACTERS='.,'\"/>\r\n" +
 "<Property actionString=\"DEFAULT_LOCAL_TZ\" action=\"530\" " +
 "type=\"java.lang.String\" value=\"Asia/Shanghai\"/>\r\n" +
 "</Message>\r\n");

nca.sendTerminal

Sends an Oracle Forms Terminal Message request to the Oracle Forms server.

Format

The nca.sendTerminal method has the following command format(s):

nca.sendTerminal(responseCode);

nca.sendTerminal(recId, responseCode);

Command Parameters

recId: Optionally specify a recorded element ID. Only used for comparison purposes in the results. May be null.
responseCode: Specify the type of terminal message to send, i.e. 1, 2, or 3.

Throws

AbstractScriptException: on any exception while sending the terminal message to the Oracle Forms server.

Example

Sends an Oracle Forms Terminal Message 1.

nca.sendTerminal(90, 1);

nca.solve

Parses a value from the source of latest action and store it as a variable.

Format

The nca.solve method has the following command format(s):

nca.solve(name, pattern, errorMessage, isOptional, source, resultIndex, encoding);

Command Parameters

name: a String specifying the Name of the variable to create. Must not be null.
pattern: a String specifying the Regular expression specifying what to extract from the most recent navigation's contents. May contain a transform expression. Must not be null.
errorMessage: an optional String specifying the error message to display if the pattern cannot be solved. If null, a meaningful error message is automatically generated.
isOptional: a boolean specifying if pattern must be solved or not. Set to True if the pattern does not have to be solved. If the pattern cannot be solved, the method quietly returns.
source: an NcaSource enum specifying which contents to return as a String.
resultIndex: an index value that specifies the 0-based index of the specific result to retrieve if the pattern matches more than one value. If null, all results will be added into the variables collection.
encoding: an EncodeOptions enum specifying the encoding or decoding operation to perform on the variable's value after solving the variable. A null value is equivalent to EncodeOptions.None.

Throws

Exception: if the object is not found.

Example

Parse a value from the specified source using a Regular Expression and store it in a variable. An optional error message returns if the pattern cannot be solved. The pattern is optional and does not have to be solved. Includes a result index value of 0 to specify it should retrieve the first match result and ecoding or decode using the specified option.

nca.solve("varStatusBar0", "FRM-(.+): Transaction complete: (.+) records " +
 "applied and saved.", "Text not Found", false, 
 NcaSource.StatusBarText, 0, EncodeOptions.None);

nca.statusBar

Identifies an Oracle Forms statusBar object by its recorded ID and handler name.

Format

The nca.statusBar method has the following command format(s):

nca.statusBar(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the statusBar. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTStatusBar object.

Example

Identifies an Oracle Forms statusBar object specified by its recorded ID and handler name.

nca.statusBar(173, "statusBar");

nca.tab

Identifies an Oracle Forms TabControl object by its handler name.

Format

The nca.tab method has the following command format(s):

nca.tab(handlerName);

nca.tab(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the TabControl. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTTabControl object.

Example

Performs an action on an Oracle Forms TabControl object specified by its recorded ID and handler name.

nca.tab(119, "SUMMARY_TABS").setFocus("");
nca.tab(120, "SUMMARY_TABS").selectByIndex(9, "1");
nca.tab(121, "SUMMARY_TABS").clearFocus("");

nca.tableBox

Identifies an Oracle Forms tableBox object by its recorded ID and handler name.

Format

The nca.tableBox method has the following command format(s):

nca.tableBox(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the tableBox. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTTableBox object.

Example

Identifies an Oracle Forms tableBox object specified by its recorded ID and handler name.

nca.tableBox(171, "tablebox");

nca.textField

Creates a reference to a text field object in the Forms applet by handler name.

The object is not actually found until performing some action against the object.

Format

The nca.textField method has the following command format(s):

nca.textField(handlerName);

nca.textField(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the text field. Must not be null.

Throws

AbstractScriptException: represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.

Returns

a new TFormsLTTextField object.

Example

Performs an action on an Oracle Forms text field object specified by its recorded ID and handler name.

nca.window(307, "NAVIGATOR").activate("");
nca.window(308, "NAVIGATOR").setVisible(true, "");
nca.textField(325, "GROUPS_OPERATING_UNIT_0").setFocus();
String text=nca.textField(327, "GROUPS_OPERATING_UNIT_0").getText();
info("text: " + text);
nca.textField(327, "GROUPS_OPERATING_UNIT_0").clickButton();

nca.timer

Identifies an Oracle Forms timer object by its handler name.

Format

The nca.timer method has the following command format(s):

nca.timer(handlerName);

nca.timer(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the timer. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTApplicationTimer object.

Example

Performs an action on an Oracle Forms timer object specified by its recorded ID and handler name.

nca.window(9078, "FOLDER_INCIDENT_TRACKING").activate("2");
nca.textField(9079, "CREATE_TASK_PLANNED_END_DATE_UI_0")
 .select(0, 20, 20, "");
nca.button(9080, "CALENDAR_OK_0").clearFocus("");
nca.textField(9081, "CREATE_TASK_PLANNED_END_DATE_UI_0")
 .setFocus("1");
nca.window(9082, "Oracle Applications - Main Window")
 .resize(1364, 768, "1");
nca.textField(9083, "CREATE_TASK_PLANNED_END_DATE_UI_0")
 .clearFocus("");
nca.jContainer(9084, "SR_TASK_GRID_GRID_ITEM_0")
 .setFocus("");
nca.jContainer(9085, "SR_TASK_GRID_GRID_ITEM_0")
 .sendMessage("<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"271\" mHandlerId=\"496\">\r\n" +
   "<Property actionString=\"EVENT\" action=\"398\" " +
   "type=\"oracle.forms.engine.Message\" >\r\n" +
   "<Message mActionString=\"MSG_UPDATE\" mActionCode=\"2\" " +
   "mHandlerClassId=\"271\" mHandlerId=\"496\">\r\n" +
   "<Property actionString=\"EVENTNAME\" action=\"399\" " +
   "type=\"java.lang.String\" value=\"focusChanged\"/>\r\n" +
   "<Property actionString=\"EVENT_ARGNAME\" action=\"400\" " +
   "type=\"java.lang.String\" value=\"currentColumn\"/>\r\n" +
   "<Property actionString=\"EVENT_ARGVALUE\" action=\"401\" " +
   "type=\"java.lang.String\" value=\" \"/>\r\n" +
   "<Property actionString=\"EVENT_ARGNAME\" action=\"400\" " +
   "type=\"java.lang.String\" value=\"currentRow\"/>\r\n" +
   "<Property actionString=\"EVENT_ARGVALUE\" action=\"401\" " +
   "type=\"java.lang.String\" value=\"2\"/>\r\n" +
   </Message>\r\n</Property>\r\n</Message>\r\n", "12");
nca.timer(9086, "COMPONENT_ID_1216").expired("1");
nca.window(9087, "FOLDER_INCIDENT_TRACKING").deactivate("1");

nca.tree

Identifies an Oracle Forms Tree object by its handler name.

Format

The nca.tree method has the following command format(s):

nca.tree(handlerName);

nca.tree(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the Tree. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTTreeItem object.

Example

Performs an action on an Oracle Forms Tree object specified by its recorded ID and handler name.

nca.tree(334, "APPTREE_NAV_TREE_NAVIGATOR_0").setFocus("");
nca.tree(335, "APPTREE_NAV_TREE_NAVIGATOR_0").expandNode(1, "1");

nca.treeList

Identifies an Oracle Forms TreeList object by its handler name.

Format

The nca.treeList method has the following command format(s):

nca.treeList(handlerName);

nca.treeList(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the TreeList. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTTListItem object.

Example

Performs an action on an Oracle Forms TreeList object specified by its recorded ID and handler name.

nca.treeList(124, "NAVIGATOR_LIST_0").setFocus("1");
nca.treeList(125, "NAVIGATOR_LIST_0").selectByIndex(1);

nca.unRegisterProperty

Unregister a property that was previously registered using registerProperty.

If the specified property does not exist, this method does not do anything.

Format

The nca.unRegisterProperty method has the following command format(s):

nca.unRegisterProperty(name, handlerId);

Command Parameters

name: a String specifying the name of the property previously registered using registerProperty.
handlerId: a value specifying the object for which this property was registered.

Throws

AbstractScriptException: represents an exception that may be thrown during the execution of a script where the exception should be reported to an end user through the controller.
NullPointerException: if the name is null.

Example

Unregisters the previously registered property.

nca.unRegisterProperty("TITLE", 6);

nca.verifyStatusBarText

Searches the status bar contents for the specified text pattern and performs a verify only matching test.

If the test fails, report a warning.

This method will never cause a script to fail, regardless of the text matching test error recovery settings. Use nca.assertStatusBarText to make the script fail when the test fails.

When playing back a script in Oracle Load Testing, always use Assertions; failed Verifications are NOT reported in OLT. If any part of the status bar text matches textToVerify, the verification succeeds.

Format

The nca.verifyStatusBarText method has the following command format(s):

nca.verifyStatusBarText(testName, textToVerify, matchOption);

nca.verifyStatusBarText(recId, testName, textToVerify, matchOption);

Command Parameters

recId: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
testName: a String specifying the test name.
textToVerify: a String specifying the Text to match on the page, or not match on the page if TextPresence is set as PassIfPresent.
matchOption: a MatchOption enum specifying how the text to match should be searched on the page, such as using a regular expression, wildcard, or exact match.

Throws

AbstractScriptException: on any failure when attempting to verify the text.

Example

Verifies the specified text matches exactly.

nca.verifyStatusBarText(151, "Verify StatusBar Text" +
 "text value", "FRM-40400: Transaction complete: " +
 "1 records applied and saved.", MatchOption.Exact);

nca.verifyText

Searches the text of selected source type for the specified text pattern performing a verify only text match.

If the test fails, report a warning. This method will never cause a script to fail, regardless of the text matching test error recovery settings. Use nca.assertText to make the script fail when the test fails.

When playing back a script in Oracle Load Testing, always use Assertions; failed Verifications are NOT reported in OLT. If any part of the source text matches textToVerify, the verification succeeds.

Format

The nca.verifyText method has the following command format(s):

nca.verifyText(testName, textToVerify, sourceType, textPresence, matchOption);

Command Parameters

testName: a String specifying the test name.
textToVerify: a String specifying the Text to match on the page, or not match on the page if TextPresence is set as PassIfPresent.
sourceType: a NcaSource enum specifying where to match the text, i.e. in the Object Details, Request and Response, or Status Bar text.
textPresence: a TestPresence enum specifying either PassIfPresent or FailIfPresent, depending on if you want the test to pass or fail if the text to match is present or not.
matchOption: a MatchOption enum specifying how the text to match should be searched on the page, such as using a regular expression, wildcard, or exact match.

Throws

AbstractScriptException: on any failure when attempting to verify the text.

Example

Adds a Verify only, never fail, Text Matching tests for Statu Bar text.

nca.verifyText("myTextMatchingTest", "match this text string", 
 NcaSource.StatusBarText, TextPresence.PassIfPresent, MatchOption.Exact);

nca.window

Identifies an Oracle Forms FormWindow object by its handler name.

Format

The nca.window method has the following command format(s):

nca.window(handlerName);

nca.window(recid, handlerName);

Command Parameters

recid: Optional the ID of a previously recorded navigation, used for comparison purposes. May be null.
handlerName: a String specifying the handler name of the FormWindow. Must not be null.

Throws

Exception: if the object is not found.

Returns

a new TFormsLTFormWindow object.

Example

Performs an action on an Oracle Forms FormWindow object specified by its recorded ID and handler name.

nca.window(102, "NAVIGATOR").activate("");
nca.registerProperty("TITLE", "", 102, RegisterPropertyOptions.RegisterForMSG_GET);
nca.unRegisterProperty("title", 102);
nca.textField(103, "NAVIGATOR_TYPE_0").setFocus("22");
nca.window(105, "NAVIGATOR").resize(586, 451, "22222");
nca.window(106, "FIND_ORDER_NUMBER_0").setCursorPosition(0, "");
nca.window(107, "CONFIGURATOR_PROCESSING").move(288, 192, "");