Config Get Command Step in Step Wizard
A Config Get command retrieves the value of an IxLoad test configuration element into a composite TestComposer variable.
To add a Config Get command step using the GUI scripting support:
While in the Test Steps pane, add a step by choosing the Actions > Add step... command. Select a Config Get step type, click thebutton to validate the selection, and specify the following parameters:
- Run Type: A Config Get step can be executed sequentially (Sequential) or in parallel (Parallel) with other steps.
- Delay: A delay specifying by how much step start is delayed. A delay value is automatically set when the step is added using the Capture functionality.
- Timeout: A period of time after which the step execution is considered to have timed out.
- Ignore step: When this option is selected, the step is skipped at execution time. Selecting this option is equivalent to right-clicking a step in the Test Steps table and choosing the Exclude command from the context menu that appears.
- Description: An optional step description can be associated with a step.
Click Next.
Define the Conditional Execution settings as explained below.Conditional Execution settings enable you to define the system conditions a test step execution is monitored for. When such a predefined condition occurs a step error or a step timeout an user-defined procedure is executed and an additional action is performed. For example, on encountering a step error, you could enforce the execution of a cleanup procedure and then terminate the test.
To monitor the step for a predefined Timeout or Error condition, select the corresponding condition, then define the associated procedure local or shared (external) by clicking the
control of the Procedure field and selecting a procedure from the the drop-down pane that appears.
For the selected procedure you can view its defined arguments by clicking the
control of the Input Arguments field, which displays a cascading table-format pane containing the argument list. To specify the actual runtime argument(s) enter the desired values in the Current Value field(s).
Configure an additional action by clicking into additional actions column and selecting either of the following options:
- Continue: After performing the specified procedure, the test execution continues.
- Exit Test: After performing the specified procedure, the test execution is terminated.
Click Next.
Whenever the step execution is monitored for predefined events, an
icon is displayed in the step's corresponding Events selected column entry. For information on turning on the displaying of the Events selected column refer to Customizing the Script Steps Table Layout.
Specify the following command parameters:
- Session: The Built-In Event session type.
- Return variable: A composite return variable that is populated with the sought attribute(s).
- Select: The command name followed by an X-Path expression that selects the configuration element instance(s) whose attributes are to be retrieved.
In addition to the X-Path notation, the select statement also supports the notation that is used by the IxLoad Tcl API, whereby a configuration element is specified using an expression composed of the tree path, an ":" string, and an element index. For example, the "/traffic/trafficItem[2]" expression could be rewritten using the "/traffic/trafficItem:6" specifier, which illustrates the fact that the X-Path index and the Tcl API index referencing an entity of a configuration element are not necessarily the same.
- Get Attributes: One or more element attribute names whose values are to be retrieved, attributes being separated by whitespace. For each sought attribute, a member field of the composite return variable is created.
Verify the step summary information and revert to a previous configuration step if needed. Click FinishExample:
Assuming we had the following
Config Get
command:Config Get Built-In Event var1 Configuration Get
select="/ixload/repository/test[1] " get="csvInterval
statViewThroughputUnits"
this would return into the var1.csvInterval and var1.statViewThroughputUnits variables the attributes for the test element specified by the select statement.
If we applied this command to multiple tests, say port 1, 2, and 3, the var1.csvInterval and var1.statViewThroughputUnits variables would contain each a space-separated list of attribute values, one value per each test.
Since object references returned by the Config Get command are not in the X-Path format used by all other IxLoad session commands, these references can only be passed to commands from the Config category, but not to other IxLoad session commands.
IxLoad TestComposer │ User Guide |