Search…
⌃K

Mainframe Keywords

Keyword: CLOSEMAINFRAME

Description: This keyword or action instructs ICE 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: for IBM Host On-Demand input must have complete emulator-window title.
In the above example after the test case debug, the execution result that is either “True/ False” will be stored in the {Output} variable.

Keyword: CONNECTSESSION

Description: This keyword or action instructs ICE 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.

Keyword: DISCONNECTSESSION

Description: This keyword or action instructs ICE 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.

Keyword: GETTEXT

Description: This keyword or action specifies the tool to fetch the text at 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).

Keyword: LAUNCHMAINFRAME

Description: This keyword or action instructs ICE to launch 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.

Keyword: SENDFUNCTIONKEYS

Description: This keyword or action instructs ICE 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.

Keyword: SENDSECUREVALUE

Description: This keyword or action instructs ICE to enter a secured value (AES encrypted) to 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.

Keyword: SENDVALUE

Description: This keyword or action instructs ICE 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.

Keyword: SETCURSOR

Description: This keyword or action instructs ICE to set 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.

Keyword: SETSECURETEXT

Description: This keyword or action instructs ICE 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.

Keyword: SETTEXT

Description: This keyword or action instructs ICE 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.

Keyword: VERIFYTEXTEXISTS

Description: This keyword or action instructs ICE 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.

Keyword: JOBSTATUS

Description: This keyword or action instructs ICE 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 debug, 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”.

Keyword: LOGOFF

Description: This keyword or action instructs ICE to log off from the Mainframe by performing one of the following actions:

Number Functions:

  1. 1.
    Prints the data set and Logoff. (Not recommended)
  2. 2.
    Delete the dataset and Logoff.
  3. 3.
    Keep the existing dataset and Logoff.
  4. 4.
    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.

Keyword: LOGIN

Description: This keyword or action instructs ICE to login 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.

Keyword: SECURELOGIN

Description: This keyword or action instructs ICE to login 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.

Keyword: SUBMITJOB

Description: This keyword or action instructs ICE 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”.