Step-1: Choose data

Choose the data type for your report.

1. Open Report Builder.

   Go to https://server_name:port/rs. On the Reports page, click Create Report. If the page doesn't open, contact your application administrator.

2. Choose a report type.
   • Click the Edit icon to select the data source. If only one data source is defined, it is selected by default. To decide what data source to choose, read this topic.
   • Select Historical Trends (time series) to report on trends and metrics for projects.
3. Limit the scope.

   Choose the projects to report on, and click Continue. If you don't select any projects, the report includes all projects that you can access.

   The list shows the projects that you can access in the data source that you selected. If your projects are not in the list, see the administrator who created the data sources for Report Builder.

   • For Data warehouse, all projects are listed.
   • For Lifecycle Query Engine, only projects that are not enabled for configurations are listed.
   • For Lifecycle Query Engine scoped by configurations, only configuration-enabled projects are listed.

   Some artifact trends are project-specific. Go to step 4 to select the trend, then return here, and select List only the projects that contain the artifact for your report.

4. Choose artifacts to report on.

   Select one or several artifact trends to report on, and click Continue. The trends are organized under the artifacts in the lists, so you might have to expand some artifacts to choose a trend.

   If you select an artifact trend that is project-specific, then return to the Limit the scope section, and select List only the projects that contain the artifact for your report.

   For example, if you want to measure work item totals, you pick the basic Totals trend under Work Item artifact. Alternatively, if you want to find out about work item creation trends, pick Creation trend. For information about specific trends, see Artifact trends in Report Builder.
   Note: For Lifecycle Query Engine, if you report on the Work Item Totals trend, the report returns only the work items that were closed in the last year.
5. Trace relationships and add artifacts.
   Trace relationships from an initial artifact to other artifacts and add artifacts according to the requirement. Select Enable multiple paths or add other source artifacts to enable multiple paths or add other source artifacts.
6. Set a time range.

   The time range that you select is added as a condition in the Set conditions section.

   Note: To report on specific quarters, months, or days, go to the Set conditions section, and add a condition for the Date [Type:Date] type; then, select the day, month, period, or quarter to report on.
7. Set conditions.

   To further refine the content of your report, specify conditions. You can set conditions for any attribute of the artifact trend that you selected.

   For example, when considering total work items, if you are interested in currently open work items, you can add this by selecting the Totals trend for Work Item in the Attributes of drop down in the condition dialog and selecting the Status Group Category attribute and constraining it to unresolved.

   The Resolution trend captures metrics around total number of resolved and closed Work Items on a given day. If you are interested in straight resolutions and not closures then add an additional condition there on the State attribute to check only for resolved. Creation trend captures all Work Items that are created on a certain day so no special considerations need to be done there.

   Note: If you selected more than one trend in step 4, some of the conditions that you apply to one trend must also be applied to the others. For example, if you selected the Creation and Resolution trends for Work Item and you want to know about defects for a particular version, the Type and the Planned for attributes must be applied to both trends.
   Add conditions

   1. Click Add condition.
   2. From the list, select an artifact type.
   3. Choose the attribute that you want to specify a condition for, and select the values to return the artifacts you want.

      For example. for trend reporting, you can select a date range to restrict the results. However, you might want to restrict the result further by allowing work days (that is. Monday to Friday) or specific months or quarters of the year. You can do this by selecting the Date artifact type.

      This ability might be most useful for improving report performance by reducing the results to a specific day of the week. If you’re examining a long date range, you can pick a specific day of the week to draw the trend from (such as Wednesday), significantly reducing the number of results the query and chart engine must process while providing the same trending information.

      Adding a condition on the Date artifact affects all the trends though. This might not be desirable if you need to accumulate trend values over the course of a period though. Especially, if the trend captures some daily value that might vary from day to day. For example, the trends such as creation or resolution, the metrics in these trends are a daily total that is How many work items were created or resolved on a specific day. If you want to see a weekly trend total for these you can’t exclude any particular days from the result. So, to add a Day of Week date condition on a particular trend, we need to select the trend in question and look for the Day of Week attribute.

   4. To keep the window open for adding other conditions, click Add. Otherwise, click Add and close.
   5. Change the lock to control whether people can or must supply a value for the condition when they run the report. You can choose from one of the following options:
      • Locked: Users cannot edit when running the report.
      • Unlocked + optional: Users can edit when running the report.
      • Unlocked + required: Users must edit when running the report.

   Edit conditions

   1. To edit a condition, click the edit icon.
   2. To create logical groups of consecutive conditions, select them, and click Group.
   3. To create nested groups of conditions, use the grouping buttons or drag conditions to existing groups.
   4. To exclude data from a report by grouping conditions, use the Not all match (AND NOT) or None match (OR NOT) options.
   5. To reorder conditions, drag them into position.
   6. To remove conditions, select them, and click Remove.

   After you create your conditions, click Continue.