4.3.0.3 RDA, Script of type run_qp command

Abbreviations, used in the manual:

RDA - Reference Data Admin

RDAD - RDA Designer

FW - Form Wizard

EF - Execution Flow

This manual will guide you on how to create a Script of type "run_qp command".

run_qp commands (run_qp.exe for Windows & run_qp.sh for Linux) allow to remotely run quilliup entities (for example: EFs, Tests, ...)

Follow the next steps in order to create a new Script of type "run_qp command":

1. In the RDAD modules, in the left side menu, under specific Project, go to the “Scripts” component:

Click “Add Script” button, the following window/form will open:

 2. Fill in all required fields:

• Name - Script`s name.
• Description - Describe the Script purpose.
• Script Type - One of the predefined options can be chosen. In our case we'll choose "run_qp command":

• Return type (*Optional) - chose "Success" or "Failure":

Success return type - if the return value equals to the results of the Script, a successful message will appear and will enable the Scriptable Button in FW.
If the return value is not equal to the results of the Script, a failure message will appear and will disable the Scriptable Button in FW. 

Failure return type - if the return value is equal to the results of the Script, a failure message will appear and will disable the Scriptable Button in FW.
If the return value is not equal to the results of the Script, a successful message will appear and will enable the Scriptable Button in FW.

• Success Message - this message will be returned in case of successful Script termination.
• Error Message - this message will be returned in case of the Script's failure.
• "Success Message" & "Error Message" will be added to the returned value in case of using "Return Type" & "Return Value";

For example:

• Use Form Variable - when checked/true => will be possible to insert the variable name you would like to use. When running such Script from Form Wizard (FW) => the chosen variable name and value(s) will be added automatically to the Script's command.

• Send variable value as one string - allow to use of variable values (when running the script from FW) as one string and not as a list of strings.

In order to keep the right URL parameters in the different environments, it's possible to use quilliup System variables as shown in the next command example:

"C:\Program Files\quilliup\webapps\ROOT\utils\run_qp.exe" -u "@quilliupServerProtocol;://@quilliupServerIp;:@quilliupServerPort;" -a "YWRtaW5AUUE6YWRtaW4=" -t "2975079" -d

Available System Variables:

@quilliupServerProtocol; - quilliup server protocol set in config.properties file (http/https).

@quilliupServerIp; - quilliup server IP address set in config.properties file.

@quilliupServerPort; - quilliup server port value set in config.properties file.

run_qp command allows to trigger QG module entities (EFs, Tests, etc.).

For example:

Please refer to the detailed run_qp command manual: command line execution guide