Finding Objects and Reporting › Reports › Custom Reports

Custom Reports

Custom reports are useful to display data for a sub group from your overall data.

Important!

• If you have the administrator or CM administrator access, you can peform the following tasks:
  • Create the custom dashboard reports for broker, project, state, and package levels.
  • Generate reports at all levels (broker, project, state and package).
• If you have the use access permissions at the project level, you can only generate the custom dashboard reports for the project, state, and package levels.

If you have the administrator or CM administrator access, you can create the customized SQL statements and can generate reports using the BIRT reports option. You can formulate the hsql queries for versions, packages, user modified versions, auditable events, or any other relevant data using the custom reports. You can create a custom report, edit, or delete the existing reports.

If you have the use access at the project level, you can only generate the custom dashboard reports (created by a user with the administrator or CM administrator access) for the following levels:

• Project
• State
• Package

Note: You can only run a previously created custom report but cannot edit or delete the existing reports. For more information about administering data, see the CA Harvest SCM Administrator Guide.

Create Custom Reports

You can create custom reports only if you have with the administrator or CM administrator access.

Follow these steps:

1. Open the Workbench Client and select the SCM broker.
2. Select the BIRT Reports toolbar button.
3. Select Custom Reports on the left pane in the Custom Dashboard Reports dialog.
4. Click Add.

   The New Custom Report dialog box opens.

5. Select a scope (Broker, Project, State, or Package objects) for which you want to create a custom report from the drop-down list.
6. Provide a title for your custom report in the Title box.
7. Select a Broker in which you want to save the custom report from the Save To drop-down list.
8. Select one of the following output formats for your custom report.

   Table

   Displays the query results in a tabular form.

   Bar Chart

   Displays the query results as a bar chart, where X-axis indicates the first column, and Y-axis indicates the number in the SQL query.

   Pie Chart

   Displays the query results as a pie chart, X-axis indicates the category, and Y-axis indicates the number that is used in the SQL query.

9. You can add custom SQL in two ways. You can either import custom SQL from an external file or type the custom SQL in the text box.
10. Use predefined keywords that are based on the selected Scope, while writing SQL.

    For example, in the Package scope, use ${PROJECT_ID}, ${STATE_ID}, ${WORKING_VIEW_ID}, ${PACKAGE_ID}, ${USER_ID}.

    These predefined keywords are available based on the selection of your scope.

    Broker

    ${USER_ID}

    Project

    ${PROJECT_ID}, ${USER_ID}

    State

    ${PROJECT_ID}, ${STATE_ID},${WORKING_VIEW_ID},${USER_ID}

    Package

    ${PROJECT_ID}, ${STATE_ID},${WORKING_VIEW_ID}, ${PACKAGE_ID}, ${USER_ID}

    Note: You can test the custom SQL before saving it as a custom report.

11. (Optional) Select the Test SQL.
12. Provide SCM Context information like the Broker name, Project name, state name, package name that is based on your selected Scope and click OK.

    A confirmation message displays the test result.

Note: If you anticipate huge records as a result of custom query execution, we recommend you to choose the tabular format.

Generate Custom Reports

If you have the administrator or CM administrator access, you can generate the custom reports for the following levels:

• Broker
• Project
• State
• Package

Follow these steps:

1. Open the Workbench and navigate to the broker, project, state, or package to generate reports.
2. Right-click the selected SCM item, select Reports, and then select one of the custom reports that are created from the menu.

   The custom report is generated for your analysis in the output format that you have chosen while creating that custom report.

If you have the use access at the project level, you can generate the custom reports for the following levels:

• Project
• State
• Package

Note: You cannot access the broker level custom dashboard reports.

Follow these steps:

1. Open the Workbench and navigate to the project, state, or package to generate reports.
2. Right-click the selected SCM item, select Reports, and then select one of the custom reports that are created from the menu.

   The custom report is generated for your analysis in the output format that the administrator user has chosen while creating that custom report.