<< Click to Display Table of Contents >> RayQC > 8.0 > User Guide > Settings  Report Profiles

Report profiles are required to configure the format definitions for exports of project evaluations.

 

Managing report profiles contains the following procedures:

 

•Select the active connection profile

•Create new profiles

•Edit profiles

•Remove profiles

 

Read on to get further details on how to accomplish these management tasks.

 

Report Profile Properties

In order to prepare decent report format profiles, the following configuration settings are required:

 

Active Report Profile:

The currently active profile can be selected here by choosing a profile from the drop-down menu. Use the Create profile button in order to create a new profile. Use the Remove button in order to delete a profile.

 

Profile Description

Short textual information about the profile for later recognition.

 

Exporting Format

There are 3 predefined export formats users may select from: PDF, DOCX, and HTML. Each of them has certain advantages and disadvantages, therefore it is important to know what purpose a report file has in order to be able to decide about the fitting export format. If, for example, a report goes out to inform a product owner, QA manager or customer about the outcome of specific QA tasks, PDF is most likely the right choice. However, if the reports are intended to be edited or extended by a later process step of the whole workflow RayQC is part of, DOCX is easier to handle. Selecting HTML makes sense when structured information is required, that might even be evaluated and analyzed by automated procedures.

 

However, the export format of a report profile is not carved in stone at profile creation, but may be adjusted whenever required. It is just a matter of convenience and efficiency to define the optimal choice right from the start.

 

Page Size (for PDF and DOCX Profiles)

The preferred page size for reports should be strongly connected to the default document guidelines applied to standard documents of an enterprise. RayQC offers users to select from a predefined set of internationally used page dimension standards:

 

•ISO / DIN A4 (210 mm x 297 mm)

•ISO / DIN A5 (148 mm x 210 mm)

•ISO / DIN B4 (250 mm x 353 mm)

•ISO / DIN B5 (176 mm x 250 mm)

•ANSI / ASME Legal (8.5 in x 14 in)

•ANSI / ASME Letter (8.5 in x 11 in)

 

Html Page Width (for HTLM Profiles)

RayQC offers users the option to define the width of the HTML page by entering the width of the page in pixels.

 

Font Size

Instead of requesting detailed font size definitions for each headline type, paragraph, foot note, etc., RayQC simply offers 3 size settings (small, medium, large) to the user and defines dependencies according to the base font size setting on its own.

 

Logo Path

It is possible to place a product or company logo within the exported report file. The logo file may be stored at any network or local location, as long as it is accessible for RayQC at the time of report generation. It is recommended to use common graphic formats, such as PNG or JPG, since these are displayed without any issues on nearly every operating system. If, for example, the report is generated as HTML file, a copy of the original logo file is added to the report files folder. Once the report is copied to another device, it may not be possible to display exotic graphic types there.

 

Element Filter

With a click on the Element Filter button below the standard property set of a report profile, users open a new dialog which contains options regarding the visibility of specific element types within the generated report files:

 

Element type: Information

Activate the checkbox to display the content of this element type within generated report files. Since Information elements do not contain test result information, but usually inform the tester about the checklist context, it may not be required to include them in reports. However, it is recommended to keep them within the reports, in order to make sure that the test routines are fully comprehensible for the reader of the report.

 

Element type: Checkpoint

Use the checkboxes to determine which elements will be included in reports: Passed, failed, or void elements. If the report purpose is to outline issues that were revealed by a checklist run, it may be sufficient to include failed elements. However, a full report of the checklist routines should contain all elements, and therefore activate all presented checkboxes.

 

Element type: Multi-Option

The checkboxes allow to include all elements that have a selected result (=valid), and / or all those that have not been answered (=void). Once again, the right constellation depends on the report purpose: A full report should contain all elements, whilst a short issue report should be reduced to problematic or missing results.

 

Element type: Data Field

Activating the checkboxes in this area determines whether or not empty and / or filled elements should be part of report files. If none is selected, this element type is not part of the generated reports.

 

As soon as all desired changes are executed, the dialog may be closed with a click on the OK button at the bottom. The changes are immediately taken into account for exports executed during the current working session of RayQC.

 

Signature Fields

With a click on the Signature Fields button below the standard property set of a report profile, users open a new dialog which contains 2 groups of properties for signature options:
 

•Signatures on the summary page

•Signatures on the protocol pages

 

It is recommended to enable signature fields on the summary page, whilst having them on each of the potentially numerous details pages might be a bit of an overkill for average acknowledgment needs.

 

For each group there are these settings to define:

 

•Show signature fields
Activate the checkbox to display signature fields. If the checkbox is inactive, the other settings for this group do not take effect on the actual report generation process. However, they may be defined as preparation for later use.

 

•Number of signature fields
RayQC allows to define signature sets of 1, 2 or 3 signature demands. The actual requirement depends on the QA process applied to the specific project or enterprise RayQC is embedded with.

 

•Label of Signee [1-3]
Make sure to match the number of signature fields to the labels defined for them: If 3 signature fields are displayed but only one has a label definition, the other 3 will most likely not be overly useful, since the role or person whose acknowledgment is demanded is unknown to the recipient of the report.

 

As soon as all desired changes are executed, the dialog may be closed with a click on the OK button at the bottom. The changes are immediately taken into account for exports executed during the current working session of RayQC.

 

Page Filter

With a click on the Page Filter button below the standard property set of a reports profile, users open a new dialog which contains three options users may activate independently:

 

Summary Page

Activate the checkbox to add a cover page to the report. The cover contains charts as visual result summary, as well as the checklist name and result, the date of the report creation, and a copy of the current task box status of the checklist. It is recommended to include the cover, as it provides swift access to the key figures of the checklist evaluation.

 

Protocol Page(s)

The protocol pages contain the checklist elements, as far as configured within the Element Filter dialog. If no elements have been activated there, an empty protocol page will be the result.

 

Separating Blank Page

If the blank page is part of the report, it is added directly after the cover page and right before the protocol page(s). It is not possible to add a blank page to reports that do not contain both cover and protocol pages. The purpose of the blank page is to get the report details on the right side for printing it in duplex mode.

 

As soon as all desired changes are executed, the dialog may be closed with a click on the OK button at the bottom. The changes are immediately taken into account for exports executed during the current working session of RayQC.

 

Define the Active Report Profile

1.Go to the settings area and click on the Report profiles tab.

 

2.Expand the options list provided within the drop down menu named Active Report Profile.

 

3.Select the desired profile.

 

 

To Create a New Report Profile

1.Go to the settings area and click on the Report profiles tab.

 

2.Click on the button Create at the right-hand side of the Active Report Profile selector control.

 

3. Enter the name of the new profile as demanded by the displayed dialog.
The profile name has to be unique among the report profiles stored for the currently logged in Windows User on the machine that is running RayQC.

 

4.Click OK to save the new profile
 

5.A new option is automatically added to the Active Report Profile selector control.
 

6.The new profile needs to be edited in order to set the parameters required to actually provide a custom report design.

 

 

To Edit a Report Profile

1.Go to the settings area and click on the Report profiles tab.

2.Expand the options list provided within the drop down menu named Active Report Profile.
 

3.Select the desired profile.
 

4.The properties of the profile are loaded into the input fields below the Active Report Profile selector.
 

5.Adjust them according to your needs. They are immediately effective and applied to the running RayQC instance.
 

 

 

To Remove a Report Profile

1.Go to the settings area and click on the report profiles tab.

 

2.Expand the options list provided within the drop down menu named Active Report Profile.

 

3.Select the desired profile.

 

4.Click on the Remove button at the right-hand side of the Active Report Profile control.

 

5.The report profile is removed from the options list.