Can run on: Windows

The Terminal Automation plugin depends on Windows-only host access components, so these steps require an agent running on Windows.

Terminal Automation: Get

Terminal Automation: Get step fetches the text from an X, Y position of a terminal.

Example:

To read the screen id, which on this host sits at row 1, column 72 and is 5 characters long, use one row:

X-POS = 1, Y-POS = 72, Length = 5, Output = screen_id, Maximum Delay (ms) = 5000

The step adds a new field called screen_id to the row, holding the text read from the screen, for example S5002.

Field Name	Description
Step Name	Name of the step. This name must be unique in a single workflow.

Input tab:

Field Name	Description
Input Fields:
X-POS	X-POS is the screen row, counted from the top, starting at 1. This is an integer. This field is mandatory.
Y-POS	Y-POS is the screen column, counted from the left, starting at 1. This field is an integer. This field is mandatory. Allowed value for X-POS, Y-POS is >0 and <= max row & column of the terminal. On a standard 24x80 screen, X-POS is 1 to 24 and Y-POS is 1 to 80. Note: many emulators show the cursor position as column/row, which is the opposite order. For example, tn5250 showing 025/001 means column 25, row 1, so you would enter X-POS = 1 and Y-POS = 25.
Length	Specify length of text to be retrieved. This field is mandatory. A positive integer is allowed for Length.
Output	Specify an output field name to hold the text retrieved. This is a string. This field is mandatory.
Maximum Delay (ms)	The longest the step waits for the terminal to be ready, in milliseconds. It is a maximum, not a fixed pause. The step continues as soon as the terminal is ready. If left blank, the plugin waits only 100 ms, which is usually too short for a real host. 5000 is a safe starting point. If the time runs out, the step returns an empty value for that row and continues.