16Keywords Reference

Keywords Reference

This chapter defines the keywords that are available for Siebel Open UI keyword automation testing and describes how to use each keyword. It includes the following topics:

Keywords Definition

The following table defines the keywords that are available for Siebel Open UI keyword automation testing.

Keyword Name Description Applies to Desktop? Applies to Mobile?

Attachment Manager

Performs actions on the Attachment Download Manager page in Siebel Mobile Application Framework (MAF).

No

Yes

ClickButton

Clicks on a button control.

Yes

Yes

ClickLink

Drills down on a link in a list applet, drills down on recently viewed links on the homepage, and shows more or less objects.

Yes

Yes

ClickOnChart

Drills down on a requested series or category, provided by the user, on a Chart applet.

Yes

No

ClickSyncButton

Clicks the Sync button to navigate from offline to online and online to offline based on the user provided options. It also verifies the state of the application after the specified navigation.

No

Yes

ClickTopNotification

Clicks the top unread message in the notification list.

Yes

No

ColumnsDisplayed

Adds or removes columns in the list applet column (which is an option available in the applet menu).

Yes

Yes

CompareValue

Compares a variable value with the expected value.

Yes

Yes

CreateRecord

Creates a new record in a list or form applet.

Yes

Yes

DoubleClick

Double clicks on an element in a user specified applet.

Yes

No

DragAndDrop

Selects a record and moves it to a particular field.

Yes

Yes

Draw

Captures a signature.

Yes

Yes

FileDownload

Downloads (and exports) a file.

Yes

No

FileUpload

Attaches or uploads (or imports) a file.

Yes

Yes

GetAboutRecord

Reads the values (Row Id, Created by, Date, and so on) from About Record (selected from the Siebel applet menu) and stores them in a user variable.

Yes

Yes

GetChartType

Obtains the type of chart in an applet and stores the value in a user variable.

Yes

No

GetConfigParam

Reads the value from the unitconfig.xml/batchconfig.xml file and stores the value in a user variable.

Yes

Yes

GetRecordCount

Obtains the total number of records and stores the value in a user variable.

Yes

Yes

GetState

Obtains the state of a specified object and stores the value in a user variable.

Yes

Yes

GetValue

Obtains the value of a specified object and stores the value in a user variable.

Yes

Yes

GetValueFromMenuPopup

Reads a value from an application level pop-up menu.

Yes

No

GoToSettings

Views and changes the default settings of a user profile.

Yes

Yes

GoToThreadbarView

Navigates to a view that is available in the Threadbar link.

Yes

Yes

GoToView

Navigates to a specified view using the Tab view, Tree view, or Site Map links.

Yes

Yes

HierarchicalList

Expands or collapsess a record in a hierarchical list applet, and shows the child items.

Yes

No

InboundWebServiceCall

Reads the XML request from a .xml file, posts the request to the server, and saves the XML response from the server.

Yes

No

InputValue

Enters a value into a specified field.

Yes

Yes

InvokeAppletMenuItem

Invokes a menu item from an applet-level menu in a list or form.

Yes

Yes

InvokeMenuBarItem

Invokes a menu item from the application menu bar.

Yes

Yes

InvokeObject

Invokes an object in a specified field in a list or form applet.

Yes

Yes

Launch

Starts the browser and logs in to an application with the provided username.

Yes

Yes

LockColumn

Locks or unlocks a selected column.

Yes

Yes

LogOut

Logs out from an application.

Yes

Yes

MafSettings

Performs the required action in the MAF Settings page in MAF applications.

No

Yes

MultiSelectRecordsInListApplet

Selects one or more rows in a list applet.

Yes

Yes

QueryRecord

Queries an existing record from a list or form applet.

Yes

Yes

RemoveFromMvg

Removes a record from the list in a multi-value group (MVG).

Yes

Yes

SelectCheckBox

Selects or clears a check box depending on the provided value (True or False).

Yes

Yes

SelectFromMvg

Select the specified record after querying the available records in an MVG.

Yes

Yes

SelectFromPickApplet

Queries and selects the first record from a drop-down list applet.

Yes

Yes

SelectPDQValue

Selects a value from the Predefined Drop-down Query (PDQ).

Yes

Yes

SelectPickListValue

Selects a value from a drop-down list in a list or form applet.

Yes

Yes

SelectRadioButton

Selects a radio button.

Yes

No

SelectRecordInListApplet

Selects a record from a list applet.

Yes

Yes

SelectToggleValue

Selects a value from a toggle control in a list applet.

Yes

No

SelectVisibilityFilterValue

Selects a value from the Visibility Filter drop-down list.

Yes

No

SendKeys

Trigger a keyboard event.

Yes

Yes

SetDateTime

Calls the DateTime or Date pop-up calendars to specify the date and time.

Yes

Yes

SortColumn

Sorts a selected column.

Yes

Yes

SwitchTab

Switches between the browser tabs.

Yes

Yes

TreeExplorer

Expands or collapses an explorer tree, and selects items from or shows items under an explorer tree.

Yes

No

VerifyColumnLockStatus

Verifies the lock status of a column.

Yes

Yes

VerifyColumnSortOrder

Verifies the order of records in a selected column.

Yes

Yes

VerifyError

Verifies the error message for a string value.

Yes

Yes

VerifyFileLoad

Performs image validation.

Yes

Yes

VerifyFocus

Verifies the focus present on an applet, view, field, or row depending on the value provided (True or False).

Yes

Yes

VerifyInPicklist

Counts the number of items in a drop-down list, auto selects using substring, and verifies the values in the drop-down list.

Yes

Yes

VerifyObject

Verifies the presence of an object or the UI name for an object.

Yes

Yes

VerifyRecordCount

Verifies the row count in a list applet.

Yes

Yes

VerifyState

Verifies the state of a specified field.

Yes

Yes

VerifyTopNotification

Verifies whether the top read or unread message in the notification list appears or not.

Yes

Yes

VerifyValue

Verifies a field value by comparing it with a user variable.

Yes

Yes

Wait

Allows the application to stay idle for the user specified time.

Yes

Yes

Keywords Description

This topic provides descriptions of each keyword that is supported for Siebel Open UI keyword automation testing.

AttachmentManager

You use the AttachmentManager keyword to perform actions in the Attachment Download Manager page in MAF applications.

Note: The AttachmentManager keyword works only on MAF iOS and MAF Android devices.

Signature

The AttachmentManager keyword supports the following signature:

AttachmentManager(AppletRN, Name of the Entity|Name of the File Name, ...;DOWNLOAD/
DOWNLOADALL/REMOVE/CLOSE/TOP)

AttachmentManger signature supports the following actions:

DOWNLOAD
DOWNLOADALL
TOP
UPLOAD
UPLOADALL
UPLOADTOP
REMOVE
REMOVEALL
=filename with extension
=Error - File Not Found
=100%
=Error - Network Error
=Sync Data First

Desktop Examples

The AttachmentManager keyword does not apply to desktop applications.

Mobile Examples

The following table describes how to use the AttachmentManager keyword to perform actions in the Attachment Download Manager page in MAF applications (on mobile devices).

Target Object Inputs Closing Action Comments

Download Attachment Applet

Download Attachment Applet

AdminSalesTool|pills1.jpg;DOWNLOAD;IPH3

To download user specified files.

Download Attachment Applet

Download Attachment Applet

AdminSalesTool|Zonall_Launch.zip,AdminSalesTool|ZonallPatientProfile.zip;DOWNLOAD;IPH3

To download user specified files.

Download Attachment Applet

Download Attachment Applet

AdminSalesTool|pills1.jpg;REMOVE;IPH3

To remove the selected files.

Download Attachment Applet

Download Attachment Applet

AdminSalesTool|Zonall_Launch.zip;TOP;IPH3

To move the file to the TOP position.

Download Attachment Applet

Download Attachment Applet

NULL;DOWNLOADALL;IPH3

Selects all the files and performs the action when the Download button is clicked.

Download Attachment Applet

Download Attachment Applet

NULL;REMOVEALL;IPH3

Selects all the files and performs the action when the Remove button is clicked.

Download Attachment Applet

Download Attachment Applet

AccountAttachment|pills1.jpg;=Error - File Not Found;IPH3

To verify Status of the user specified in Download Attachment - the equals sign ('=') signifies verification.

Download Attachment Applet

Download Attachment Applet

NULL;=pills1.jpg;IPH3

To verify if the user specified file (pills1.jpg) is available in the Download Attachment - the equals sign ('=') signifies verification.

Download Attachment Applet

Upload Attachment Applet

AccountAttachment|Test.jpeg;UPLOAD;IPH3

To upload user specified files.

Download Attachment Applet

Upload Attachment Applet

AccountAttachment|Test.jpeg;=Sync Data First;IPH3

To verify Status of the user specified in Upload Attachment - the equals sign ('=') signifies verification.

Download Attachment Applet

Upload Attachment Applet

AccountAttachment|Test.jpeg;UPLOADTOP;IPH3

To move the file to the TOP position.

Download Attachment Applet

Upload Attachment Applet

NULL;UPLOADALL;IPH3

Selects all the files and performs the action when the Upload button is clicked.

Download Attachment Applet

Upload Attachment Applet

NULL;=Test.jpeg;IPH3

To verify if the user specified file (Test.jpeg) is available in the Upload Attachment - the equals sign ('=') signifies verification.

Download Attachment Applet

Upload Attachment Applet

AccountAttachment|Test.jpeg,AccountAttachment|pills.jpeg;UPLOAD;IPH3

To upload user specified files.

Download Attachment Applet

Attachment Applet

NULL;Close;IPH3

To close the Attachment Manager.

ClickButton

You use the ClickButton keyword to click on a button control present in any list or form applet or in any multi-value group or drop-down applet, and to click Close (the X icon) to close a pop-up window.

Signature

The ClickButton keyword supports the following signature:

ClickButton(AppletRN|ButtonRN,OK/CANCEL/NULL)

Note the following about the ClickButton keyword signature:

  • If the action is to be performed on Tile applets, then the SelectRecordInListApplet keyword should be used before the Click button.

  • You must provide OK and Cancel options in case a Delete confirmation dialog box is expected.

  • You must provide NULL for other buttons, even if a pop-up window or dialog box is expected. Other keywords will carry out any subsequent action on the pop-up window or dialog box.

Desktop Examples

The following table describes how to use the ClickButton keyword to click on button controls in desktop applications.

Target Object Inputs Closing Action Comments

Synergy Toolbar

N/A

NULL

Clicks the Delete Record button in a list applet and handles the button in the confirmation pop up.

NULL|SiebTabViews

N/A

NULL

In SUI theme, invokes the L2 level links that appear when a button is clicked.

SIS Account List Applet|NewQuery

N/A

NULL

Clicks the Delete Record button in a list applet and handles the button in the confirmation pop up.

SIS Account List Applet|DeleteRecord

N/A

OK

Clicks the Delete Record button in a list applet.

SIS Account Entry Applet|GotoNextSet

N/A

NULL

Clicks the Go to Next Set button in a form applet.

Product Pick Applet(Eligibility)| PickRecord

N/A

NULL

Clicks the drop-down list in a pop-up window.

NULL|PickRecord

N/A

NULL

Clicks a button in a pop-up window.

Close

N/A

OK

Clicks Close or X button in a pop-up window and then clicks OK.

Close

N/A

Cancel

Clicks Close or X button in a pop-up window and then clicks Cancel.

Mobile Examples

The following table describes how to use the ClickButton keyword to click on button controls in desktop mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Contact List Applet - Mobile|DeleteRecord

N/A

OK

Clicks the Delete Record button in a list applet.

SHCE Sales Contact List Applet - Mobile|Create

N/A

NULL

Clicks the Create button in a list applet.

Close

N/A

OK

Clicks Close or X button in a pop-up window and then clicks OK.

NULL|NewQuery

N/A

NULL

Clicks a button in a pop-up window.

Signatures

The ClickLink keyword supports the following signatures:

ClickLink(AppletRN|FieldRN/ClassName/RowId|[RowNum],Value/Variable/NULL/ShowMore/
Show Less/Expand/Collapse)
Note: The row number is optional in this signature. If row number is not provided, then the first row will be used by default.
ClickLink(AppletRN|@Var ,Value/Variable) 
Note: @var support in FieldRN is available only for Mobile application.
ClickLink(AppetRN|TimeslotRN ,NULL) 
Note: This signature clicks on the given Timeslot in the Calendar applet.
ClickLink(AppetRN|@FirstName+@LastName+TimeslotRN,NULL)
Note: This signature provides a support for clicking on dynamic Timeslot in the Calendar applet.

Desktop Examples

The following table describes how to use the ClickLink keyword to drill down on links in desktop applications.

Target Object Inputs Closing Action Comments

ClickLinkAccount Contact List Applet|Last Name

<Ramakrishna>

N.A

Drills down on the Last Name value. For example, drills down on the last name value Ramakrishna.

ClickLinkAppletRN|ClassName

NULL

N.A

Clicks on the link based on the Class Name.

NULL|SiteMap

NULL

N.A

Clicks on the toolbar item (Site Map).

Account Contact List Applet|Last Name|2

Pinas

N.A

Drills down on the Last Name of the second record with the value provided in the inputs.

SIS Account List Applet|ToggleListRowCount

NULL

N.A

Clicks the Show More link in the list applet.

SIS Account List Applet|ToggleListRowCount

Show More

N.A

Clicks the Show More link in the List applet.

SIS Account List Applet|ToggleListRowCount

Show Less

N.A

Clicks the Show Less link in the List applet.

LS Pharma Inbox Applet|ButtonMaximizeApplet

Expand

N.A

Expands the list in the Home page.

LS Pharma Inbox Applet|ButtonMinimizeApplet

Collapse

N.A

Collapses the list in the Home page.

Contact Home Public and Private View Link List Applet|Name

My Contacts

N.A

Clicks the link of the recently viewed contacts screen (My Contacts).

NULL|Save Query As Applet.SaveAs

NULL

N.A

Clicks the button link in the pop-up window.

Account Home Public and Private View Link List Applet|2

All Accounts

N.A

Click the frequently viewed links.

Mobile Examples

The following table describes how to use the ClickLink keyword to drill down on links in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Contact List Applet - Mobile|Last Name|1

<last name>

N/A

Drills down on the name value in the first row.

SHCE Sales Contact List Applet - Mobile|Last Name

<last name>

N/A

Drills down on the name value.

LS Home Page Calendar Applet-Mobile|@Var

NULL

N/A

Drills down on a call in the calendar applet.

You can obtain the row Id of the record using GetAboutRecord keyword by navigating to the view.

LS Home Page Calendar Applet-Mobile|slot-0-090000MikeAdlerDr.

NULL

N/A

Clicks the specified timeslot in the Calendar applet.

LS Home Page Calendar Applet-Mobile|@AccountCall+slotCol-0-10:00

NULL

N/A

Supports clicking on the dynamic Timeslot in the Calendar applet (Account call).

LS Home Page Calendar Applet-Mobile|@FirstName+@LastName+@title+slotCol-0-10:00

NULL

N/A

Supports clicking on the dynamic Timeslot in the Calendar Applet (Contact call).

LS Home Page Calendar Applet-Mobile|@Accountname+@Date

NULL

N/A

Supports clicking on the dynamic activity in the Calendar applet.

ClickOnChart

You use the ClickOnChart keyword to drill down on a required series or category, provided by the user, on a Chart.

Signatures

The ClickOnChart keyword supports the following signature:

ClickonChart(AppletRN, Series;Category)

Desktop Examples

The following table describes how to use the ClickOnChart keyword in desktop applications.

Target Object Inputs Closing Action Comments

Oppty Chart Applet - Campaign Analysis

1; 0

N/A

Drills down on the chart based on the series and category specified by the user.

Mobile Examples

The DoubleClick keyword does not apply to mobile applications.

ClickSyncButton

Depending on user provided options, you use the ClickSyncButton keyword to click on the Sync button to switch from offline to online mode or from online to offline mode. The keyword also verifies the state of the application after the specified navigation.

Signature

The ClickSyncButton keyword supports the following signature:

ClickSyncButton(RnofSyncButton,RnofOfflineOptions;RnofStateoftheApplication)

Desktop Examples

The ClickSyncButton keyword does not apply to desktop applications.

Mobile Examples

The following table describes how to use the ClickSyncButton keyword to switch between online and offline modes in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

GoOffline

NULL;Offline

N/A

Clicks the Sync button and moves to offline mode.

GoOffline

uploadGoOnline;Online

N/A

Clicks the Sync button and selects the option uploadGoOnline in offline mode.

GoOffline

syncStayOffline;Online

N/A

Clicks the Sync button and selects the option syncStayOffline in offline mode.

GoOffline

uploadStayOffline;Online

N/A

Clicks the Sync button and selects the option uploadStayOffline in offline mode.

ClickTopNotification

You use the ClickTopNotification keyword to click and drill down on the top unread notification message in the notifications list. You also use the keyword to click the Mark All as Read option in the notification list, and then close the notification list.

Signature

The ClickTopNotification keyword supports the following signature:

ClickTopNotification(MessagebroadcastRN,Expectedmessage,Close/KeepOpen)
Note: The user must click on Mark All as Read option before using the click operation on any message.

ClickTopNotication checks for notification messages for up to ten iterations (with an interval of one minute for each of the iterations).

Desktop Examples

The following table describes how to use the ClickTopNotification keyword to drill down on the top unread notification.

Target Object Inputs Closing Action Comments

MsgBrdCstIcon

Account_10142015_041155918

Close

Clicks the top unread message in the notification list and closes the control.

MsgBrdCstIcon

Mark All As Read

Close

Clicks the Mark all as Read option in the notifications and closes the control.

MsgBrdCstIcon

Mark All As Read

KeepOpen

Clicks the Mark all as Read option in the notifications and keeps the control open.

MsgBrdCstIcon

NULL

Close

Closes the notification control.

MsgBrdCstIcon

Account_10142015_041155918

KeepOpen

Clicks the top unread message in the notifications and keeps the control open.

Mobile Examples

The ClickTopNotification keyword does not apply to mobile applications.

ColumnsDisplayed

You use the ColumnsDisplayed keyword to specify the columns to appear in a list applet, and in what order. You use the keyword to move columns from the Available to the Selected list (or from the Selected to the Available list), and to move columns up and down so that the column order changes as required. The following actions are supported: Save, Reset, and Cancel.

Signature

The ColumnsDisplayed keyword supports the following signature:

ColumnsDisplayed(AppletRN|ColumnsDisplayedRN,Select:columnName1|columnName2|..; 
DeSelect:columnName1|columnName2|..;Order:columnName|Up/Down/Top/Bottom,RN (Save/
Cancel/Reset Defaults))

where:

  • The value in columnName must be used for desktop applications.

  • The display text in columnName must be used for mobile applications.

Desktop Examples

The following table describes how to use the ColumnsDisplayed keyword to move columns in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Columns Displayed (SWE)

Select:Account Team;NULL;NULL

Columns Displayed Popup Applet (SWE).ButtonSave

Adds the Account Team column to the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;DeSelect:Account Team;NULL

Columns Displayed Popup Applet (SWE).ButtonSave

Hides the Account Team column to the list applet.

SIS Account List Applet|Columns Displayed (SWE)

Select:ALL;NULL;NULL

Columns Displayed Popup Applet (SWE).ButtonSave

Adds all columns to the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;DeSelect:ALL;NULL

Columns Displayed Popup Applet (SWE).ButtonSave

Hides all columns to the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;Order:Account Team|UP

Columns Displayed Popup Applet (SWE).ButtonSave

Orders the columns by moving one position left in the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;Order:Account Team|DOWN

Columns Displayed Popup Applet (SWE).ButtonSave

Orders the columns by moving one position right in the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;Order:Account Team|TOP

Columns Displayed Popup Applet (SWE).ButtonSave

Moves the column to the first position in the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;Order:Account Team|BOTTOM

Columns Displayed Popup Applet (SWE).ButtonSave

Moves the column to the last position in the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;NULL

Columns Displayed Popup Applet (SWE).ButtonCancel

Opens the ColumnDisplayed pop-up window and clicks Cancel.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;NULL

Columns Displayed Popup Applet (SWE).ButtonReset

Opens the ColumnDisplayed pop-up and clicks Reset.

SIS Account List Applet|Columns Displayed (SWE)

Select:Account Team;NULL;NULL

Columns Displayed Popup Applet (SWE).ButtonReset

Move the column to the last position in the list applet and clicks Reset.

Mobile Examples

The following table describes how to use the ColumnsDisplayed keyword to move columns in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SIS Account List Applet|Columns Displayed (SWE)

Select:Account Team;NULL;NULL

Columns Displayed Popup Applet (SWE).ButtonSave

Adds the Account Team column to the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;DeSelect:Account Team;NULL

Columns Displayed Popup Applet (SWE).ButtonSave

Hides the Account Team column to the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;Order:Account Team|UP

Columns Displayed Popup Applet (SWE).ButtonSave

Orders the columns by moving one position left in the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;Order:Account Team|DOWN

Columns Displayed Popup Applet (SWE).ButtonSave

Orders the columns by moving one position right in the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;Order:Account Team|TOP

Columns Displayed Popup Applet (SWE).ButtonSave

Moves the columns to the first position in the list applet.

SIS Account List Applet|Columns Displayed (SWE)

NULL;NULL;Order:Account Team|BOTTOM

Columns Displayed Popup Applet (SWE).ButtonSave

Moves the columns to the last position in the list applet.

CompareValue

You use the CompareValue keyword to compare a variable value with the expected value. The expected value can be a variable or value.

Signature

The CompareValue keyword supports the following signature:

CompareValue(@Variable|Operator|value (or) @Variable) 

Operator can be one of the following characters or values: = (equalsl), > (greater than), < (less than), <= (less than or equal to), >= (greater than or equal to), contains, startswith, endswith.

Desktop Examples

The following table describes how to use the CompareValue keyword to compare a variable value with the expected value for desktop applications.

Target Object Inputs Closing Action Comments

N/A

@var1|>=|3.56

N/A

Verifies a variable value by comparing it with the expected value 3.56.

N/A

@Var1|=|@Var2

N/A

Verifies a variable value by comparing it with the expected value.

N/A

@Var|startswith|nc

N/A

Verifies a variable value by comparing it with the expected value that starts with nc.

N/A

@Var|endswith|nc

N/A

Verifies a variable value by comparing it with the expected value that ends with nc.

N/A

@Var|=|{[123]}

N/A

Verifies a variable value by comparing it with the expected value.

N/A

@Var|=|"text123;

N/A

Verifies a variable value by comparing it with the expected value text123.

Mobile Examples

The following table describes how to use the CompareValue keyword to compare a variable value with the expected value for mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

N/A

@var1|>=|3.56

N/A

Verifies a variable value by comparing it with the expected value 3.56.

N/A

@Var1|=|@Var2

N/A

Verifies a variable value by comparing it with the expected value.

N/A

@Var|startswith|nc

N/A

Verifies a variable value by comparing it with the expected value that starts with nc.

N/A

@Var|endswith|nc

N/A

Verify a variable value by comparing it with the expected value that ends with nc.

N/A

@Var|=|{[123]}

N/A

Verifies a variable value by comparing it with the expected value.

N/A

@Var|=|"text123;

N/A

"Verifies a variable value by comparing it with the expected value text123.

CreateRecord

You use the CreateRecord keyword to create a new record by entering values into one or more fields in a list or form applet. The keyword fails in list applets if the sequence Id is automatically generated when a user tries to create a new record.

Signature

The CreateRecord keyword supports the following signature:

CreateRecord(AppletRN|Button(RN)|[RowNum],FieldRN(1..N)|Value(1...N) OR 
Variable,RN of Save record in AppletMenu)

Note the following about the CreateRecord keyword signature:

  • The row number is optional.

  • The keyword supports:

    • Unique values by adding the '$' symbol at the end of the text.

    • Date format like Today,Today+1,Today-1.

    • Variables like @var1, @var2 and numbers.

Desktop Examples

The following table describes how to use the CreateRecord keyword to create a new record in list and form applets in desktop applications.

Target Object Inputs Closing Action Comments

Contact List Applet|NewRecord

Last Name|last,First Name|first

WriteRecord(SWE)

Creates a record in the list applet.

SIS Account List Applet|NewRecord

Name|D$,Account Status|Red Customer

WriteRecord(SWE)

Creates a record in the list applet.

Contact Form Applet|NewRecord

LastName|@var1,FirstName|first

WriteRecord(SWE)

Creates a record in the form applet.

Contact List Applet|NewRecord|3

Last Name|@Variable

WriteRecord(SWE)

Creates a record in the third row in the list applet.

Mobile Examples

The following table describes how to use the CreateRecord keyword to create a new record in list and form applets in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Opportunity Form Applet - Mobile|New

Name|John$,Currency|USD,CloseDate|11|12|12

WriteRecord

Creates a record in the form applet.

CG Account List Applet - Mobile|New

Name|abc

WriteRecord

Creates a record in the list applet.

CG Account List Applet - Mobile|New|4

Name|abc

WriteRecord

Creates a record in the fourth row in the list applet.

DoubleClick

You use the DoubleClick keyword to double click on an element in an applet.

Signatures

The DoubleClickt keyword supports the following signature:

DoubleClick(AppletRN|ItemRN)

Desktop Examples

The following table describes how to use the DoubleClick keyword in desktop applications.

Target Object Inputs Closing Action Comments

TNT Function Bookings Gantt Applet|@var1+-event+@FunType+@FuncDate+@FunStart+@FunInvStatus

N/A

N/A

Double clicks on the element.

Mobile Examples

The DoubleClick keyword does not apply to mobile applications.

DragAndDrop

You use the DragAndDrop keyword to select a record in an applet and move it to a particular field.

Note the following about the DragAndDrop keyword signature:

  • The records must be visible in the screen.

  • In the mobile application, the keyword works only in landscape mode and both source and destination applets must be active.

Signatures

The DragAndDrop keyword supports the following signatures:

DragAndDrop (SourceAppletRN|NULL|Rowno, DestinationAppletRN|FieldRN)
DragAndDrop (SourceAppletRN|FieldRN, DestinationAppletRN|FieldRN)

Desktop Examples

The following table describes how to use the DragAndDrop keyword to drag a record from an applet and drop it on a specific field in desktop applications.

Target Object Inputs Closing Action Comments

FINCORP Deal Account Pick Applet|NULL|3

Opportunity List Applet|Account

N/A

Selects a record from an applet and moves it to a specific field.

Opportunity List Applet|Account

Opportunity List Applet|Primary Revenue Win Probability

N/A

Swaps the columns in the applet.

NT Function Bookings Gantt Applet|@var1-event+@FunType+@FuncDate+@FunStart+@FunInvStatus

TNT Function Bookings Gantt Applet|@var2+UR

N/A

Selects a record from an applet and moves it to a specific field in a Gantt Chart.

WebControlPalette|WebControl-field

PreviewArea;placeholder-112

N/A

Selects a record from a field in the Webcontrol palette and moves it to placeholder-112 in the preview area of the Webtools Editor.

WT Repository Applet Edit Web Layout Palette|NULL|2

PreviewArea;placeholder-112;IPH3

N/A

None.

Mobile Examples

The following table describes how to use the DragAndDrop keyword to drag a record from applet and drop it to a specific field in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

FINCORP Deal Account Pick Applet|NULL|3

Opportunity List Applet|Account

N/A

Drags a record from an applet and drops it on a specific field.

LS Home Page Contact List Applet - Mobile |NULL|3

LS Home Page Calendar Applet-Mobile |slotCol-0-08:00

N/A

Drags a record from the call applet and drops it on the calendar applet (according to the specified rn).

Draw

You use the Draw keyword to capture the signature.

Signature

The Draw keyword supports the following signature:

Draw(FieldRN)

Desktop and Mobile Examples

The following table describes how to use the Draw keyword to capture a signature in desktop and mobile applications.

Target Object Inputs Closing Action Comments

FieldRN

Captures a signature.

FileDownload

You use the FileDownload keyword to download (and export) a file.

Signature

The ServerConfig keyword supports the following signature:

FileDownload(FileName,ButtonRN/NULL,Save/Cancel)

The file downloads to the following location: C:\\temp\\Download_File.

Note: The Exefiles folder must be copied from the TestHarness before execution.

Desktop Examples

The following table describes how to use the FileDownload keyword to download a file in desktop applications.

Target Object Inputs Closing Action Comments

abc.txt

NULL

Save

Downloads the file.

export.csv

SWE Export Applet.btnNext

Cancel

Cancels the download pop-up window.

Mobile Examples

The FileDownload keyword does not apply to mobile applications.

FileUpload

You use the FileUpload keyword to attach and upload (import) a file.

Signature

The FileUpload keyword supports the following signature:

FileUpload(AppletRN|FieldRN(or)ButtonRN, FileName , ButtonRN/NULL)

Note the following about the FileUpload keyword signature:

Note: To upload a file, the file must be placed in the FileUpload folder at the TestHarness location.
Note: The Exefiles folder must be copied from the TestHarness before execution.

Desktop Examples

The following table describes how to use the FileUpload keyword to upload a file to the FileUpload folder in desktop applications.

Target Object Inputs Closing Action Comments

SWE Import Applet|file

InputFileSales.txt

NULL

Uploads the Sales.txt file to the FileUpload folder.

UCM List Import Jobs Form Applet - Job Details|FileName

output.csv

NULL

Uploads the output.csv file to the FileUpload folder.

Mobile Examples

FileUpload Attachment List Applet - Mobile|New File IMG_002.PNG;IPH2;IPH3 NULL

GetAboutRecord

You use the GetAboutRecord keyword to obtain parameter values from the About Record pop-up window, invoked from the Applet Menu, and store the values in a user variable.

Signature

The GetAboutRecord keyword supports the following signature:

GetAboutRecord(AppletRN|RN of AboutRecord,RN of Label(1..N)|Variable(1..N))

Desktop Examples

The following table describes how to use the GetAboutRecord keyword to obtain and store information from the About Record pop-up window in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|About Record (SWE)

Row:|@var1

N/A

Stores the row field value from the AboutRecord pop-up window in a variable.

SIS Account Entry Applet|About Record (SWE)

Row:|@var1,Conflict:|@var2,Created_On:|@var3,Created By:|@var4

N/A

Stores the Row, Conflict, Created_on, and CreatedBy field values from the About Record pop-up window in a variable.

Mobile Examples

The following table describes how to use the GetAboutRecord keyword to obtain and store information from the About Record pop-up window in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|About Record (SWE)

RowId|@var1,UpdatedOn:|@var2,CreatedOn:|@var3

N/A

Stores the Row, UpdatedOn, Created_on field values from the About Record pop-up window in a variable.

GetChartType

You use the GetChartType keyword to obtain the type of chart in an applet and store the value in a user variable.

Signatures

The GetChartType keyword supports the following signature:

GetChartType (AppletRN, @type)

Desktop Examples

The following table describes how to use the GetChartType keyword in desktop applications to obtain and store information from the Chart type.

Target Object Inputs Closing Action Comments

Oppty Chart Applet - Campaign Pipeline Analysis

@Var;IPH2;IPH3

N/A

Stores the Chart type value in a variable.

Mobile Examples

The DoubleClick keyword does not apply to mobile applications.

GetConfigParam

You use the GetConfigParam keyword to read the values in the config.xml file. The keyword retrieves one value at a time, given the correct parameter name (tagname).

Signature

The GetConfigParam keyword supports the following signature:

Tag name till value/Null;?Required Tagname;Variable

Note the following about the GetConfigParam keyword signature:

  • All three inputs are mandatory to enter.

  • If the attribute value to be obtained from the config.xml file is available under any parent tag, then provide the application name in the Inputs column.

  • If the attribute value to be obtained from the config.xml file is not available under any parent tag (directly), then provide NULL in the Inputs column.

GetRecordCount

You use the GetRecordCount keyword to obtain the total number of records and store the value in a user variable.

Signature

The GetRecordCount keyword supports the following signature:

GetRecordCount(Applet RN|RN of Recordcount Menu item/NULL,Variable)
Note: Use NULL for the applets without menu.

Desktop Examples

The following table describes how to use the GetRecordCount keyword to obtain the total number of records and store the value in a user variable in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Record Count (SWE)

@Var1

N/A

Stores the total record count in a user variable.

SIS Account List Applet|NULL

@Var1

N/A

Uses NULL for the applets without menu.

Mobile Examples

The following table describes how to use the GetRecordCount keyword to obtain the total number of records and store the value in a user variable in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|Record Count (SWE)

@recordcount

N/A

Stores the total record count in a user defined variable.

SHCE Sales Account List Applet - Mobile|

@Var1

N/A

Uses NULL for the applets without a menu.

GetState

You use the GetState keyword to obtain the state of a specified object and store the state in a variable. The state of an object can be Read-only, Enabled, Disabled, Editable, and so on.

Signatures

The ServerConfig keyword supports the following signatures:

GetState(AppletRN|FieldRN|[RowNum] ,@Variable)

GetState(AppletRN|MenuButtonRN|MenuItemRN ,@Variable)

GetState(ApplicationLevelMenuRN|ApplicationLevelMenuItemRN,@Variable)

Desktop Examples

The following table describes how to use the GetState keyword to obtain the state of a specified object and store the state in a variable in desktop applications.

Target Object Inputs Closing Action Comments

SIS Product List Admin Applet|Release

@variable1

N/A

Stores the Release state in a variable.

SIS Product List Admin Applet|XA Class Name|3

@variable2

N/A

Stores XA Class Name state for the third record in a variable.

SIS Product List Admin Applet|SiebAppletMenu|Delete Record (SWE)

@variable3

N/A

Stores the Delete record (SWE) state in a variable.

Menu-File|File - Send Fax

@variable4

N/A

Stores the File - Send Fax state in a variable.

Mobile Examples

The following table describes how to use the GetState keyword to obtain the state of a specified object and store the state in a variable in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|QuerySrchSpec

@var

N/A

Gets the state of a variable and stores the state in @var.

SHCE Sales Account List Applet - Mobile|SiebAppletMenu|Record Count (SWE)

@var

N/A

Gets the state of a menu item and stores the state in @var.

GetValue

You use the GetValue keyword to obtain the value from a specified object and store the value in a variable.

Signature

The GetValue keyword supports the following signature:

GetValue(AppletRN|FieldRN/ClassName/ThreadbarID|[RowNum/Tileindex],@Variable)
Note: If the action is to be performed on tile applets, then the Tile index or row number must start from one.

Desktop Examples

The following table describes how to use the GetValue keyword to obtain the value from the specified object and store the value in a variable in desktop applications.

Target Object Inputs Closing Action Comments

AppletRN|ClassName|[RowNumber]

@Var

N/A

Gets a value based on Class Name.

SIS Account List Applet|Account Status|2

@Var

N/A

Gets a value from the Account Status field in the second row and stores the value in a variable.

Opportunity Form Applet - Child|SalesRep2

@Var

N/A

Gets a value from the SalesRep2 field in the form applet and stores the value in a variable.

Opportunity Form Applet - Child|Description2

@Var

N/A

Gets the value from the Description2 field in the form applet and stores the value in a variable.

NULL|Save Query As Applet._SweQueryName

@Var

N/A

Gets a value from the pop-up input field.

SIS Account List Applet|Name

@Var[3]

N/A

Gets a value of first three records in the Accounts list applet.

Mobile Examples

The following table describes how to use the GetValue keyword to obtain the value from a specified object and store the value in a variable in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|Name|4

@accountname

N/A

Gets a value from the Name field in the fourth row and stores the value in the account name variable.

SHCE Sales Account List Applet - Mobile|Name

@accountname

N/A

Gets a value from the Name field in the first row and stores the value in the account name variable.

GetValueFromMenuPopup

You use the GetValueFromMenuPopup keyword to read values from application level pop-up menus.

Signature

The GetValueFromMenuPopup keyword supports the following signature:

GetValueFromMenuPopup(MenuRN|MenuItemRN,RN_Label(1..N)|Variable(1..N))

Desktop Examples

The following table describes how to use the GetValueFromMenuPopup keyword to read values from application level pop-up menus in desktop applications.

Target Object Inputs Closing Action Comments

Help|Help - Technical Support

Application Version|@var1

N/A

Gets the value in the Application Version field when Help - Technical Support is selected from the application-level menu.

Help|Help - About Record

Created By|@var1

N/A

Gets the value in the CreatedBy field when Help, then Technical Support is selected from the application-level menu.

Mobile Examples

The GetValueFromMenuPopup keyword does not apply to mobile applications.

GoToSettings

You use the GoToSettings keyword to view and change the default settings of a user profile.

Signature

The GoToSettings keyword supports the following signature:

Gotosettings()

Desktop and Mobile Examples

The following table describes how to use the GoToSettings keyword to view and change the default settings of a user profile in desktop and mobile applications.

Target Object Inputs Closing Action Comments

Navigates to the Settings (user profile) screen.

GoToThreadbarView

You use the GoToThreadbarView keyword to move to a view in the threadbar.

Signature

The GoToThreadbarView keyword supports the following signature:

GoToThreadbarView(Id of Threadbar Link)

Desktop Examples

The following table describes how to use the GoToThreadbarView keyword to move to a view in the threadbar in desktop applications.

Target Object Inputs Closing Action Comments

Views_tb_0

N/A

N/A

Clicks on the specified threadbar link.

Views_tb_1

N/A

N/A

Clicks on the specified threadbar link.

Mobile Examples

The GoToThreadbarView keyword does not apply to mobile applications.

GoToView

You use the GoToView keyword to move to a specified view from the Tab view, Tree view or Site Map view.

Signatures (Desktop)

The GoToView keyword supports the following signature on mobile devices:

GoToView(ScreenRN|ViewRN|Level)

Note the following:

  • To go to Sitemap: ScreenRN|View RN|NULL

  • To go to ScreenTab: ScreenRN|View RN|L1

  • To go to TabView: NULL|ViewRN|L2/L3/L4

Note the following about the GoToView keyword signature:

  • View levels can be L1, L2, L3, and L4.

  • Before going to the next level, the user must be in the immediate previous level. For example, if the user has to go to level 3, the user must be in level 2.

Signature (Mobile)

The GoToView keyword supports the following signature on desktop machines:

GotoView(ViewRN)

Desktop Examples

The following table describes how to use the GoToView keyword to move to a specified view in desktop applications.

Target Object Inputs Closing Action Comments

NULL|Accounts Screen|L1

N/A

N/A

Navigates to the accounts screen, first level view bar.

NULL|Account List View|L2

N/A

N/A

Navigates to the accounts screen, second level view bar.

NULL|TNT SHM Opportunity Agenda View|L3

N/A

N/A

Navigates to the accounts screen, third level view bar.

NULL|Quote Item XA View|L4

N/A

N/A

Navigates to the accounts screen, fourth level view bar.

Sitemap.Asset Management Screen|Sitemap.Asset Mgmt - Assets View|NULL

N/A

N/A

Clicks on the Site Map links.

Mobile Examples

The following table describes how to use the GoToView keyword to move to a specified view in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

Pharma Contact List View - Mobile

N/A

N/A

Navigates to the Contact List view.

HierarchicalList

You use the HierarchicalList keyword to expand and collapse the Hierarchical List applet, including both parent and child records based on the row number provided. You also use the keyword to obtain the total number of child records in the Hierarchical List applet.

Signature

The HierarchicalList keyword supports the following signature:

HierarchicalList(AppletRN|Rownum,Expand/Collapse/GetChildItemsCount|Variable)

Note the following about the HierarchicalList keyword signature:

  • Expand is for expanding the record.

  • Collapse is for collapsing the record.

  • GetChildItemsCount|@var is for expanding and taking a child count of the record irrespective of whether the record has a child or not.

Desktop Examples

The following table describes how to use the HierarchicalList keyword to expand, collapse and get the child count in desktop applications.

Target Object Inputs Closing Action Comments

Order Entry - Line Item List Applet (Sales)|1

Expand

N/A

Expands the first record.

Order Entry - Line Item List Applet (Sales)|8

Collapse

N/A

Collapses the eighth record.

Order Entry - Line Item List Applet (Sales)|2

GetChildItemsCount|Variable

N/A

Expands the second record and reads the child count in the record.

Mobile Examples

The HierarchicalList keyword does not apply to mobile applications.

InboundWebServiceCall

You use the InboundWebServiceCall keyword to read an XML request from a .xml file, post the request to the server, and save the XML response from the server. The keyword also verifies the expected TagName and value in the XML response.

Signature

The InboundWebServiceCall keyword supports the following signature:

Inboundwebservicecall(XMLFIle;Tagname|@VAR1,Tagname2|@var2/NULL;Tagname|Value/
@var/@STOREVAR,Tagname|value/@var/@STOREVAR)

Note the following about the InboundWebServiceCall keyword signature:

  • You must provide the full Tagname in the signature.

  • The variable name must begin with @STORE to store the response value of a tagname into the variable.

XML structure

To pass the dynamic variable into the XMLFIle PFB, use the following XML structure:

<tagname>$var</tagname>
<tagname>="$var"</tagname>

XML Structure

An example of the XML structure is as follows:

<EAI>
<EAI-SERVERNAME>Component Alias</EAI-SERVERNAME>
<EAI-USERNAME>Username</EAI-USERNAME>
<EAI-PASSWORD>Password</EAI-PASSWORD>
</EAI>

Desktop Examples

The following table describes how to use the InboundWebServiceCall keyword to read, post, and save an XML request and then verify the response in desktop applications.

Target Object Inputs Closing Action Comments

N/A

Prod1.xml;swip:WorkspaceName|@var,swip:WorkspaceReuseFlag|@var2;ActiveFlag|@STOREVAR

N/A

Stores the tagname value in the response (ActiveFlag) in the @STOREVAR variable.

N/A

Prod1.xml;swip:WorkspaceName|@var,swip:WorkspaceReuseFlag|@var2;ActiveFlag|Y

N/A

Passes the values to a SOAP request dynamically.

N/A

Currency.xml;ConversionRateResult|0.0161

N/A

Sends the XML request and verifies the response.

N/A

Currency.xml;swip:WorkspaceName|@var,swip:WorkspaceReuseFlag|@var2;ActiveFlag|@var2

N/A

Passes the values to a SOAP request dynamically.

N/A

new.xml;NULL;OrderItem|ProductId|88-46TS9:ActionCode|@STOREsdf

N/A

Stores ActionCode from Order item tags in the @STOREsdf variable with the unique productID 88-46TS9.

Mobile Examples

The InboundWebServiceCall keyword does not apply to mobile applications.

InputValue

You use the InputValue keyword to enter a value into a field. The keyword supports unique values by adding the dollar ($) symbol to the end of the text. For example, if the input is john$, then a random unique value appends like "john548".

The InputValue keyword supports the following special characters and operators:

  • * (asterisk). For example: like AAX*.

  • = (equals). For example: date=Today+1.

  • + (plus). For example: Today+1.

  • - (minus). For example: Today-1.

  • LIKE, like. For example: date format like, LIKE AAX*.

  • OR. For example: @var1 OR @var2.

  • Numerals zero to nine (0 - 9).

Signature

The InputValue keyword supports the following signature:

InputValue(AppletRN|FieldRN|[Active_Record/Tileindex/RowNum],Value OR Variable)

Note the following about the HierarchicalList keyword signature:

  • RowNumber is optional. If RowNum is not specified, then RowNum defaults to the first row.

  • Active_Record obtains the row number of the active record during execution.

  • If the action is to be performed on tile applets, then the tile index or row number must start from one.

  • !+! is the delimiter used for concatenating dynamic variable in the middle of input data. For more information, see the examples in the following table.

Desktop Examples

The following table describes how to use the InputValue keyword to enter values into fields in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account list Applet|Name

john$

N/A

Creates a unique value when $ is appended to the end of the value.

SIS Account list Applet|Name

Test!+!@storedVar!+!Kwd

N/A

Appends the dynamic variable value(storedVar) in between static text by using the delimiter !+!.

SIS Account list Applet|Name|Active_Record

john$

N/A

Enters the value in to the field for the highlighted row in the list applet.

Opportunity Form Applet - Child|CloseDate

today+10

N/A

Enters the today+10 value into the CloseDate Field.

SIS Account List Applet|Main Phone Number

LIKE 650

N/A

Enters the phone number LIKE 650*.

NULL|Save Query As Applet._SweQueryName

Test1234

N/A

Enters the value in to the pop-up input field.

SIS Account list Applet|Name

NULL

N/A

Enters the empty value into the input field (Name).

Mobile Examples

The following table describes how to use the InputValue keyword to enter values into fields in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Account Entry Applet - Mobile|Name

john$

N/A

Creates a unique value when $ is appended to the end of the value.

SHCE Sales Account List Applet - Mobile|Location|2

Paris

N/A

Enters the value into the second row of the list applet. For example, Paris.

InvokeAppletMenuItem

You use the InvokeAppletMenuItem keyword to call a menu item from an applet-level menu in a list or form.

Signature

The InvokeAppletMenuItem keyword supports the following signature:

InvokeAppletMenuItem(AppletRN|RN of Menu Item,(RN of Closing Action/NULL))

Note the following about the InvokeAppletMenuItem keyword signature:

  • The Confirmation dialog box does not close after you delete a record.

  • The VerifyError keyword must be used after the deletion of any record.

Desktop Examples

The following table describes how to use the InvokeAppletMenuItem keyword to call a menu item from an applet-level menu in a list or form in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|New Record (SWE)

N/A

NULL

Invokes the New Record applet menu item with no action in the pop-up window that appears.

SIS Account List Applet|Delete Record (SWE)

N/A

NULL

Invokes the Delete Record applet menu item with no action in the pop-up window that appears.

SIS Account List Applet|Record Count (SWE)

N/A

CloseApplet

Invokes the Record Count applet menu item where users must click on OK in the pop-up window that appears.

SIS Account List Applet|About Record (SWE)

N/A

CloseButton

Invokes the About Record applet menu item where users must click on OK in the pop-up window that appears.

Mobile Examples

The following table describes how to use the InvokeAppletMenuItem keyword to call a menu item from an applet-level menu in a list or form in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|Record Count (SWE)

N/A

CloseApplet

Invokes the Record Count applet menu item where users must click OK in the pop-up window that appears.

SHCE Sales Account List Applet - Mobile|Get Bookmark URL (SWE)

N/A

CloseApplet

Invokes the Get Bookmark URL applet menu item where users must click OK in the pop-up window that appears.

InvokeMenuBarItem

You use the InvokeMenuBarItem keyword to call a menu item from the application-level menu.

Signature

The InvokeMenuBarItem keyword supports the following signature:

InvokeMenuBarItem(MenuRN|MenuItemRN)

Desktop Examples

The following table describes how to use the InvokeMenuBarItem keyword to call a menu item from the application-level menu in desktop applications.

Target Object Inputs Closing Action Comments

Menu-Help|Help - Technical Support

IPH1;IPH2 ;IPH3

OK/CANCEL/NULL

Selects Technical Support from the (application-level) Help menu.

Mobile Examples

The InvokeMenuBarItem keyword does not apply to mobile applications.

InvokeObject

You use the InvokeObject keyword to call UI objects such as PickApplet, MVG, Calculator, Currency Image, and so on.

Signature

The InvokeObject keyword supports the following signature:

InvokeObject(AppletRN|FieldRN|[RowNum]/[Active_Record])
Note: The Active_Record obtains the row number of the active record during the execution.

Desktop Examples

The following table describes how to use the InvokeObject keyword to call UI objects in desktop applications.

Target Object Inputs Closing Action Comments

SIS Product List Admin Applet|Product Line

N/A

N/A

Invokes the list applet field object.

SIS Product List Admin Applet|Product Line|3

N/A

N/A

Invokes the list applet field object in the third row.

SIS Product List Admin Applet|Product Line|Active_Record

N/A

N/A

Invokes the list applet field object from the current active row.

Opportunity Form Applet - Child|Account2

N/A

N/A

Invokes the form applet field object.

Opportunity Form Applet - Child|Revenue2

N/A

N/A

Invokes a Form applet field object.

NULL|Revenue2

N/A

N/A

Invokes the object in a pop-up window.

Mobile Examples

The following table describes how to use the InvokeObject keyword to call UI objects in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Opportunity List Applet ReadOnly - Mobile|Primary Revenue Amount|1

N/A

N/A

Invokes the Currency pop-up window.

SHCE Sales Opportunity List Applet ReadOnly - Mobile|Account

N/A

N/A

Invokes the drop-down list applet.

NULL|Currency Code

N/A

N/A

Invokes the Currency code dialog box.

Launch

You use the Launch keyword to start and log in to applications by providing the username.

Signature

The Launch keyword supports the following signature:

Launch(component_alias;username;Y/N

Note the following about the Launch keyword signature:

  • Component_alias must come from the predefined component names for a product.

  • Component_alias and username are mandatory parameters.

  • [clearBrowser] is an optional parameter, which can be specified if there is a specific requirement to clear cookies at application startup.

  • By default, cookies are not cleared at application startup.

Desktop Examples

The following table describes how to use the Launch keyword to start and log in to an application by providing the username in desktop applications.

Target Object Inputs Closing Action Comments

N/A

CORE_UIF;SADMIN;Y

N/A

Starts the browser, clears the browser cookies and logs in with the username SADMIN.

N/A

CORE_UIF;SADMIN;N

N/A

Starts the browser and logs in with the username SADMIN.

N/A

CORE_UIF;PortalApplication;Y

N/A

Handles the login page in the Portal application.

N/A

PHARMAM;LaunchApp;Y

N/A

Starts the application.

Mobile Examples

The following table describes how to use the Launch keyword to start and log in to an application by providing the username in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

N/A

PHARMAM;SPORTER

N/A

Starts the application.

LockColumn

You use the LockColumn keyword to lock or unlock a selected column.

Signature

The LockColumn keyword supports the following signature:

LockColumn(AppletRN | FieldRN,Lock/Unlock)
Note: Lock/Unlock input is case insensitive

Desktop Examples

The following table describes how to use the LockColumn keyword to lock or unlock a selected column in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Name

LOCK

N/A

Locks the selected column.

SIS Account List Applet|Name

UNLOCK

N/A

Unlocks the selected column.

Mobile Examples

The following table describes how to use the LockColumn keyword to lock or unlock a selected column in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

Contact List Applet - Mobile|First Name

LOCK

N/A

Locks the selected column.

Contact List Applet - Mobile|First Name

UNLOCK

N/A

Unlocks the selected column.

LogOut

You use the LogOut keyword to log out from applications.

Signature

The LogOut keyword supports the following signature:

LogOut

Desktop and Mobile Examples

The following table describes how to use the LogOut keyword to log out from applications in desktop applications and mobile.

Target Object Inputs Closing Action Comments

Logs out from the application.

MafSettings

You use the MafSettings keyword to perform the required action in the MAF Settings page in MAF applications (on iOS and Android devices).

Signatures

The signature to start the Siebel app is as follows:

Launch(component_alias;LaunchApp;[clearBrowser])

The signature for the MafSettings keyword is as follows:

MafSettings(Action:Id; Value/NULL; OK/CANCEL/NULL)

Note the following about the MafSettings keyword signature:

  • Action can be one of the following: Input, Click, Verify, verifyerrorMsg, Flip, or Springboard.

  • Value can be a User input value or NULL.

  • ClosingAction can be OK, CANCEL, or NULL.

Desktop Examples

The MafSettings keyword does not apply to desktop applications.

Mobile Examples

The following table describes how to use the MafSettings keyword to perform the required action in the MAF Settings page in MAF applications on iOS and Android devices.

Target Object Inputs Closing Action Comments

Click:setting-fragment2:host__inputElement

NULL

NULL

Clicks host.

Input:setting-fragment2:host__inputElement

Servername

NULL

Inputs the host value.

verifyerrorMsg:

Alert Invalid Host Server Address

OK

Verifies the alert message.

verify:setting-fragment2:host::lbl

Host;True

NULL

Verifies the host.

flip:sbs-dock__switch

Y

NULL

Flips Enable Show in the dock.

Springboard:Refresh Button

NULL

NULL

Clicks the Springboard toolbar.

MultiSelectRecordsInListApplet

You use the MultiSelectRecordsInListApplet keyword to select multiple records in a list applet.

Signature

The MultiSelectRecordsInListApplet keyword supports the following signature:

MultiSelectRecordsinListApplet(AppletRN,RowNum(1..N)

Desktop Examples

The following table describes how to use the MultiSelectRecordsInListApplet keyword to select multiple records in list applets in desktop applications.

Target Object Inputs Closing Action Comments

AppletRN

1,3,5

N/A

Selects first, third, and fifth record from the list applet.

Mobile Examples

The following table describes how to use the MultiSelectRecordsInListApplet keyword to select multiple records in list applets in mobile applications on (mobile devices).

Target Object Inputs Closing Action Comments

CG Account List Applet - Mobile

1,3,5

N/A

Selects the first, third, and fifth record from the list applet.

QueryRecord

You use the QueryRecord keyword to query a record in a list or form applet.

Signature

The QueryRecord keyword supports the following signature:

QueryRecord(Applet RN|ButtonRN,FieldRN(1..N)|Value(1...N) OR Variable)
Note: To query for an existing record, use one or more fields or run an empty query.

Desktop Examples

The following table describes how to use the QueryRecord keyword to query a record in list or form applets in desktop applications.

Target Object Inputs Closing Action Comments

Contact List Applet|NewQuery

Last Name|oracle$,First Name|company$,Work Phone #|6506123456

N/A

Queries the record with the specified search criteria.

Contact List Applet|NewQuery

LastName| David,FirstName|Albert

N/A

Queries the record with the specified search criteria.

Contact List Applet|NewQuery

First Name|AAAX*

N/A

Queries the record with the specified search criteria.

Contact List Applet|NewQuery

Work Phone #|650678-0987

Queries the record with the specified search criteria.

Opportunity Form Applet - Child|NewQuery

Opportunity Currency2|USD

Queries the record with the specified search criteria.

Contact List Applet|NewQuery

First Name|AAAX*

Queries the record with the specified search criteria.

Contact List Applet|NewQuery

First Name|NULL

Searches for an empty query (that is for records where First Name is NULL).

Contact List Applet|NewQuery

M/M|Mr.

Queries the record with the specified search criteria.

Mobile Examples

The following table describes how to use the QueryRecord keyword to query a record in list or form applets in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Opportunity Form Applet - Mobile|NewQuery

Name|John$,Currency|USD,CloseDate|11|12|12

N/A

Queries the record with the specified search criteria.

CG Account List Applet - Mobile|NewQuery

Name|abc

N/A

Queries the record with the specified search criteria.

RemoveFromMvg

You use the RemoveFromMvg keyword to remove a specified record or all records from an MVG list. The "Query:" will be appended to the results after executing the keyword.

Signature

The RemoveFromMvg keyword supports the following signature:

RemoveFromMvg(AppletRN|FieldRN|[RowNum]/
[Active_Record],Query:FieldRN(1…N)(1..N)|Value(1…N:);Remove/RemoveAll;OK/
CANCEL,RN(OK)

Note the following about the RemoveFromMvg keyword signature:

  • Active_Record is the row number of the active record during execution.

  • The OK and Cancel options are optional in the input column.

Desktop Examples

The following table describes how to use the RemoveFromMvg keyword to remove a specific or all records from an MVG list in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Sales Rep

Active Last Name|Silver,Active First Name|Victor;Remove

RN of OK

Removes an account team from an account in a list applet.

SIS Account List Applet|Sales Rep|Active_Record

Active Last Name|Silver,Active First Name|Victor;Remove

RN of OK

Removes an account team from an account in a list applet. Performs the action on the field of the active row.

SIS Account Entry Applet|SalesRep

Active Last Name|Dupont,Active First Name|Dupont;Remove

RN of OK

Removes an account team from an account in a form applet.

SIS Account List Applet|Sales Rep

NULL;RemoveAll

RN of OK

Removes all accounts in a list applet.

SIS Account List Applet|Sales Rep

NULL;RemoveAll;OK

RN of OK

Removes all accounts in a list applet. Users must click OK on confirmation.

Mobile Examples

The following table describes how to use the RemoveFromMvg keyword to remove a specified or all records from an MVG list in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|Primary Account Address Name

Name|abc;RemoveAll

Idcancel

Removes all accounts in a list applet.

SHCE Sales Account List Applet - Mobile|Primary Account Address Name

Name|abc;Remove

Idcancel

Removes an account in a list applet.

SelectCheckBox

You use the SelectCheckBox keyword to select or clear a check box.

Signature

The SelectCheckBox keyword supports the following signature:

SelectCheckbox(AppletRN|FieldRN|[RowNum],TRUE(or)FALSE(or)@variable)

Desktop Examples

The following table describes how to use the SelectCheckBox keyword to select or clear a check box in desktop applications.

Target Object Inputs Closing Action Comments

Opportunity List Zpplet|Committed

TRUE

N/A

Selects the check box.

SIS Account List Applet|Fund Eligible Flag|3

FALSE

N/A

Clears the check box in the third row of the list applet.

Opportunity List Applet|Committed

@Variable

N/A

Selects or clears the check box depending on the variable value (True or False).

MultiAdd Product On Order|Select All|Select All

True/False

N/A

Selects the check box in the column header.

Mobile Examples

The following table describes how to use the SelectCheckBox keyword to select or clear a check box in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Address List Applet - Mobile|SSA Primary Field

TRUE

N/A

Selects the check box for the specified object based on the provided user value.

SHCE Address List Applet - Mobile|SSA Primary Field|3

FALSE

N/A

Clears the check box for the specified object based on the provided user value.

SelectFromMvg

You use the SelectFromMvg keyword to select a specified record after querying the available records in an MVG.

Signature

The SelectFromMvg keyword supports the following signature:

SelectFromMvg(AppletRN|FieldRN|[RowNum]/
[Active_Record],FieldRN(1…N)|Value(1…Nb),RN of OK)
Note: Active_Record obtains the row number of the active record during execution.

Desktop Examples

The following table describes how to use the SelectFromMvg keyword to select a specified record after querying the available records in an MVG in desktop applications. The Query will be appended to the results after executing the keyword.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Sales Rep

Query:Last Name|Yang

Idok

Selects a Sales Rep after querying the available records in an MVG.

SIS Account List Applet|Sales Rep|Active_Record

Query:Last Name|Yang

Idok

Selects a Sales Rep after querying the available records in an MVG of the active record.

Mobile Examples

The following table describes how to use the SelectFromMvg keyword to select a specified record after querying the available records in an MVG in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|Primary Account Address Name

Query:Name|abc

Idcancel

Selects a name after querying the available records in an MVG.

SelectFromPickApplet

You use the SelectFromPickApplet keyword to query and select the first record from a drop-down list applet.

Signature

The SelectFromPickApplet keyword supports the following signature:

SelectFromPickApplet(AppletRN|FieldRN|[RowNum]/
[Active_Record],Query:FieldRN(1…N)|Value(1…Nt),RN(OK/CANCEL))

Note the following about the SelectFromPickApplet keyword signature:

  • RowNum is an optional value. If RowNum is not specified, then RowNum defaults to the first row.

  • Active_Record obtains the row number of the active record during execution.

Desktop Examples

The following table describes how to use the SelectFromPickApplet keyword to query and select the first record from a drop-down list applet in desktop applications.

Target Object Inputs Closing Action Comments

Opportunity Form Applet - Child|Account2

Query:City|Berkeley

Idcancel

Queries and cancels the first value in a drop-down list applet form.

Account Profile Applet|Price List

Query:Name |ACR764 Price List,Start Date|7/16/2007 05:00:00

PMPopupQueryPick

Queries and selects the first value in a drop-down list applet.

Contact List Applet|Account|1

Query:Name|Hibbing

PopupQueryPick

Queries and selects the first value in a drop-down list applet form.

Contact List Applet|Account|Active_Record

Query:Name|Hibbing

PopupQueryPick

Queries and selects the first value in a drop-down list applet (in active record).

NULL|Currency Code

Query:Currency Code|USD

PopupQueryPick

Queries and selects the first value in a drop-down list applet form.

Mobile Examples

The following table describes how to use the SelectFromPickApplet keyword to query and select the first record from a drop-down list applet in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|Parent Account Name

Query:Name|abc

PopupQueryPick

Queries and selects the first value in a drop-down list applet form.

SHCE Sales Contact List Applet - Mobile|NewRecord

Query:Last Name|abc

AddRecord

Queries and selects the first value in a drop-down list applet form (having clicked the plus (+) icon in the list applet).

SelectPDQValue

You use the SelectPDQValue keyword to select a value from the Predefined Query (PDQ) list in the application.

Signature

The SelectPDQValue keyword supports the following signature:

SelectPDQValue(ItemRN OR Variable)

Desktop Examples

The following table describes how to use the SelectPDQValue keyword to select a value from the PDQ list in desktop applications.

Target Object Inputs Closing Action Comments

Account

N/A

Selects a PDQ value named <abc>.

@Variable

N/A

Selects a PDQ value stored in a variable.

Mobile Examples

The following table describes how to use the SelectPDQValue keyword to select a value from the PDQ list in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

Account

N/A

N/A

Selects a PDQ value named <abc>.

@Variable

N/A

N/A

Selects a PDQ value stored in a variable.

SelectPickListValue

You use the SelectPicklistValue keyword to select a value from the drop-down list in a form or list applet.

Signature

The SelectPicklistValue keyword supports the following signature:

SelectPicklistValue(AppletRN|FieldRN|[RowNum]/[Active_Record],Value(or)Variable)
Note: Active_Record obtains the row number of the active record during execution.

Desktop Examples

The following table describes how to use the SelectPicklistValue keyword to select a value from the drop-down list in a form or list applet in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Account Status|2

Active

N/A

Sets a value in a drop-down list of a particular field in the second row of the list applet.

SIS Account List Applet|Account Status|Active_Record

Active

N/A

Sets a value in a drop-down list of a particular field in the active row of the list applet.

SIS Account List Applet|Account Status

@Variable

N/A

Sets a value (by using a variable) in a drop-down list of a particular field in a list applet.

Opportunity Home Search Virtual Form Applet|SalesStage

@Variable

N/A

Sets a value (by using a variable) in a drop-down list of a particular field in a form applet.

Mobile Examples

The following table describes how to use the SelectPicklistValue keyword to select a value from a drop-down list in a form or list applet in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Account Entry Applet - Mobile|Type

Customer

N/A

Selects a value from a drop-down list or LOV (List of Values) in a form or list applet.

SHCE Sales Account List Applet - Mobile|Type

@var

N/A

Sets a value in a drop-down list of a particular field in the second row of a list applet.

SHCE Sales Account List Applet - Mobile|Type|1

@var

N/A

Sets a value (by using a variable) in a drop-down list of a particular field in a form applet.

SelectRadioButton

You use the SelectRadioButton keyword to select a radio button.

Signatures

The SelectRadioButton keyword supports the following signatures:

SelectRadioButton(AppletRN|FieldRN ,Value OR Variable)
SelectRadioButton(NULL|FieldRN ,Value)
SelectRadioButton(AppletRN|FieldRN ,Variable)
Note: Value must not be the UI name. Use the DOM attribute as the name Value.

Desktop Examples

The following table describes how to use the SelectRadioButton keyword to select a radio button in desktop applications.

Target Object Inputs Closing Action Comments

Sort Order Popup Applet (SWE)|rdbDesc1

Ascending

N/A

Selects a specified radio button.

NULL|SWE Export Applet.rdbRowsToExport

All Rows In Current Query

N/A

Selects a specified radio button.

Sort Order Popup Applet (SWE)|rdbDesc1

@Variable

N/A

Selecta a variable value radio button.

Mobile Examples

The SelectRadioButton keyword does not apply to mobile applications.

SelectRecordInListApplet

You use the SelectRecordInListApplet to select a particular record in a list applet.

Signature

The SelectRecordInListApplet keyword supports the following signature:

SelectRecordinListApplet(AppletRN|FieldRN|[RowNum/Tileindex],Value/Variable/NULL)
Note: If the action is to be performed on tile applets, then the tile index and row number must start from one.

Desktop Examples

The following table describes how to use the SelectRecordInListApplet keyword to select a particular record in a list applet in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Name

Metropolitan Investments

N/A

Selects the specified field value record in the list applet.

AppletSIS Account List Applet|Name|5

NULL

N/A

Selects a record (the fifth record) based on the specified row index (5).

AppletSIS Account List Applet|Name|5

NULL

N/A

Selects the fifth record in the list applet.

AppletQuote List Applet|Quote Number

@Variable

N/A

Selects the specified field value from a variable record in the list applet.

AppletSIS Account List Applet|Name|4

Abc

N/A

Selects the specified row (or fourth record) in the list applet.

Mobile Examples

The following table describes how to use the SelectRecordInListApplet keyword to select a particular record in a list applet in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

AppletRN|FieldRN|[RowNumber]

Value

N/A

Selects a record in the list applet, according to the specified input value.

AppletSHCE Sales Account List Applet - Mobile|Name|1

FinanceOne Corporation

N/A

Selects the specified value in the specified row number.

SHCE Sales Account List Applet - Mobile|Name

FinanceOne Corporation

N/A

Matches the value in the visible records.

AppletSHCE Sales Account List Applet - Mobile|Name|1

@accountName

N/A

Matches the field value in a variable record.

SelectToggleValue

You use the SelectToggleValue keyword to select a value from a toggle control in a list applet.

Signature

The SelectToggleValue keyword supports the following signature:

SelectToggleValue(AppletRN|ToggleRN,Value)

Desktop Examples

The following table describes how to use the SelectToggleValue keyword to select a value from a toggle control in a list applet in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|SiebToggle

Accounts

N/A

Selects the specified value from the toggle control in a list applet.

Pharma Calendar Activity List Applet|SiebToggle

1

N/A

Selects the specified value from the toggle control in a list applet.

Note: Input "1" represents the "value" attribute in DOM

Mobile Examples

The SelectToggleValue keyword does not apply to mobile applications.

SelectVisibilityFilterValue

You use the SelectVisibilityFilterValue keyword to select a value from the Visibility Filter drop-down list in an applet.

Signature

The SelectVisibilityFilterValue keyword supports the following signature:

SelectVisibilityFilterValue(AppletRN|ItemRN)

Desktop Examples

The following table describes how to use the SelectVisibilityFilterValue keyword to select a value from the Visibility Filter drop-down list in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|All Account List View

N/A

N/A

Selects the All Account list view from the Visibility Filter drop-down list.

Contact List Applet|Manager's Contact List View

N/A

N/A

Selects the Manager's Contact list view from the Visibility Filter drop-down list.

Mobile Examples

The SelectVisibilityFilterValue keyword does not apply to mobile applications.

SendKeys

You use the SendKeys keyword to trigger keyboard events.

Signature

The SendKeys keyword supports the following signature:

SendKeys(Keystroke)

Note the following about the SendKeys keyword signature:

  • You must use SendKeys only if the test case requires an action to be performed using the keyboard.

  • You must open SendKeys in Inetpub.

  • You must enable screenshot for test steps when using SendKeys for debugging.

  • Before performing a SendKeys action, the focus must be on the object.

  • Avoid using the keyboard (including SendKeys) during unit testing of the test cases.

  • During batch execution, the computer window in which execution occurs must be closed, to avoid sending false key input.

  • Special characters keys are supported, including combinations of the following:

    • Lowercase a to z.

    • Uppercase A to Z.

    • Numerals 1 to 9.

  • The following keyboard keys are supported:

ADD; ALT; ARROW_DOWN; ARROW_LEFT; ARROW_UP; ARROW_RIGHT; BACK_SPACE; CANCEL; CLEAR; COMMAND; CONTROL; DELETE; DECIMAL; DIVIDE; DOWN; END; ENTER; EQUALS; ESCAPE; F1; F2; F3; F4; F5; F6; F7; F8; F9; F10; F11; F12; HELP; HOME; INSERT; MULTIPLY; NUMPAD0; NUMPAD1; NUMPAD2; NUMPAD3; NUMPAD4; NUMPAD5; NUMPAD6; NUMPAD7; NUMPAD8; NUMPAD9; PAGE_DOWN; PAGE_UP; SHIFT LEFT; RIGHT; SPACE; SUBTRACT; TAB; UP; BRACERIGHT; BRACELEFT

Desktop Examples

The following table describes how to use the SendKeys keyword to trigger keyboard events in desktop applications.

Target Object Inputs Closing Action Comments

CTRL+ALT+N

N/A

N/A

Selects all records.

CTRL+S

N/A

N/A

Saves.

CTRL+TAB

N/A

N/A

Tabs out.

SetDateTime

You use the SetDateTime keyword to call the DateTime or Date pop-up calendar specify the date and time.

Signature

The SetDateTime keyword supports the following signature:

SetDateTime(AppletRN|FieldRN|[RowNum]/[Active_Record],today(+/-))

Note the following about the SendDateTime keyword signature:

  • Active_Record obtains the row number of the active record during execution.

  • If the time is not specified, then the default time is 00:00:00. Value can be a DATETIME, a DATE, or a Variable.

Desktop Examples

The following table describes how to use the SetDateTime keyword to call the DateTime or Date pop-up calendar to provide the date and time in desktop applications.

Target Object Inputs Closing Action Comments

Opportunity Form Applet - Child|CloseDate2

DD:MM:YYYY;01:01:2015

N/A

Chooses a date in the Calendar pop-up window.

Activity List Applet With Navigation|Planned

Today

N/A

Sets the current date and time.

Activity List Applet With Navigation|Planned|Active_Record

Today

N/A

Sets the current date and time in the field of the active record.

Activity List Applet With Navigation|Planned

DD:MM:YYYY:HH:MM:SS;05:08:2014 : 10:17:20

N/A

Sets the specified date and time.

Activity List Applet With Navigation|Planned

DD:MM:YYYY:HH:MM:SS;05:08:2014 : 10:17:20

N/A

Sets the specified date and time.

Opportunity Form Applet - Child|CloseDate2

Today+365

N/A

Sets the specified date plus (+)365 days.

Opportunity Form Applet - Child|CloseDate2

Today-365

N/A

Sets the specified date minus (-) 365 days.

Opportunity Form Applet - Child|CloseDate2

28|01|CURRENTYEAR

N/A

Sets a specified date in the current year.

Opportunity Form Applet - Child|CloseDate2

28|01|CURRENTYEAR-1

N/A

Sets the specified date in the previous year.

Opportunity Form Applet - Child|CloseDate2

28|01|CURRENTYEAR+2

N/A

Sets the specified date in the current year plus (+)2.

Mobile Examples

The following table describes how to use the SetDateTime keyword to call the DateTime or Date pop-up calendar to provide the date and time in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Contact Opportunity List Applet - Mobile|Primary Revenue Close Date

Today

N/A

Sets the current date and time.

SHCE Sales Opportunity Quote List Applet ReadOnly - Mobile|Start Date

Today+9

N/A

Sets the current date and time.

SHCE Quote Entry Applet - Mobile|StartDate

DD:MM:YYYY;11:05:2014

N/A

Sets the specified date in the target object.

SHCE Sales Order Entry List Applet - Mobile|Order Date

DD:MM:YYYY:HH:MM:SS; 11:5:2014:12:12:30

N/A

Sets the specified date and time in the target object.

SHCE Sales Order Entry List Applet - Mobile|Order Date

DD:MM:YYYY:HH:MM:SS; 1:8:2014:12:30:20

N/A

Sets the specified date in the target object.

SortColumn

You use the SortColumn keyword to sort a selected column.

Signature

The SortColumn keyword supports the following signature:

SortColumn(AppletRN | FieldRN,ASC/DESC)
Note: The SortColumn input is case insensitive.

Desktop Examples

The following table describes how to use the SortColumn keyword to sort a selected column in desktop applications.

Target Object Inputs Closing Action Comments

Opportunity List Applet|Primary Revenue Amount

ASC

N/A

Sorts the columns in ascending order.

SIS Account List Applet|Type

DESC

N/A

Sorts the columns in descending order.

Mobile Examples

The following table describes how to use the SortColumn keyword to sort a selected column in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Account Team List Applet - Mobile|Active Last Name

ASC

N/A

Sorts the columns in ascending order.

SHCE Sales Contact List Applet - Mobile|First Name

DESC

N/A

Sorts the columns in descending order.

SwitchTab

You use the SwitchTab keyword to switch between browser tabs.

Signatures

The SwitchTab keyword supports the following signature:

SwitchTab(id/WindowName,URL/NULL)

Desktop Examples

The following table describes how to use the SwitchTab keyword in desktop applications to switch between browser tabs.

Target Object Inputs Closing Action Comments

N/A

Account;@URL;IPH3

N/A

Switches to the new tab with the specified URL.

N/A

1;NULL;IPH3

N/A

Focuses and navigates to the first tab.

N/A

Account;NULL;IPH3

N/A

Focuses and navigates to the Account tab.

Mobile Examples

The following table describes how to use the Wait keyword in mobile applications.

Target Object Inputs Closing Action Comments

N/A

10

N/A

Application remains idle for 10 seconds.

TreeExplorer

You use the TreeExplorer keyword to perform operations in the explorer tree applet, such as, expand and collapse the tree, select any item in the tree, and show the child items.

Signature

The TreeExplorer keyword supports the following signature:

TreeExplorer(TreeAppletRN|Tree_id,Expand/Collapse/SelectTreeItem/
GetTreeChildItemsCount|@var/IsNodeExists[;@Var;True/
False;GetTreeChildItemsCount|@var])

Desktop Examples

The following table describes how to use the TreeExlorer keyword to expand, collapse, select items from, and show the child items under an explorer tree in desktop applications.

Target Object Inputs Closing Action Comments

Account Tree Applet|1.9

Expand

N/A

Expands the tree structure.

Account Tree Applet|1.9

Collapse

N/A

Collapses the tree structure.

Account Tree Applet|1.9

IsNodeExists

N/A

Verifies the existence of a node.

Account Tree Applet|1.9

IsNodeExists;@Var;True/False

N/A

Verifies the existence of a node in the case of a negative scenario.

Account Tree Applet|1.9

SelectTreeItem

N/A

Selects the specified tree item.

Account Tree Applet|1.2

GetTreeChildItemsCount|@var

N/A

Obtains the number of child items and saves the value in a variable.

Mobile Examples

The TreeExplorer keyword does not apply to mobile applications.

VerifyColumnLockStatus

You use the VerifyColumnLockStatus keyword to verify the lock status of a column.

Signature

The VerifyColumnLockStatus keyword supports the following signature:

VerifyColumnLockStatus(AppletRN | FieldRN,Lock/Unlock
Note: The VerifyColumnLockStatus input is case insensitive.

Desktop Examples

The following table describes how to use the VerifyColumnLockStatus keyword to verify the lock status of a column in desktop applications.

Target Object Inputs Closing Action Comments

LockStatusSIS Account List Applet|Name

LOCK

N/A

Verifies the lock status of the specified column.

LockStatusSIS Account List Applet|Name

UNLOCK

N/A

Verifies the unlock status of the specified column.

Mobile Examples

The following table describes how to use the VerifyColumnLockStatus keyword to verify the lock status of a column in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

LockStatusContact List Applet - Mobile|First Name

LOCK

N/A

Verifies the lock status of the specified column.

LockStatusContact List Applet - Mobile|First Name

UNLOCK

N/A

Verifies the unlock status of the specified column.

VerifyColumnSortOrder

You use the VerifyColumnSortOrder keyword to verify the order of records in a selected column.

Signature

The VerifyColumnSortOrder keyword supports the following signature:

VerifyColumnSortOrder(AppletRN | FieldRN,ASC/DESC)

Desktop Examples

The following table describes how to use the VerifyColumnSortOrder keyword to verify the order of records in a selected column in desktop applications.

Target Object Inputs Closing Action Comments

Opportunity List Applet|Primary Revenue Amount

ASC

N/A

Verifies that records are sorted in ascending order.

SIS Account List Applet|Type

DESC

N/A

Verifies that records are sorted in descending order.

Mobile Examples

The following table describes how to use the VerifyColumnSortOrder keyword to verify the order of records in a selected column in mobile applications.

Target Object Inputs Closing Action Comments

SHCE Account Team List Applet - Mobile|Active Last Name

ASC

N/A

Verifies that records are sorted in ascending order.

SHCE Sales Contact List Applet - Mobile|First Name

DESC

N/A

Verifies that records are sorted in descending order.

VerifyError

You use the VerifyError keyword to verify the error messages that appear in applications i.e., Siebel error pop ups’.

Signature

The VerifyError keyword supports the following signature:

VerifyError(ExpectedMessageSubstring1|ExpectedMessageSubstring2|…..ExpectedMessage
SubstringN,OK/CANCEL) 
Note: Clicking on OK in the pop-up window is an implicit action.

Desktop Examples

The following table describes how to use the VerifyError keyword to verify the error messages that appear in applications in desktop applications.

Target Object Inputs Closing Action Comments

N/A

'Duration' is a required field|Please enter a value for the field.|SBL-DAT-00498

OK

Verifies whether the error message, which appears in the application, contains the specified string value or not. (The Pipe separator is used a separator to verify multiple strings.)

N/A

'Duration' is a required field. Please enter a value for the field.(SBL-DAT-00498)

OK

To verify if the complete error message is displayed correctly.

Mobile Examples

The following table describes how to use the VerifyError keyword to verify the error messages that appear in applications in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

N/A

'Duration' is a required field|Please enter a value for the field.|SBL-DAT-00498

OK

Verifies whether the error message, which appears in the application, contains the specified string value or not.

VerifyFileLoad

You use the VerifyFileLoad keyword to perform image validation, such as, checking that the image has downloaded completely (100% download) and the image filename.

Signature

The VerifyFileLoad keyword supports the following signature:

VerifyFileLoad(AppletRN|ImageFileName|TilePosition,Y/N [Full Download])
Note: The TilePosition index must start at one.

Desktop Examples

The following table describes how to use the VerifyFileLoad keyword to perform image validation in desktop applications.

Target Object Inputs Closing Action Comments

eDetailer Messaging Plan Items Preview List Applet - Mobile|ThumbnailFN3_01132017.jpg|1

Y

N/A

Verifies that the image has downloaded completely.

eDetailer Messaging Plan Items Preview List Applet - Mobile|ThumbnailFN3_01132017.jpg

Y

N/A

Verifies that the image has downloaded completely.

Mobile Examples

Verifyfileload eDetailer Messaging Plan Items Preview List Applet - Mobile|ThumbnailFN3_01132017.jpg|1 Y

VerifyFocus

You use the VerifyFocus keyword to verify the focus location in an application. Focus can be on one of the following in an application: list, form, view, field, or rows in an applet.

Signature

The VerifyFocus keyword supports the following signature:

VerifyFocus(AppletRN(or)ViewRN|FieldRN,TRUE/FALSE)

Note the following about the VerifyFocus keyword signature:

  • The True and False input covers the following scenarios:

  • Use False to check that focus is not on a particular applet, field, or row.

  • Use True to check that focus is on a particular applet, field, row, application-level menu, or application-level menu item.

Desktop Examples

The following table describes how to use the VerifyFocus keyword to verify the focus location in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|NULL

TRUE

N/A

Verifies that focus is on the specified list applet.

SIS Account List Applet|NULL

FALSE

N/A

Verifies that focus is not on the specified list applet.

SIS Account List Applet|Row Status|2

TRUE

N/A

Verifies that focus is on the specified field in the list applet.

SIS Account Entry Applet|Name

TRUE

N/A

Verifies that focus is on the specified field in the form applet.

SIS Account Entry Applet|Name

FALSE

N/A

Verifies that focus is not on the specified field in the form applet.

SIS Account List Applet|2

TRUE

N/A

Verifies that focus is on the specified row number in the list applet.

SIS Account List Applet|2

FALSE

N/A

Verifies that focus is not on the specified row number in the list applet.

SIS Account List Applet|2,3

TRUE

N/A

Verifies that focus is on the specified row numbers in the list applet.

Search Admin|NULL

TRUE

N/A

Verifies that focus is on the specified view.

Menu-File|Null

TRUE

N/A

Verifies that focus is on the application-level menu.

Menu-File|Null

FALSE

N/A

Verifies that focus on the application-level menu.

Menu-File|File - Custom Print

TRUE

N/A

Verifies that focus is on the application-level menu item.

Menu-File|File - Custom Print

FALSE

N/A

Verifies that focus is on the application-level menu item.

Mobile Examples

The following table describes how to use the VerifyFocus keyword to verify the focus location in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Account Entry Applet - Mobile|Name

TRUE

N/A

Verifies that focus is on the specified field in the form applet.

SHCE Sales Account List Applet - Mobile|NULL

TRUE

N/A

Verifies that focus is on the specified list applet.

SHCE Sales Account List Applet - Mobile|Name|1

TRUE

N/A

Verifies that focus is on the specified field in the list applet.

SHCE Sales Account List Applet - Mobile|1

TRUE

Verifies that focus is on the specified row number in the list applet.

VerifyInPicklist

You use the VerifyInPicklist keyword to count the number of items in a drop-down list, auto select using the substring, and verify whether the values exist or not in the drop-down list without selecting the values.

Signature

The VerifyInPicklist keyword supports the following signature:

VerifyInPicklist(AppletRN|FieldRN|[RowNum],Count:operator,value(or) Variable;True/
False [AutoSelect]: [Exists]: value or variable; True/false)

Desktop Examples

The following table describes how to use the VerifyInPicklist keyword to verify the values in a drop-down list in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Type|1

Count;=;118|True

N/A

Verifies that all values (118) are present in the Type drop-down list.

SIS Account List Applet|Type|1

AutoSelect;contains;ac|TRUE

N/A

Verifies that there are values that contain the keyword ac.

SIS Account List Applet|Type|1

Exists;=;Customer123|True

N/A

Verifies whether a value exists or not.

Opportunity Form Applet - Child|SalesStage2

AutoSelect;starts;App|TRUE

N/A

Verifies that there are values that start with App.

SIS Account List Applet|Type|1

Exists;=;@var|True

N/A

Verifies whether a variable value exists or not.

Mobile Examples

Verifies the color of the picklist value.

Cfg Cx Runtime Instance Frame (JS HI)|RF1060
_Accessory_DOMAINSELECT 
color:RED;=;RF1060_Packof10Zip Disks|TRUE 
Packof10Zip Disks|TRUE

Verifies that the items in the Accessories pick list are showing up in (the color) RED.

VerifyObject

You use the VerifyObject keyword to verify the presence of an object or UI name in applications.

Signature

The VerifyObject keyword supports the following signature:

VerifyObject(AppletRN|FieldRN/MenuItemRN,UN name/data-caption of MenuItem/Inner 
Text or Title for field items/NULL; TRUE/FALSE)

Note the following in the VerifyObject keyword signature:

  • Use NULL as the input to verify the existence of an object

  • Use the object label (for example, the name of a button) as the input to verify the object name.

  • Use the menu item label as the input to verify the menu item name.

  • Use the field label as the input to verify the field name or title.

  • True or False input is mandatory.

  • If the True parameter is set and if the expected object does not match the actual object in the UI, then the test step fails.

  • If the True parameter is set and if the expected object matches the actual object in the UI, then the test step passes.

  • If the False parameter is set and if the expected object does not match the actual object in the UI, then the test step passes.

  • If the False parameter is set and if the expected object matches the actual object in the UI, then test the step fails.

Note: True/False is case insensitive.

Desktop Examples

The following table describes how to use the VerifyObject keyword to verify the presence of an object or UI name in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|NULL

NULL;TRUE

N/A

Verifies the existence of an applet.

NULL|SUI_OPEN_TOOLBAR

NULL;TRUE

N/A

Verifies that the toolbar is open.

NULL|SUI_CLOSED_TOOLBAR

NULL;TRUE

N/A

Verifies that the toolbar is open.

SIS Account List Applet|SiebVisList

All Accounts Across Organizations;TRUE

N/A

Verifies that the item exists in the Visibility list in the list applet.

SIS Account List Applet|DeleteRecord

NULL;TRUE

N/A

Verifies that the Delete button exists in the list applet.

SIS Account List Applet|DeleteRecord

Delete;TRUE

N/A

Verifies that the Delete button UI name exists in the list applet.

SIS Account Entry Applet|DeleteRecord

NULL;TRUE

N/A

Verifies that the Delete button exists in the form applet.

SIS Account List Applet|NewQuery

NULL;TRUE

N/A

Checks that the NewQuery button exists in the list applet.

SIS Account List Applet|Type

Account Type;TRUE

N/A

Checks that the Column Account Type exists in the list applet.

SIS Account List Applet|QueryComboBox

NULL;TRUE

N/A

Verifies that the QueryComboBox drop-down list exists in the list applet.

SIS Account List Applet|About Record (SWE)

About Record [Ctrl+Alt+K];TRUE

N/A

Verifies that the menu item About Record (SWE) exists in the list applet.

SIS Account List Applet|Account Type Code|1

Customer;TRUE

N/A

Checks the title of the Account Type Code field with the row number in the list applet.

Menu-File|File - Create Bookmark

Create Bookmark…;TRUE

N/A

Verifies that the application menu item Create Bookmark exists in the file menu.

NULL|SWE Export Applet.rdbRowsToExport

All Rows In Current Query;TRUE

N/A

Verifies that the Radio button exists in the pop-up.

NULL|Account List View|L2

Accounts List;TRUE

N/A

Verifies that the application links exist.

SIS Account List Applet|DeleteRecord

Delete;FALSE

N/A

Verifies the absence of the Delete button UI name in the list applet (negative scenario).

Mobile Examples

The following table describes how to use the VerifyObject keyword to verify the presence of an object or UI name in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

AppletRN|FieldRN

FieldUN;TRUE/FALSE

N/A

Verifies the UI name of the field.

SHCE Sales Account List Applet - Mobile|NewQuery

Query;TRUE

N/A

Verifies that the Query button exists in the list applet.

SHCE Sales Account List Applet - Mobile|QuerySrchSpec

Accounts;TRUE

N/A

Verifies that items exist in the QuerySearch text box in the list applet.

SHCE Sales Account List Applet - Mobile|DeleteRecord

Delete;TRUE

N/A

Verifies that the Delete button UI name exists in the list applet.

SHCE Sales Account List Applet - Mobile|QueryComboBox

NULL;TRUE

N/A

Verifies that the QueryComboBox drop-down list exists in the list applet.

SHCE Sales Account List Applet - Mobile|Type|1

Customer;TRUE

N/A

Checks the title of the Account Type Code field with the row number in the list applet.

NULL|Account List View

Accounts List;TRUE

N/A

Verifies that the application links exist.

VerifyRecordCount

You use the VerifyRecordCount keyword to verify the number of records (the record count) in a list applet.

Signature

The VerifyRecordCount keyword supports the following signature:

VerifyRecordCount(AppletRN|Rn of record count from the list/Form applet menu/
NULL,Operator,Value(or)@Variable)

Note the following about the VerifyRecordCount keyword signature:

  • The following operators are supported: greater than (>), greater than or equal to (>=), less than (<), less than or equal to (<=), equals (<>).

  • If using NULL, then the record count is verified in a pop-up window or applet that does not have an applet menu.

Desktop Examples

The following table describes how to use the VerifyRecordCount keyword to verify the number of records in a list applet in desktop applications.

Target Object Inputs Closing Action Comments

SIS Account List Applet|Record Count (SWE)

>=,6

N/A

Verifies if the count is greater than or equal to 6.

SIS Account List Applet|Record Count (SWE)

<=,6

N/A

Verifies if record count is less than or equal to 6.

SIS Account List Applet|Record Count (SWE)

<>,6

N/A

Verifies if the record count with less than or greater than 6.

SIS Account List Applet|Record Count (SWE)

< ,6

N/A

Verifies the record count is less than 6.

SIS Account List Applet|Record Count (SWE)

> ,6

N/A

Verifies if the record count is greater than 6.

SIS Account List Applet|Record Count (SWE)

> =,@var

N/A

Verifies if the record count is greater than or equal to any variable.

SIS Account List Applet|NULL

> =,2

N/A

Verifies if the record count is greater than or equal to 2.

Mobile Examples

The following table describes how to use the VerifyRecordCount keyword to verify the number of rcords in a list applet in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|Record Count (SWE)

>,6

N/A

Verifies if the record count is greater than or equal to 6.

SHCE Sales Account List Applet - Mobile|Record Count (SWE)

<,@var

N/A

Verifies if the record count is less than any variable.

SHCE Sales Account List Applet - Mobile|NULL

<,2

N/A

Verifies if the record count is less than 2.

VerifyState

You use the VerifyState keyword to verify the state of an object.

Signatures

The VerifyState keyword supports the following signatures:

VerifyState(AppletRN|FieldRN|[RowNum] ,TRUE/FALSE)
VerifyState(AppletRN|MenuButtonRN|MenuItemRN ,TRUE)
VerifyState(ApplicationLevelMenuRN|ApplicationLevelMenuItemRN,TRUE)

Note the following about the VerifyState keyword signature:

  • If an object is enabled, editable, or drillable, then verification is True.

  • If an object is disabled or read only, then verification is False.

  • You can verify the state of most objects, including the following: button, text, check box, drop-down list, menu item, application-level menu items.

Desktop Examples

The following table describes how to use the VerifyState keyword to verify the state of an object in desktop applications.

Target Object Inputs Closing Action Comments

SIS Product Form Applet - ISS Admin|NewRecord

TRUE

N/A

Verifies whether the button state is enabled or disabled.

SIS Product List Admin Applet|Billable Flag|3

FALSE

N/A

Verifies whether the check box field is enabled or disabled.

SIS Product Form Applet - ISS Admin|SiebAppletMenu|New Record (SWE)

TRUE

N/A

Verifies the state of menu item in the form applet.

Menu-Query|Query - QueryAssist

FALSE

N/A

Verifies the state of application level menu items.

NULL|Tree

TRUE

N/A

Verifies the state of the application.

NULL|Tab

TRUE

N/A

Verifies the state of the application.

NULL|Side Menu

TRUE

N/A

Verifies the state of the application.

Mobile Examples

The following table describes how to use the VerifyState keyword to verify the state of an object in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|QuerySrchSpec

TRUE

N/A

Verifies the state of the variable and stores the value in @var.

SHCE Sales Account List Applet - Mobile|SiebAppletMenu|Record Count (SWE)

TRUE

N/A

Verifies the state of the menu item.

VerifyTopNotification

You use the VerifyTopNotification keyword to verify whether or not a notification message appears in the application. The keyword also verifies the color of the notification.

Signature

The VerifyTopNotification keyword supports the following signature:

VerifyTopNotification((MessagebroadcastRN,Expectedmessage|[ExpectedHeader];Color|E
xpectedd Color/NULL|Match/NoMatch,Close/KeepOpen))
Note: You must click the Marl All as Read option before using the click operation on any notification message. VerifyTopNotication checks for the message in the notification list for up to ten iterations (with an interval of one minute between iterations).

Desktop Examples

The following table describes how to use the VerifyTopNotification keyword to verify whether or not a notification message appears in desktop applications.

Target Object Inputs Closing Action Comments

MsgBrdCstIcon

Account_10142015_041 155918;NULL;Match

Close

Verifies whether or not the top unread message appears in the notification list, and closes the control.

MsgBrdCstIcon

Account_10142015_041 155918;NULL;NoMatch

Close

Verifies whether or not the top unread message appears in the notification list, and closes the control.

MsgBrdCstIcon

Account_10142015_041 155918;Color|Red;Match

Close

Verifies whether the color of the top unread message in the notification list matches the input value, and closes the control.

MsgBrdCstIcon

Account_10142015_041 155918;Color|Red;Match

KeepOpen

Verifies whether the color of the top unread message in the notification list matches the input value, and keeps the control open.

MsgBrdCstIcon

SVP Action|populate Actions;NULL;Match

Close

Verifies whether the top unread message in the notification list matches the input value, and closes the control.

Mobile Examples

The following table describes how to use the VerifyTopNotification keyword to verify whether or not a notification message appears in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

MsgBrdCstIcon

Data synchronization notification|Data is ready for download;NULL;Match

Close

Verifies whether or not the top unread message appears in the notification list, before going offline and closing the control.

VerifyValue

You use the VerifyValue keyword to verify a field value by comparing the field value with a user variable (input value).

Signature

The VerifyValue keyword supports the following signature:

VerifyValue(AppletRN|FieldRN|[RowNum]/[Active_Record],Operator,Value(or)@Variable)

Note the following about the VerifyValue keyword signature:

  • If performing the action on tile applets, then the tile index and row number must start with one.

  • The row number is optional. If RowNum is not specified, then RowNum defaults to the first row.

  • The following operators are supported: greater than (>), greater than or equal to (>=), less than (<), less than or equal to (<=), not equals (<>), contains, startswith, endswith, LIKE, etc.

Desktop Examples

The following table describes how to use the VerifyValue keyword to verify a field value by comparing the field value with a user variable (input value) in desktop applications.

Target Object Inputs Closing Action Comments

Contact List Applet|StartDate

=,Today

N/A

Verifies the field value by comparing it with the input value.

Opportunity List Applet|Committed

=,Y

N/A

Verifies the check box field value by comparing it with the input value.

Contact List Applet|M/M|2

=,Mr.

N/A

Verifies the field value by comparing it with the input value.

SIS Account List Applet|Name

=,@Var1

N/A

Verifies the field value by comparing it with the input value.

SIS Account List Applet|Name|2

=,@Var1

N/A

Verifies the field value by comparing it with the input value.

Contact List Applet|Last Name

startswith,Ab

N/A

Verifies the field value by comparing it with the input value, starts with Ab.

SIS Account List Applet|Name

<>,A*

N/A

Verifies the field value by comparing it with the input value, not equal to A.

Opportunity List Applet|Name

=,LIKE Q*

N/A

Verifies the field value by comparing it with the input value.

Opportunity List Applet|Name

<>,"Q*

N/A

"Verifies the field value by comparing it with the input value.

Mobile Examples

The following table describes how to use the VerifyValue keyword to verify a field value by comparing the field value with a user variable (input value) in mobile applications (on mobile devices).

Target Object Inputs Closing Action Comments

SHCE Sales Account List Applet - Mobile|Name|4

=,AG Edwards & Sons, Inc

N/A

Verifies the field value by comparing it with the input value.

SHCE Sales Account List Applet - Mobile|Name

=,@accountname

N/A

Verifies the field value by comparing it with the input value.

SHCE Sales Account List Applet - Mobile|Name

startswith,Ab

N/A

Verifies the field value by comparing it with the input value, starts with Ab.

SHCE Sales Account List Applet - Mobile|Name

=,A

N/A

Verifies the field value by comparing it with the input value, not equal to A.

Wait

You use the Wait keyword to allow the application to remain idle for the user specified time.

Signatures

The Wait keyword supports the following signature:

wait(seconds)

Desktop Examples

The following table describes how to use the Wait keyword in desktop applications.

Target Object Inputs Closing Action Comments

N/A

10

N/A

Application remains idle for 10 seconds.

Mobile Examples

The following table describes how to use the Wait keyword in mobile applications.

Target Object Inputs Closing Action Comments

N/A

10

N/A

Application remains idle for 10 seconds.

Keywords Supporting Tools and Server Configuration

The following keywords support Siebel Tools and Siebel Server configuration for mobile application:

The following prerequisites are requried to use these keywords:

  • Strawberry Perl must be installed and setup.

  • Strawberry Perl must be installed on client machines.

InvokePerl

You use the InvokePerl keyword to execute a Perl file.

  • Signature supported:

    InvokePerl (Select Machine|scriptname.pl:@VAR/String[String1,String2....N]/NULL|Output Variable)

    • Select Machine : SiebelServer machine or TestHarness machine. Siebel Server reads the server credentials from the xml file and executes the Perl file on server machine.

    • TestHarness Machine : Executes the perl file locally.

    • Scriptname.pl : Perl script to be executed.

    • @VAR/String[String1,String2....N : Variable support or strings to be passed to the perl file.

    • @Output Variable : Variable support to get the value from the perl file.

    Note: You should declare a PerlExecStatus variable in the Perl file. Separate all string inputs by commas to InvokePerl resolves to ARGV[1] in your perl program. Comma separated inputs in your program are parsed, if multiple strings are expected.
  • Include PerlExecStatus at the end of the Perl File (as shown in the following example).

    print"PerlExecStatus = $PerlExecStatus";
  • To save a value into a variable, use the following syntax in the perl file:

    print"\@invokePerl1=$ARGV[1]."; 
    print"\@invokePerl2=$ARGV[0]."; 
    print"perlexecstatus = $PerlExecStatus";
  • Prerequisites:

    Folder Structure: All user defined perl files and cmd.txt for execution should be placed in the Resources/invokePerl folder in TestHarness.

    The exe files folder should be placed in the framework\exe in TestHarness.

  • Update the following tags in config.xml:

    SIEBEL-SERVER-NAME=macihne-name ----SERVER_MACHINE will be passed as $ARGV [0] to the perl file
    SIEBEL-SERVER-MACHINE-LOGIN-ID=userid ----SERVER_LOGIN will be passed as $ARGV [1] to the perl file
    SIEBEL-SERVER-MACHINE-PASSWORD=pwd ----SERVER_LOGIN will be passed as $ARGV [2] to the perl file
    SIEBEL-SERVER-OS-TYPE=WINDOWS ----SERVER_OS_TYPE will be passed as $ARGV [3] to the perl file
    SERVER-DB-TYPE=MSSQL ----SERVER_DB_TYPE will be passed as $ARGV [4] to the perl file
    SERVER_DB_NAME=dbname ----SERVER_DB_NAME will be passed as $ARGV [5] to the perl file
    DBSERVER-AND-PORT=dbserver,port ----DBSERVER_AND_PORT will be passed as $ARGV [6] to the perl file
    DB-TABLE-OWNER=XYZ ----DB_TABLE_OWNER will be passed as $ARGV [7] to the perl file
    DB-SERVER-LOGIN=SADMIN|MSSQL ----DBSERVER_Login will be passed as $ARGV [8]&& $ARGV [9] to the perl file
    TEST-MACHINE-NAME=machinename ----CLIENT_MACHINE will be passed as $ARGV [10] to the perl file
    ----------- ----TestHarness Path $ARGV[11] 
    SIEBEL-GATEWAY-PORT=servername:port ----ENTSERVER_AND_PORT will be passed as $ARGV[12] 
    SERVER-INSTALLATION-PATH ----C:\\23044\\ses\\siebsrvr\\BIN ----SERVER INSTALLATION PATH will be passed as $ARGV[13]
    ------------- ----Exefiles folder location will be passed as $ARGV[14] 
    Variable passed from script ----Will be passed as $ARGV[15] 
    [PERL-PATH]
    Ex: PERL-PATH= \\\\servername\\install\\PERL_UTILS\\Perl1\\bin\\perl.exe

Examples in the following table show how to use the InvokePerl keyword.

Keyword Target Object Inputs Closing Action

InvokePerl

N/A

SiebelServer Machine;test.pl:NULL;NULL

N/A

InvokePerl

N/A

SiebelServer Machine;test.pl:value1,value2;NULL

N/A

InvokePerl

N/A

SiebelServer Machine;test.pl:value1;NULL

N/A

InvokePerl

N/A

SiebelServer Machine;test.pl:value1,@invokePerl;NULL

N/A

InvokePerl

N/A

SiebelServer Machine;test.pl:@invokePerl;NULL

N/A

InvokePerl

N/A

SiebelServer Machine;test.pl:@invokePerl,@invokePerl;NULL

N/A

InvokePerl

N/A

SiebelServer Machine;test.pl:@invokePerl,@invokePerl;@invokePerl1

N/A

InvokePerl

N/A

SiebelServer Machine;test.pl:@invokePerl,@invokePerl;@invokePerl1,@invokePerl2

N/A

InvokePerl

N/A

TestHarness Machine;test.pl:NULL;NULL

N/A

InvokePerl

N/A

TestHarness Machine;test.pl:value1,value2;NULL

N/A

InvokePerl

N/A

TestHarness Machine;test.pl:value1,@invokePerl;NULL

N/A

InvokePerl

N/A

TestHarness Machine;test.pl:@invokePerl,@invokePerl;@invokePerl1

N/A

InvokePerl

N/A

TestHarness Machine;test.pl:@invokePerl,@invokePerl;@invokePerl1,@invokePerl2

N/A

ToolsConfig

You use ToolsConfig keyword to apply Siebel customizations by importing pre-exported sif files using Web tools.

  • Signature supported:

    ToolsConfig(Sif1,Sif2|Merge/Overwrite|branch$,workspace$)

  • Sif files must be copied to the SiebelTestAutomation\Resources\toolsconfig folder.

  • Resources files must be zipped and attached to the Master Suite attachment applet.

  • STE run will copy the Resources.zip to the client machine and unzip the file during execution.

  • ToolsConfig is a composite keyword which covers the following functionalities:

    • Create an Integration branch using Webtools.

    • Create a Workspace under the newly created branch using Webtools.

    • Import the SIF files through CLI.

    • Create a Checkpoint, Submit, and Deliver using Webtools.

  • After completing an operation using the toolsconfig keyword, you can execute change_branch.txt with server restart using the serverconfig keyword to change the application branch. The command in change_branch.txt is shown in the following example.

    Example - for callcenter application:

    change param WorkspaceBranchName=int_branch for comp SCCObjMgr_enu

    Update the following tags in config.xml:

     PERL-PATH
    SERVER-INSTALLATION-PATH
    SIEBEL-TOOLS-MACHINE
    SIEBEL-TOOLS-PATH
    SIEBEL-TOOLS-USER-NAME
    SIEBEL-TOOLS-PASSWORD
    DSN-NAME
    DATABASE-USERID
    DATABASE-PASSWORD
    [PERL-PATH]
    Ex: PERL-PATH= \\slcnas607\\karta\\ATF_QTP\\Perl\\bin\\perl.exe
  • Toolsconfig Revert option: Once you complete the Testing in the Integration branch, to change the application from Integration branch to MAIN branch, you can execute a command in the server manager using the serverconfig keyword.

    Example - for Call Center application :

    "change param WorkspaceBranchName=MAIN for comp SCCObjMgr_enu"#

    change_branch.txt file:

    change_branch.txt file will have the command to change the application from MAIN branch to Integration branch.
    Note: Here the txt file name should be change_branch. This is mandatory.

Examples in the following table show how to use the ToolsConfig keyword.

Keyword Target Object Inputs Closing Action Comments

ToolsConfig

N/A

RTC.sif|Merge|branch$,workspace$

N/A

Importing and compiling single sif file.

ToolsConfig

N/A

RTC.sif ,RTC1.sif,RTC2.sif|Overwrite|branch$,workspace$

N/A

Importing and compiling multiple sif file.

ServerConfig

You use the ServerConfig keyword to configure and start0 the Siebel server.

  • Signature supported:

    ServerConfig(Y)

    ServerConfig(commandsFile.txt)

    Note: If the Launch keyword is used after ServerConfig, then use clear browser in the launch.

    SERVER : Machine where Siebel server is running. Machine details are available in the SERVER-LOGIN-CREDENTIAL tag, which is in config.xml.

    commandsFile.txt : Text file containing the list of commands to be executed in server manager.

  • Prerequisite:

    Folder Structure: All perl files related to the serverconfig keyword should be available in the framework\perl folder in Test Harness

  • ServerConfig is a composite keyword which includes the following:

    • Launch server manager

    • Command to be executed

    • Stop ses/swsm

    • Stop sieb server

    • Start ses/swsm

    • Start sieb server

  • Update the following tags in config.xml

    [PERL-PATH]
    Ex: PERL-PATH= \\slcnas607\\karta\\ATF_QTP\\Perl\\bin\\perl.exe 
    SERVER-OS-TYPE
    SERVER-LOGIN-CREDENTIAL
    AI-SERVER-PORT
    SERVER-HOME-PATH
    GATEWAYSERVER-TSLPORT

Examples in the following table show how to use the ServerConfig keyword.

Keyword Target Object Inputs Closing Action Comments

ServerConfig

N/A

Y;NULL;IPH3

N/A

Bounce the SERVER.

ServerConfig

N/A

N;cmd.txt;IPH3

N/A

Connect to server manager ,execute the commands in cmd.txt file.

ServerConfig

N/A

Y;cmd.txt;IPH3

N/A

Connect to server manager ,execute the commands in cmd.txt file and bounce the SERVER.

Unsupported Keywords for Siebel Open UI Keyword Automation

The following keywords are not supported for Siebel Open UI keyword automation testing.

  • Calendar(Change slot of Call/Activity)

  • Dispatch Board

  • Intelligent Advisor

  • Find Result Pane

  • Search Result Pane

  • Charts

  • Promotion Designer

  • Gantt (Diary)

  • Task Pane items

  • Gantt Chart - Promotion List

  • Script recorded in any language for e.g. DEU - can be play backed in same language i.e. in DEU

  • Script recorded in ENU language – can’t be play backed in any other NON ENU language like DEU, JPN etc.

You can make a note of the different scenarios and the corresponding values to be entered in the resource.xml file.

Note: The different scenarios and values listed in the following table are applicable only for NON ENU languages.

S.No. Scenario where Resource file needs to be updated Value needs to be updated in Resource File

1

Column Display (Hide, Show, MovingUP, MovingDown

Selected Field Value should be entered Resource File

2

Verify the Error/Warning message

Error/Warning message in NONENU Language

3

Toggle Value

Selected Togglevalues should be entered in NONENU languages

4

Verify Short Date

Short Date in correspending NONENU language format

5

Verify Long Date

Long Date in correspending NONENU language format

6

Verify Date Time

Date Time in correspending NONENU language format

7

Verify Value - Numeric

Numeric value should be entered in correspending NONENU language format

8

Verify Value - String

Translated string value

9

Verify Value - DateTime/Date

Date Time in correspending NONENU language format should be entered

10

Any string value present in Combo box

Data LIC value should be entered

11

Visibilty DropDown value

Translated value of visibilty dropdown should be entered

12

Verifies Button Existence/Absence

Translated name of the button should be entered

13

Verifies Column name Existence/Absence

Translated name of the column should be entered

14

Verifies Menu Item Existence/Absence

Translated name of the MenuItem should be entered

15

Verifies Existence/Absence of Label of any field

Translated name of the Label should be entered

16

Verifies the Presence/Absence of RadioButton on the Popup

Translated value of radio button label should be entered

17

Compare strings values

Translated string value should be entered

18

Compare numeric values

Numeric value should be entered in correspending NONENU language format

19

Compare date/DateTime values

Date/DateTime value should be entered in correspending NONENU language format

20

Picklist applet -if any combo box value need to be selected

Data LIC value should be entered

21

MVG applet -if any combo box value need to be selected

Data LIC value should be entered

22

Application level Menu Item verification

Translated name of the MenuItem should be entered

23

Selection of Radio button in export and import

Labels translated value should be entered

24

Selection of Radio button in Advance Sort

LIC values of dropdown should be entered

25

In simple query - query with any combo box value

Data LIC value should be entered for query combo box

26

Verify the Application level Menu Enable/Disable

Translated value of Application level menu should be entered

27

Verify the Applet level Menu Enable/Disable

Translated value of Applet level menu should be entered

28

Verify Label in any form applet

Translated value of Label should be entered in File

29

Verify applet level record count (1 - 30 of 30+)

Transalated Record count value should entered in file

30

Applet level search option

Data LIC value for combo box value should be entered