Wait Terminal Action
<AMWAITFORTERMTEXT SESSION="Text" TIMEOUT="Number" MEASURE="Text [options]" USECASE="yes/no" USERE="yes/no" TYPE="Text [options]" FOUNDTEXTVARIABLE="Text" ROW="Text" COLUMN="Text"</AMWAITFORTERMTEXT>
Causes task execution to pause at the current line until the specified condition exists at the terminal.
Commonly used to wait for a condition that indicates the terminal is ready for the next step of the task. Waits for text, a blank screen, a default prompt, or a cursor position to exist in a terminal session. If the condition is met, the task continues. Otherwise it fails.
The terminal actions are used in lieu of terminal emulation software. Using the terminal actions, legacy systems can be automated in the background without the use of 3rd party software.
Specifies the condition to wait for.
Text to appear: wait for specific text to appear. Specify text in Text field.
Text to disappear: wait for specific text to disappear. Specify text in Text field.
Cursor moved to: wait for cursor to move to specified coordinates. Specify position in Row and Column fields.
Cursor moved out of: wait for cursor to move to out of specified coordinates. Specify position in Row and Column fields.
Screen to blank: wait for screen to be blank
Screen to contain text: wait for screen to contain any text
Default prompt: wait for default prompt as specified in the Default prompt parameter of the Connect Terminal step.
Specifies the text that is to appear or disappear. Only valid if Text to appear or Text to disappear is the selected Wait for option.
Specifies whether the Text parameter is a regular expression. If the option is no, the Text parameter contains literal text, if the option is yes, the Text parameter contains a regular expression.
Specifies the row number for the cursor position.
Specifies the column number for the cursor position.
Specifies the number of milliseconds, seconds, minutes, or hours to wait before failing the step.
Specifies the session name. This session name must have been previously created with a prior Connect Terminal step. This allows several connections to be active simultaneously. If you are only using one connection at a time, do not specify a value other than the default.
Specifies an already created variable in which to place the found text. Valid only if Text to appear or Screen to contain text is selected.
This action includes the Description tab for entering a custom step description.
More on setting custom step description
This action also includes the standard Error Causes and On Error failure handling options/tabs.
More on Error Handling Options
All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.
More on variables
More on expressions
More on the expression builder
NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.
<AMWAITFORTERMTEXT SESSION="TermSess2" TIMEOUT="500" FOUNDTEXTVARIABLE="TextVariable" TYPE="TEXT">Process complete</AMWAITFORTERMTEXT>