Rich Reports

This topic describes rich reports in the StarTeam Cross-Platform Client.

In this topic:

About Rich Reports

The StarTeam Cross-Platform Client offers rich reports based on the BIRT report designer to create custom reports. You can easily select your data source and tables and fields from the StarTeam schema to customize your report.

For more information about BIRT reports and the BIRT report designer, refer to http://eclipse.org/birt/.

Back to top

Create a New Report

To create a rich report in the StarTeam Cross-Platform Client, do the following:

1. Open the StarTeam Reports dialog box by right clicking an item and selecting Reports.

   The Reports dialog box opens.

2. Select the Rich Reports option.
3. Enter in a name in the Output file name field.
4. Enter a title in the Report title field.

5. To configure the report, click Open Report Editor.

   The BIRT Report Designer opens.

6. Click File > New > Report.

   The New Report dialog box opens.

7. Select the folder for the report and enter the File name.
8. Click Next.
9. On the Report screen, select the type of report to create from the Report templates list.
10. Click Finish.

Back to top

Create the Data Source

To create a data source for a rich report, do the following:

1. From the BIRT Report Designer, click Data > New Data Source.
2. On the New Data Source page, select StarTeam Data Source.
3. In the Data Source Name field, enter the data source name. For example: localhost.

4. Click Next.

   The New StarTeam Data Source Profile page open.

5. Enter the following fields for the data source:

   Server Address	Address of the StarTeam Server. For example: localhost.
   TCP/IP Endpoint	Port of the server.
   Project	The name of the StarTeam project to use.
   View	The name of the StarTeam view to use that exists in the project specified above.
   User name	The StarTeam user to log in as.
   Password	The user's password.

6. Click Finish.

Back to top

Create the Data Set

To create a data set for a rich report, do the following:

1. From the BIRT Report Designer, click Data > New Data Set.

   The New Data Set page opens.

2. Select an existing Data Source.
3. Select StarTeam Data Set as the Data Set Type.
4. Enter a name in the Data Set Name field.

5. Click Next.

   The Select Query page opens.

6. Use the Select Query page to model commands that you would use in the command line. Restrictions on this page are based on how some types will or will not work with other queries or types. The Query Text field is editable and allows you to create your own (advanced) query. For example, you can build a where clause with property names: select * from File where propertyNameA ="A" and propertyNameB="Bla". You can also restrict the columns returned by saying select propertyNameA, propertyNameB from file.

   If the server is down when you open the Data Set page, an error is displayed and all fields will be disabled except for Query Text. This is because many fields retrieve from the server. You can still edit/save the Query Text.

   If you share a report with another user, the DataSource credentials will only decrypt if you have the same user name. If you try to edit the data set or data source, an error will be reported telling you that decryption failed and to re-enter the credentials.

7. Click Check when you are satisfied with your query. You will be notified of the results.

8. Click Finish.

   The Output Columns page opens.

9. Use the Output Columns page to change display names or change types.

   The Edit button allows you to change the default fields for the data set. For example, you could change the display name of a column or change a string data type to an Integer data type, as long as the format is correct.

10. Click OK.

    The Preview Results page opens with your results.

11. Click OK.

    BIRT will display all columns in the tree, allowing you to drag them onto the report, create charts, or use any other BIRT functionality that you need.

Back to top