Modifying project configuration report templates
Project configuration reports, which are exported from Helix ALM to Microsoft Word, contain details about a project's configuration. See Exporting project configuration reports. Exported reports use a Word template to specify how the resulting document looks. If you want your reports to use different formatting, organization, or static text, you can modify the Word template.
The template is named ProjectConfigurationReportTemplate.docx and it is located in the templates\ProjectConfigurationReport directory in Helix ALM application directory. Make a backup copy of the template before you make changes. When you finish making changes, save the template as ProjectConfigurationReportTemplate.docx in the templates\ProjectConfigurationReport directory.
Note: The ProjectConfigurationReport directory also includes a ProjectConfigurationReportTemplate.css file. Do not modify this file because changes may cause issues with exporting the report.
The template includes the following elements.
- Bookmarks are placeholders for exported project information, which are replaced with the corresponding project data when the report is exported.
- Styles specify the formatting of text in the report. Styles are automatically applied to exported text and are also applied to static text. You can change the style properties to use a different look to match your organization's standards.
- Static text is used for the report cover page, introduction information, section headings, section descriptions and other information in the report. You can edit or delete this text, or apply different styles, to customize the report.
Tip: Export a report using the installed template before you modify the template. With the exported report open side-by-side with the template you are modifying, you can preview and fine tune changes in the exported report and save the changes in the template.
Bookmarks
Bookmarks are placeholders for information in the Word template. When a report is exported, the bookmarks are replaced with corresponding data from the project.
Bookmarks are positioned at the end of the introduction text in each section within the Project Configuration section of the report. You can rearrange bookmarks if you want to display them in a different location in the report or delete them if you do not want to include information about a specific project area. See the Word help for information about viewing and working with bookmarks.
The template includes the following bookmarks.
| Bookmark | Populated with: |
|---|---|
| SEAPINE_AUTOMATIONRULES | Automation rules |
| SEAPINE_CUSTOMFIELDDEFS | Custom fields |
| SEAPINE_EMAILTEMPLATES | Email templates |
| SEAPINE_FIELDLABELS | Field labels |
| SEAPINE_FIELDRELATIONSHIPS | Field relationships |
| SEAPINE_FILTERS | Filters |
| SEAPINE_WEBHOOKRECIPIENTS | Webhook recipients |
| SEAPINE_FOLDERTYPES | Folder types |
| SEAPINE_ITEMMAPPINGRULES | Item mapping rules |
| SEAPINE_LINKDEFS | Link definitions |
| SEAPINE_PROJECTOPTIONS | Project options |
| SEAPINE_REQFIELDSDEFAULTVALS | Required fields and default values |
| SEAPINE_RQMTTYPES | Requirement types |
| SEAPINE_SECURITYGROUPS | Security groups |
| SEAPINE_WORKFLOW | Workflow |
Styles
Styles are used to format text in the exported report. The report template installed with Helix ALM has several paragraph and character styles used to automatically format exported data and other static text.
You can modify a style if you want to change the text properties, such as font, color, size, and spacing. You cannot change the styles applied to text exported from a project, but you can change a style's properties. For example, the Data style is applied to field labels and values. You cannot apply a different style, such as Description, to field labels and values, but you can update the properties of the Data style to change its appearance. You can apply different styles to static text.
We recommend only modifying styles if you are familiar with working with Word styles. See the Word help for information about modifying styles.
Note: Some styles are based on other styles to maintain consistent formatting. If you change a style, any styles based on it are also automatically updated.
The template includes the following styles.
| Style | Style type | Applied to: |
|---|---|---|
| Cover_Text | Paragraph | Text on the report cover page, such as Created date and time |
| Cover_Title | Paragraph | Report title on the cover page |
| Data | Paragraph | Field labels and values |
| Data_Multiline | Paragraph | Multi-line text field labels and values |
| Description | Paragraph | Section description and 'No data available' text |
| Document_Instructions | Paragraph | Placeholder text throughout the document. Replace this text and apply the Description style before the document is complete. |
| Footer | Paragraph | Page footer |
| Heading_1 | Paragraph | First-level headings that identify areas of the Helix ALM project |
| Heading_2 | Paragraph | Second-level headings |
| Heading_3 | Paragraph | Third-level headings |
| Heading_4 | Paragraph | Fourth-level headings |
| Heading_5 | Paragraph | Fifth-level headings |
| Heading_6 | Paragraph | Sixth-level headings |
| Heading_Sub | Paragraph | Group box names in dialog boxes and other subheadings |
| Inactive | Paragraph | 'Inactive' text used to indicate inactive items |
| Label | Character | Field labels |
| Section_Heading | Paragraph | Primary section headings, such as Introduction, Purpose, and Project Configuration |
| TOC 1 | Paragraph | First-level table of contents entries (Section_Heading) |
| TOC 2 | Paragraph | Second-level table of contents entries (Heading_1) |
| TOC 3 | Paragraph | Third-level table of contents entries (Heading_2) |
| Value | Character | Field values |
Static text
Static text in the template, such as section headings and description text, can be changed. You can also add static text and images to the template. For examples, you may want to add content to the cover page, such as a logo or legal statement. Static text and images you add are always included in exported reports.
The following report sections include static text.
Cover page
The report cover page includes the following elements.
| Element | Description | Style applied |
|---|---|---|
| Report name | Uses 'Configuration Report' prepended with the project name the report was exported from (e.g., Development Configuration Report) | Cover_Title |
| Created date/time | Date and time the report was exported prepended with 'Created: '. | Cover_Text |
Contents section
The table of contents includes the following elements.
| Element | Description | Style applied |
|---|---|---|
| Section heading | Uses 'Contents' to identify the section. | TOC_Heading |
| Entries | Includes three levels of entries based on the Section_Heading, Heading_1, and Heading_2 styles. You can add levels to the table of contents or change how headings are mapped to styles. See the Word help for information about working with tables of contents. | TOC 1, TOC 2, TOC 3 |
Introduction, Purpose, Scope of Validation, and Other Information to Include sections
The Introduction, Purpose, Scope of Validation, and Other Information to Include are placeholder sections for information you may want to include in your reports depending on validation requirements. You can modify or delete these sections.
| Element | Description | Style applied |
|---|---|---|
| Section headings | Uses 'Introduction', 'Purpose', 'Scope of Validation', and 'Other Information to Include' to identify each section. | Section_Heading |
| Text | Placeholder text to explain the information to add to each section. You may want to replace the italicized gray text in these sections with your own text to provide instructions for updates needed each time the report is exported, replace the text with other text that is always used in all reports and apply the Description style, or delete any sections that are not required. | Document_Instructions |
Project Configuration
The Project Configuration section contains the data exported from the project.
| Element | Description | Style applied |
|---|---|---|
| Section heading | Uses 'Project Configuration' to identify the section. | Section_Heading |
| Project area headings | Identifies each exported project area (e.g., Automation Rules, Field Relationships, etc.). | Heading_1 |
| Area descriptions | Explains the content in each section. You may want to edit this text to use your own terminology. | Description |
| Project information | Data exported from the project. | Various. Styles are automatically applied to the data. |
Conclusion
| Element | Description | Style applied |
|---|---|---|
| Section heading | Uses 'Conclusion' to identify the section. | Section_Heading |
| Text | Placeholder text to explain the information to add. You may want to replace the italicized gray text in with your own text to provide instructions for updates needed each time the report is exported, replace the text with other text that is always used in all reports and apply the Description style, or delete the section if it is not required. | Document_Instructions |
Other information
You may also want to change the following in the Word template.
- Section breaks—The template uses section breaks to start some sections on odd-numbered pages. You can add or delete section breaks in the template, but you may need to adjust page number and print layout settings after making changes.
- Page footers—The page footer contains the project name the report was exported from appended with 'Configuration Report' (e.g., Sample Project Configuration Report) and page numbers. The footer in the Contents section uses Roman numeral page numbers. Other sections use normal numbers, starting with page 1.
