DoxRunner
Macquarie University Student Accommodation
Overview
​
LoadRunner supports Additional Attributes, which is a facility for passing data to scripts within a scenario without the need to edit the scripts within that scenario. They are very handy, especially for URLs.
DoxRunner also supports them. The documentation described here is treated in a manner similar to other parameters, but the Process Raw operation goes the extra mile and configures the runtime settings appropriately.
​
The illustration below shows a typical configuration in LoadRunner. The illustration below that shows a typical set of documented rules.
​
Parameter
​
The Parameter Name is mandatory. It must be unique and only appears in the column with heading Parameter in the table of any Additional Attributes section.
​
It must also conform to LoadRunner rules.
​
Configuration
The Configuration column is mandatory, however it can be empty.
​
The two Configuration Item IDs (Name, and Value) are optional as described below.
​
If the Name CI ID is not present, then the Parameter Name is used as the Attribute Name.
​
If the Value CI ID is not present, then the value can be assigned during the Process Raw operation.
​
Note that an empty Configuration cell indicates that both the Name and Value are considered not present and both of the above apply.
​
1. Name
The Name Component is optional.
It must conform to the LoadRunner's Attribute Name rules.
If it's not included, the Parameter Name is used as the Attribute Name.
If it is included, it must be distinguished from the Value my prefixing it with the Component Indicator ID 'Name:'.
​
1. Value
The Value component is optional.
If the Name is not present, or if the Name's Component Indicator ID is in place, then the Value's Component Indicator is not necessary. Otherwise it must be preceded by the Component Indicator ID 'Format:' to distinguish it from the Name.
​
Section Management - Additional Attributes
​
An Additional Attribute section is optional, is semi-structured, and may appear in three places:​​
-
Any Test Case;
-
The Solution document;
-
The Test Case Template document.
​
Each instance of the Additional Attribute section consists of:
-
a Section Title;
-
a Bookmark;
-
free-form Body Text;
-
a Table with a minimum of two columns (Parameter and Configuration).
​
The Bookmark:​
-
Mandatory;
-
Location: Immediately before the Section Title;
-
Structure: Depends on which document it is embedded in:
-
Test Case: P_TST002_AdditionalAttribute (where TST002 is the Test Case ID)
-
Test Case Template: P_AdditionalAttribute
-
Solution document: V_AdditionalAttribute
-
​
The Section Title:
-
Mandatory;
-
Location: immediately after the Bookmark;
-
Structure: Free-format text;
-
Style: I_Heading n or I_Appendix n, where n can be an integer from 1 to 5;
-
Length: Cannot be longer than 200 characters.
​
The Body Text
-
Optional;
-
Location: between the Section Title and the Table;
-
Structure: free-format text;
-
Style: I_BodyText;
-
Length: Cannot be longer than 1,000 characters.
​​
The Table:
-
Mandatory;
-
Location: immediately below the Body Text (or Section Title if there is no Body Text):
-
A minimum of two rows:
-
A Heading row and a Data row (one data row per rule);
-
If there are no rules, the last Data row can contain empty cells (or the section can be deleted);
-
-
A minimum of two columns:
-
A Parameter column and a Configuration column;
-
More columns can be added;
-
A Description column is recommended.
-
-
All cells in the Parameter and Configuration columns must conform to specific rules, as described in the Overview above.​
​
​
Advice
​
Assess whether the section is necessary. This decision will need to take into consideration two factors:​
-
Whether the Test Case needs Additional Attribute rules;
-
Which scenario you have chosen when assessing the relationship between Test Case sections and Solution document sections.
​
Assess the Section Title and update it if necessary.
​
Make sure the table has the two mandatory columns (Parameter and Configuration), each with the specified heading text.
​
Assess the table to see whether more columns are appropriate, especially a Description column.
​
Assess the Body Text between the Section Title and the Table and update it if necessary.
​
Make sure its bookmark is visible and located immediately before the first character of the Section Title (see each of the examples further down this page).
​
Do not change the bookmark.
​
The section looks better when on a page with portrait orientation.
​
Test Case Section
​
In a test case, the Additional Attributes section is optional and can be located anywhere between the Description sections and the Transaction Timer section.
​
It is semi-structured as described above.
​
If you know that a test case won't require Additional Attribute rules, you may decide to delete the section. This can be done in two ways:
-
Using the DoxRunner Manage Sections operation;
​
If you deleted the section from the test case and decide to re-add it, then it can be done in two ways also:
-
Using the DoxRunner Manage Sections operation;
-
Manually.
​
If the Solution document also contains an Additional Attributes section with a Parameter name that is the same as one in a test case, then the one in the test case takes precedence.
​
The illustration below shows a typical Additional Attribute Rules section as it appears in a test case. Note the following points:
- The Bookmark must be structured as shown in the previous section:
-
That is, "P_", followed by the Test Case ID, followed by "_AdditionalAttribute";
- For example, if the is TSC705, then the bookmark should be P_TSC705_AdditionalAttribute;
-
-
The symbol is an optional link to the top of the test case for easier navigation.
​
Example
​
Test Case Template Section
​
The Text Data File section is optional and can be located anywhere in the Test Case Template between the Description sections and the Transaction Timer section.
​
It is semi-structured. The structure is described above.
​
It must be referenced by a Bookmark that must be located immediately before the Section Title.
The Bookmark is structured as follows: P_AdditionalAttribute
​
The Body Text is expected to contain generic text that will be copied to any new test case then updated by the scripter.
​
The Table must have a minimum of two rows - a Heading row and a Data row - and two columns as shown below.
It is recommended that you leave the table empty and populate it only after it's incorporated into a test case. If the Data row contains a rule, then that rule is copied to any new test case.
​
Example
​
Solution Document Section
​
The Additional Attributes section is optional and can be located anywhere in the Solution document.
​
Additional Attribute rules are normally defined in the Additional Attributes section of a test case, however they can also be documented in the Solution document. This is optional. One is included in the original downloaded version of the Solution document and is available unless it was manually deleted after the document was downloaded.
​
There is only one way to add rules to the Additional Attributes section of a Solution document and that is to manually insert them into the table.
​
If it exists, the section it is semi-structured. The structure is described above and is identical to the test case.
​
It must be referenced by a Bookmark that must be located immediately before the Section Title.
The Bookmark is structured as follows: V_AdditionalAttribute
​
Why would you use the Solution document to document Additional Attribute rules? You don't need to, but if there are rules that are common across multiple test cases, then they may be easier to manage if placed in the Solution document instead. In fact, to take an extreme view, you can document -all- Additional Attribute rules in the Solution document and define -none- in the test cases, if that is easier to manage. The choice is yours.
​
If a rule in a Data row of the Table contains a Parameter name that is the same as one in a test case then the one in the test case takes precedence.
​
Example
​
Add an Additional Attribute rule
​
In all cases, each Additional Attribute rule is documented as a row in the table that is embedded in a Additional Attribute section. The section must exist in the appropriate place beforehand.
​
They can be added to a test case in three ways:
-
Manually add a row in the table that should exist in the appropriate Additional Attribute section;
-
Via the green Parameter Association screen during a Process Raw operation;
-
Via the Reverse Engineer operation from a legacy script.
​
They can only be added to the Solution document or the Test Case Template manually.
An empty table is present in the Test Case Template when downloaded from this site. Rules are not normally added to this table, but can be in the rare case where a rule is known to be needed in all (or most) new test cases.
​
​
Add an Additional Attribute rule manually
This can be done in a test case, the Solution document, and the Test Case Template. Make sure the Additional Attribute section exists. It should exist unless you have deleted it.
​
Adding a rule manually is simply a matter of adding a row to the table and typing in the details, making sure there is one row per parameter as illustrated below. Only the Parameter and Configuration columns are used by the Process Raw operation.
Extra columns can be added, but are ignored by the Process Raw operation. A Description column is optional but recommended.
Refer to the Overview above for details of each column. Take particular note of the Configuration column.
​
Add using the Green Parameter Association Screen
​
If, during the Process Raw operation, it is noticed that a xxx rule can be applied to an Unassociated Name / Value Pair (that is, one that appears in the top left hand pane of the green Parameter Association screen), then it can be added to the test case.
​
This is done implicitly if you type in new details in the boxes at the bottom of the top right hand pane. Note that the Description isn't added here - it must be added to the rule in the table manually once the Process Raw operation has completed.
​
Add using the Reverse Engineer Operation
​
The Reverse Engineer operation is designed to update the documentation for a test case from a legacy script.
xxx rules are included in this process, however it's possible that not all rules are captured and documented.
Make sure you check the test case once the Reverse Engineer operation has completed.
​
Delete a Rule
​
Except for the last rule, deleting one can be done manually in all documents by simply deleting the respective row in the table.
​
Deleting the last rule can be done in two ways:
-
Simply clear all cells in the row (do not delete the row);
-
Delete the entire section.
​
A rule can also be deleted from a test case via the green Parameter Association screen during a Process Raw operation, as described below.
​
Delete using the Green Parameter Association Screen
​
If, during the Process Raw operation, a xxx rule is noticed that is no longer required, it can be deleted from the test case using the Delete from document button that appears on the green Parameter Association screen.
​