Report Header Control

The Report Header control is an interactive reporting dashboard allowing you to view different types of workflow reports. Use the control to filter charts or grids on a view or form. You can configure rules to run a chart or grid when you change a filters, or you can use the control as a header to indicate which filters apply to the chart or grid by enabling the Read-Only property.

  1. Create a view.
  2. Drag the control onto the canvas. You can find the control in the Reports section of the Toolbox.
  3. Configure the properties as necessary.
  4. Add another Report control such as a chart or grid to display the information and configure the properties of that control. The example shows an Activity Instances Chart control.
  5. Add a rule to run the chart or grid when the control is changed to refresh the filters.

You can find the control in the Reports section of the Toolbox.

Property Description Can be set in runtime using Rules
Detail
Name A unique identifier for the control. This property is required and defaults to the name of the control. No
Title The title to display for the control. Yes, see Control Properties Actions for more information.
Users
Users Select users who start or participate in a workflow instance. Click the ellipsis to use the Users Picker. Yes, see Control Properties Actions for more information.
Display Shows or hides the Users filter. Yes, see Control Properties Actions for more information.
Edit Enables or disables the Users filter. Yes, see Control Properties Actions for more information.
Status
Status You can select specific statuses of the activity instance or workflow instance you want to filter. The statuses depend on the type of report you use with the control. Click the ellipsis to use the Status Picker. The default setting is All. Yes, see Control Properties Actions for more information.
Display Shows or hides the Status filter. Yes, see Control Properties Actions for more information.
Edit Enables or disables the Status filter. Yes, see Control Properties Actions for more information.
Range
Range

The date range to use to filter the data. The data returned typically executes according to the date on which a workflow instance or activity instance is started. Select a date range from the predefined drop-down list to filter. Click the ellipsis to use the Date Range Picker.

 Yes, see Control Properties Actions for more information.
Display Shows or hides the Range filter. Yes, see Control Properties Actions for more information.
Edit Enables or disables the Range filter. Yes, see Control Properties Actions for more information.
Workflows
Workflow Names

This is the workflow on which you want to filter the data. If you select All, all workflows are shown. Click the ellipsis to use the Workflows Picker. You can add more than one workflow to the list. The default setting is All.

 Yes, see Control Properties Actions for more information.
Display Shows or hides the Workflows filter. Yes, see Control Properties Actions for more information.
Edit Enables or disables the Workflows filter. Yes, see Control Properties Actions for more information.
Activity
Activity Name This is the activity on which you want to filter the data. This property is only applicable when you use the control with a User Performance Chart or User Performance Grid control. Click the ellipsis to use the Activity Picker. Yes, see Control Properties Actions for more information.
Display Shows or hides the Activity filter. Yes, see Control Properties Actions for more information.
Edit Enables or disables the Activity filter. Yes, see Control Properties Actions for more information.
Display Value
Display Value This shows how the data is aggregated in the chart or grid. You can select to show the data in duration (how long the activity took to complete) or instance count (the amount of instances per activity). Yes, see Control Properties Actions for more information.
Display Shows or hides the Display Value filter. Yes, see Control Properties Actions for more information.
Edit Enables or disables the Display Value filter. Yes, see Control Properties Actions for more information.
Chart Type
Chart Type You can display a chart as a Column, Pie or Bar chart
Column - Displays values as sets of vertical columns that are grouped by category
Pie - Is a circular chart divided into sectors. Each sector shows the relative size of each value
Bar - Is a chart using rectangular bars with lengths proportional to the values they represent		 Yes, see Control Properties Actions for more information.
Settings
Expanded Expands or collapses the header. Yes, see Control Properties Actions for more information.
General
Tab Index Defines a sequence that users follow when they use the Tab key to navigate through a page at runtime. Yes, see Control Properties Actions for more information.
Height Adjusts the height of the control. You can enter any whole number or pixel value (maximum of 32767px). When set to zero, it's sized to fit the content of the page. Yes, see Control Properties Actions for more information.
Visible Shows or hides the control. Yes, see Control Properties Actions for more information.
Enabled Enables or disables the control. If the control is disabled, you cannot interact with the control. Yes, see Control Properties Actions for more information.
Read-Only Shows the control as read-only. Yes, see Control Properties Actions for more information.
Styles Opens the Style Builder allowing you to specify style features like format, font, borders, padding and margins. See the Style Builder topic for more information on styling options. No
Conditional Styles Opens the Conditional Formatting page. You can design styles that apply only when certain conditions are met. See the Conditional Styles section for more information. Click the ellipsis to open the Conditional Formatting page. No

Report controls interact with each other through rules. When you bind properties between different controls, you can use the data to populate properties or set values. As an example, if you bind the Range property of the Report Header control to each report control on a view or form, you can use the Range filter to apply the same date range to all reporting controls.

The following event is available on the control:
Rule Events:

  • When [control] is Changed: This event executes when the control is set to a new value that is different from the previous value. You can use this event to trigger actions when the control is changed, for example execute the Run method of another report control.

Security on the Report controls ensures that the data is seen by only those who are authorized. Permissions are based on the process rights assigned to the process in Management Site:

  • Admin or View permissions: You can access the Report controls.
  • View Participate permissions: You can view the Report controls from the point where you are part of the workflow.