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 (items, requests, projects/streams, or baselines).

  • Specify filtering and sorting criteria.

  • Preview the report, so that you can tailor your reporting options before 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 this report.

    Unless you select the is public option, only you can see this report name in the navigation pane of the calling dialog box.

    Based on the selected option, the report name is placed in either the My Reports or Public Reports folder.

    Product

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

    Default is the current product.

    If you select <<ALL>>, you will also be able to specify only <<ALL>> for Dimensions CM object class types.

    Item type(s), Request type(s), Project/stream type(s), or Baseline type(s)

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

    Click the associated button browse_button_2.gif to select just specific types to be included in the report.

    Default is <<ALL>> types.

    If <<ALL>> products are selected for Product, you will also be able to specify only <<ALL>> here.

    accordion_button_minus.gif Report type

    Report type accordion menu fields (described below).

    Default is expanded.

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

    Type

    Select a report type from the list.

    Depending on the type of report selected, an additional Then by field may then be displayed.

    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 present, select another desired attribute type to be used to group the elements of the generated report.

     

    Ascending/ Descending

    If present, 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 present, select a date span for the attributes.

    Selection in the additional Date Span field depends only on the attribute selected in any of the Group By fields. If there is at least one date attribute, the Date Span field is enabled regardless of the selected report type.

    accordion_button_minus.gif Attributes to display

    Attributes to display accordion menu fields (described below).

    Default is expanded.

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

    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.

    move_attr_to_selected_list.gif

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

     

    move_attr_to_available_list.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.

    move_attr_up_selected_list.gif

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

     

    move_attr_down_selected_list.gif

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

     

    accordion_button_plus.gif Filtering

    Filtering accordion menu fields (described below).

    Default is collapsed.

    Click the Expand button accordion_button_plus.gif to expand the accordion menu.

    The web 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.

    Field

    Select a system attribute, user attribute (if present), or relationship from the list.

    If an attribute is selected, an additional Value  field and an associated browse button browse_button_2.gif is displayed.

    If a relationship is selected, the Operator field is replaced by the Relationship field and browse button browse_button_2.gif.

    Operator

    Select a logical operation from the list.

    The logical operator specifies how you wish to filter with respect to the Value field, for example, filter to show all Titles that match (equal to ) or do not match (not equal to ) the entry in the Value field.

    Only present if a system attribute was selected in the Field list.

    The full list of filtering logical operations available is:

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

    • For all 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.

    Value

    Enter the required value to add to the filter criteria area:

    • Enter the value in the Value field.

    • Click the browse value button browse_button_2.gif to select the value from available options.

    Only present if a system attribute was selected in the Field list.

    The menu includes a <Query at Runtime> option that enables you to specify the value at the time the report is run.

    For attributes that take a date format, you can also:

    • Click the calendar picker button calendar_picker.gif next to the pre-populated entry of
      DD-MMM-YYYY to open a calendar where you can select the appropriate date.

    • Click the browse value button browse_button_2.gif to specify one of the special values: <Query at Runtime>, <Today>, <Today>+7, <Today>-7, <Today>+30, <Today>-30, <Today>+365, <Today>-365.

    For attributes that take a user identity values (for example, Originator, Owner, and Sender ID), you can also click the browse value button browse_button_2.gif and select a user.

    For attributes that have related valid sets (for example, a request report of Request type CR with a Filtering user attribute of Severity/Priority) you can also: Click the browse value button browse_button_2.gif to open a valid set selector. You can select multiple values and create multiple OR/AND criteria using the Add Multiple 'OR' or Add Multiple 'AND' buttons.

    Relationship

    Enter the relationship to add to the filter criteria area:

    • Type it in the Relationship field.

    • Click the browse relationship button to invoke the Add Relationship Criterion dialog box.

    Only present if a relationship is selected in the Field list.

    In the context of Report Builder, the Add Relationship Criterion dialog box includes a <Query at Runtime> button to set a variable that enables you to specify the object identity at the time the report is run.

    For request, part, or project relationships, there is also a <Current <Object_class>> button (for example <Current Request>) button that enables you to specify that the report should use the current object identity of the object class at the time it is run.

     

    Click the Add button to add a filter criterion to the filter criteria area.

    As each filter criterion is added, it will be placed by default into a logical AND relationship with the previously added filter criterion in the filter criteria area.

     

    Click the Delete button to delete a selected filter criterion from the filter criteria area.

     
     

    Click the And/Or button to toggle between AND and OR the logical relationship with the previously added filter criterion in the filter criteria area.

    Only applicable to the currently selected criterion.

    rept_builder_filter_mgmt_add_open_barce_button.gif

    Click the rept_builder_filter_mgmt_add_open_barce_button.gif button to add an open parenthesis to a filter criterion.

    An open parentheses is added.

    rept_builder_filter_mgmt_add_close_barce_button.gif

    Click the rept_builder_filter_mgmt_add_close_barce_button.gif button to add a close parenthesis to a filter criterion.

    A close parentheses is added.

    rept_builder_filter_mgmt_remove_open_barce_button.gif

    Click the rept_builder_filter_mgmt_remove_open_barce_button.gif button to remove an open parenthesis from a filter criterion.

    An open parenthesis is removed.

    rept_builder_filter_mgmt_remove_close_barce_button.gif

    Click the rept_builder_filter_mgmt_remove_close_barce_button.gif button to remove a close parenthesis from a filter criterion.

    A close parenthesis is removed.

     

    Click the Modify button to modify a selected filter criterion in the filter criteria area with new values entered in the Field /Operator /Value /Relationship fields.

     
     

    Click the Delete All button to delete all filter criteria from the filter criteria area.

     

    accordion_button_plus.gif Sorting

    Sorting accordion menu fields (described below).

    Default is collapsed.

    Click the Expand button accordion_button_plus.gif 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.

    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 to sort in ascending order.

     

    Descending

    For each selected attribute, click Descending to sort in descending order.

     

    preview_tab_label.gif 

    Click to test run the report prior to saving it or modifying your reporting selections.

     

    Save

    Click Save to save the report.

    After a report is saved, it is displayed in both the navigation and content panes of the relevant Reports tab in the web client.

    The report name is also placed, appropriately, in the My Reports or Public Reports folder in the navigation pane of the calling dialog box.

Back to top

See also: