Activity Instances Grid Control
The Activity Instances Grid control lists all activity instances of a workflow according to filter criteria, and is displayed as detailed information of an activity instance or instances. You can use the grid to:
- Determine the priority and status of activity instances
- Determine when the activity instance is assigned and date of completion
- View the user involved with the specific activity instance. To do this, you can configure a rule to interact with the User Performance Grid. See the Rules, Events, and Actions section for more detail.
Try it yourself!
- Create a view.
- Drag the control onto the canvas. You can find the control in the Reports section of the Toolbox
- Configure the properties of the control as needed. See the Properties section below for detail about the options available
- Run the view
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 selected control. This property is required and defaults to the name of the control. | No |
Title | The title of the control. | Yes, see Configure the Set a Control's Properties Action for more information. |
Show Title | Shows or hides the title. | Yes, see Configure the Set a Control's Properties Action for more information. |
Filters | ||
Workflow Names | The workflow on which to filter the data returned in runtime. If All is selected, all activity instances of 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 Configure the Set a Control's Properties Action for more information. |
Status | The status of the activity instance to filter. Click the ellipsis to use the Status Picker. The default setting is All. | Yes, see Configure the Set a Control's Properties Action for more information. |
Users | Includes users who participate in an activity instance. Click the ellipsis to use the Users Picker. | Yes, see Configure the Set a Control's Properties Action for more information. |
Exclude Server Events | When you select this option, server events are not included in the data. | Yes, see Configure the Set a Control's Properties Action for more information. |
Chart Data | ||
Range | The date range to use to filter the data. The data returned typically executes according to the date on which an activity instance is started. Select a date range from the predefined drop-down list to filter on. Click the ellipsis to use the Date Range Picker. | Yes, see Configure the Set a Control's Properties Action for more information. |
Show Range | Shows or hides the date range at the top of the control. | Yes, see Configure the Set a Control's Properties Action for more information. |
Data | ||
Visible Columns | You can select which columns are visible. Click the ellipsis then select the columns. | Yes, see Configure the Set a Control's Properties Action for more information. |
Initial Value | First record - You can choose if the first record returned on the list is selected when you use the Run Grid method of the control. This can be useful when you expect only one record to return and require no user interaction to select the record. If you select None, the first record is not automatically selected when the method executes. | Yes, see Configure the Set a Control's Properties Action for more information. |
Display | ||
Sort by Default | Uses the default value of Date Assigned to sort the results. | No |
Use Paging | Enables paging in runtime. If you do not select this option, all results return as one list. | Yes, see Configure the Set a Control's Properties Action for more information. |
Page Size | You can specify the amount of records to show per page. The default is 10, but you can type any number. | Yes, see Configure the Set a Control's Properties Action for more information. |
General | ||
Width | Adjusts the width of the control. You can enter any whole percentage up to 100%, whole number, or pixel value to a maximum of 32767px. | Yes, see Configure the Set a Control's Properties Action for more information. |
Visible | Shows or hides the control. | Yes, see Configure the Set a Control's Properties Action for more information. |
Enabled | Enables or disables the control. | Yes, see Configure the Set a Control's Properties Action for more information. |
Read-Only | Shows the control as read-only. | Yes, see Configure the Set a Control's Properties Action for more information. |
Format | Opens the Format page where you can configure formatting and style features such as format, font, borders, padding and margins. See the Format topic for more information. | No |
Conditional Format | Opens the Conditional Formatting page. You can add conditional formatting to apply a specific format or style when a condition you set is True. Use conditional format on its own or with the Format feature. See Conditional Format 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 in runtime.
- When you use rules, you can use the control properties in the context browser for mapping to other controls. This means that you can drag the property from the control to another control’s properties or control value
- You can use the following properties as input mapping properties and in the context browser when you use rules for mapping to other controls. These properties are additional to those mentioned in the Properties section of this topic, but are only available for interaction with rules:
Activity Name: Filters the grid based on the full activity name (including the folder and process name)
Workflow Instance ID: Filters the grid based on a Workflow Instance ID - You can, for example, use the Workflow Instances Grid to filter the Activity Instances Grid and User Performance Grid. This allows you to click an activity on the Workflow Instances Grid, the Activity Instances Grid is updated to show only activities for the selected workflow instance. In turn, when you click a filtered activity on the Activity Instances Grid, the User Performance Grid is updated to show users who have completed that specific activity of the workflow instance. Create and configure the following rules for this scenario:
- Event: When the View executes a method
Action: Execute a control's method
Action: Execute a control's method
Action: Execute a control's method - Event: When a control on the View raises an event
Action: Execute a control's method
Configuration: Map the Workflow Instances Grid to the Workflow Instance ID of the Activity Instances Grid - Event: When a control on the View raises an event
Action: Execute a control's method
Configuration: Map the Workflow Instances Grid to the Workflow Instance ID of the User Performance Grid and the Full Activity Name of the Activity Instances Grid to the Activity Name of the User Performance Grid - The result looks like this:
- Event: When the View executes a method
The following events and methods are 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.
- When [control] is Populated: This event executes each time the control is loaded. You can execute a rule condition or action when the control is loaded, for example execute the Run method of another report control.
- When [control] is Clicked: You can execute a rule condition or action when the control is clicked, for example populate another control.
- When [control] is Double-Clicked: You can execute a rule condition or action when the control is double-clicked, for example populate another control or open a subview.
Control Methods:
- Execute a control's Clear method: Clears the workflow data from the control. You can use this method for example to clear the workflow data and then execute a Run method using rule mappings of a different workflow.
- Execute a control's Run method: Gets the data from the database, applies configuration and rule settings, and then displays detailed information of an activity instance or instances.
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.
- The control is also available when designing forms
- The value of the Activity Instances Grid is the instance id. When you click a record in the Activity Instances Grid at runtime, the value of the grid is the selected instance id which you can use to bind properties or configure rules.
- When you use custom themes, be sure to specify the CSS classes for the elements.
- You cannot change the predefined grid control columns. However, you can deselect columns in the control's properties so that they do not display.
- You can use Report controls to access the data of workflows created in any workflow designer, including the K2 Designer and K2 Designer for SharePoint.