top of page

 

Custom Parameter Operations

 

FlowChart.gif

Overview

​

Both VUGen and DoxRunner support a type of parameter called Custom. 

 

This parameter type is useful for assigning a constant value to a parameter so that if the value needs to be changed between tests, it can be changed in one place.

​

One typical example is URLs, where a URL may change from test to test if changing environments. This saves time and reduces the likelihood of mistakes. Regardless of this time saving feature, it may be better to consider Additional Attributes.

​

One situation where an Additional Attribute is not appropriate is where a value needs to change per iteration, and no standard parameter type is appropriate. One example is where a bespoke function is needed to execute at the top of each iteration. In this case, even though some manual configuration is required, a Custom Parameter is ideal.

​

This page describes four ways that a scripter can configure them:

   1. Standard VUGen method 1;

   2. Standard VUGen method 2;

   3. The usual method;

   4. The DoxRunner method.

​

The best method is number 4, the DoxRunner method. It provides a platform for documenting Custom Parameter rules and a process for automatically updating a raw script with the documented rules.

StandardVUGen1.gif
StandardMethod1

​

Standard VUGen method 1

​

One way of configuring Custom parameters is shown on the right.

 

1. Select the Parameters menu item in the Solution Explorer;

​

2. Type in the parameter name;

​

3. Choose Custom from the drop-down listbox;

​

4a. Type in the value;

4b. Optionally type in a description;

​

5a. Manually replace all relevant values in the script with the parameter name;

5b. Optionally type in a description at the end of each line;

​

Disadvantages:

  1. The process needs to be repeated for every Custom parameter;

  2. The process needs to be repeated whenever you need to re-record the script;

  3. At run-time the value will be assigned to the parameter once and only once, as if it was assigned at the beginning of vuser_init.

StandardMethod2
StandardVUGen2.gif

​

Standard VUGen Method 2

​

Another way of configuring Custom parameters is shown on the right.

 

1. Select the value you want to be replaced;

2. Right-click, and select Replace with a Parameter;

3. Select Create New Parameter;

4. Type in the parameter name;

5. Choose Custom from the Parameter Type drop-down listbox;

6. Type in the value;

7. Optionally press Properties;

8. Optionally type in a description and press Close;

9a. Optionally replace all values with the parameter (dangerous for short values)

               or

9b. Manually replace the relevant values with the parameter one by one.

​

Disadvantages:

  1. The process needs to be repeated for every Custom parameter;

  2. The process needs to be repeated whenever you need to re-record the script;

  3. At run-time the value will be assigned to the parameter once and only once, as if it was assigned at the beginning of vuser_init.

Usual
StandardVUGen3.gif

 

The usual method

​

Most scripters simply ignore the VUGen configuration methods described above and use simple lr_save_string() function(s).

​

  1. Placed at the top of vuser_init.c, this will achieve the same objective as both of the above methods.

  2. Placed at the top of Action.c allows the scripter to form the parameter value in a more complex way such as the use of a function or constructing a value from other parameters where the values update at each iteration.

  3. The scripter must replace the relevant values in the script with the parameters.

 

Advantages:

  1. If multiple Custom parameters are required they are easily viewed and updated in the script without having to open multiple dialog boxes;

  2. More complex value assignments can be implemented such as the use of a function or building up a value from other parameters;

  3. The scripter can do the same thing at the top of Action.c, allowing the value to update for every iteration where a function or a more complex value needs to be assigned.

​

Disadvantages:

  1. The process needs to be repeated for every Custom parameter (although it's easier and more flexible);

  2. The process needs to be repeated whenever you need to re-record the script.

​

DoxRunner

 

The DoxRunner method

​

DoxRunner is test case-centric, so Custom Parameters are documented in a Custom Parameter section. Refer to the documentation page for details on how to document Custom Parameters.

​

Refer to the How it works section below for how the documented rules are used by the Process Raw operation.

​

Advantages:

  1. You only need to document each rule once, and the rule is quickly and accurately applied by the Process Raw operation whenever the script needs to be re-recorded;

  2. The test case can be viewed by semi-technical people without having to trawl through the script;

  3. The Description is automatically inserted, adding to script readability;

  4. If multiple Custom Parameters are required they are easily viewed in the script and updated without having to open multiple dialog boxes;

  5. More complex value assignments can be implemented such as the use of a function or building up a value from other parameters;

  6. The Process Raw operation automatically determines whether the parameter is assigned at the top of vuser_init or Action.c, or you can specify where. The scripter then only needs to assess each one to see whether a function or other criteria needs to be applied instead of the lr_save_string() function.

​​

Disadvantages:

  1. The scripter needs to take the time to document the rules in the test case. We all know that performance testers don't like to document, even though it is more professional to do so.

​

HowItWorks

 

How it works

 

As well as facilitating performance test documentation, DoxRunner provides operations that enhance scripting by applying the documentation to VUGen scripts. The most important is the Process Raw operation, which includes support for Custom Parameters. 

​

The description of the Process Raw operation below as it applies to Custom Parameters uses 7 examples, each one showing a different possibility, reflecting the extra functionality of the DoxRunner method over standard VUGen.

​

Goal
ProcessRaw

​

Process Raw operation

​

Goal

​

1. To convert the documented Custom Parameter rules into lr_save_string() functions;

2. All relevant values in all script files are replaced with the specified Custom Parameter.

​

Examples

​

Examples

​

The Process Raw operation description below uses 5 examples to illustrate how different scenarios are handled:

Example 1: Straight use of the documented value by the Process Raw operation;

Example 2: Replace the documented value with an unassociated name / value pair by the Process Raw operation;

Example 3: How an empty documented value is handled by the Process Raw operation;

Example 4: Add a Custom Parameter to the test case during the Process Raw operation;

Example 5: Delete a Custom Parameter from the test case during the Process Raw operation.

​

All examples assume 4 initial steps as discussed below.

​

InitialSteps
Goal1.gif

​

Process Raw initial steps

 

Before each of the 7 examples are discussed, a brief discussion of the Process Raw preparation follows, illustrated below.

​

  1. Any Custom Parameters that are documented in the Solution document outside of any test case (at bookmark V_Custom) are read in;

  2. Any Custom Parameters that are documented in the test case at bookmark V_<TestCaseID>_Custom are read in;

  3. All Custom Parameters read in at 1 and 2 above are combined. If there are any conflicts, those in the test case take precedence over those at bookmark V_Custom;

  4. The combined Custom Parameters are presented to the scripter in the Custom pane of the green Parameter Association screen;

​

It is within the green Parameter Association screen that the scripter has the final opportunity to determine what value the Custom Parameter will take on and where is is assigned. See Detailed examples below for a detailed discussion of the 7 examples.

​

Example1

​

Example 1

​

Straight use of the documented Value

 

The parameter pSupplierPortalURL is used in this example. Its Value is defined in the documentation. Even though the scripter has the opportunity to change that value, this example shows what happens if the documented value is used unchanged.

​

It is assumed that you have read all 4 initial steps above, which deals with the first 4 steps (from the documentation to the green screen). The steps below take the process from the green screen to the configured script, as illustrated on the right.

 

  1. The scripter selects the parameter in the Custom pane;

  2. Note that the parameter name, documented value and 'Update value on' (Auto) display in the fields at the bottom of the Custom tab;

  3. The scripter simply presses the Associate by value button;

  4. The association is displayed in the bottom pane and disappears from the Custom pane;

  5. Repeat for all other parameters as appropriate;

  6. When finished, press the Apply button;

  7. Because the 'Update value on' is Auto, the Process Raw operation determines whether the first occurrence of the Value occurs during the steps that belong to vuser_init, or Action.c:

    • If the first occurrence is in vuser_init, then the lr_save_string() is written at the top of vuser_init.c;

    • Otherwise it is written at the top of Action.c;

    • In the example it will be at the top of vuser_init;

    • The documented value is appended as a comment.

  8. The Process Raw operation replaces all occurrences of the Value with the parameter {pSupplierPortalURL} and appends the original value to each line as a comment.

​

Example2
Example1.gif
Example3

​

Example 2

​

- Replace the documented value with an unassociated name / value pair

- Manually update the assignment with a function

 

The parameter pPlotSize is used in this example. Its documented value is 5100.

​

It is assumed that you have read all 4 initial steps above, which deals with the first 4 steps (from the documentation to the green screen). The steps below take the process from the green screen to the configured script, as illustrated on the right.

​

  1. Select the parameter in the Custom pane;

  2. Note that the parameter name, documented value and 'Update value on' (Iteration) display in the fields at the bottom of the Custom tab;

  3. Select a name - value pair from the Unassociated name-value pair pane;

  4. The documented value (5100) is replaced by the selected value (5000);

  5. Press either the Associate by value or Associate by boundary button. The parameter is displayed in the bottom pane and disappears from the Custom pane. It also disappears from the Unassociated name-value pair pane;

  6. Repeat for all other parameters as appropriate;

  7. When finished, press the Apply button;

  8. The Process Raw operation places the assignment at the top of Action.c. because the 'Update value on' CI is Iteration;

  9. The Process Raw operation replaces all occurrences of the assigned value value with the parameter ({pPlotSize});

  10. The scripter can leave the assignment as it is, or manually update it with more complex assignments, such as the use of a function that resets the value upon each iteration.

​

Example2.gif

​

Example 3

​

How an empty value is handled

 

The parameter pClientID is used in this example. The Configuration column in the documentation is empty, so no documented value exists, and the 'Update value on' CI defaults to 'Auto'.

​

It is assumed that you have read all 4 initial steps above, which deals with the first 4 steps (from the documentation to the green screen). The steps below take the process from the green screen to the configured script, as illustrated on the right.

​

  1. Select the parameter in the Custom pane. Note that the parameter name displays at the bottom of the Custom tab, but the value is blank;

  2. The documented 'Update value on' is also blank, but it defaults to Auto;

  3. At this point you can manually enter a value, or choose one from the 'Unassociated name-value pairs' pane. To use the parameter without a value, simply press the Configure only button;

  4. The parameter is displayed in the bottom pane and disappears from the Custom pane;

  5. Repeat for all other parameters as appropriate;

  6. When finished, press the Apply button;

  7. Since the value is blank, the Process Raw operation cannot make an assessment as to where the first assignment will occur, so it simply types the lr_save_string() at the top of vuser_init.c;

  8. The Process Raw operation cannot replace any value in the script files with the parameter. It is up to the scripter as to what to do with the parameter;

  9. One option is for the scripter to assign a more complex value to the parameter. In the illustration on the right, a value is extracted from the database and assigned. The assignment is also moved from vuser_init.c to the top of Action.c. This implies that the documentation should have set the 'Update value on' CI to Iteration, rather than leaving it blank.

​​

Example4
Example3.gif
Example4.gif
Example5

​

Example 4

​

How to add a Custom Parameter during the Process Raw operation

 

The parameter pStalkType is used in this example.

​

It is assumed that you have read all 4 initial steps above, which deals with the first 4 steps (from the documentation to the green screen). The steps below take the process from the green screen to the configured script, as illustrated on the right.

 

  1. Type in a parameter name and default value into the two text boxes at the bottom of the Custom tab;

  2. Press the Use default value button;

  3. The parameter is displayed in the bottom pane;

  4. Repeat for all other parameters as appropriate;

  5. When finished, press the Apply button;

  6. The Process Raw operation determines whether the first occurrence of the default value occurs during the steps that belong to vuser_init, or Action.c:

    1. If the first occurrence is in vuser_init, then the lr_save_string() is written at the top;

    2. Otherwise it is written at the top of Action.c;

    3. In the example it will be at the top of vuser_init.

  7. The Process Raw operation replaces all occurrences of the default value with the parameter ({pStalkType });

  8. The Process Raw operation inserts the new parameter into the Custom Parameters section with description "New";

​

It is expected that the scripter will expand on the description.

​

​

Example 5 

​

How to delete a Custom Parameter during the Process Raw operation

 

The parameter pServiceType is used in this example.

​

It is assumed that you have read all 4 initial steps above, which deals with the first 4 steps (from the documentation to the green screen). The steps below take the process from the green screen to the configured script, as illustrated on the right.

​

  1. Select the parameter in the Custom pane;

  2. Note that the parameter name and default value display at the bottom of the Custom tab;

  3. Press the Delete from document button;

  4. The parameter will be deleted from the Custom Parameters section after the Process Raw operation completes all script-related actions.

​

Example5.gif
bottom of page