Mainframe Keywords
Last updated
Avo Assure
Avo Assure - User Guide v24.1
Last updated
Description: This keyword or action instructs Avo Assure Client to close the mainframe and any open mainframe API session.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
CloseMainframe
<Emulator-window (Optional)>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
Note: the input must have a complete emulator window title for IBM Host On-Demand.
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.
Description: This keyword or action instructs Avo Assure Client to connect to any open host session.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
ConnectSession
<ShortSessionID>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {ConnSession} variable.
Description: This keyword or action instructs Avo Assure Client to disconnect the session from a connected host.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
DisconnectSession
<N/A>
(Optional)
N/A
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {DisConnSession} variable.
Description: This keyword or action specifies the tool to fetch the text at a specified location.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
GetText
<Row Number>; <Column Number>; <length>
{Variable}; {Status}
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, {msg} variable will contain the text value fetched by the keyword. The execution result that is either “True/ False” will be stored in the second output variable (if specified).
Description: This keyword or action instructs Avo Assure Client to launch the mainframe through specified emulator “{emulator type}” present in specified {path}.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
LaunchMainframe
<Emulator Path>; <Emulator Type>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.
Description: This keyword or action instructs Avo Assure Client to perform key actions based on the specified key presses.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
SendFuntionKeys
<Function keys>; <Number>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.
Description: This keyword or action instructs Avo Assure Client to enter a secured value (AES encrypted) into the mainframe.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
SendSecureValue
<Encrypted value>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.
Description: This keyword or action instructs Avo Assure Client to send value to the mainframe.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
SendValue
<Input value>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.
Description: This keyword or action instructs Avo Assure Client to set the cursor to a specified location in the mainframe.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
SetCursor
<Row Number>; <Column Number>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.
Description: This keyword or action instructs Avo Assure Client to set secure text (AES Encrypted) to a specified location in the mainframe.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
SetSecureText
<Row Number>; <Column Number>; <Encrypted Text>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.
Description: This keyword or action instructs Avo Assure Client to set text to a specified location in the mainframe.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
SetText
<Row Number>; <Column Number>; <Input Text>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.
Description: This keyword or action instructs Avo Assure Client to verify if the text value specified is available in the mainframe emulator.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
VerifyTextExists
<Input value>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the {verifyexist} variable.
Description: This keyword or action instructs Avo Assure Client to fetch the status of the specified job.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
JobStatus
<Output variable of Submit Job>
{Variable}; {Status}
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, and PCOMM.
Find the snippet of the keyword below:
In the above example, after the test case debugs, the output variable will contain the status of the specified job, and the second output variable (if specified) will contain the execution status of the keyword, that is, either “True/ False”.
Description: This keyword or action instructs Avo Assure Client to log off from the Mainframe by performing one of the following actions:
Prints the data set and Logoff. (Not recommended)
Delete the dataset and Logoff.
Keep the existing dataset and Logoff.
Keep the new dataset and Logoff.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
LogOff
<Number (based on the number function)>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the selected number function action will be performed and the execution result that is either “True/False” will be stored in the output variable.
Description: This keyword or action instructs Avo Assure Client to log in to the Mainframe Region using userID and password.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
Login
<Region>; <UserID>; <Password>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the output variable.
Description: This keyword or action instructs Avo Assure Client to log in to the Mainframe Region using userID and encrypted password.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
SecureLogin
<Region>; <UserID>; <Encrypted_Password>
(Optional)
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the execution result that is either “True/ False” will be stored in the output variable.
Description: This keyword or action instructs Avo Assure Client to submit the specified job to the mainframe and stores the Job ID in the output variable.
Keyword
Input Syntax
Output Syntax
Supported Input Formats
SubmitJob
<Job Path>; <Member Name>
{Variable}; {Status}
Text
Static values
Dynamic variables
Note: Supported Emulators are Bluezone, EXTRA, Rumba, PCOMM, and HOD.
Find the snippet of the keyword below:
In the above example, after the test case debug, the specified job will be submitted, and the output variable will contain the Job ID. The second output variable (if specified) will contain the execution status of the keyword, that is, either “True/ False”.
