21 Siebel OpenUI Function Library

Format

The functionLib.activateRow method has the following command format(s):

functionLib.activateRow(xpath, row);

Command Parameters

xpath

a String specifying the object path. Should be taken from any column header from the List Applet.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Example

Activates the fifth row in the list.

functionLib.activateRow("/web:window" +
 "/web:document" +
 "/web:div[@rn='Name' and @ot='JText' " +
  "and @un='Name']", 5);

Format

The functionLib.activeApplet method has the following command format(s):

functionLib.activeApplet( );

Throws

Exception

on any error.

Returns

a String repository name of the current context.

Example

Gets the repository name of the current view and prints the custom message.

//Using Java variable.
String value = functionLib.activeApplet();
System.out.println("active Applet is "+ value);

Format

The functionLib.activeRow method has the following command format(s):

functionLib.activeRow(AppletRepname);

Command Parameters

AppletRepname

a String specifying the Applet.

Throws

Exception

on any error.

Returns

an Integer row number.

Example

Gets the active row number.

//Using Java variable.
int activeRow = functionLib.activeRow("Applet Name");
System.out.println("The active row is "+activeRow);

Format

The functionLib.activeScreen method has the following command format(s):

functionLib.activeScreen( );

Throws

Exception

on any error.

Returns

the RepositoryName (un SiebelPageTab object attribute) of the activeScreen, as represented by the active Aggregate Category link.

Example

Gets the RepositoryName (un SiebelPageTab object attribute) of the activeScreen, as represented by the active Aggregate Category link and prints the custom message.

//Using Java variable.
String value = functionLib.activeScreen();
System.out.println("activeScreen is "+value);

Format

The functionLib.ActiveTreeItem method has the following command format(s):

functionLib.ActiveTreeItem(AppletRepname);

Command Parameters

AppletRepname

a String specifying the Applet.

Throws

Exception

on any error.

Returns

a String of the active item name.

Example

Gets the active tree item.

//Using Java variable.
String activeitem = functionLib.ActiveTreeItem("Applet Name");
System.out.println("The active tree item is "+activeitem);

Format

The functionLib.activeView method has the following command format(s):

functionLib.activeView( );

Throws

Exception

on any error.

Returns

the RepositoryName (rn attribute) of the active view, as represented by the active Aggregate Category link.

Example

Gets the RepositoryName (rn attribute) of the active view, as represented by the active Aggregate Category link and prints the custom message.

//Using Java variable.
String value = functionLib.activeView();
System.out.println("Active View is "+value);

Format

The functionLib.advancededitGetRoProperty method has the following command format(s):

functionLib.advancededitGetRoProperty(propertyName, xpath);

Command Parameters

propertyName

a String specifying the property (for example, classname, rn, un, value) to get.

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the String value of the specified property.

Example

Gets the value of the advancededit element with the attribute value and prints the custom message.

//Using Java variable.
String value = functionLib.advancededitGetRoProperty("value","/web:window[]" +
 "/web:document[]" +
 "/web:form[]" +
 "/web:input_text[@rn='Revenue' and @ot='JCurrencyCalc' " +
  "and @un='Revenue']");
System.out.println("AdvancedEdit value is "+value);

Format

The functionLib.appletClassName method has the following command format(s):

functionLib.appletClassName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String specifying the class property of the Applet object.

Example

Gets the class attribute and prints the custom message.

//Using Java variable.
String value = functionLib.appletClassName("");
System.out.println("Class Name is "+value);

Format

The functionLib.appletCount method has the following command format(s):

functionLib.appletCount( );

Throws

Exception

on any error.

Returns

the number of Applets in the current screen.

Example

Gets the number of Applets under the current screen and prints the custom message.

//Using Java variable.
int value = functionLib.appletCount();
System.out.println("Applet count is "+value);

Format

The functionLib.appletGetROProperty method has the following command format(s):

functionLib.appletGetROProperty(propertyName);

Command Parameters

propertyName

a String specifying the property (For example, un, rn, exist) to get.

Throws

Exception

on any error.

Returns

the String value of the specified property.

Example

Gets the repository name (rn) of the Applet object and prints the custom message if matches the expected value.

//Using Java variable.
String repName = functionLib.appletGetROProperty("rn");
if(repName.equals("Visible Contact List View"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.appletRepositoryName method has the following command format(s):

functionLib.appletRepositoryName( );

Throws

Exception

on any error.

Returns

a String Repository name of the active Applet.

Example

Gets the Repository name of the active Applet and prints the custom message.

//Using Java variable.
String getAttribute = functionLib.appletRepositoryName();
if (getAttribute.equals("Visible Contact List View")) 
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.appletUiName method has the following command format(s):

functionLib.appletUiName( );

Throws

Exception

on any error.

Returns

a String value of the rn property.

Example

Gets the Applet UI name and prints the custom message.

// Using Java variable.
String appName = functionLib.appletUiName();
if(appName.equals("SIS Account List Applet"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.ApplicationMenuClick method has the following command format(s):

functionLib.ApplicationMenuClick(unLIAppMenuItem, unLIAppSubmenuItem);

Command Parameters

unLIAppMenuItem

a String specifying the UN attribute of the Main menu Link. For example, File, Edit, View, etc.

unLIAppSubmenuItem

a String specifying the UN attribute of the Link which is present inside the main menu item. For example, Logout, Action Pane, etc.

Throws

Exception

on any error.

Example

Performs click action on the Application Menu Links.

functionLib.ApplicationMenuClick("File", "File - Logout");

Format

The functionLib.buttonClassName method has the following command format(s):

functionLib.buttonClassName(xpath);

Command Parameters

xpath

a String specifying the object xpath.

Throws

Exception

on any error.

Returns

a String class name of the object button.

Example

Gets the attribute class for the element button and prints the custom message.

//Using Java variable.
String classname = functionLib.buttonClassName("/web:window" +
 "/web:document" +
 "/web:form" +
 "/web:button[@rn='NewRecord' and @ot='Button' and @un='New']");
System.out.println(classname);

Format

The functionLib.buttonclick method has the following command format(s):

functionLib.buttonclick(rn, ListORForm);

Command Parameters

rn

Repository name of teh button.

ListORForm

Specify List or Form.

Throws

Exception

on any error.

Example

Clicks on the button based on the specified Form Applet.

functionLib.buttonclick("NewQuery", "Form");

Format

The functionLib.buttonGetRoProperty method has the following command format(s):

functionLib.buttonGetRoProperty(xpath, propertyName);

Command Parameters

xpath

a String specifying the object xpath.

propertyName

a String specifying the property (For example, text, un, rn, classname, isenabled) to get.

Throws

Exception

on any error.

Returns

the String value of the specified property.

Example

Gets the value of the button element with the attribute text and prints the custom message.

//Using Java variable.
String getAttribute = functionLib.buttonGetRoProperty("/web:window" +
 "/web:document" +
 "/web:form" +
 "/web:button[@rn='NewRecord' and @ot='Button' and @un='New']", "text");
//Using If condition comparing with expected.
if (getAttribute.equals("New")) 
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.buttonIsEnabled method has the following command format(s):

functionLib.buttonIsEnabled(xpath);

Command Parameters

xpath

a String specifying the object xpath.

Throws

Exception

on any error.

Returns

true if the object is enabled, false if the object is disabled.

Example

Detect whether or not the button is enabled and prints the custom message if enable/disabled.

//Using Java variable.
boolean enabled = functionLib.buttonIsEnabled("/web:window" +
 "/web:document" +
 "/web:form" +
 "/web:button[@rn='NewRecord' and @ot='Button' and @un='New']");
if(enabled)
{
 System.out.println("button is enabled");
}
else
 System.out.println("button is not enabled");

Format

The functionLib.buttonRepositoryName method has the following command format(s):

functionLib.buttonRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object xpath.

Throws

Exception

on any error.

Returns

a String repository name of the object button.

Example

Gets the rn attribute of the target xpath and prints the custom message.

//Using Java variable.
String repoName = functionLib.buttonRepositoryName("/web:window" +
 "/web:document" +
 "/web:form" +
 "/web:button[@rn='NewRecord' and @ot='Button' and @un='New']");
if(repoName.equals("New"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.buttonUIName method has the following command format(s):

functionLib.buttonUIName(xpath);

Command Parameters

xpath

a String specifying the object xpath.

Throws

Exception

on any error.

Returns

a String UIname of the object button.

Example

Gets the attribute un for the element button and prints the custom message.

//Using Java variable.
String UIName = functionLib.buttonUIName("/web:window" +
 "/web:document" +
 "/web:form" +
 "/web:button[@rn='NewRecord' and @ot='Button' and @un='New']");
if(UIName.equals("New"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.calculatorClassName method has the following command format(s):

functionLib.calculatorClassName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the classname of the calculator object

Example

Gets the classname of the calculator object element and prints the custom message.

//Using Java variable.
String value = functionLib.calculatorClassName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0' ]" +
 "/web:input_text[@rn='Current Volume' and @ot='JCurrencyCalc' " +
   "and @un='Current Volume']"); 
System.out.println("Calculator classname is"+value);

Format

The functionLib.calculatorGetROProperty method has the following command format(s):

functionLib.calculatorGetROProperty(xpath, propertyname);

functionLib.calculatorGetROProperty(xpath, propertyname, row);

Command Parameters

xpath

a String specifying the object path.

propertyname

the property name to get.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value of the specified property.

Example

Gets the value of the calculator element with the attribute value and prints the custom message if matches the required value.

//Using Java variable.
String getAttribute2 = functionLib.calculatorGetROProperty("/web:window" +
 "/web:document" +
 "/web:div[@rn='NRC Total' and @ot='JCurrencyCalc' " +
  "and @un='NRC Total']", "value", 2 );      
if(getAttribute2.equals(""))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.calculatorIsEnabled method has the following command format(s):

functionLib.calculatorIsEnabled(xpath);

functionLib.calculatorIsEnabled(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet..

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

true if the object is enabled, false if the object is disabled.

Example

Detects whether the calculator object is enabled or disabled and prints a custom message based on whether calculator object is enabled or disabled.

//Using Java variable.
boolean cal = functionLib.calculatorIsEnabled("/web:window" +
 "/web:document" +
 "/web:div[@rn='NRC Total' and @ot='JCurrencyCalc' " +
  "and @un='NRC Total']",5);
if(cal)
{
 System.out.println("Enabled");
}
else
{
 System.out.println("Disabled");
} 

Format

The functionLib.calculatorIsOpen method has the following command format(s):

functionLib.calculatorIsOpen(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

String true if the calculator popup is opened, false if the calculator popup is closed.

Example

Detect whether the calculator popup is open or closed and prints a custom message.

//Using Java variable.
String value = functionLib.calculatorIsOpen("/web:window[]" +
 "/web:document[]" +
 "/web:input_text[@id='s_0_1_313_0']");
if(value.equals("true"))
{
 System.out.println("calculator popup is Opened");
}
else
{
 System.out.println("calculator popup is Closed"); 
}

Format

The functionLib.calculatorRepositoryName method has the following command format(s):

functionLib.calculatorRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the repository name of the calculator object.

Example

Gets the RepositoryName attribute of the calculator object element and prints the custom message.

//Using Java variable.
String value = functionLib.calculatorRepositoryName("/web:window[]" +
 "/web:document[]" +
 "/web:form[@name='SWEForm1_0' ]" +
 "/web:input_text[@rn='Current Volume' and @ot='JCurrencyCalc' " +
  "and @un='Current Volume']"); 
System.out.println("Calculator RepositoryName is "+value);

Format

The functionLib.calculatorText method has the following command format(s):

functionLib.calculatorText(xpath);

functionLib.calculatorText(xpath, row);

Command Parameters

xpath

a String specifying the object path.

row

an Integer value specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value specifying the text of the object.

Example

Gets the text value from the object for the second row of the List Applet and prints the custom message.

//Using Java variable.
String value = functionLib.calculatorText("/web:window" +
 "/web:document" +
 "/web:div[@rn='NRC Total' and @ot='JCurrencyCalc' " +
  "and @un='NRC Total']", 2); 
if(value.equals("$1,222.00"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.calculatorUiName method has the following command format(s):

functionLib.calculatorUiName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the UI of the calculator object.

Example

Gets the UiName of the calculator object element and prints the custom message.

//Using Java variable.
String value = functionLib.calculatorUiName("/web:window" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_text[@rn='NetTotal' and @ot='JCalculator' " +
  "and @un='Quote Total']"); 
System.out.println("Calculator UiName is "+value);

Format

The functionLib.calendarDay method has the following command format(s):

functionLib.calendarDay(xpath);

functionLib.calendarDay(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header of the List Applet..

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

String value of sepcifying the day of the calendar object.

Example

Gets the day of the calendar object for the List Applet and prints the custom message.

//Using Java variable.
String day = functionLib.calendarDay("/web:window" +
 "/web:document" +
 "/web:div[@rn='Start Date' and @ot='JDatePick' " +
  "and @un='Effective As Of']", 5);
System.out.println("Day is "+day);

Format

The functionLib.calendarDayClick method has the following command format(s):

functionLib.calendarDayClick(xpath, day);

functionLib.calendarDayClick(xpath, row, day);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header of the List Applet.

row

an integer specifying the row number from the List Applet (should always start from one).

day

String specifying a day to click on the calendar popup.

Throws

Exception

on any error.

Example

Clicks a day on the calendar popup in the List Applet.

//Using Java variable.
String ispopup = functionLib.isCalendarPopup();
if(ispopup.equals("true"))
{
 System.out.println("calendar is popup");
 functionLib.calendarDayClick("/web:window" +
  "/web:document" +
  "/web:div[(@rn='Primary Revenue Close Date' " +
   "and @ot='JDatePick') or @un='Close Date']", 1, "12");
}
else
{
 System.out.println("calendar is not popup"); 
}
 

Format

The functionLib.calendarDayListApplet method has the following command format(s):

functionLib.calendarDayListApplet(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

row

an Integer specifying the row of the record in the List Applet for which the calendar day value is to be retrieved.

Throws

Exception

on any error.

Returns

a String day value.

Example

Gets the calendar day value.

//Using Java variable.
String dayvalue = functionLib.calendarDayListApplet("/web:window[]" +
 "/web:document[]" +
 "/web:input_text[@id='s_0_1_313_0']", 2);
System.out.println("Day value is "+dayvalue);

Format

The functionLib.calendarIsOpen method has the following command format(s):

functionLib.calendarIsOpen(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

String true if the calendar popup is open, false if the calendar popup is closed.

Example

Detect whether calendar popup is open or closed and prints a custom message.

//Using Java variable.
String value = functionLib.calendarIsOpen("/web:window[]" +
 "/web:document[]" +
 "/web:input_text[@id='s_0_1_313_0']");
if(value.equals("true"))
{
 System.out.println("calendar popup is Opened");
}
else
{
 System.out.println("calendar popup is Closed"); 
}

Format

The functionLib.calendarMonth method has the following command format(s):

functionLib.calendarMonth(xpath);

functionLib.calendarMonth(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value sepcifying the month of the calendar object (Output: Jan, Feb, etc.).

Example

Gets the month of the calendar object for the List Applet and prints the custom message.

//Using Java variable.
String month = functionLib.calendarMonth("/web:window" +
 "/web:document" +
 "/web:div[@rn='Start Date' and @ot='JDatePick' " +
  "and @un='Effective As Of']", 5);
System.out.println("Month is "+month);

Format

The functionLib.calendarMonthListApplet method has the following command format(s):

functionLib.calendarMonthListApplet(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

row

an Integer specifying the row of the record in the List Applet for which the calendar month value is to be retrieved.

Throws

Exception

on any error.

Returns

a String month value.

Example

Gets the calendar month value.

//Using Java variable.
String monthvalue = functionLib.calendarMonthListApplet("/web:window[]" +
 "/web:document[]" +
 "/web:input_text[@id='s_0_1_313_0']", 2);
System.out.println("Month value is "+monthvalue);

Format

The functionLib.calendarYear method has the following command format(s):

functionLib.calendarYear(xpath);

functionLib.calendarYear(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header of the List Applet..

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

string year value of the calendar field in the Form Applet.

Example

Gets the year of the calendar object for the fifth row in the List Applet and prints the custom message.

//Using Java variable.
String year = functionLib.calendarYear("/web:window" +
 "/web:document" +
 "/web:div[@rn='Start Date' and @ot='JDatePick' " +
  "and @un='Effective As Of']", 5);
System.out.println("year is "+year);

Format

The functionLib.calendarYearListApplet method has the following command format(s):

functionLib.calendarYearListApplet(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

row

an Integer specifying the row of the record in the List Applet for which the calendar year value is to be retrieved.

Throws

Exception

on any error.

Returns

a String year value.

Example

Gets the calendar year value.

//Using Java variable.
String yearvalue = functionLib.calendarYearListApplet("/web:window[]" +
 "/web:document[]" +
 "/web:input_text[@id='s_0_1_313_0']", 2);
System.out.println("Year value is "+yearvalue);

Format

The functionLib.calenderClassName method has the following command format(s):

functionLib.calenderClassName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String class specified calendar object.

Example

Gets the classname attribute of the calendar object and prints the custom message.

//Using Java variable.
String classname = functionLib.calenderClassName("/web:window" +
 "/web:document" +
 "/web:input_text[@rn='CloseDate2' and @ot='JDatePick' " +
  "and @un='Close Date']");
System.out.println("calendar classname is "+classname);

Format

The functionLib.calenderGetROProperty method has the following command format(s):

functionLib.calenderGetROProperty(xpath, propertyname);

functionLib.calenderGetROProperty(xpath, propertyname, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

propertyname

a String specifying the property (for example, rn, un, classname, value) to get.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value of the specified property.

Example

Gets the value of the calender element with the attribute value and prints the custom message if matches the required value.

//Using Java variable.
String getAttribute = functionLib.calenderGetROProperty("/web:window" +
 "/web:document" +
 "/web:div[@rn='Primary Revenue Close Date' " +
 "and @ot='JDatePick' and @un='Close Date']", "value", 2 );   
if(getAttribute.equals("9/7/2013"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.calenderIsEnabled method has the following command format(s):

functionLib.calenderIsEnabled(xpath);

functionLib.calenderIsEnabled(xpath, row);

Command Parameters

xpath

a String specifying the object path.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

true if the object is enabled, false if the object is disabled.

Example

Detects whether the calendar object is enabled or disabled and prints a custom message.

//Using Java variable.
boolean pklst2 = functionLib.calenderIsEnabled("/web:window" +
 "/web:document" +
 "/web:input_text[@rn='CloseDate2' and @ot='JDatePick' " +
  "and @un='Close Date']", 5);
if(pklst2)
{
 System.out.println("Enabled");
}
else
{
 System.out.println("Disabled");
}

Format

The functionLib.calenderUiName method has the following command format(s):

functionLib.calenderUiName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the calendar object.

Example

Gets the repository name of the calendar object and prints the custom message.

//Using Java variable.
String value = functionLib.calenderUiName("/web:window" +
 "/web:document" +
 "/web:input_text[@rn='CloseDate2' and @ot='JDatePick' " +
 "and @un='Close Date']");
System.out.println("calendar UI name is "+value);

Format

The functionLib.checkBoxClassName method has the following command format(s):

functionLib.checkBoxClassName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String of class name of the checkbox object.

Example

Gets the class attribute of the currency object and prints the custom message.

//Using Java variable.
String chkbox = functionLib.checkBoxClassName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_checkbox[@rn='Active' and @ot='JCheckBox' " +
  "and @un='Active']");
 System.out.println("Check box class name "+ chkbox); 

Format

The functionLib.checkboxGetROProperty method has the following command format(s):

functionLib.checkboxGetROProperty(xpath, propertyName);

functionLib.checkboxGetROProperty(xpath, propertyName, row);

Command Parameters

xpath

a String specifying the object path.

propertyName

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value of the specified property.

Example

Gets the UI Name of the checkbox element with the attribute un and prints the custom message if matches the required value.

//Using Java variable.
String getAttribute = functionLib.checkboxGetROProperty("/web:window" +
 "/web:document" +
 "/web:input_checkbox[@rn='Secure2' and @ot='JCheckBox' " +
  "and @un='Secure']", "un", 2);     
if(getAttribute.equals("Secure"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.checkboxRepositoryName method has the following command format(s):

functionLib.checkboxRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the pagetab object.

Example

Gets the repository name of the checkbox object and prints the custom message.

//Using Java variable.
String chkbox = functionLib.checkboxRepositoryName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_checkbox[@rn='Active' and @ot='JCheckBox' " +
 "and @un='Active']");
System.out.println("Check box Repository name "+ chkbox);

Format

The functionLib.checkBoxUIName method has the following command format(s):

functionLib.checkBoxUIName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String of the specified UiMame of the checkbox object.

Example

Gets the UiName of the currency object and prints the custom message.

//Using Java variable.
String chkbox = functionLib.checkBoxUIName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_checkbox[@rn='Active' and @ot='JCheckBox' " +
  "and @un='Active']");
 System.out.println("Check box UI Name"+ chkbox); 

Format

The functionLib.clickDone method has the following command format(s):

functionLib.clickDone( );

Throws

Exception

on any error.

Example

Clicks the Done button in the calendar popup when the calendar is opened in List or Form Applets.

//Using Java variable.
String isCalOpen = functionLib.isCalendarPopup();
if(isCalOpen.equals("true"))
{
 System.out.println("calendar is popup");
 functionLib.clickDone();
}
else
{
 System.out.println("calendar is not popup"); 
}
 

Format

The functionLib.clickNow method has the following command format(s):

functionLib.clickNow( );

Throws

Exception

on any error.

Example

Clicks the Now button in the calendar popup when the calendar is opened in List or Form Applets.

//Using Java variable.
String isCalOpen = functionLib.isCalendarPopup();
if(isCalOpen.equals("true"))
{
 System.out.println("calendar is popup");
 functionLib.clickNow();
}
else
{
 System.out.println("calendar is not popup"); 
}
 

Format

The functionLib.Collapse method has the following command format(s):

functionLib.Collapse(StrId);

Command Parameters

StrId

a String specifying the String ID.

Throws

Exception

on any error.

Example

Collapses the object specified by String ID.

functionLib.Collapse("stringid");

Format

The functionLib.columnCount method has the following command format(s):

functionLib.columnCount(xpath);

Command Parameters

xpath

a String specifying the object path should be taken from the any column header from the List Applet.

Throws

Exception

on any error.

Returns

an Integer number of currently visible rows.

Example

Gets the columns count of the List Applet and prints the custom message.

//Using Java variable.
int col = functionLib.columnCount("/web:window" +
 "/web:document" +
 "/web:div[@rn='Account' and @ot='JText' " +
  "and @un='Account']");
for(int i = 1; i< col ; i++)
{
 System.out.println("column number "+ i );
}

Format

The functionLib.commToolbarClassname method has the following command format(s):

functionLib.commToolbarClassname(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String class name of the communication toolbar object.

Example

Gets the class attribute from the HTML DOM and prints the custom message.

//Using Java variable.
String value = functionLib.commToolbarClassname("/web:window" +
 "/web:document" +
 "/web:img[@rn='Release Work' and @ot='button' " +
  "and @un='Release_Work']");
if(value.equals("Release Work"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.commToolbarGetRoProperty method has the following command format(s):

functionLib.commToolbarGetRoProperty(xpath, value);

Command Parameters

xpath

a String specifying the object path.

value

a String specifying the value to check in the CommunicationsToolbar list (rn, un, name and classname).

Throws

Exception

Returns

the current value of the test object property from the object in the application.

Example

Gets the UI name of the CommunicationsToolbar with the attribute un and prints the custom message.

//Using Java variable.
String value = functionLib.commToolbarGetRoProperty("/web:window[]" +
 "/web:document[]" +
 "/web:img[@rn='SignOn' and @ot='button' " +
  "and @un='SignOn']", "SignOn");  
System.out.println("CommunicationsToolbar repository name is "+value);

Format

The functionLib.commToolbarIsEnabled method has the following command format(s):

functionLib.commToolbarIsEnabled(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

true if the object is enabled, false if the object is disabled.

Example

Gets the "aria-disabled" attribute from the HTML DOM and prints the custom message.

//Using Java variable.
boolean chkEnble = functionLib.commToolbarIsEnabled("/web:window" +
 "/web:document" +
 "/web:img[@rn='Release Work' and @ot='button' " +
  "and @un='Release_Work']");
if(chkEnble)
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.commToolbarRepositoryname method has the following command format(s):

functionLib.commToolbarRepositoryname(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the communication toolbar object.

Example

Gets the rn attribute from the HTML DOM and prints the custom message.

//Using Java variable.
String value = functionLib.commToolbarRepositoryname("/web:window" +
 "/web:document" +
 "/web:img[@rn='Release Work' and @ot='button' " +
  "and @un='Release_Work']");
if(value.equals("Release Work"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.commToolbarShowButtonToolTip method has the following command format(s):

functionLib.commToolbarShowButtonToolTip(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String value specifying the alt attribute of the object.

Example

Gets the alt attribute of the toolbar object and prints the custom message.

//Using Java variable.
String value = functionLib.getPageTabRepositoryName("/web:window" +
 "/web:document" +
 "/web:img[@rn='Release Work' and @ot='button' " +
 "and @un='Release_Work']");
System.out.println("Alt tag value is "+value);

Format

The functionLib.commToolbarText method has the following command format(s):

functionLib.commToolbarText(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String text value of the communication toolbar object.

Example

Gets the text value from the HTML DOM and prints the custom message.

//Using Java variable.
String value = functionLib.commToolbarText("/web:window" +
 "/web:document" +
 "/web:img[@rn='Release Work' and @ot='button' " +
  "and @un='Release_Work']");
if(value.equals("Release Work"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.commToolbarUiName method has the following command format(s):

functionLib.commToolbarUiName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String UI name of the communication toolbar object.

Example

Gets the un attribute from the HTML DOM and prints the custom message.

//Using Java variable.
String value = functionLib.commToolbarUiName("/web:window" +
 "/web:document" +
 "/web:img[@rn='Release Work' and @ot='button' " +
  "and @un='Release_Work']");
if(value.equals("Release Work"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.currencyAmount method has the following command format(s):

functionLib.currencyAmount(xpath);

functionLib.currencyAmount(xpath, rowid);

Command Parameters

xpath

a String specifying the object path.

rowid

an integer specifying the row ID of the object (should always start from one).

Throws

Exception

on any error.

Returns

the amount value of the currency field in the Form Applet.

Example

Gets the Amount of the currency object element and prints the custom message.

//Using Java variable.
String value = functionLib.currencyAmount("/web:window[]" +
 "/web:document[]" +
 "/web:input_text[@id='s_0_1_312_1']", 5);
 System.out.println("Currency Amount is "+value);

Format

The functionLib.currencyClassName method has the following command format(s):

functionLib.currencyClassName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the currency object.

Example

Gets the repository name of the currency object and prints the custom message.

//Using Java variable.
String classname = functionLib.currencyClassName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_text[@rn='NetTotal' and @ot='JCalculator' " +
  "and @un='Quote Total']");
System.out.println("Class name is "+classname);

Format

The functionLib.currencyCode method has the following command format(s):

functionLib.currencyCode(xpath);

functionLib.currencyCode(xpath, rowid);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

rowid

an Integer specifying the row id of the record in the List Applet for which the Currency Code value is to be retrieved.

Throws

Exception

on any error.

Returns

a String Currency Code value.

Example

Returns the Currency Code value of the currency field.

//Using Java variable.
String curvalue = functionLib.currencyCode("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0' or @index='2']" +
 "/web:input_text[@rn='Sub-Status' and @ot='JComboBox' " +
 "and @un='Sub Status']", 2);
System.out.println("Currency code value is "+curvalue);

Format

The functionLib.currencyCodeClassName method has the following command format(s):

functionLib.currencyCodeClassName(xpath);

Command Parameters

xpath

a String specifying the currency code bject path.

Throws

Exception

on any error.

Returns

the classname of the currency code object.

Example

Gets the classname of the currency code object element and prints the custom message.

//Using Java variable.
String value = functionLib.currencyCodeClassName("/web:window" +
 "/web:document" +
 "/web:input_text[@id='s_0_1_313_1']");
System.out.println("Currency code classname is "+value);

Format

The functionLib.currencyCodeValue method has the following command format(s):

functionLib.currencyCodeValue(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the Currency Code value of the currency object.

Example

Gets the Value of the currency object element and prints the custom message.

//Using Java variable.
String value = functionLib.currencyCodeValue("/web:window[]" +
 "/web:document[]" +
 "/web:input_text[@id='s_0_1_313_0']");
System.out.println("currency code Value is "+value);

Format

The functionLib.currencyGetROProperty method has the following command format(s):

functionLib.currencyGetROProperty(xpath, propertyname);

functionLib.currencyGetROProperty(xpath, propertyname, row);

Command Parameters

xpath

a String specifying the object path.

propertyname

a String specifying the property (for example,: rn, un, classname, value) to get.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value of the specified property.

Example

Gets the value of the currency element with the attribute value and prints the custom message if it matches the required value.

//Using Java variable.
String getAttribute = functionLib.currencyGetROProperty("/web:window" +
 "/web:document" +
 "/web:input_text[@rn='Revenue2' and @ot='JCurrencyCalc' " +
  "and @un='Revenue']", "value", 2); 
if(getAttribute.equals("$100.00"))
{
 System.out.println("Pass");
}
 else
{
 System.out.println("Fail");
}

Format

The functionLib.currencyIsEnabled method has the following command format(s):

functionLib.currencyIsEnabled(xpath);

functionLib.currencyIsEnabled(xpath, row);

Command Parameters

xpath

a String specifying the object path.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

true if the object is enabled, false if the object is disabled.

Example

Detects whether the currency object is enabled or disabled and prints a custom message based on whether currency object is enabled or disabled.

//Using Java variable.
boolean currency = functionLib.currencyIsEnabled("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_text[@rn='NetTotal' and @ot='JCalculator' " +
  "and @un='Quote Total']", 5);
if(currency)
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
} 

Format

The functionLib.currencyIsOpen method has the following command format(s):

functionLib.currencyIsOpen(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

true if the Currency popup is opened, false if the Currency popup is closed.

Example

Detect whether Currency popup is open or closed and prints a custom message.

//Using Java variable.
boolean value33 = functionLib.currencyIsOpen("/web:window[]" +
 "/web:document[]" +
 "/web:input_text[@id='s_0_1_313_0']");
if(value33)
{
 System.out.println("Currency popup is Opened"); 
}
else
{
 System.out.println("Currency popup is Closed"); 
}

Format

The functionLib.currencyRepositoryName method has the following command format(s):

functionLib.currencyRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String value specifying the repository of the currency object.

Example

Gets the rn attribute of the currency object and prints the custom message.

//Using Java variable.
String currencyRN = functionLib.currencyRepositoryName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_text[@rn='NetTotal' and @ot='JCalculator' " +
 "and @un='Quote Total']");
System.out.println("currency Repository Name is "+currencyRN);

Format

The functionLib.CurrencyText method has the following command format(s):

functionLib.CurrencyText(xpath);

functionLib.CurrencyText(xpath, row);

Command Parameters

xpath

a String specifying the object path.

row

an Integer value specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value specifying the text of the object.

Example

Gets the text value from the object for the second row of the List Applet and prints the custom message.

//Using Java variable.
String value = functionLib.CurrencyText("/web:window" +
 "/web:document" +
 "/web:div[@rn='Primary Revenue Amount' and @ot='JCurrencyCalc' " +
  "and @un='Revenue']", 2);
if(value.equals("$1,222.00"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.currencyUiName method has the following command format(s):

functionLib.currencyUiName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String value of specifying the UIName of the Currency object.

Example

Gets the un attribute of the currency object and prints the custom message.

//Using Java variable.
String currencyUN = functionLib.currencyUiName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_text[@rn='NetTotal' and @ot='JCalculator' " +
  "and @un='Quote Total']");
 System.out.println("currency UIName is "+currencyUN); 

Format

The functionLib.DataLevel method has the following command format(s):

functionLib.DataLevel(xpath, row);

Command Parameters

xpath

a String specifying the object path. Should be taken from the specified column header from the List Applet.

row

an integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value indicating the Level of the row in the Hierarchial List Applet.

Example

Gets the level at which the Current row exists in the Hierarchial List Applet and prints a custom messaage.

//Using Java variable.
String datalevel = functionLib.DataLevel("/web:window" +
 "/web:document" +
 "/web:div[(@rn='Name' and @ot='JText') " +
  "or @un='Name']", 3);
System.out.println("data level is " + datalevel);
 

Format

The functionLib.DataParentId method has the following command format(s):

functionLib.DataParentId(xpath, row);

Command Parameters

xpath

a String specifying the object path. Should be taken from the specified column header from the List Applet.

row

an integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value indicating the parent ID in the Hierarchial List Applet.

Example

Gets the parent ID of the Specified row and prints a custom message.

//Using Java variable.
String dataParentId = functionLib.DataParentId("/web:window" +
 "/web:document" +
 "/web:div[(@rn='Name' and @ot='JText') " +
  "or @un='Name']", 3);
System.out.println("data parent ID is " + dataParentId);
 

Format

The functionLib.dialogGetROProperty method has the following command format(s):

functionLib.dialogGetROProperty(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the current value of the test object property from the object in the application.

Example

Gets the current value of the test object property from the object in the application and prints the custom message.

//Using Java variable.
String value = functionLib.dialogGetROProperty("/web:dialog_confirm[]" +
 "/web:accDialog[@name='Message from webpage']"); 
System.out.println("Dialog Property is "+value);

Format

The functionLib.Drilldown method has the following command format(s):

functionLib.Drilldown(xpath, row);

Command Parameters

xpath

a String specifying the object path. Should be taken from the specified column header from the List Applet.

row

an integer specifying the row number from the List applet (should always start from one).

Throws

Exception

on any error.

Example

Get the xpath of the column header in the List Applet and the row number pass as the two arguments.

functionLib.Drilldown("/web:window" +
 "/web:document" +
 "/web:div[@rn='Name' and @ot='JText' " +
  "and @un='Name']",2);

Format

The functionLib.Expand method has the following command format(s):

functionLib.Expand(StrId);

Command Parameters

StrId

a String specifying the String ID.

Throws

Exception

on any error.

Example

Expands the object specified by String ID.

functionLib.Expand("stringid");

Format

The functionLib.extractId method has the following command format(s):

functionLib.extractId(xpath, x, y, rowid);

Command Parameters

xpath

a String specifying the object path.

x

a char value for specifying the ID attribute value to be extracted.

y

a char value for specifying the ID attribute value to be extracted.

rowid

an Integer specifying the row id value.

Returns

a String with unique value.

Example

Extracts and returns the ID attribute value of the given Xpath.

//Using Java variable.
char val[] = new char[]{'r','n'};
String extractid = functionLib.extractId("/web:window" +
 "/web:document" +
 "/web:div[@rn='Name' and @ot='JText' " +
 "and @un='Name']", val[0], val[1], 2);

Format

The functionLib.focus method has the following command format(s):

functionLib.focus(attribute);

Command Parameters

attribute

a String specifying the property name.

Throws

Exception

on any error.

Returns

a String of the specified attribute.

Example

Sets focus to the target HTML element defined by the path, retrives the specified attribute, and prints the attribute value.

//Using Java variable.
String g = functionLib.focus("type");
System.out.println(g);

Format

The functionLib.formRecordNumber method has the following command format(s):

functionLib.formRecordNumber( );

Throws

Exception

on any error.

Returns

a String record number.

Example

Gets the form record number.

//Using Java variable.
String formrecnum = functionLib.formRecordNumber();
System.out.println("Record number is "+formrecnum);

Format

The functionLib.generateID method has the following command format(s):

functionLib.generateID(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

row

an Integer specifying the row number.

Throws

Exception

on any error.

Returns

a String ID value.

Example

Generate the ID from the given row.

//Using Java variable.
String idvalue = functionLib.generateID("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0' or @index='2']" +
 "/web:input_text[@rn='Sub-Status' and @ot='JComboBox' " +
 "and @un='Sub Status']", 2);
System.out.println("ID value is "+idvalue);

Format

The functionLib.getCellData method has the following command format(s):

functionLib.getCellData(xpath, row);

functionLib.getCellData(xpath, row, AppletRepName);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

row

an Integer specifying the row number from the List Applet (should always start from one).

AppletRepName

a string specifying the repository name of the Applet().

Throws

Exception

on any error.

Returns

a String specifying the text for a specified cell.

Example

Gets the rows count of the List Applet, loops, and prints the custom message for all the rows.

//Using Java variable.
int rows = functionLib.rowCount("/web:window" +
 "/web:document" +
 "/web:div[@rn='PenaltyAmount' " +
  "and @ot='JCurrencyCalc']");
for(int i = 1; i< rows ; i++)
{
 System.out.println(functionLib.getCellData("/web:window" +
  "/web:document" +
  "/web:div[@rn='PenaltyAmount' " +
   "and @ot='JCurrencyCalc']", i ,"ISS Promotion Upgrade To List Applet")); 
}

Format

The functionLib.GetChildCount method has the following command format(s):

functionLib.GetChildCount(strId);

Command Parameters

strId

a String specifying the String ID.

Throws

Exception

on any error.

Returns

an Integer of the child count.

Example

Gets the child count of the specified object.

//Using Java variable.
int count = functionLib.GetChildCount("stringid");
System.out.println("Child count is "+count);

Format

The functionLib.getMonthNumber method has the following command format(s):

functionLib.getMonthNumber(month);

Command Parameters

month

a String specifying the month in three-letter format.

Returns

an Integer of the month number.

Example

Gets the number of the month.

int curMonth = functionLib.getMonthNumber("Dec");
 System.out.println("Month is "+curMonth);

Format

The functionLib.getNumberMonth method has the following command format(s):

functionLib.getNumberMonth(val);

Command Parameters

val

an integer that specifies the number for that month (should always start from zero). For example. 0, 1 ,2.

Throws

Exception

on any error.

Returns

a String month for the corresponding number. For example, if val 0 is passed, the function returns "Jan". If val is 11, it returns "Dec".

Example

Gets the equivalent month for the corresponding number.

//Using Java variable.
String month = functionLib.getNumberMonth(3);
System.out.println("Month is " +month);

Format

The functionLib.getPageTabRepositoryName method has the following command format(s):

functionLib.getPageTabRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the pagetab object.

Example

Gets the repository name of the pagetab object and prints the custom message.

//Using Java variable.
String pagerp = functionLib.getPageTabRepositoryName("/web:window" +
 "/web:document" +
 "/web:a[@text='Accounts']");
if(pagerp.equals("Accounts"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.getPageTabRepositoryNameByIndex method has the following command format(s):

functionLib.getPageTabRepositoryNameByIndex(xpath, index);

Command Parameters

xpath

a String specifying the object path.

index

an Integer. use inspect path on the element to get index.

Throws

Exception

on any error.

Returns

a String repository name of the pagetab object.

Example

Gets the repository name of the pagetab object and prints the custom message.

//Using Java variable.
String pagerp = functionLib.getPageTabRepositoryNameByIndex("/web:window" +
 "/web:document" +
 "/web:a[@text='Accounts']", 1);
System.out.println("Repository name is "+pagerp);

Format

The functionLib.GetTreeItemName method has the following command format(s):

functionLib.GetTreeItemName(StrId);

Command Parameters

StrId

a String specifying the String ID.

Throws

Exception

on any error.

Returns

a String of the active tree item name.

Example

Gets the name of the tree item.

//Using Java variable.
String treename = functionLib.GetTreeItemName("stringid");
System.out.println("Tree name is "+treename);

Format

The functionLib.getUiName method has the following command format(s):

functionLib.getUiName(xpath);

Command Parameters

xpath

a String specifying the property to get.

Throws

Exception

on any error.

Returns

a String value of the specified property.

Example

Gets the un attribute of the Link object and prints a custom message.

//Using Java variable.
String chkbox = functionLib.getUiName("/web:window" +
 "/web:document" +
 "/web:div[@rn='Row Status' and @ot='JCheckBox' and @un='New']");
System.out.println("UI name is "+chkbox);

Format

The functionLib.Hcollapse method has the following command format(s):

functionLib.Hcollapse(xpath, row);

Command Parameters

xpath

a String specifying the object path. Should be taken from the specified column header from the List Applet.

row

an integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Example

Collapses the specified row in the Hierarchial List Applet.

functionLib.Hcollapse("/web:window" +
 "/web:document" +
 "/web:div[(@rn='Name' and @ot='JText') " +
  "or @un='Name']", 2);
 

Format

The functionLib.Hexpand method has the following command format(s):

functionLib.Hexpand(xpath, row);

Command Parameters

xpath

a String specifying the object path. Should be taken from the specified column header from the List Applet.

row

an integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Example

Expands the specified row in the Hierarchial List Applet.

functionLib.Hexpand("/web:window" +
 "/web:document" +
 "/web:div[(@rn='Name' and @ot='JText') " +
  "or @un='Name']", 1);
 

Format

The functionLib.iconColor method has the following command format(s):

functionLib.iconColor(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header of the List Applet.

row

an integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String specifying the color of the icon alt tag value from the DOM.

Example

Gets the color of the icon in the List Applet.

//Using Java variable.
String V_icon_color_green=functionLib.iconColor("/web:window" +
 "/web:document" +
 "/web:div[(@rn='StateIcon' and @ot='JText') " +
  "or @un='State']", 2);
System.out.println(V_icon_color_green); 
 

Format

The functionLib.imageGetRoProperty method has the following command format(s):

functionLib.imageGetRoProperty(propertyName, xpath);

Command Parameters

propertyName

a String specifying the property (for example, classname, isenabled, repositoryname, text, uiname) to get.

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the String value of the specified property.

Example

Gets the text of the image object with the attribute text and prints the custom message.

//Using Java variable.
String value = functionLib.imageGetRoProperty("text","/web:window[]" +
 "/web:document[]" +
 "/web:img[]");
System.out.println("Image text is  "+value);

Format

The functionLib.isCalculatorPopup method has the following command format(s):

functionLib.isCalculatorPopup( );

Throws

Exception

on any error.

Returns

boolean true if the calculator is opened, false if the calculator is closed.

Example

Detects whether the calculator is opened or closed.

//Using Java variable.
boolean ispopup = functionLib.isCalculatorPopup();
if(ispopup)
{
 System.out.println("calculator is opened");
}
else
{
 System.out.println("calculator is closed"); 
}

Format

The functionLib.isCalendarPopup method has the following command format(s):

functionLib.isCalendarPopup( );

Throws

Exception

on any error.

Returns

a String true if the calendar is opened, false if the calendar is closed.

Example

Detects whether the calendar is opened or closed and prints a custom message.

//Using Java variable.
String ispopup = functionLib.isCalendarPopup();
if(ispopup.equals("true"))
{
 System.out.println("calendar is opened");
}
else
{
 System.out.println("calendar is closed"); 
}

Format

The functionLib.isCheckboxChecked method has the following command format(s):

functionLib.isCheckboxChecked(xpath);

functionLib.isCheckboxChecked(xpath, row);

Command Parameters

xpath

a String specifying the object xpath.

row

an Integer specifying the row number for the List Applet (should always starts from one) .

Throws

Exception

on any error.

Returns

true if the object is checked, false if the object is unchecked.

Example

Detects whether the checkbox object is checked or unchecked and prints a custom message based on whether the checkbox object is checked or unchecked.

//Using Java variable.
boolean chkbox = functionLib.isCheckboxChecked("/web:window" +
 "/web:document" +
 "/web:div[@rn='Row Status' and @ot='JCheckBox' and @un='New']", 1);
if(chkbox)
{
 System.out.println("Checked");
}
else
{
 System.out.println("Unchecked");
} 

Format

The functionLib.isCheckboxEnabled method has the following command format(s):

functionLib.isCheckboxEnabled(xpath);

functionLib.isCheckboxEnabled(xpath, row);

Command Parameters

xpath

a String specifying the object xpath.

row

an Integer specifying the row number for the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

true if the object is enabled, false if the object is disabled.

Example

Detects whether checkbox object is enabled or disabled and prints a custom message based on whether the checkbox object is enabled or disabled.

//Using Java variable.
boolean chkbox = functionLib.isCheckboxEnabled("/web:window" +
 "/web:document" +
 "/web:div[@rn='Row Status' and @ot='JCheckBox' and @un='New'],1"); 
if(chkbox)
{
 System.out.println("enabled");
}
else
{
 System.out.println("disabled");
}

Format

The functionLib.isColumnExist method has the following command format(s):

functionLib.isColumnExist(AppletRepName, ColumnRepName);

Command Parameters

AppletRepName

a String specifying the RepositoryName of the Applet in which Column is present.

ColumnRepName

a String specifying the RepositoryName of the column.

Throws

Exception

on any error.

Returns

true if the column exists, false if the column does not exist.

Example

Detects the coulmn existence and prints the custom message.

if(functionLib.isColumnExist("SIS Account List Applet", "Name"))
{
 System.out.println("Exists");
}
else
{
 System.out.println("Does not exist");
}

Format

The functionLib.isColumnwritable method has the following command format(s):

functionLib.isColumnwritable(xpath);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

Throws

Exception

on any error.

Returns

true if the object is writable, false if the object is readonly.

Example

Detects the the state of table column and prints the custom message.

//Using Java variable.
boolean writable = functionLib.isColumnwritable("/web:window" +
 "/web:document" +
 "/web:div[@rn='First Name' and @ot='JText' " +
  "and @un='First Name']");
if(writable)
{
 System.out.println("Writable");
}
else
{
 System.out.println("Not writable");
}

Format

The functionLib.isExpanded method has the following command format(s):

functionLib.isExpanded(strId);

Command Parameters

strId

a String specifying the String ID.

Throws

Exception

on any error.

Returns

String true if the object is expanded, false if the object is not expanded.

Example

Detect whether the object is expanded and prints a custom message.

//Using Java variable.
String expanded = functionLib.isExpanded("stringid");
if (expanded.equals("true"))
{
 System.out.println("Expanded");
}
else
{
 System.out.println("Not expanded");
}

Format

The functionLib.isHierarchialListExpanded method has the following command format(s):

functionLib.isHierarchialListExpanded(xpath, row);

Command Parameters

xpath

a String specifying the object path. Should be taken from the specified column header from the List Applet.

row

an integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String true if the row is expanded, false if the row is not expanded.

Example

Detects if the specified row is expanded or not in the Hierarchial List Applet and prints a custom message.

//Using Java variable.
String isExpanded = functionLib.isHierarchialListExpanded("/web:window" +
 "/web:document" +
 "/web:div[(@rn='Name' and @ot='JText') " +
  "or @un='Name']", 3);
if(isExpanded.equals("true"))
{
 System.out.println("Row is expanded");
}
else
{
 System.out.println("Row is not expanded"); 
}
 

Format

The functionLib.isPopupApplet method has the following command format(s):

functionLib.isPopupApplet( );

Throws

Exception

on any error.

Returns

true if the popup exists, false if it does not exist.

Example

Detects whether or not the popup exists and prints the custom message if it exists or does not exist.

//Using Java variable.
Boolean exist = functionLib.isPopupApplet();   
//Using If condition to compare with expected.
if (exist) 
{
 System.out.println("popup exists");
}
else
{
 System.out.println("popup does not exist");
}

Format

The functionLib.isRequired method has the following command format(s):

functionLib.isRequired(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

true if the object is required.

Example

Indicates whether the object is required and prints the custom message.

//Using Java variable.
boolean value = functionLib.isRequired("/web:window[]" +
 "/web:document[]" +
 "/web:form[@name='SWEForm1_0']" +
 "/web:input_text[@rn='Type' and @ot='JComboBox' " +
  "and @un='Account Type']");
System.out.println("The object Required is "+value);

Format

The functionLib.IsSelected method has the following command format(s):

functionLib.IsSelected(strId);

Command Parameters

strId

a String specifying the String ID.

Throws

Exception

on any error.

Returns

String true if the object is selected, false if the object is not selected.

Example

Detect whether or not the object is selected and prints a custom message.

//Using Java variable.
String selected = functionLib.IsSelected("stringid");
if (selected.equals("true"))
{
 System.out.println("Selected");
}
else
{
 System.out.println("Not selected");
}

Format

The functionLib.l2Count method has the following command format(s):

functionLib.l2Count( );

Throws

Exception

on any error.

Returns

the number of views present in the Second Level View Bar.

Example

Gets the number of views present in the Second Level View Bar and prints the custom message.

//Using Java variable.
int value = functionLib.l2Count();
System.out.println("Number of Views present in the second " +
 "level view bar is "+value);

Format

The functionLib.linkGetRoProperty method has the following command format(s):

functionLib.linkGetRoProperty(propertyName, xpath);

Command Parameters

propertyName

a String specifying the property (for example, text, uiname, classname, repositoryname, isenabled) to get.

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the String value of the specified property.

Example

Gets the text of the link element with the attribute text and prints the custom message.

//Using Java variable.
String value = functionLib.linkGetRoProperty("text","/web:window[]" +
 "/web:document[]" +
 "/web:a[@text='Abu Nidal organization (ANO)']");
System.out.println("link text is "+value);

Format

The functionLib.log method has the following command format(s):

functionLib.log(message);

Command Parameters

message

an String that specifies the text to write to the log file.

Throws

IOException

on any IO error.

Example

Writes the specified message String to a results log file.

functionLib.log("Log this message");

Format

The functionLib.Login method has the following command format(s):

functionLib.Login(UserType, BrowserName, EnvName);

Command Parameters

UserType

a String indicates the user type. for example, SADMIN, DJROSEN, BFSCRANT ,etc.

BrowserName

a String indicates the name of the browser. (For example, callcenter, eCommunications etc

EnvName

a String Environment name created from the ATC portal.

Throws

Exception

on any error.

Example

Launches the browser and logs in.

functionLib.Login("SADMIN", "callcenter", "Environment name"); 

Format

The functionLib.make_uniq method has the following command format(s):

functionLib.make_uniq(recordName);

Command Parameters

recordName

a String which needs to be made unique.

Returns

a String with unique value.

Example

Creates unique record by appending the date and time to "test".

//Using Java variable.
String unique = functionLib.make_uniq("test");
System.out.println("Unique value is "+unique);

Format

The functionLib.menuCount method has the following command format(s):

functionLib.menuCount(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

an Integer specifying the number of menu items.

Example

Gets the number of items from the menu object and prints a custom message.

//Using Java variable.
int items = functionLib.menuCount("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0' or @index='1']" +
 "/web:button[@id='s_at_m_1' or @index='3']");
System.out.println("Number of menu items "+items);

Format

The functionLib.menuItemClassName method has the following command format(s):

functionLib.menuItemClassName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the classname of the menu object.

Example

Gets the classname of the menu object element and prints the custom message.

//Using Java variable.
String value = functionLib.menuItemClassName("/web:window[]" +
 "/web:document[]" +
 "/web:a['@text='Save List']"); 
System.out.println("Menu Item classname is "+value);

Format

The functionLib.menuItemClick method has the following command format(s):

functionLib.menuItemClick(rn);

Command Parameters

rn

a String specifying the rn value of the item to be selected.

Throws

Exception

on any error.

Example

Clicks and selects the item from the menu list.

functionLib.menuItemClick("*Browser Applet* *Import*SIS Account List Applet* *420*230*true");

Format

The functionLib.menuItemEnabled method has the following command format(s):

functionLib.menuItemEnabled(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

true if the object is enabled, false if the object is disabled.

Example

Detects whether checkbox object is enabled or disabled and prints a custom message.

//Using Java variable.
boolean value = functionLib.menuItemEnabled("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0' or @index='1']" +
 "/web:button[@id='s_at_m_1' or @index='3']");
if(value)
{
 System.out.println("Menu item is enabled");
}
else
{
 System.out.println("Menu item is disabled");
}

Format

The functionLib.menuItemExist method has the following command format(s):

functionLib.menuItemExist(rn);

Command Parameters

rn

a String specifying the rn value of the menu object or item.

Throws

Exception

on any error.

Returns

true if the object exists, false if the object is disabled.

Example

Detect whether or not the menu item object exists and prints a custom message.

//Using Java variable.
boolean menuExists = functionLib.menuItemExist("*Browser Applet* *ExecuteQuery*SIS Account List Applet* "); 
if(menuExists)
{
 System.out.println("Menu item exists");
}
else
{
 System.out.println("Menu item does not exist");
}
 

Format

The functionLib.menuItemGetRepositoryName method has the following command format(s):

functionLib.menuItemGetRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the menu object.

Example

Gets the repository name of the menu object and prints the custom message.

//Using Java variable.
String menuRP = functionLib.menuItemGetRepositoryName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0' or @index='1']" +
 "/web:button[@id='s_at_m_1' or @index='3']");
System.out.println("Repository name is"+menuRP);

Format

The functionLib.menuItemGetUiName method has the following command format(s):

functionLib.menuItemGetUiName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the UI name (display name in the user interface) of the menu object.

Example

Gets the UI name of the menu object element and prints the custom message.

//Using Java variable.
String value = functionLib.menuItemGetUiName("/web:window[]" +
 "/web:document[]" +
 "/web:a['@text='Save List']");
System.out.println("Menu item UI name is "+value);

Format

The functionLib.menuItemRepositoryName method has the following command format(s):

functionLib.menuItemRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the menu object.

Example

Gets the repository name of the menu object and prints the custom message.

//Using Java variable.
String menurp = functionLib.menuItemRepositoryName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0' or @index='1']" +
 "/web:button[@id='s_at_m_1' or @index='3']");
System.out.println("Repository name is"+menurp);

Format

The functionLib.monthMapping method has the following command format(s):

functionLib.monthMapping(vall);

Command Parameters

vall

a String that specifies the number for that month (should always starts from zero). For example, 0, 1, 2.

Throws

Exception

on any error.

Returns

a String month for the corresponding number. For example, if val 0 is passed, the function returns "Jan". If val is 11, it returns "Dec".

Example

Gets the equivalent month.

String month = functionLib.monthMapping("5");

Format

The functionLib.Navigate_Screen method has the following command format(s):

functionLib.Navigate_Screen(RepName, L1UIName, L2VName, L2UIName);

Command Parameters

RepName

a String specifying the repository name.

L1UIName

a String specifying the level 1 SiteMap UI name.

L2VName

a String specifying the level 2 SiteMap View name.

L2UIName

a String specifying the level 2 SiteMap UI name.

Throws

Exception

on any error.

Example

Navigates to the Screen/View from SiteMap.

functionLib.Navigate_Screen("RepName", "Level 1 UIName", 
 "Level 2 SiteMap View", "Level 2 UIName");

Format

The functionLib.Nextmonth method has the following command format(s):

functionLib.Nextmonth(val);

Command Parameters

val

an Integer specifying the current month number.

Returns

an Integer of the month number.

Example

Gets the number of the next month.

int curMonth = functionLib.getMonthNumber("Dec");
 int nextmonth = functionLib.Nextmonth(curMonth);
 System.out.println("Next month is "+nextmonth);

Format

The functionLib.NextPage method has the following command format(s):

functionLib.NextPage(Rn_Applet);

Command Parameters

Rn_Applet

a String specifying the Applet.

Throws

Exception

on any error.

Example

Go to the next page of the specified Applet.

functionLib.NextPage("Rn Applet");

Format

The functionLib.notificationCount method has the following command format(s):

functionLib.notificationCount(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

the notification pane size count.

Example

Gets the notificationCount attribute of the target HTML element.

//Using Java variable.
int value = functionLib.notificationCount("/web:window" +
 "/web:document" +
 "/web:span[]"); 
 System.out.println("Notification pane size count is "+value);

Format

The functionLib.openCellElement method has the following command format(s):

functionLib.openCellElement(columnxpath, row);

Command Parameters

columnxpath

a String specifying the object path should be taken from the specified column header from the List Applet..

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String specifying the text for a specified cell.

Example

Gets the rows count of the List Applet. Then, loop and opens the cell for all the rows.

//Using Java variable.
int rows = functionLib.rowCount("/web:window" +
 "/web:document" +
 "/web:div[@rn='Type' and @ot='JComboBox' " +
  "and @un='Account Type']");
for(int i = 1; i< rows ; i++)
{
 functionLib.openCellElement("/web:window" +
  "/web:document" +
  "/web:div[@rn='Type' and @ot='JComboBox' " +
    "and @un='Account Type']", i );
}

Format

The functionLib.openpopup method has the following command format(s):

functionLib.openpopup(xpath);

functionLib.openpopup(xpath, row);

Command Parameters

xpath

a String specifying the object path.

row

an integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Example

Opens the pop up for the specified field.

functionLib.openpopup("/web:window" +
 "/web:document" +
 "/web:div[@rn='Start Date' and @ot='JDatePick' " +
  "and @un='Effective As Of'], 2");
 

Format

The functionLib.openUiSync method has the following command format(s):

functionLib.openUiSync( );

Throws

Exception

on any error.

Example

Waits until the siebel application is in a busy state.

//Using Java variable.
web.link(11,"//web:a[@rn='Sitemap.Activities Screen' " +
 "and @ot='SiebWebSitemapAnchor' or @un='Activities']")
 .click();
functionLib.openUiSync();

Format

The functionLib.pageTabActiveScreen method has the following command format(s):

functionLib.pageTabActiveScreen(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String specifying the repository name of the pagetab active screen.

Example

Gets the repository name of the pagetab object and prints the custom message.

//Using Java variable.
String pageactive = functionLib.pageTabActiveScreen("/web:window" +
 "/web:document" +
 "/web:a[@text='Accounts']");
System.out.println("Repository name is "+pageactive);

Format

The functionLib.pageTabIsExists method has the following command format(s):

functionLib.pageTabIsExists(Xpath, TabRepName);

Command Parameters

Xpath

a String specifying the object path.

TabRepName

a String specifying the Repository Name of the object.

Throws

Exception

on any error.

Returns

true if the Pagetab object exists. Return false if the Pagetab object does not exist.

Example

Detects whether or not the Pagetab object exists and print a custom message.

//Using Java variable.
boolean value = functionLib.pageTabIsExists("/web:window[]" +
 "/web:document[]" +
 "/web:a[]", "Account Screen Homepage View");
if(value)
{
 System.out.println("Pagetab object exists");
}
else
{
 System.out.println("Pagetab object does not exist");
}

Format

The functionLib.pagetabsGetROProperty method has the following command format(s):

functionLib.pagetabsGetROProperty(propertyName);

Command Parameters

propertyName

a String specifying the property (Eg : pageTabActiveScreen, activeView, screenCount, viewCount) to get.

Throws

Exception

on any error.

Returns

the String value of the specified property.

Example

Gets the active view of the pagetab element with the attribute activeView and prints the custom message.

//Using Java variable.
String value = functionLib.pagetabsGetROProperty("activeView");
System.out.println("Pagetab repository name is "+value);

Format

The functionLib.pdqActive method has the following command format(s):

functionLib.pdqActive(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the PDQ object.

Example

Gets a data value representing the visible query title and prints a custom message.

//Using Java variable.
String value = functionLib.pdqActive("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm0']" +
 "/web:select[(@name='s_pdq')]");
System.out.println("PDQ value is "+value);

Format

The functionLib.pdqClassName method has the following command format(s):

functionLib.pdqClassName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String class specified PDQ object.

Example

Gets the class attribute of the PDQ object and prints the custom message.

//Using Java variable.
String PDQclassname = functionLib.pdqClassName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm0']" +
 "/web:select[(@name='s_pdq')]");
System.out.println("PDQ classname is "+PDQclassname );

Format

The functionLib.pdqGetROProperty method has the following command format(s):

functionLib.pdqGetROProperty(xpath, propertyName);

Command Parameters

xpath

a String specifying the object path.

propertyName

a String specifying the property (for example, rn, un, text) to get.

Throws

Exception

on any error.

Returns

the current value of the test object property from the object in the application.

Example

Gets the text value of the PDQ element with the attribute text and prints the custom message.

//Using Java variable.
String value = functionLib.pdqGetROProperty("/web:window[]" +
 "/web:document[]" +
 "/web:form[]" +
 "/web:select[(@name='s_pdq') " +
  "and multiple mod 'False']", "text"); 
System.out.println("PDQ text is "+value);

Format

The functionLib.pdqisExist method has the following command format(s):

functionLib.pdqisExist(xpath, value);

Command Parameters

xpath

a String specifying the object path.

value

a String specifying the rn value.

Throws

Exception

on any error.

Returns

a boolean value indicating whether the specified object exists.

Example

Detects whether or not the specified object exists and prints the custom message.

//Using Java variable.
Boolean pdqexists = functionLib.pdqisExist("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm0']" +
 "/web:select[(@name='s_pdq')]", "");
if (pdqexists)
{
 System.out.println("PDQ object exists");
}
else
{
 System.out.println("PDQ object does not exist");
}

Format

The functionLib.pdqItemCount method has the following command format(s):

functionLib.pdqItemCount(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

an Integer of the number of objects present in the current context.

Example

Gets the number of objects in the current context of the PDQ object and prints the custom message.

//Using Java variable.
int items = functionLib.pdqItemCount("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm0']" +
 "/web:select[(@name='s_pdq')]");
System.out.println("PDQ items count is "+items);

Format

The functionLib.pdqRepositoryName method has the following command format(s):

functionLib.pdqRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the specified object.

Example

Gets the rn attribute of the PDQ object and prints the custom message.

//Using Java variable.
String pdqRP =  functionLib.pdqRepositoryName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm0']" +
 "/web:select[(@name='s_pdq')]");
if(pdqRP.equals("Health"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.pdqUiName method has the following command format(s):

functionLib.pdqUiName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String UI name of the PDQ object.

Example

Gets the un attribute of the PDQ object and prints the custom message.

//Using Java variable.
String pdqUI = functionLib.pdqUiName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm0']" +
 "/web:select[(@name='s_pdq')]");
if(pdqUI.equals("Health"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.pickListActiveItem method has the following command format(s):

functionLib.pickListActiveItem(xpath);

functionLib.pickListActiveItem(xpath, row);

Command Parameters

xpath

a String specifying the object path should be taken from the specified column header from the List Applet.

row

an Integer value specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value specifying the data of the currently selected item for the Picklist.

Example

Gets the value with specified row (2) from the Picklist object and prints the custom message.

//Using Java variable.
String value = functionLib.pickListActiveItem("/web:window" +
 "/web:document" +
 "/web:div[@rn='Priority' and @ot='JComboBox' " +
  "and @un='Priority']", 2); 
if(value.equals("medium"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.pickListClassName method has the following command format(s):

functionLib.pickListClassName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String class name of the picklist object.

Example

Gets the UI name of the picklist object and prints the custom message.

//Using Java variable.
String classname = functionLib.pickListClassName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm2_0']" +
 "/web:input_text[@rn='State' and @ot='JComboBox' " +
  "and @un='State']");
System.out.println("Class name is "+classname);

Format

The functionLib.pickListCount method has the following command format(s):

functionLib.pickListCount(xpath);

functionLib.pickListCount(xpath, row);

Command Parameters

xpath

a String specifying the object path.

row

an Integer specifying the row number from the List Applet (should always start from one) .

Throws

Exception

on any error.

Returns

an Integer value, sepcifying the number of items are present in the Picklist object.

Example

Gets the number of items of the Picklist object for the Form Applet and prints the custom message.

//Using Java variable.
int number = functionLib.pickListCount("/web:window" +
 "/web:document" +
 "/web:input_text[@rn='Status' and @ot='JComboBox' " +
  "and @un='Status']", 2);
System.out.println("Number of items is "+number );

Format

The functionLib.pickListGetROProperty method has the following command format(s):

functionLib.pickListGetROProperty(xpath, propertyname);

functionLib.pickListGetROProperty(columnxpath, propertyname, row);

Command Parameters

xpath

a String specifying the object path.

propertyname

a String specifying the property(for example, rn, un, classname, value) to get.

columnxpath

a String specifying the column path.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

a String value of the specified property.

Example

Gets the value of the picklist element with the attribute value and prints the custom message.

String getAttribute13 = functionLib.pickListGetROProperty("/web:window" +
 "/web:document" +
 "/web:input_text[@rn='State' and @ot='JComboBox' " +
  "and @un='State']", "value" , 2);  
if(getAttribute13.equals("CA"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.pickListIsEnabled method has the following command format(s):

functionLib.pickListIsEnabled(xpath);

functionLib.pickListIsEnabled(xpath, row);

Command Parameters

xpath

a String specifying the object path.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

true if the object is enabled, false if the object is disabled.

Example

Detects whether the PickList object is enabled or disabled and prints a custom message based on whether PickList object is enabled or disabled.

//Using Java variable.
boolean pklst = functionLib.pickListIsEnabled("/web:window" +
 "/web:document" +
 "/web:div[@rn='Primary Revenue Class' and @ot='JComboBox' " +
  "and @un='Revenue Class']", 5);
if(pklst)
{
 System.out.println("Enabled");
}
else
{
 System.out.println("Disabled");
}

Format

The functionLib.picklistItemIsExist method has the following command format(s):

functionLib.picklistItemIsExist(xpath, ItemName);

functionLib.picklistItemIsExist(xpath, ItemName, row);

Command Parameters

xpath

a String specifying the object path.

ItemName

a String to be checked for the existence.

row

an Integer specifying the row number from the List Applet (should always start from one).

Throws

Exception

on any error.

Returns

true if the item exists, false if the item does not exist.

Example

Detects the existence of the Picklist item in the given LOV list.

//Using Java variable.
boolean value = functionLib.picklistItemIsExist("/web:window" +
 "/web:document" +
 "/web:input_text[@rn='Status' and @ot='JComboBox' " +
 "and @un='Status']", "Open", 5);
if(value)
{
 System.out.println("Exists");
}
else
{
 System.out.println("Does Not exist");
}

Format

The functionLib.pickListRepositoryName method has the following command format(s):

functionLib.pickListRepositoryName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String repository name of the picklist object.

Example

Gets the repository name of the picklist object and prints the custom message.

//Using Java variable.
String pickRP = functionLib.pickListRepositoryName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm2_0']" +
 "/web:input_text[@rn='State' and @ot='JComboBox' " +
 "and @un='State']");
if(pickRP.equals("some repository name"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.pickListSetText method has the following command format(s):

functionLib.pickListSetText(xpath, value);

functionLib.pickListSetText(xpath, value, row);

Command Parameters

xpath

a String specifying the object path.

value

a text to set in to the picklist object.

row

an Integer specifying the row.

Throws

Exception

on any error.

Example

Clicks and enters the text "medium" into picklist object.

functionLib.pickListSetText("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm1_0' or @index='2']" +
 "/web:input_text[@rn='Sub-Status' and @ot='JComboBox' " +
  "and @un='Sub Status']", "medium", 2);

Format

The functionLib.pickListUIName method has the following command format(s):

functionLib.pickListUIName(xpath);

Command Parameters

xpath

a String specifying the object path.

Throws

Exception

on any error.

Returns

a String UI name of the picklist object.

Example

Gets the UI name of the picklist object and prints the custom message.

//Using Java variable.
String pickUI = functionLib.pickListUIName("/web:window" +
 "/web:document" +
 "/web:form[@name='SWEForm2_0']" +
 "/web:input_text[@rn='State' and @ot='JComboBox' " +
 "and @un='State']");
if(pickUI.equals("State"))
{
 System.out.println("Pass");
}
else
{
 System.out.println("Fail");
}

Format

The functionLib.Previousmonth method has the following command format(s):

functionLib.Previousmonth(val);

Command Parameters

val

an Integer specifying the current month number.

Returns

an Integer of the month number.

Example

Gets the number of the previous month.

int curMonth = functionLib.getMonthNumber("Dec");
int prevmonth = functionLib.Previousmonth(curMonth);
System.out.println("Previous month is "+prevmonth );

Format

The functionLib.PreviousPage method has the following command format(s):

functionLib.PreviousPage(Rn_Applet);

Command Parameters

Rn_Applet

a String specifying the Applet.

Throws

Exception

on any error.

Example

Go to the previous page of the specified Applet.

functionLib.PreviousPage("Rn Applet");

Format