Report Builder dialog box

Use the Report Builder dialog box to:

  • Specify the report name.

  • Select the product.

  • Select one or more types for the particular Dimensions CM object class you are reporting on (baselines, customers, design parts, items, projects, releases, requests, or secondary requests).

  • Specify filtering and sorting criteria.

  • Preview what the report will look like, so that you can tailor your reporting options prior to saving the report.

    Field

    Description

    Rules and Guidelines

    Edit

    Click to access the fields required to name the report and specify the report.

     

    Report Name

    Enter a new or existing report name.

    Required.

    The report name is specific to your Dimensions CM user-id, that is, different users can have reports with the same name.

    is public

    Select if you want other users to see the report.

    If is public is cleared, only you can see the report name.

     

    Clear report

    Click if you wish to clear your currently entered reporting criteria and reset them to the defaults for the object class for this report.

     

    accordion_button_minus00060.gif Context

    Context accordion menu fields (described below).

    Installation default is collapsed. State is remembered between invocations of this dialog box.

    Click the accordion_button_minus00060.gif button if you wish to collapse this accordion menu.

    Click the accordion_button_plus00062.gif button if you wish to expand this accordion menu.

    Product

    Select one or <ALL PRODUCTS> products from the list.

    Default is the current product.

    Type filter

    For the particular Dimensions CM object class for which you are running a report, chose one or more of its available types.

     

    accordion_button_minus00060.gif Report Type

    Report Type accordion menu fields (described below).

    Installation default is collapsed. State is remembered between invocations of this dialog box.

    Click the accordion_button_minus00060.gif button if you wish to collapse this accordion menu.

    Click the accordion_button_plus00062.gif button if you wish to expand this accordion menu.

    Type

    Select a report type from the list.

    Depending on the type of report selected, the Then by and Date Span pick lists may be disabled.

    Group by

    Select the desired attribute type to be used to group the elements of the generated report.

     

    Ascending/Descending

    Click the Ascending or Descending radio button to specify whether you wish the element grouping to be displayed in ascending or descending order respectively.

    The default is ascending.

    Then by

    If selectable, select another desired attribute type to be used to group the elements of the generated report.

    Depending on the type of report selected, the Then by pick list may be disabled.

    Ascending/Descending

    If selectable, click the Ascending or Descending radio button to specify whether you wish the element grouping to be displayed in ascending or descending order respectively.

    The default is ascending.

    Date span

    If selectable, select a date span for the attributes.

    Selection in the additional Date span field only depends on the attribute selected in any of the Group by fields; if at least one of them is a date attribute, then the Date span field will be enabled regardless of the report type selected.

    accordion_button_minus00060.gif Attributes to Display

    Attributes to Display accordion menu fields (described below).

    Installation default is collapsed. State is remembered between invocations of this dialog box.

    Click the accordion_button_minus00060.gif button if you wish to collapse this accordion menu.

    Click the accordion_button_plus00062.gif button if you wish to expand this accordion menu.

    For report types that support subsequently generated child drilldown reports, these attributes will be displayed in the child drilldown report; otherwise, the attributes will be displayed in the generated report itself.

    Available

    Attributes available for transfer to the Selected list.

    The Dimensions CM object class attribute types available depend on what has been defined in the process model.

    Selected

    Specifies the attributes to be displayed when the report is run.

    Required.

    rept_builder_dt_add_attribute_to_selected_button.gif 

    Click this button to transfer selected attributes in the Available list to the Selected list.

     

    rept_builder_dt_remove_attribute_from_selected_button.gif 

    Click this button to transfer selected attributes in the Selected list back to the Available list.

    At least one attribute must remain in the Selected list.

    rept_builder_dt_selected_up_button.gif 

    Click this button to move selected attributes in the Selected list up the list.

     

    rept_builder_dt_selected_down_button.gif 

    Click this button to move selected attributes in the Selected list down the list.

     

    accordion_button_plus00062.gif Filtering

    Filtering accordion menu fields (described below).

    Installation default is collapsed. State is remembered between invocations of this dialog box.

    Click the accordion_button_plus00062.gif button if you wish to expand this accordion menu.

    Click the accordion_button_minus00060.gif button if you wish to collapse this accordion menu.

    The desktop client optimizes filter criteria, which may affect how the criteria are displayed. The format may be slightly different to that specified. Client report results are not affected.

    For item reports, the items retrieved are restricted to the selected project. However, items can belong to more than one project, therefore the number of item revisions retrieved may be greater than the number that are displayed when you run the report.

    Available

    System attributes or relationships available for transfer to the Selected list.

     

    Selected

    Specifies the attributes or relationships to be included in a Boolean filtering relationship determined by the logical operators described below.

     

    rept_builder_dt_filtering_to_selected_list.gif 

    Click this button to transfer a selected attribute or relationship in the Available list to the Selected list as a filter criterion.

    If an attribute is selected, a value specification dialog box is displayed and for date/time attributes there is an associated find button.

    If a relationship is selected, a relationship specification dialog box is displayed and for most relationships associated Find and Keywords buttons.

    Repeat as appropriate to build up the filter criteria using the logical operators described below.

    The full list of filtering logical operations available is:

    • For date/time attributes: equal to, not equal to, before, after, not after, not before, is null, and is not null.

    • For other attributes: equal to, not equal to, less than, greater than, less than or equal to, greater than or equal to, Is null, and is not null.

    The pop up menu of options includes a <Query at Runtime> option to set a variable that enables you to specify the value at the time the report is run. Depending on the system attribute selected, certain other values or variables are available for selection, for example:

    • <Query at Runtime> option to set a variable that enables you to specify the value at the time the report is run

    • For date attributes:

      <Today>, <Today>+ 7, <Today>-7, <Today>+30, <Today>-30, <Today>+365, <Today>-365.

    rept_builder_dt_filtering_edit_button.gif 

    Click this button to modify a particular selected criterion within the filter criteria in the Selected list.

    You can modify, as appropriate, the attribute value in the value specification dialog box or the relationship in the relationship specification dialog box. The filter criterion will be updated appropriately.

     

    rept_builder_dt_filtering_back_to_available_list.gif 

    Click this button to delete a selected filter criterion from the filter criteria in the Selected list.

     

    rept_builder_dt_filtering_all_back_to_available_list.gif 

    Click this button to delete all filter criteria from the Selected list.

     

    rept_builder_dt_filtering_and_button.gif 

    Click to change the logical relationship to AND.

    As each filter criterion is added to the Selected list it is placed by default into a logical AND relationship with the previously added filter criterion.

    rept_builder_dt_filtering_or_button.gif 

    Click to change the logical relationship to OR.

    As each filter criterion is added to the Selected list it is placed by default into a logical AND relationship with the previously added filter criterion.

    rept_builder_dt_filtering_not_button.gif 

    Click to logically negate the currently selected expression.

    As each filter criterion is added to the Selected list it is placed by default into a logical AND relationship with the previously added filter criterion.

    rept_builder_dt_filtering_and_arrow_button.gif 

    Once you have started populating the Selected list, for certain attributes, when you then select in the Available list, the AND button will change to an AND > button.

    The AND > button performs the same function as the rept_builder_dt_filtering_to_selected_list.gifbutton but places the attribute value specifically into a logical AND relationship with the last relationship currently in the Selected list.

    rept_builder_dt_filtering_or_arrow_button.gif 

    Once you have started populating the Selected list, for certain attributes, when you then select in the Available list, the OR button will change to an OR > button.

    This button performs the same function as the rept_builder_dt_filtering_to_selected_list.gif button but places the attribute value specifically into a logical OR relationship with the last relationship currently in the Selected list.

    rept_builder_dt_selected_up_button.gif

    Click this button to move the selected filter criterion up the filter criteria in the Selected list.

     

    rept_builder_dt_selected_down_button.gif

    Click this button to move the selected filter criterion down the filter criteria in the Selected list.

     

    accordion_button_plus00062.gif Sorting

    Sorting accordion menu fields (described below).

    Default is collapsed. State is remembered between invocations of this dialog box.

    Click the accordion_button_plus00062.gif button if you wish to expand this accordion menu.

    Click the accordion_button_minus00060.gif button if you wish to collapse this accordion menu.

    For report types that support subsequently generated child drilldown reports, these attributes will be displayed in the child drilldown report; otherwise, the attributes will be displayed in the generated report itself.

    Sorted by/
    Then by

    Select a desired attribute type in the Sorted by list and as many of the three Then by lists as you require to refine your sorting criteria.

     

    Ascending

    For each selected attribute, click Ascending if you wish the sorting to be in ascending order.

     

    Descending

    For each selected attribute, click Descending if you wish the sorting to be in descending order.

     

    dt_rept_builder_run_button.gif 

     

    Click Run to generate a preview of the client report based on the choices you made. The generated preview report will be displayed in a standard right-hand desktop client view (inheriting the functionality such views afford).

    The preview report will contain the following group of toolbar buttons to manage the preview report:

    dt_rept_builder_generated_report_toolbar_buttons.gif 

    Click dt_save_preview_report_button.gif If you are satisfied with the preview of the report. The report will be added the left-hand Reports and Lists navigation pane to the my_reports_node.gif or public_reports_node.gif tree node as appropriate.

     Click dt_edit_preview_report_button.gif to refine your report. You will be returned to the dialog box you used to set up the report.

    Click dt_export_preview_report_button.gif to export the report in various formats. The formats into which you can save the report depend on the report type, but comprise in total:

    • Comma-separated variables (CSV) suitable for importing into other tools.

    • BMP image file.

    Click dt_select_all_preview_report_button.gif to select all the objects in the report.

    No drilldown is available in the preview for those reports that support it. Such reports have to be saved before drilldown becomes available.

    The formats into which you can export a report depend on the report type, but comprise in total:

    • Comma separated variables (CSV) suitable for importing into other tools.

    • BMP image file.

Back to top

See also: