(DV-2208) MS Document Template

The new concept of MS Document Templates allows you to define your own document layout. The template is a simple Microsoft Word .docx file that contains some placeholders. Placeholders are replaced with real values in the process of generation of Test Plan Documentation. All allowed placeholders are reflecting the real data structure provided by Validate Test Plan.

Manage Test Plan default templates

Templates are stored in SNP Validate Document Repository accessible in Test Management settings

Open

Open

Default templates delivered in SNP Validate transport are:

1. Test Plan Default Template [ID: DVD_VAL_DOCX_TP_DEFAULT_TEMPLATE] - contains all Test Plan-specific information like in the old template (with the fixed layout).

2. Test Plan w/o details Template [ID: DVD_VAL_DOCX_TP_WO_DETAILS_TEMPLATE] - contains all Test Plan-specific information without variant details.

The default template can be downloaded to the local PC, modified, and uploaded back to the SNP Validate Document Repository under a new ID with the prefix ZVAL_DOCX_. It is not allowed to overwrite default templates!

Create own template

To create or change the template you have to toggle the developer toolbar in Microsoft Word (File -> Options -> Customize ribbon)

Go to the Developer tab and turn on Design Mode.

Create your own text layout of Test Plan documentation with the desired formatting. Write placeholder names (use only allowed placeholder names) to the places which will be later replaced with real values by the generator. The formating used on placeholder names will be used on real values.

Save the template as Microsoft Document .dox file and upload it to SNP Validate Template Repository.

Create simple placeholder

Convert written placeholder names to a real placeholder that can be recognized by the Test Plan documentation generator in the following way:

1. Select the placeholder name

2. In the developer toolbar click on the Rich Text Content Control icon and then click on Properties.

3. Enter the tag name. The tag name started with f_* / d_* refers to a real field in the data structure of the test plan.

4. Repeat it for all placeholders.

Create placeholders for repeated content

To create repeated rows or text fragment(s) use the following procedure:

1. Select row or text fragment(s), and click on the Repeating Section Content Control icon in the developer toolbar.

2. Place the cursor at the beginning or end of the control and click on properties.

3. Set the tag name of repeated part starting with t_* that refers to the real table name in a data structure of the test plan.

4. Tag all placeholders in the document.

In the same way, you can repeat any content of any text or even pages. Just select the content, click on the Repeating Section Content Control icon, and set the proper tag.

The repeated part with placeholder names (tags especially) has to reflect the real hierarchy of fields and tables in the data structure of the Test Plan.

Create placeholders for sub-document

With the placeholder is possible to insert also Test Case / Test Plan status document or the main document of the Test Case (a.g. document for manual testing). The principle for the placeholder is the same as for a simple placeholder. Placeholder name which refers to document is starting with prefix d_*.

The sub-document is inserted into the main document in a process of generation and kees all formating of the sub-document. The sub-document has to be stored in the new Microsoft Document .docx format otherwise a message will appear that the sub-document will not be inserted in the process of generation. The sub-document placeholder name has to refer to the real data structure of the Test Plan.

Placeholder list

The data structure with placeholder (tag) names of each Test plan is following:

<TEST_PLAN_DATA>