Use Cases

Reporting System Configuration

Description: Provide a mechanism to configure various parameters of the reporting system. For performance and other reasons, disabling reporting for a portion of the application may be required. Fine-grained controls are required in such cases.

Actors: Host Admin, Domain Admin, CEE User having Project - Edit permission

Normal Flow: A Host/Domain Admin logs into CEE and configures the following parameters.

Enable/Disable Reporting

This option enables/disables the reporting option. This can be done at 3 levels: Host, Domain, and Project. If disabled, then the reporting pages do not appear in the UI at the level where it is disabled. If disabled at the Host level, then the reporting implementation is not available for the entire site. In addition, the ETL data harvesting also will not happen at the level where it is disabled.

The behavior should be consistent with other parts of the application. That is if reporting is disabled at the host level, then the option can’t be enabled at the domain or project level.

The option is enabled by default.

ETL Runtime Process

Description: Provide a mechanism to the transfer data from the production data store to a warehouse for use in generating reports. The warehouse needs to be updated periodically with changes from the production database. This use case deals with the timing and mechanics of actually transferring the data from the production data store to the warehouse via an ETL framework.

Actors: System scheduler, ETL runtime Component, Reporting Application.

Normal Flow

1. The system scheduler triggers an ETL runtime operation.
2. The reporting application or ETL framework looks up the list of registered ETL modules and passes it to the ETL runtime component.
3. The ETL runtime component extracts, transforms, and loads data from the production database of all the registered components since the last update to the warehouse data store.
4. The ETL framework logs information on the total number of records processed, skipped, or failed.

View Report

Description: Provide a way for a user to run and view a point in time (PIT) or trend report. The output of the report should be rendered in the browser in either tabular or graphical format. There should also be an option to export reports to PDF or raw data format (csv, xls).

Actors: CEE User with right permissions.

Normal Flow

1. User selects a project to run reports.
2. User selects the Metrics and Reporting tool.
3. System displays the two landing page report-lets.
4. User selects a report-let.
5. The report results are displayed in the browser with tabs to select graphical or tabular views.
6. User has the option to modify the parameters of the report.
7. User has the option to export the report to the following formats:
   PDF file containing both the Graphical and tabular representation of the data.
   CSV or XSL (Not containing graphics) tabular representation of the data.

Embed Report-let

Description: Provide a way for a user to embed a report-let in HTML, or view just the chart section of a report as an image. This report-let is the chart section of a full report.

Actors: CEE user with right permissions.

Normal Flow

1. User views a report from any entry point (ALM report, Saved URL, AdHoc, Dashboard report).
2. User is presented with a link on the report page; this link is a direct URL to generate the report-let image that is the chart in the "graphical" report view.
3. If Basic Auth is disabled for this host, then a warning will be displayed that non-logged-in users will see a "broken" image in place of the report-let.
4. User copies the URL using their browser.
5. User pastes the URL in an HTML page, as the src value of an <img> tag.
6. User views the html page and the reporting engine will re-render the report and serve up the image that is the chart.

Parameterize Report

Description: Provide a way for a user to define the parameters that will be used to generate a Point in Time (PIT) or Trend report.

Actors: CEE user with right permissions.

Normal Flow

1. User selects parameterize a report (coming from viewing a report or saving a report).
2. User chooses parameterization as follows:

   Parameter

   Tool

   Report

   Required

   Note

   Report Type

   PT/SVN

   PIT/Trend

   Y

   Depending on where the user has come from this may be preselected.

   Artifact Type

   PT

   PIT/Trend

   Y

   At least one must be selected.

   State Attribute Option Value

   PT

   PIT/Trend

   N

   If State exists in all previously selected Attributes.

   One arbitrary common Attribute

   PT

   PIT/Trend

   N

   The only Attribute displayed will be the Attributes with the same XML Names and display names for all Artifact types selected. Only attributes of list type will be displayed.

   Common Attribute Option Value

   PT

   PIT/Trend

   N

   The only Options displayed will be the Options with the same XML Names and display names for the Attribute selected.

   Time Period

   PT/SVN

   Trend

   Y

   Last week by day, Last 2 weeks by day, Last month by week, Last Quarter by month, Last year by month, Project lifespan by month.

   Primary Grouping

   PT

   PIT

   Y

   Indicating which Artifact Type or Attribute is the primary grouping for the X axis. If Attribute is selected, indicate which Attribute (State or arbitrary).

   Secondary Grouping

   PT

   PIT

   N

   Indicating Artifact Type or Attribute is the sub grouping for the X axis. If Attribute is selected, indicate which Attribute (State or arbitrary). Same dimension cannot be selected for primary and subgrouping.

   Project scope

   SVN

   PIT/Trend

   Y

   Available only at the domain level Subversion activity reporting. Entire domain or a custom list of projects.

   Report metric

   SVN

   PIT/Trend

   Y

   The metric on which the SVN report is to be generated. Options include Domain/Project activity, File downloads, Active users.

   Type of activity

   SVN

   PIT/Trend

   Y

   Subversion activity type.

   Time frame

   SVN

   Trend

   Y

   Option to specify a date range or select a relative time period.

   Day selection

   SVN

   PIT

   Y

   Select any date in the last three months or choose the last data harvesting date.

   
3. User chooses the generate report action.
4. The report results are displayed in the browser with tabs to select graphical or tabular views.
5. User has the option to go back and alter the parameterization.
6. User has the option to cut and paste a URL to re-run the report they have parameterized. The user can save this URL (external to CEE).
7. User has the option to cut and paste the URL to generate a report-let image. The user can save this URL (external to CEE) and can embed it in their own html inside an <img> tag.

Save Report Parameters

Description: Provide the user with a way to save the report parameterization.

Actors: CEE user with right permissions.

Normal Flow

1. User chooses to edit one of the two dashboard report-lets on Metrics and Reporting landing page.
2. User is taken through parameterize report.
3. User has indication during the parameterize report flow that they are in a position to save the parameters of a specific report at the end of the flow.
4. User chooses to view the report.
5. User chooses the Save action and the report-let is saved back to the position where the user started on the Metrics and Reporting Page. User is notified that the report has been saved or an error has occurred.

Save Parameters - ALM Report

Description: Provide the user with a way to save a reportlet into an ALM page.

Actors: CEE user with right permissions.

Normal Flow

1. Using content editor, user chooses to add a report-let to an ALM page.
2. Content editor does any ALM page configuring it needs (out of scope of this use case) and forwards user to choose report type. ALM Content editor passes an "ALM Report Identifier" to the reporting. This identifier will be used to uniquely identify this report when the report parameterization is saved through the content editor. Content editor also passes a report indicator to allow the parameterize report section indicate the position the report will be saved to (This could be a report title).
3. User chooses between PIT or Trend Report.
4. User is taken through parameterize report.
5. User has indication during the parameterize report flow that they are in a position to save the parameters of a specific report at the end of the flow.
6. User chooses to view the report.
7. User chooses to save report.
8. Reporting calls a save API in the ALM content Editor passing:
   • ALM Report identifier (so the ALM content editor knows where to save the report. This is the same Identifier that the content editor passed in step 2).
   • URL to the report-let servlet containing report parameters (so that the report-let can be displayed using an <img> tag in the ALM page).
   • URL for editing/saving the report in the future (so the ALM page can display an edit option for the report-let). This will contain the ALM Report identifier and report parameterization.
   • URL for viewing the full report in the future (so the ALM page can make the report-let clickable).
9. Content Editor returns success/failure and user is notified that the report has been saved or an error has occurred.