Execute DevHub Command

Runs a command via a "Micro Focus DevHub" RSE connection. Only the following connection types are supported:

Micro Focus DevHub using RSE
Micro Focus DevHub using SSH

The tool can parse returned keywords as described under the Operating System Function Package. See Execute OS Command for more information.

Each keyword must be returned at the beginning of a line in STDOUT. This can be used to call custom AWM scripts on the remote machine and return messages, output parameters, and so forth.

Additionally, the tool can write any output produced by the run command into a File Descriptor of the type Input Stream.

Note: The two connection types "Micro Focus DevHub using RSE" and "Micro Focus DevHub using SSH" will produce different output formats. This does not affect called AWM scripts, as the returned keywords can be parsed with both return formats.

Attributes

Attribute	Type	Description
Return Code Expected	Boolean	Whether an AWM return code is expected in the output of the executed command. The return code must be returned in a separate line, starting with "ReturnCode: ", followed by a numeric value. This option is intended for commands that run AWM scripts, returning keywords. See Execute OS Command for more information. If set to true, and no return code is found in the command output, the action will end with an error message. This enables you to ensure that subsequent tools will only run if the called script did not end unexpectedly. The default value is false.
Input Parameter Separator	String	Specifies the delimiter to be used to separate input parameter values. Only relevant if two or more input parameters are specified. For better visual identification, quote characters can be used before and after the delimiter. The quotes are removed at run time. You can specify multi-character delimiters. The default value is " " (blank).
Output Parameter Separator	String	Specifies the delimiter to be used to separate output parameter values returned by a called AWM script. Only relevant if two or more output parameters are returned via the "OutParm: " keyword. For better visual identification, quote characters can be used before and after the delimiter. The quotes are removed at run time. You can specify multi-character delimiters. The default value is " " (blank).

Attribute

Type

Description

Return Code Expected

Boolean

Whether an AWM return code is expected in the output of the executed command. The return code must be returned in a separate line, starting with "ReturnCode: ", followed by a numeric value.

This option is intended for commands that run AWM scripts, returning keywords. See Execute OS Command for more information.

If set to true, and no return code is found in the command output, the action will end with an error message. This enables you to ensure that subsequent tools will only run if the called script did not end unexpectedly.

The default value is false.

Input Parameter Separator

String

Specifies the delimiter to be used to separate input parameter values. Only relevant if two or more input parameters are specified. For better visual identification, quote characters can be used before and after the delimiter. The quotes are removed at run time. You can specify multi-character delimiters.

The default value is " " (blank).

Output Parameter Separator

String

Specifies the delimiter to be used to separate output parameter values returned by a called AWM script. Only relevant if two or more output parameters are returned via the "OutParm: " keyword. For better visual identification, quote characters can be used before and after the delimiter. The quotes are removed at run time. You can specify multi-character delimiters.

The default value is " " (blank).

Parameters

Parameter Name	I/O	Type	Description
Connection Name [0..1]	I	String	Specifies the name of the Micro Focus DevHub connection to use. If not specified or empty, AWM will attempt to use the only available, suitable Micro Focus DevHub connection. If multiple connections are specified, the command will not be executed and an error message will be displayed.
Input Parameter [1..*]	I	String	Specifies the command string to execute. Multiple input parameters will be concatenated to a single command string using the Input Parameter Separator attribute value as a delimiter.
Output Parameter [1..*]	O	String/File	Specifies the output parameters expected to be returned by a called AWM script. If specified, AWM expects a value to be returned by the run command under the "OutParm: " keyword. Multiple output parameter values are parsed by using the Output Parameter Separator attribute value as a delimiter. Type File is currently not fully supported, as there is no File Descriptor type to reflect files on the remote system.
Command Output	O	File	Specifies the File Descriptor of type Input Stream to write any output returned by the run command to.
Resource Operation Value	O	Resource Operation	Specifies the pointer to a property to which the resource operation value returned by the tool is mapped if the tool supports tool defined resource operations. See Tool-defined Resource Processing for more information.