Report Builder dialog box

On the Edit tab of the Report Builder dialog box, specify the following report details:

  • Enter 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).

  • Provide filtering and sorting criteria.

On the Preview tab on the Report Builder dialog box, preview the report, so that you can tailor your reporting options before saving the report.

Field Description

Report Name

Enter a new or existing report name.

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 to make the report visible to other users.

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

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 can specify only <<ALL>> for Dimensions CM object class types.

[Object] type(s)

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

Click the browse button to select the types to include in the report. By default, <<ALL>> types are included.

If <<ALL>> products are selected for Product, you can specify only <<ALL>> here.

accordion_button_minus.gif Report type

In the Report Type menu, select a report type and the grouping options.

By default, the menu is expanded.

Type

Select a report type from the list.

Depending on the selected report type, an additional Then by field may be available.

Group by

Select the attribute type by which to group the elements of the generated report.

Next to the Group By field, select the option to display the element grouping in ascending or descending order. By default, it is displayed in ascending order.

Then by

If available, select another attribute type by which to group the elements of the generated report.

Depending on the report type, this option may be disabled.

Next to the Then By field, select the option to display the element grouping in ascending or descending order. By default, it is displayed in ascending order.

Date span

If available, select a date span for the attributes.

This option depends only on the attribute selected in any of the grouping fields. If at least one of the grouping attributes is a date attribute, the Date Span field is enabled, regardless of the selected report type.

accordion_button_minus.gif Attributes to display

In the Attributes to Display menu, select the attributes to display.

By default, the menu is expanded.

Available

Displays a list of attributes available for selection.

The available object class attribute types depend on the settings in your process model.

Select an attribute and click the right arrow button to transfer the attribute to the Selected list.

Selected

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

You must select at least one attribute.

Use the Up and Down buttons to move selected attributes up or down the list.

accordion_button_plus.gif Filtering

In the Filtering menu, set the filtering options.

By default, the menu is collapsed. Expand it to view the options.

The web client optimizes filter criteria, which may affect how the criteria are displayed. The format may slightly differ from 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 a associated browse button  is displayed.

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

Operator

Select a logical operation from the list.

The logical operator specifies how to filter based on the Value field. For example, you can filter to display all titles that match (equal to) or do not match (not equal to) the entry in the Value field.

This option is displayed only if a system attribute was selected in the Field list.

Here is the full list of filtering logical operations:

  • 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 to select the value from available options.

This option is displayed only 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 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 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 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  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.

This option is displayed only 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. It enables you to specify that the report should use the current object identity of the object class at the time it is run.

Add button

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

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

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

Click 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 to add an open parenthesis to a filter criterion.
rept_builder_filter_mgmt_add_close_barce_button.gif Click to add a close parenthesis to a filter criterion.
rept_builder_filter_mgmt_remove_open_barce_button.gif Click to remove an open parenthesis from a filter criterion.
rept_builder_filter_mgmt_remove_close_barce_button.gif Click to remove a close parenthesis from a filter criterion.
Modify button Click to modify a selected filter criterion in the filter criteria area with new values entered in the Field /Operator /Value /Relationship fields.
Delete All button Click to delete all filter criteria from the filter criteria area.

accordion_button_plus.gif Sorting

In the Sorting menu, set the sorting options.

By default, the menu is collapsed. Expand it to view the options.

For report types that support subsequently generated child drilldown reports, these attributes are displayed in the child drilldown report. Otherwise, the attributes are displayed in the generated report itself.

Sorted by/
Then by

Select an attribute type in the Sorted By list and as many as three Then by lists to refine your sorting criteria.

Next to each field, select the option to sort your selection in ascending or descending order.

Preview Select the Preview tab to test run the report before saving it.

Save

Click to save the report.

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

Back to top

See also: