Wait Terminal

Description

Causes Workflow 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 Workflow. 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 Workflow 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.

Declaration

<AMWAITFORTERMTEXT SESSION="Text" TIMEOUT="Number" MEASURE="Text [options]"  USECASE="yes/no" USERE="yes/no" TYPE="Text [options]" FOUNDTEXTVARIABLE="Text" ROW="Text" COLUMN="Text"</AMWAITFORTERMTEXT>

Example

<AMWAITFORTERMTEXT SESSION="TermSess2" TIMEOUT="500" FOUNDTEXTVARIABLE="TextVariable" TYPE="TEXT">Process complete</AMWAITFORTERMTEXT>

General Tab Parameters

Wait for: 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

Text [options], Optional - Default "Text to appear"
MARKUP: TYPE="BLANKSCREEN"

Text: 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.

Text, Required if Text to appear or Text to disappear is selected
MARKUP: >Text to search for

Regular expression: 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.

Yes/No, Optional - default "no"
MARKUP: USERE="YES"

Cursor row: Specifies the row number for the cursor position.

Text, Required if Cursor move to or Cursor move out of is selected
MARKUP: ROW="1"

Cursor column: Specifies the column number for the cursor position.

Text, Required if Cursor move to or Cursor move out of is selected
MARKUP:  COLUMN="2"

Timeout: Specifies the number of milliseconds, seconds, minutes, or hours to wait before failing the step.

Number, optional - default 5000 milliseconds
MARKUP: TIMEOUT="5" MEASURE="seconds"

Session name: 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.

Text, Optional - Default "TermSess1"
MARKUP: SESSION="TermSess2"

Advanced Tab Parameters

Populate variable with found text: Specifies a variable in which to place the text found. Valid only if Text to appear or Screen to contain text is selected.

Text [variable name], Optional
MARKUP: FOUNDTEXTVARIABLE="VariableName"