AUTOMATION ANYWHERE

MetaBot – SAP DLL Functions

This Document covers the description of SAP MetaBot DLL functions used while working on the Automation Anywhere MetaBot application.
 MetaBot – SAP DLL Functions

Contents
Function 1: LoginWithNewSession..................................................................................................................................... 2
Function 2: LoginOnExistingSession ................................................................................................................................. 3
Function 3: SearchObjectByLocation................................................................................................................................. 4
Function 4: SeachObjectByID ............................................................................................................................................. 5
Function 5: SearchObjctByName ....................................................................................................................................... 6
Function 6: ExecuteLeftClick ............................................................................................................................................... 7
Function 7: ExecuteRightClick ............................................................................................................................................ 8
Function 8: ExecuteDoubleClick ......................................................................................................................................... 9
Function 9: ExecutePressButton ...................................................................................................................................... 10
Function 10: ExecuteClick ................................................................................................................................................. 11
Function 11: ExecuteSelectAction .................................................................................................................................... 12
Function 12: ExecuteSetTextAction ................................................................................................................................. 13
Function 13: ExpandNode ................................................................................................................................................. 14
Function 14: SelectNode.................................................................................................................................................... 15
Function 15: GetTotalRows ............................................................................................................................................... 16
Function 16: GetTotalColumns ......................................................................................................................................... 17
Function 17: SetSelectall ................................................................................................................................................... 18
Function 18: ExtractTableData ......................................................................................................................................... 19
Function 19: ExecuteGetTextAction................................................................................................................................. 20
Function 20: ExecuteEnterkey .......................................................................................................................................... 21
Function 21: SetFocus ....................................................................................................................................................... 22
Function 22: ExecuteMaximize ......................................................................................................................................... 23
Function 23: ExecuteKey ................................................................................................................................................... 24
Function 24: ExecuteCheckAction ................................................................................................................................... 25
Function 25: GetObjectFromPoint .................................................................................................................................... 26
Function 26: GetAllSAPObjectProperties ........................................................................................................................ 27
Function 27: GetSAPObjectProperties ............................................................................................................................ 28
Function 28: DisConnectSAPSession ............................................................................................................................. 29
Function 29: CloseAndDisConnectAllExistingSession .................................................................................................. 30

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 1
 MetaBot – SAP DLL Functions

Function 1: LoginWithNewSession

Function Details: Create new session and login into

SAP GUI using provided login credentials

Return Type: String

Parameters:

Name Type Details

sapDescription String Logon Connection Name

strClient String Client number configure on

SAP server

userName String Username to login into SAP

GUI

password String Password to login into SAP

GUI

LogonLang String Logon Default Language

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 2
 MetaBot – SAP DLL Functions

Function 2: LoginOnExistingSession

Function Details: Login into the existing open

connection

Return Type: String

Parameters:

Name Type Details

ConnectionSessionIndex int connection

session index,
session start from
0

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 3
 MetaBot – SAP DLL Functions

Function 3: SearchObjectByLocation

Function Details: Search SAP object based on location

(e.g. left, top)

Return Type: String

Parameters:

Name Type Details

Obj_Left int Left value of object

Obj_Top int Top value of object

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 4
 MetaBot – SAP DLL Functions

Function 4: SeachObjectByID

Function Details: Search SAP GUI object based on ID

Return Type: String

Parameters:

Name Type Details

SAPGUIId String SAP GUI ID which user want to

search the object

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 5
 MetaBot – SAP DLL Functions

Function 5: SearchObjctByName

Function Details: Search SAP GUI object based on

object name and type (e.g. Tree, Combobox, Textbox)

Return Type: String

Parameters:

Name Type Details

SAPGUIName String Name of an object

SAPGUIType Type of an object (e.g.

String
Textbox, Radio button)

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 6
 MetaBot – SAP DLL Functions

Function 6: ExecuteLeftClick

Function Details: Execute left-click action on Output when left click is performed:
the searched object

Return Type: Bool

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 7
 MetaBot – SAP DLL Functions

Function 7: ExecuteRightClick

Function Details: Execute right-click action on Output when right click is performed:
the searched object

Return Type: Bool

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 8
 MetaBot – SAP DLL Functions

Function 8: ExecuteDoubleClick

Function Details: Execute double-click action Output when double-click is performed on the object located
on the searched object by the function SearchObjectById():

Return Type: Bool

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 9
 MetaBot – SAP DLL Functions

Function 9: ExecutePressButton

Function Details: Execute press button action Output when press button action is performed:
on the searched object

Return Type: Bool

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 10
 MetaBot – SAP DLL Functions

Function 10: ExecuteClick

Function Details: Execute click action on the Output when click is performed:
searched object

Return Type: Bool

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 11
 MetaBot – SAP DLL Functions

Function 11: ExecuteSelectAction

Function Details: Execute select action on the Output when select action is performed:
searched Combo-Box or list view control based
on Index

Return Type: Bool

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 12
 MetaBot – SAP DLL Functions

Function 12: ExecuteSetTextAction

Function Details: Execute Set Text action on the

searched Text-Box control

Return Type: Bool

Parameters:

Name Type Details

Textvalue String Text to set into the textbox

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 13
 MetaBot – SAP DLL Functions

Function 13: ExpandNode

Function Details: Expand a node from the tree view For example:

Return Type: String

Parameters:

Name Type Details

NodePath String Enter node path (e.g. 2\1\4\1)

Use the ExpandNode function to expand the

highlighted “Logistic” node in the above image, and
enter the node value from the root.

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 14
 MetaBot – SAP DLL Functions

Function 14: SelectNode

Function Details: Select a node from the tree view For example:
Use the SelectNode function to select “Logistics
Return Type: String Execution” node after expanding “Logistics” node, and
enter the node value from the root.
Parameters:

Name Type Details

NodePath String Enter node path (e.g. 2\1\4\1)

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 15
 MetaBot – SAP DLL Functions

Function 15: GetTotalRows

Function Details: Get total rows of the table

Return Type: String

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 16
 MetaBot – SAP DLL Functions

Function 16: GetTotalColumns

Function Details: Get total columns of the table

Return Type: String

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 17
 MetaBot – SAP DLL Functions

Function 17: SetSelectall

Function Details: Select the entire Table Data

Return Type: String

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 18
 MetaBot – SAP DLL Functions

Function 18: ExtractTableData

Function Details: Extract table data into CSV file

Return Type: String

Parameters:

Name Type Details

CSVPath String CSV File path

RowTotal String Number of rows you want to

extract

ColumnTotal String Number of columns you want

to extract

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 19
 MetaBot – SAP DLL Functions

Function 19: ExecuteGetTextAction

Function Details: Get text value for the searched GUI Control

Return Type: String

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 20
 MetaBot – SAP DLL Functions

Function 20: ExecuteEnterkey

Function Details: Execute SAP submit action

Return Type: String

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 21
 MetaBot – SAP DLL Functions

Function 21: SetFocus

Function Details: Set focus on the SAP GUI Object

Return Type: String

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 22
 MetaBot – SAP DLL Functions

Function 22: ExecuteMaximize

Function Details: Maximize the SAP window

Return Type: String

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 23
 MetaBot – SAP DLL Functions

Function 23: ExecuteKey

Function Details: Execute key into the SAP Application

Return Type: String

Parameters:

Name Type Details

Key Int Key code which user want to

perform

Output when key action is performed:

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 24
 MetaBot – SAP DLL Functions

Function 24: ExecuteCheckAction

Function Details: Select check boxes or radio buttons True: Enter the value as 1
False: Enter the value as 0
Return Type: Bool

Parameters:

Name Type Details

SelValue Int 1 for True or 0 for False

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 25
 MetaBot – SAP DLL Functions

Function 25: GetObjectFromPoint

Function Details: Get SAP GUI object based on the

co-ordinates

Return Type: String

Parameters:

Name Type Details

X Int X co-ordinate

Y Int Y co-ordinate

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 26
 MetaBot – SAP DLL Functions

Function 26: GetAllSAPObjectProperties

Function Details: Collect all properties of the SAP Output when this function is performed:
GUI object

Return Type: String

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 27
 MetaBot – SAP DLL Functions

Function 27: GetSAPObjectProperties

Function Details: Collect specific object properties

value

Return Type: String

Parameters:

Name Type Details

ProerptyName String SAP Object Property name

which user wants to get.

Output when this function is performed (selected

object’s name is stored into variable):

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 28
 MetaBot – SAP DLL Functions

Function 28: DisConnectSAPSession

Function Details: Disconnect session from GUI Scripting

Return Type: Bool

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 29
 MetaBot – SAP DLL Functions

Function 29: CloseAndDisConnectAllExistingSession

Function Details: Close All Open SAPGUI Session and windows

Return Type: Bool

Note: No parameter required

633 River Oaks Parkway San Jose, CA 95134 (San Jose address) 30