getUserData()

Return the value of the user data.

Syntax

getUserData(
  keyName STRING)
  RETURNS STRING
  1. keyName is the name of the user data key.

Usage

You can use this function to return the value of a specified piece of user data.

Example

Execute the scenario and provide user data:

$ ggcadmin tcp --user-data testname=hello --user-data loops=3 --scenario myTests.MyScenario

In the scenario, obtain the data using getUserData():

DEFINE testname STRING
DEFINE loops INTEGER
LET testname = ggc.getUserData("testname") 
LET loops = ggc.getUserData("loops")