top of page

 

REGEX Correlation Rules

 

​DoxRunner only provides a means to document Regex rules.

 

They are documented in a table in a Regex Correlation section which can be present in a test case or in the Solution document.

​

DoxRunner is not able to update any script with them - they need to be manually applied.

​

However, documenting them does improve efficiency by making it easier to manually apply them, especially if the script needs to be re-recorded.

​​

    Documentation

​

​​​​

Getting Started​

​

A Regex Correlation section is NOT included in the Solution document nor in the Test Case Template when they are downloaded from the DoxRunner site.

​​

If you need it, then you will need to add it manually. Unless you add it manually to the Test Case Template document, it will not appear in any new Test Case. If it is needed in only a few Test Cases, then not including it the Test Case Template document may be normal, in which case you will need to add it manually to those Test Cases that need it. Refer to the Test Case Operations page for details on managing sections.

​​

Once the Regex Section is added, refer to the Documentation section further in this page and execute these actions:

​

  1. ​Assess the Section Title and update it if necessary.

  2. ​Make sure the table has the three mandatory columns (Parameter, Role, and Configuration), each with the specified heading text. A Description column can be included and is recommended.

  3. ​Assess the Body Text between the Section Title and the Table and update it if necessary.

  4. ​Make sure its bookmark is visible and located immediately before the first character of the Section Title. ​Do not change the bookmark.

  5. There is one Regex Rule per row, but the rows is best viewed as pairs - one for Requests and one for Responses. Add rows as required.​

​​​​​

​A REGEX Correlation Rule section is optional, is semi-structured, and may appear in three places:​​

​

​

Each instance of a REGEX Correlation Rule section consists of:

  • a Section Title;

  • a Bookmark;

  • free-form Body Text;

  • a Table with a minimum of three columns (Parameter, Role and Configuration).

​

The Bookmark:​

  • Mandatory;

  • Location: Immediately before the Section Title;

  • Structure: Depends on which document it is embedded in:

​

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 three rows:

    • A Heading row and a Data row (two data rows per rule);

      • One data row should have a Role of Request, while the other should have a Role of Response;​

    • If there are no rules, the last Data row can contain empty cells (or the section can be deleted);

  • A minimum of three columns:

    • A Parameter column, a Role column, and a Configuration column;

    • More columns can be added;

    • A Description column optional but recommended.

  • All cells in the Parameter, Role, and Configuration columns must conform to specific rules, as described below.​

​

 

Documentation

​

 

Test Case section

 

Like all DoxRunner sections, the Regex Correlation section in a test case is highly structured:

  • Bookmark = P_TC001_RegexRules for test case TC001;

  • Title - can be any text, but the Microsoft Word style should begin with I_Appendix;

  • Text - can be any text up to 1,000 characters. The Microsoft Word style should be I_BodyText;

  • Table - must contain at least three columns, as described below.

 

 

Solution document section

 

Like all DoxRunner sections, the Regex Correlation section in the Solution document is highly structured:

  • Bookmark = V_RegexRules for test case TC001;

  • Title - can be any text, but the Microsoft Word style should begin with I_Appendix;

  • Text - can be any text up to 1,000 characters. The Microsoft Word style should be I_BodyText;

  • Table - must contain at least three columns, as described below.

 

 

Test Case Template section

 

Like all DoxRunner sections, the Regex Correlation section in the Test Case Template is highly structured:

  • Bookmark = P_RegexRules ;

  • Title - can be any text, but the Microsoft Word style should begin with I_Appendix;

  • Text - can be any text up to 1,000 characters. The Microsoft Word style should be I_BodyText;

  • Table - must contain at least three columns, as described below.

 

bottom of page