Get Parameter
Gets the value of a parameter previously created in the IBM RPA Control Center.
Command availability: IBM RPA SaaS and IBM RPA on premises
Script syntax
IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.
getParameter --name(String) (String)=value
Dependencies
You must create a parameter previously in the IBM RPA Control Center. See Creating parameters for instructions.
Input parameter
The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.
| Designer mode label | Script mode name | Required | Accepted variable types | Description |
|---|---|---|---|---|
| Key Name | name |
Required |
Text |
The parameter's name. |
Output parameter
| Designer mode label | Script mode name | Accepted variable types | Description |
|---|---|---|---|
| Value | value |
Text, Number, Boolean |
Returns the value stored in the parameter chosen in the Key Name input parameter. |
Example
The following code example demonstrates how to get a specific parameter to use in the script. The Get Parameter (getParameter) command gets the value of the parameter you select and assigns that value to the variable
"parameterValue".
defVar --name parameterValue --type String
// Gets the value of the parameter you select.
getParameter --name <SELECT_A_ PARAMETER> parameterValue=value
// Logs the parameter value you've got.
logMessage --message "${parameterValue}" --type "Info"