Skip to main content

Action: ExecuteShellCommand

Function: The action executes a shell command on the PLC device.

Call: Devices test driver

Tab: Configuration

Device name

Device in the open project whose shell is connected

tm_storefullobjectname.png: Copies the settings of an object, which is selected in the POUs tree or device tree, to the input field

_cds_icon_arrow_down.png: Opens a list box with suitable objects which are configured in the open project

Hint: You can also drag the settings of a selected object to the input field (Drag&Drop).

Command

The command to be executed

For more information about the shell command, see the help page of the PLC Shell tab.

Timeout (ms)

Waiting time for a response from the device shell

If no response is received from the device during this time span, then the action fails.

Table 41. Result

Do not check result

The response from the device shell is not evaluated.

Match string

Checks whether or not the received response matches the specified string

If this is not the case, then the action fails. The string can be specified in the field below.

Match regular expression

Checks whether or not the response corresponds to the specified regular expression

If this is not the case, then the action fails. The regular expression can be specified in the field below.



Save result

Output parameter to which the received response is assigned

Specified without quotation marks

Example: {ResultShellCommand}

When Match regular expression is active, the first match group of the regular expression is assigned to the script variables.

Tab: Parameters

The parameters defined on the Parameters tab are used to exchange values between test script variables and parameters of test actions. Parameters can be used as placeholders on the Configuration tab. For this, the name of the parameter is set in braces in the configuration dialog. Example: {name}.

Tip

Variables defined globally in the script (with the prefix $GLOBALS.) can be used directly in the test action. It is not necessary to use input parameters for passing. Using output parameters is necessary for writing global variables.

Input parameters: When executing the test action, the values of the test script variables are passed to the input parameters of the test action and can be used in the configuration of the test action.

Output parameters: When executing the test action, the values of the output parameters of the test action are passed to the test script variables and can be used (for example, in other test actions).

Name

Name of the input/output parameter

This name is defined in addition to the variable name to identify the origin of the parameter when it is passed to another script. During the test run, this name is displayed as the Outer name on the Variables (scope #<n>) tab in the Test progress window.

Background: When a script A calls another script B, and its variable x passes y as a parameter to the script B, then the parameter y is the variable y from the point of view of script B.

To see that this variable is recognized as variable x "outside" of script B, there is the Name column ("Outer name"). The variable y has the name x in the scope pf script B because it has been passed as variable x to the parameter y in the scope of the calling script A.

Variable

Name of the test script variable

Example: TS_CaseA_Result

Move Up

Moves the selected variable one line up

Move Down

Moves the selected variable one line down

Remove

Removes the selected variable from the list