Reporting → Using Custom Reports → Report Reference → Other Reports → Version Control Actions Reports

Version Control Actions Reports

Note: These reports are available only to on-premise customers.

Version Control Actions reports allow SourceBridge and most version control integration users to access information pertaining to source code files associated with SBM primary items. You can generate reports based on items associated with files checked in or checked out, date ranges, and process app users performing version control actions through SourceBridge or another version control integration tool. File association records can also be accessed using Version Control Actions reports.

Because version control actions and file associations are associated only with primary items, you can only generate Version Control Actions reports for primary tables.

Note: Perforce version control actions cannot be retrieved by Version Control Actions reports.

Content Options

The following options are available in the Content area for Version Control Actions reports.
  • Report Item Type

    Indicates the application the report is based on.

  • Report Project

    For reports based on primary tables, the project you select when creating a report determines which items are returned in your report. The project selection also determines where the report is stored and which users can access the report. For example, if you select Project A, only users who have privileges to run reports in Project A can run the report.

    For details, refer to Selecting a Report Project.

  • Select Columns to Display
    You can select fields to display in your report results. You can also rearrange the order in which these fields appear in the report. The following fields are available for Version Control Actions reports:
    Field Description
    Associated Item Table Displays the name of the primary table in which items containing version control records or file associations are stored.
    Associated Business Process Apps Item Displays the title of the primary item associated with the actions or associations.
    Closing Action Displays the closing action or association against a file.
    Closing Date/Time Displays the time of the closing action or association against a file.
    Closing Revision Displays the version ID of the file at the closing action or association.
    Closing User Displays the name of the process app user who performed the closing action or association.
    File Name Displays the name of the file.
    Initiating Action Displays the initiating action or association against a file.
    Initiating Date/Time Displays the time of the initiating action or association against a file.
    Initiating Revision Displays the version ID of the file at the initiating action or association.
    Initiating User Displays the name of the process app user who performed the initiating action or association.
    Log Message Displays the log message or comment appended to the file.
    URL Displays a link to the version control tool's Web interface, if applicable. The URL is associated with the closing version ID; however, the link properties may differ depending on the version control integration you are using.
    VC Integration Displays the name of the integration tool associated with version control actions. SourceBridge (generic) appears as the integration tool for all associations made from SourceBridge and from file associations.
  • Set Custom Field Widths

    By default, the width of field columns is set automatically based on the size of your browser window and the number of fields displayed on the report. You can force the column for a selected field to be larger or smaller by specifying an absolute width in pixels.

    To change the display width of a field, select a field in the left pane, and then click the Set Custom Field Widths link to specify a display with in pixels for the field. You can then move the field to the right pane.

Calculations

In Version Control Actions reports, perform calculations on the Closing Date/Time and Initiating Date/Time fields. Use Date/Time keywords, such as Now and Startof_LastWeek, in these calculations.

To calculate how long a source file associated with a primary item was checked out, specify the following parameters in the Calculated Fields to Display section of the report form:

Entire Time Checked Out = Closing Date/Time - Initiating Date/Time

To calculate the amount of time a file has been checked out, specify the following parameters in the Calculated Fields to Display section of the report form:

Elapsed Time Checked Out = Now - Initiating Date/Time

Search Filters

Search filters enable you to narrow your search for items.

Select the following options for creating a search filter for your report:

Option Description
Show Search Filter In Results Select this option to display your Search Filter settings in the output of the report. This option allows report viewers to see which filters are used in the report. It is also helpful when you select to print a report, since it displays which Query At Runtime parameters were selected.
Limit selections using field dependencies and project selections

Select this check box to use the project's field dependency rules.

For example, in Project A, the Priority field has a dependency with the Severity field. The dependency states that when the Severity field is Critical, then the Priority field must be 1 or 2.

You create a Details report on Project A and add a Search Specification of Severity in Critical. Then, you add a Search Specification for the Priority field. The available Field Values for the Priority field will be limited to 1 and 2.

Note: Changing this setting does not affect values that have already been selected.
Basic Conditions

When you select a field from the Fields drop-down list, the Operator drop-down list contains values appropriate for that field, and the list box underneath the list of field values contains the possible values for that field. In some cases, you see a search icon, which you can use to filter the list of values.

Select an operator, and then select the value or values that constitute your search criterion.

Note: If there are arrow buttons and a second list box to hold field values, you can either use the arrow buttons to move values that you want in your criterion into the right-hand box, or you can multi-select the values in the left-hand box; however, do not use both mechanisms at once.

Click OK to save your criterion.
Use Advanced SQL Conditions

(on-premise customers only)

SQL (Structured Query Language) is an industry-standard language for selecting records from a database. For detailed information about using Advanced SQL conditions in SBM reports, refer to Using Advanced SQL Conditions in SBM Reports.

NOTES:

  • The Version Control Actions report only supports the pass-through method @ modifier when you use an Advanced SQL condition. Privileges granted by your administrator determine if you can create a Version Control Actions report using Advanced SQL conditions.

  • You can change the type of condition the report uses, but your search criteria is not converted. For example, if you specify an Advanced SQL condition, and then select the Use Basic Conditions option, your Advanced SQL is not converted to a basic condition.

Sorting Options

Sort options enable you to sort search results based on values in selected fields. For example, you can sort items by the user who performed initiating actions or associations.

Tip: The fields you select for sorting are independent of the fields you select to display. For best results, you may want to display the fields you choose for sorting. For details, refer to Content Options.

The following sorting options are available:

Option Description
Sort by / Then by From the drop-down lists, select the fields for which you want to sort report results based on field values. Fields available for sorting are Closing Action (Grouping only), Closing Date/Time, Closing Revision, Closing User, Initiating Action (Grouping only), Initiating Date/Time, Initiating Revision, Initiating User, and VC Integration (Grouping Only).
Ascending / Descending Select one of these options for each field to specify its sort order.

Additional Options

The following options are available in the Additional Options area of the Version Control Actions report form. These options can be considered "advanced" report options.

  • Add Columns of Calculations

    You can include a calculation of Closing Date/Time - Initiating Date/Time. Click the Date/Time Keywords link to select a Date/Time keyword, such as Now or Startof_NextWeek, for your calculation. Calculated fields display last in the report. For details, refer to Calculations.

    To add a calculation to a report:

    1. In the Column box, type the name that will appear as the Column Header in the report.

    2. In the first calculation box, select Closing Date/Time.

    3. Select the subtraction (-) operator from the next list.

    4. In the second calculation box, select Initiating Date/Time from the drop-down list.

      Note: The Database Management System (DBMS) performs the calculations, so SBM cannot catch errors, like division by zero, before it causes the report to fail. Also, date calculations that result in a negative number may not appear in the report.
  • Footer
    Optionally, supply a footer for your report.
    Note: The footer renders some common HTML tags such as <i>, <b>, and <font>. However, this means that character entity references such as >, <, ", and & are not encoded in the footer. Therefore, in order to display <Some Text> in the footer, you must send the following encoded sequence: &lt;Some Text&gt;.
  • Optional HTML Template

    This drop-down list contains HTML templates for customizing the look of your report. Provided templates include excellist.htm, which improves the display of Listing report results when they are exported (by right-clicking the report output and then selecting Export to Microsoft Excel), and massselectlist.htm, which provides buttons at the top of the page, enabling you to select or clear the check boxes for all items in the results list. Your administrator can customize report templates, and the templates in the list may or may not apply to the type of report you are creating. Select the template from the drop-down list.

Results

The Version Control Actions report appears in the Item List pane. The list of primary items that contain version control action or file association information displays fields you selected from the Fields to Display drop-down lists when you created the report.

The first field selected to appear in the report form is a link to the item, which appears in the Item Details pane.

Copyright © 2013–2014 Serena Software, Inc. All rights reserved.