Creating history reports

History reports include historical information about actions performed on files, including details about who, what, where, and when for each action. Use these reports to determine what changed recently or to find changes made by a specific team member that may need a code review.

1. Choose Tools > Reports.

The Reports dialog box opens.

2. Click Add.

The Select Report Type dialog box opens.

3. Select History and click OK.

The Add Report dialog box opens.

4. Enter a Report name.

5. Select a Public/private report option.

Public reports are shared with all users. Private reports are not shared. You may only be able to create private reports depending on your security permissions.

6. On the Restrictions tab, select the criteria that files must meet to be included in the report.

The Report Restriction dialog box opens. The options change based on the selected restriction.

7. Enter or select the restriction values. See Adding restrictions.

8. Click OK.

The restriction is added. The values are displayed in the restriction list and the Summary field.

To change a value, double-click it in the Restrictions list.

9. Add any additional restrictions.

10. Click the Output tab.

11. Select an Output format.

Reports can be formatted in HTML, space-delimited columns, or tab-delimited columns.

If a report is in HTML format, a pie chart can be included in it. See Charting report data.

12. Select a report Stylesheet.

Cascading Style Sheets (CSS) files are installed with Surround SCM to create reports with a predefined layout and design. You can customize these stylesheets or create your own. Stylesheets are stored in the StyleSheets directory in the Surround SCM application directory on the server.

13. Select a report style.

Summary style report includes an overview of file details.

  • Hide repositories without selected actions excludes repositories with files that do not meet the report criteria.
  • Include difference information includes file version differences. Click Diff Options to specify differences to display. See Running file differences reports.

Table style report includes file information in a table format.

  • Primary sort column and Order sorts the first column of report results. Select Group by primary sort column to organize results into groups that can be collapsed and expanded in the report. To include a pie chart in the report, you must select this option. See Charting report data.
  • Secondary sort column and Order sorts the second column of report results (optional). Select the Group by secondary sort column option to organize results into groups that can be collapsed and expanded.

14. Select the Field Options to specify the columns to include in the report.

Select the column to add in the Available columns list and click the right arrow button to move it to the Selected columns list. To remove a column, select it in the Selected columns list and click the left arrow button. Select a column in the Selected columns list and click Top, Move Up, Move Down, or Bottom to change the display order.

15. Click OK.

The report is added. See Running reports for information about running reports.