Creating a Report

  1. On the Reports tab, select the appropriate Dimensions CM object class folder (Items, Requests, Projects/Streams, or Baselines), in the navigation pane.

  2. Click the New Report button.

  3. On the Report Builder dialog box, use the Edit tab to set up report generation criteria and/or the Preview tab to show you the client report that will be generated based on the choices you make on the Edit tab.

Edit Tab

Enter your reporting criteria on the Edit tab as explained below:

  1. Enter a Report Name.

  2. Unless you check the is public check box, the report will be a private report that only you will be able to see after the report is created. The report name is also placed, appropriately, in the My Reports or Public Reports folder in the navigation pane of the calling dialog box.

  3. Select one or <<ALL>> products from the Product drop down list.

  4. Depending on the class of Dimensions CM object you accessed Report Builder for, either accept, as default, all Item type(s), Request type(s), Project/stream type(s), or Baseline type(s) (indicated by <<ALL>>) or click the associated button browse_button_2.gif to select just specific types to be included in the report.

  5. In the Report type menu area:

  6. a    For Type, select the report type.

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

    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.

    b    For Group by and, if present, Then by and Date span, select the desired attribute type to be used to group the elements of the generated report. 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.

  7. In the Attributes to display menu area, attributes that you include in the Selected list are displayed when you generate the report.

  8. NOTE  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 listing report itself.

    To manage the attributes in the Selected list, do the following:

    a    To add a single attribute, select it (single click) in the Available list, and click the move_attr_to_selected_list.gif button.

    b    To add several attributes, select them (individually using CTRL+click or as a contiguous group using Shift+click) in the Available list, and click the move_attr_to_selected_list00001.gif button.

    c     To remove an attribute, select it in the Selected list, and click the move_attr_to_available_list.gif button.

    d    To remove several attributes, select them (individually using CTRL+click or as a contiguous group using Shift+click) in the Selected list, and click the move_attr_to_available_list00002.gif button.

    e    To move an attribute up the Selected list, select it and click the move_attr_up_selected_list.gif button.

    f      To move an attribute down the Selected list, select it and click the move_attr_down_selected_list.gif button.

  9. In the Filtering menu area, system attributes and/or relationships that you include in the Selected list can have sophisticated Boolean filtering criteria applied to them when you generate the report.

  10. NOTE  The Filtering menu area is initially collapsed; to expand it, click the ReportBuilder00003.jpg button. This menu is only applicable to a listing report and a drilldown list.

    To manage the filtering, do the following:

    a    For Field, select the desired attribute or relationship type:

          If an attribute is selected, an additional Value field and associated find button browse_button_200004.gif is displayed.

          If a relationship is selected, the Operator field is replaced by a selection of either related to or not related to, and associated Relationship find button browse_button_200005.gif

    b    For a system attribute or user attribute (if present), either enter the required value in the Value field or click the find value button browse_button_200006.gifto invoke an associated find dialog box. If you click the find value button browse_button_200007.gif, depending on the attribute you selected, you can select certain special values, especially <Query at Runtime> a variable that enables you to specify the value at the time the report is run.

    For text fields, you can use “&” or “*”as a wildcard character. Note that this works when the logical operator is equal to or not equal to, and therefore is equivalent to the expressions “like” and “not like” in some other query syntaxes. (See Examples: .)

    IMPORTANT!  <Query at Runtime> can currently only be selected for one attribute or relationship.

    TIPS:

          For attributes that take a date format:

          Click the calendar picker button calendar_picker.gif next to the pre-populated entry of
    DD-MMM-YYYY to invoke a calendar dialog box to assist you in selecting the appropriate date.

          Click the find value button browse_button_200008.gif to specify one of the following 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): click the find value button browse_button_200009.gif to open a user picker dialog box.

          For attributes that have related valid sets (for example, an item report of Item type EXE with a Filtering user attribute of Operating System): Click the find value button browse_button_200010.gif to open a valid set selector. You can use this selector to select multiple values and create multiple OR/AND criteria at one time using the add_multiple_or.gif or add_multiple_and.gif buttons.

    Select a logical operator from the Operator drop down 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. The full list of filtering logical operations available is:

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

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

    Click the rept_builder_filter_mgmt_add_button.gif button to post your current attribute/operator/value filter criteria to the list below, in which the compound filter criteria will be built up.

    c     For a relationship, either enter the required relationship in the Relationship field or click the find relationship button browse_button_200011.gifto invoke an associated find dialog box (access the help if you need assistance in using the find dialog box). If you click the find relationship button browse_button_200012.gif, depending on the relationship you selected, you can select certain special values, especially <Query at Runtime> a variable that enables you to specify the relationship at the time the report is run.

    IMPORTANT!  <Query at Runtime> can currently only be selected for one attribute or relationship.

    For the Operator, select Related to or Not related to.

    Click the rept_builder_filter_mgmt_add_button00013.gif button to post your current relationship filter criteria to the list below, in which the compound filter criteria will be built up.

    d    Repeat Step a and Step b or Step c as many times as required to build up the compound filter criteria (including where conditions) in the list below, using the following buttons to manage the filter criteria as explained below:

    rept_builder_filter_mgmt_buttons.gif

     

          To add a filter criterion, complete Step a and Step b or Step c above and click the rept_builder_filter_mgmt_add_button00014.gif button. As each filter criterion is added, it will be placed by default into a logical AND relationship with the previously added filter criterion—to change the relationship to an OR relationship for the currently selected filter criterion only, click the rept_builder_filter_mgmt_and_or_button.gif button.

          To delete a filter criterion, select it and click the rept_builder_filter_mgmt_delete_button.gifbutton. To delete all filter criteria, click the rept_builder_filter_mgmt_delete_all_button.gif button.

          To modify a filter criterion: select the criterion; modify, as appropriate, the system attribute Value and/or Operator fields or relationship Relationship field; and click the rept_builder_filter_mgmt_modify_button.gifbutton. The filter criterion will be updated appropriately.

          To add an open parenthesis to a filter criterion, select the criterion and click the rept_builder_filter_mgmt_add_open_barce_button.gif button. An open parentheses is added.

          To add a close parenthesis to a filter criterion, select the criterion and click the rept_builder_filter_mgmt_add_close_barce_button.gif button. A close parentheses is added.

          To remove an open parenthesis from a filter criterion, select the criterion and click the rept_builder_filter_mgmt_remove_open_barce_button.gifbutton. An open parenthesis is removed.

          To remove a close parenthesis from a filter criterion, select the criterion and click the rept_builder_filter_mgmt_remove_close_barce_button.gifbutton. A close parenthesis is removed.

    NOTES  

          Filter criteria that you enter are optimized by the Dimensions CM web client. Consequently, the criteria may appear in a slightly different format to that specified. However, 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, therefor the number of item revisions retrieved may be greater than the number that are displayed when you run the report.

          Examples:

    To create a report to find CR requests that are not closed and are critical or severe, or CRs that are raised, your filter will look like this:

    (Status != 'CLOSED'

    And

    Severity/Priority = '1_critical'

    Or

    Severity/Priority = '2_severe')

    Or

    Status = 'RAISED'

    To create a report to find items of file extension .zip that do not contain the string “output” in the filename, and are owned by JSMITH, your filter will look like this:

    Filename = ‘%.zip’

    And

    Filename <> ‘%output%’

    And

    Owner = ‘JSMITH’

  11. In the Sorting menu area:

  12. NOTE  The Sorting menu area is initially collapsed; to expand it, click the ReportBuilder00015.jpg button. This menu is only applicable to a listing report and a drilldown list.

    a    For Sorted by, select the desired attribute type and click Ascending or Descending to decide how the attributes are sorted in the elements of the generated report.

    b    For subsequent Then by fields, further refine your attribute sorting criteria.

  13. Proceed to the Preview tab to test run the report prior to saving it or modifying your reporting selections.

Related Topics

Drilling Down into a Client Report Using the Web Client

Exporting a Client Report Using the Web Client

Report Builder Dialog Box

Running a Client Report Using the Web Client

Preview Tab

The Preview tab shows you the client listing report or summary report (see Drilling Down into a Client Report Using the Web Client) that will be generated based on the choices you made on the Edit tab.

If you are satisfied with the preview of the report, click Save; otherwise, return to the Edit tab to refine your reporting choices.

Once a report is saved, it will appear in both the navigation and content panes of the Reports tab in Dimensions web client when you select the relevant folder in the navigation pane. In the navigation pane the report name will appear in the appropriate folder, that is, My Reports or Public Reports.

Related Topics

Drilling Down into a Client Report Using the Web Client

Exporting a Client Report Using the Web Client

Report Builder Dialog Box

Running a Client Report Using the Web Client