DoxRunner
Macquarie University Student Accommodation
Overview
​
Configuration items (CIs) are critical to DoxRunner operations. They are documented as rows in a table in a Configuration section, which is normally buried as an appendix to the Solution document because, once tailored to the Solution, it rarely needs to be updated.
​
The section acts like a .ini file in that it tells the DoxRunner operations how to go about its operations and where to find things.
It is in the Solution document because it normally applies to all test cases. However, there may be occasions where a test case requires one or more of the Configuration Items to be different. In that situation, a Configuration section can be added to any test case.
​
The CIs can be catalogued into seven separate groups:
-
VTS CIs
​
Type
​
The following is a list of CI Types:
-
Organisation
-
Solution
-
Project
-
Release
-
Environment
-
Support Folder
-
Script Folder
-
Included Files Folder
-
Timer Name Template
-
VTS Server Name
-
VTS Server Port
-
Database Name
-
Database Server Name
-
Correlate Values
-
Validation Template LB
-
Validation Template RB
​
Value​
​
The Value depends on the CI Type and how it is to be used in the Solution.
​
Section Management - Configuration
​
A Configuration 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 Configuration section consists of:
-
a Section Title;
-
a Bookmark;
-
free-form Body Text;
-
a Table with a minimum of two columns (Type and Value).
​
The Bookmark:​
-
Location: Immediately before the Section Title;
-
Structure: Depends on which document the section is embedded in:
-
Test Case: P_TST110_Configuration (where TST110 is the Test Case ID)
-
Test Case Template: P_Configuration
-
Solution document: V_Configuration
-
​
The Section Title:
-
Structure: Free-format text immediately preceded by the Bookmark;
-
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
-
Structure: free-format text and optional:
-
Location: between the Heading and the Table;
-
Style: I_BodyText;
-
Length: Cannot be longer than 1,000 characters.
​​
The Table:
-
Location: immediately below the Body Text (or Section Title if there is no Body Text):
-
A minimum of two rows:
-
A minimum of two columns:
-
All cells in the Type and Value columns must conform to specific rules, as described in the Overview above.​
​
​
Advice
​
The Configuration section is mandatory in the Solution document.
​
Assess whether the section is necessary in a Test Case. ​
Any Configuration Items at the Test Case level should be by exception only - avoid having Test Case specific CIs.
​
Assess the Section Title and update it if necessary.
​
Make sure the table has the two mandatory columns (Type and Value), 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.
​
Solution Document Section
​
The Solution document is the primary location for the Configuration section. It is mandatory, semi-structured, and can be located anywhere in it.
​
It must be referenced by a Bookmark that must be located immediately before the Section Title.
The Bookmark is structured as follows: V_Configuration
There is only one way to add CIs to the Configuration section of a Solution document and that is to manually insert them into the table.
​​
If a CI in a Data row of the Table is the same as one in a test case then the one in the test case takes precedence.
​
Test Case section
​
The Configuration section is mandatory in the Solution document, but optional in a test case. If it exists in a test case, it is usually a cut-down version, and it can be located anywhere in a test case between the Description sections and the Transaction Timer section.
It is semi-structured. The structure is described above and illustrated below.
​
It must be referenced by a Bookmark that must be located immediately before the Section Title.
The Bookmark must contain the Test Case ID and is structured as follows (where CEP001 is an example Test Case ID):
P_CEP001_Configuration
​
CIs must be added manually. If a CI has the same type as one in the Solution document, then the one in the test case takes precedence.
​
Test Case Template section
​
The Configuration section is not normally present in the Test Case Template that is downloaded from the DoxRunner site.
​
If it is required, it must be added manually and located anywhere in the Test Case Template between the Description sections and the Transaction Timer section, preferable just before the Transaction Timer section.
​
It is semi-structured. The structure is identical to to test case and Solution document as described above, with the only difference being the name of the referencing bookmark, which is: P_Configuration
​
The Body Text is expected to contain generic text that will be copied to any new test case.
​
When the Test Case Template is downloaded from the DoxRunner site, it contains the CIs as illustrated below. If it is known that the CIs in the Solution document will be sufficient for all test cases, then it can be deleted from the Test Case Template.
​
However if it is known that one or more may be different for some or all test cases, then simply delete those that are known to be unnecessary.
​
Example
​
Example
​
Example
​
CI Management
​
Add a CI
​
A CI can only be added to any document manually.
​
In all cases, a CI is added as a row in the table that is embedded in a Configuration section.
​
Columns
​
Delete a CI
​
Except for the last one, deleting a CI 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.
​
Section management
​
Add a section
​
​
How to add a Configuration section to a Test Case
A Configuration section is not included in the Test Case Template downloaded from this site. Hence it would not normally form a part of any new test case. This is because it is expected that, normally, the CIs in the Solution document will apply to all test cases in the solution.
​
Occasionally you may have one or two test cases that require one or more CIs to be different to those defined in the Solution document. A typical example would be a test case that has included files that are in a folder separate from other test cases in the Solution, or maybe a different timer template.
The steps below show you how to add a Configuration section to a specified test case. The first 10 steps are generic to all test case sections and uses the DoxRunner Manage Section operation. Steps 11 to 13 are specific to the Configuration section.
​
​
...
​
The new section will contain -all- CIs. You are advised to review each CI and delete those that aren't unique to the test case.
​
The bookmark will be structured in a manner similar to all other test case bookmarks. That is, it will be prefaced by P_, followed by the Test Case ID, and end in _Configuration. Example: P_CEP001_Configuration
The triangle symbol at the end of the heading is a link to the top of the test case.
​
The table contains -all- possible CIs.
Delete those that don't need to be in the test case and update the remainder.
They will take precedence over those from the Solution document referenced by bookmark V_Configuration.
​
Delete a section
​
How to delete a Configuration section from a Test Case
This is only required if you added it to a test case, or if you added it to the Test Case Template and created one or more test cases from it, and don't need it in one or more of those test cases.
​
The steps below show you how to delete any section from a specified test case. The first 10 steps are generic to all test case sections and uses the DoxRunner Manage Section operation.
​