Using Scarab report builder

Scarab allows you to build reports to provide snapshot status reviews of issue activity. You can tailor the reports to fit your specific needs by defining which data types are included and selecting the output format. The report data types can include attributes and options, users, and dates. The report can be formatted for the web browser, Excel (.xls), or as a tab separated list (.txt). You can define reports to include a single or multiple issue types in a single or multiple modules.

To access Scarab reports:

  1. Select module in which you want to start defining the report.
  2. Click on the Reports link. This will take you to the Saved reports list page. You can select a previously saved report, or you can build a new report.
  3. Select the report you wish to run by clicking on the report name, or access the report builder by clicking the Create new button.

The Scarab report build consists of three tabs: Report information, Row content, Column content.

Report information

The Report information tab allows you to define the scope of the report and enter summary information. The summary information is for saving reports. There are two sections on this tab: Artifact types selected for this report, and Summary.

Selecting issue types

The issue type included in the report defaults to the currently selected issue type. If you wish to define a report for a different or multiple issue types/modules, click the Edit list button. This will take you to the Cross module/issue type list page. You can use this page to define a list of issues types within the current module or across multiple modules to be included in your report. It is highly recommended that the issue types for the report be chosen prior to working with the content tabs. Though it is possible to modify the list later, additions that conflict with already entered data on the other tabs will not be allowed.

On the Cross module/issue type list page, you can perform the following tasks:

Entering Summary information

The Summary section of the Report information tab allows you to enter information for saving your report. This information is optional and can be added at any point report creation process. You can provide the following information:

When you have entered all of the desired information, click the Update button to add this information to your report.

Row and column content

The Row content and Column content tabs allow you to define and organize the data included in your report. These tabs contain identical information and options; however, you can select different data types on each tab. This allows you to create unique, in depth reports. Once both the row and column content have been defined, you can generate the report.

Data types

The Row/Column criteria section allows you to select the type of data presented in the rows or columns of your report. The available selections are:

Attribute(s) / option(s)
When this data type is selected, you can choose from among the attributes and options defined for the selected issue types.
Users (by user attribute)
When this data type is selected, you can choose from among the module members and specify a user attribute for each user selected.
Date(s)
When this data type is selected, you can define dates for each row or column of your report.

The option selected in the Select content type field determines the data available in the rest of the sections of these tabs. Only one content type can be used for each heading. If you choose Date(s) as a content type on either the Row content or Column content tab, it must be the only heading on that axis. However, you can define user criteria for one or more heading levels and option attributes for other headings on the same axis. Changing the content type to Date(s) after defining a set of user or attribute/option criteria for either the row or column content tabs will discard the previously entered data for that tab.

Sorting attribute options and user attributes into headings and groups

When generating reports containing attribute options and user attributes, the organization of the data can mean the difference between a useful analysis tool and an unreadable mass of numbers. To help you organize your data, Scarab allows you to arrange report data into headings which are combined in the final report to allow multiple criteria per cell.

Headings are defined solely by the data they contain. To create headings within your report:

  1. In the Report builder, click on either the Row content tab or the Column content tab.
  2. Select the content type for this heading in the Select content type drop down box.
  3. Select the options you wish to include in the first heading of your report.
  4. Click the Update button.
  5. If you wish to include more than one heading in your report, in the axis content: Row/Column headings section, click the Add another heading button.
  6. Select the content type for this heading in the Select content type drop down box. If the previously defined heading contains user attributes or attributes/options, you cannot select the Date(s) content types. Doing so will discard the previously entered heading.
  7. Select the options you wish to include in this heading.
  8. When finished, click the Update button.
  9. Continue adding headings and selecting options in this manner until all the options you wish to see in your report have been included.

You can edit a previously defined heading by clicking on the radio button next to the heading and clicking the Edit selected heading button. You can delete previously defined heading by clicking on the radio button next to the heading and clicking the Remove selected heading button.

Scarab allows you to further organize reports data by grouping the attributes and options within your headings. For example, if options P1, P2, P3, and P4 for the Priority attribute have all been selected, you could group P1 and P2 as "high priority" and P3 and P4 as "low priority".

You must have defined at least one heading containing Attribute/option(s) in your report before you can define groups. To group options within headings:

  1. On the Row content tab or the Column content tab, select a heading containing the Attribute/option(s) content type and click the Edit selected heading button.
  2. In the group related data section, enter a name for the group and click the Add new button. Repeat this step if you wish to have additional groups within this heading.
  3. In the Grouping report data-set attributes/options section, select the group you want each option to appear in from the Group name drop down box next to each attribute/option.
  4. When done, click the Update button.

Selecting users and attributes

Reporting on user attributes allows you to determine how the workload in your module is distributed. You can use the Users (by attribute) data type to create reports that indicate how issues are assigned or otherwise associated with users.

To define Users (by attribute) reporting criteria:

  1. On either the Row content or Column content tab, select User (by attribute) from the Select content type drop down box.
  2. In the Users table, select the checkbox in the Select column and the desired user attribute in the drop down box in the Association column of the user you wish to include.
  3. Click the Add selected to assignee list button.

To include multiple user attributes for a single user, you must add the user again with the additional attribute selected. For instance, if you wanted to generate a report to indicate which users have ownership and quality assurance responsibility for the issues in your module, you would need to select each user twice--first with the Assigned to user attribute, then with the QA contact user attribute.

Reporting by dates

To help you determine how your module is progressing, Scarab allows you generate reports based on dates/times. Date/time reports provide a snapshot of issue activity at a single point in time. You can design reports to include several date/times to show the progress over a specific period of time.

To create date/time reports:

  1. On either the Row content or Column content tab, Select Date(s) from the Select content type drop down box.
  2. In the Select row/column (dates) content table, use the drop down boxes to select the date and time you want to include in your report.
  3. Click the Add single date/time button.
  4. Continue adding dates in this fashion until all desired dates are included.

You can include future dates in your report. A row or column with a future date will appear blank in the generated report; however, the row or column will populate when the report is regenerated after the date has passed. This can be used to create progress reports which are generated repeatedly. By adding dates well into the future and saving the report, you can minimize the amount of time spent defining frequently generated reports.

Generating and saving reports

Once you have defined both row and column content, the Generate report button will appear. Clicking this button will create the report in the format you have selected on the Report information tab.

When viewing the report in the Web format, you can perform the following tasks:

  1. Rotate the report by clicking the swap row and column link.
  2. Save the report by clicking the Save this report button. If you have not entered summary information on the Report information tab, you will be returned to that tab. You must enter a name for the report and click the Update button to add the summary information to the report. Click the Save this report button again to save.
  3. Export the report to Excel or tab separated values by selecting the desired export format from the Export results to: drop down box.