Configuration Options - Task List Web Part

Sets up the SharePoint Task List Web Part.

Navigation

  1. In SharePoint, navigate to the Task List Web Part.
  2. On the Web Part window, click the Arrow button, and then click Edit Web Part. The Arrow button appears only when you move the pointer over the Web Part window.

    The navigation for this task varies, depending upon your SharePoint version and the SharePoint settings in your local environment. For more information, see the documentation for SharePoint.

Field Definitions

Field Name Definition

Type of List

Definition:
Determines the scope of the tasks you want to display in the Task List Web Part.
Note: Except for the default Tasks option, all options listed here have the potential to download a large amount of data, which can slow SharePoint performance. These options are recommended only in views or pages created for managers. They are not recommended for other users.
Allowed Values:
  • Tasks - Displays your tasks only.
  • MyDirectTeam - Displays your tasks, plus the tasks for any users for whom you are listed as the Manager in AgilePoint Enterprise Manager.
  • MyTeamAndSub - Displays tasks for you, the members of your direct team, and the members of their direct teams. This is typically used by higher level managers.
  • MyDepartment - Displays your tasks and the tasks for everyone in your department.
  • MyGroup - Displays your tasks and the tasks for all members of groups for which you are the group leader in Enterprise Manager.
  • MyGroupPeers - Displays your tasks and the tasks for all members of all groups for which you are a member.
  • AllTasks - Display all the tasks for all users within the AgilePoint BPMS system.
Default Value:
Tasks

Templates

Definition:
Specifies process templates the Web Part uses to filter process instances.
Allowed Values:
One or more process template names.

You can enter multiple process template names, separated by semicolons (;).

Default Value:
None

Groups

Definition:
Limits the display of tasks. Only the tasks of the specified list of groups are displayed.
Allowed Values:
The name of your group.

You can separate groups using semicolons.

Default Value:
None

Departments

Definition:
Limits the display of tasks. Only the tasks of the specified list of departments are displayed.
Allowed Values:
The name of your department.

You can separate departments using semicolons.

Default Value:
None

SharePoint Fields

Definition:
Allows to display the context data of a process instance.

To perform this, you must first publish context data into the SharePoint library using metadata fields, and then type a semicolon-separated list of column names.

Allowed Values:
The name of your SharePoint fields.

You can separate list of columns using semicolons.

Default Value:
None

Show "Complete Selected Tasks" in Global Actions

Definition:
Determines whether to display the Complete Selected Tasks option in the Global Actions list that enables the user to complete a number of selected tasks at once.
Allowed Values:
  • Deselected - Specifies not to display the Complete Selected Tasks option in the Global Actions list.
  • Selected - Specifies to display the Complete Selected Tasks option in the Global Actions list.
Default Value:
Deselected

Show Multiple Dynamic Group/Roles

Definition:
Determines whether to disable querying against multiple dynamic groups or roles if a Web Part performance is slow.

The reason is that some organizations experience slow performance while querying against multiple dynamic groups or roles. You can deselect this option to enhance the Web Part performance. The tasks for the dynamic groups or roles are not displayed in the Web Part.

This setting is optional. Not all organizations experience this issue, and deselecting this option results in reduced functionality.

Allowed Values:
  • Selected - Specifies to execute queries against multiple dynamic groups or roles.
  • Deselected - Specifies not to execute queries against multiple dynamic groups or roles.
Default Value:
Selected

Open task by clicking the task link

Definition:
Determines whether to enable a user to open a task by clicking the hyperlinked task name.
Allowed Values:
  • Deselected - Specifies not to open a task by clicking the hyperlinked task name.
  • Selected - Specifies to open a task by clicking the hyperlinked task name.
Default Value:
Deselected

Show Overdue Task in Color

Definition:
Determines whether the Web Part displays overdue tasks with a different color.
Allowed Values:
  • Deselected - Disables displaying overdue tasks with a different color.
  • Selected - Enables displaying overdue tasks with a different color.
Default Value:
Deselected

Color for Overdue Tasks

Definition:
Specifies to choose a color from the list to mark overdue tasks.
Allowed Values:
The color you want.
Default Value:
Red

Color for Selected Task

Definition:
Specifies to choose a color from the list to set the background color for the selected tasks.

Selected tasks are marked when the ID of tasks is passed using the http query string parameters. This is also applied while sending emails to include a link to task:

http://mysite/default.aspx?WID=[WorkItemID]

Allowed Values:
The color you want.
Default Value:
LightBlue

Color for Tasks on Pool

Definition:
Specifies to choose a color from the list to set the background color for tasks that are assigned to a pool.
Allowed Values:
The color you want.
Default Value:
LightYellow

Items Per Page

Definition:
Specifies the number of items to display on one page in the Web Part.
Allowed Values:
An integer.
Default Value:
10

Max. Tasks to Retrieve

Definition:
Limits the number of tasks to be retrieved. Limiting the number of tasks to retrieve can help improve performance.
Allowed Values:
An integer.

If you are using columns that retrieve data from Custom Data Sources, AgilePoint recommends limiting this number to 50 or lower.

Default Value:
500

AgilePoint Columns

Function:
Enables you to show or hide columns on the Web Part and set the display name for columns.

Apply Filter

Definition:
Specifies whether to filter items in the Task List Web Part based on column values.

The value in the Filter Condition field performs actual filtering operation.

Allowed Values:
  • Deselected - Specifies not to filter items int the Task List.
  • Selected - Enables filtering for the Task List using the Filter Condition field.

    This option may adversely affect the Task List performance.

Default Value:
Deselected

Filter Condition

Function:
Sets the filter criteria that defines which SharePoint list data to be retrieved.
Allowed Values:
A valid SQL query.

For more information, see Filtering the SharePoint Task List

Default Value:
None
Example:
For more information, see Filtering the SharePoint Task List

Pre-Processing Custom Filter

Definition:
Specifies whether pre-processing custom filter is enabled on the task list. This option enables you to filter Task List results before they are processed by the Task List Web Part in order to improve Task List performance.

This advanced option supersedes the Apply Filter field used for standard Task List filtering.

Note: This advanced option is required only if you want to perform pre-processing for filtering custom data columns. This is an uncommon situation.
Allowed Values:
  • Deselected - Specifies not to apply any filter condition.
  • Selected - Enables the pre-processing filter condition option.
Default Value:
Deselected

Data Population DataBase

Definition:
Specifies the name of your data population database.
Note: This advanced option is required only if you want to perform pre-processing for filtering custom data columns. This is an uncommon situation.
Allowed Values:
The name of your data population database.
Default Value:
None
Example:
MyDatabase

Query

Definition:
Specifies a query to retrieve Task List data from the Data Population database before filtering it with the Filter Condition.
Note: This advanced option is required only if you want to perform pre-processing for filtering custom data columns. This is an uncommon situation.

Click the Ellipses button to open an editor window to set the query condition in the field.

Allowed Values:
A SQL query in the following format:

SELECT [process instance ID] FROM <data population table> WHERE <condition>

  • [process instance ID] - The name of the column in the population table to which process instance id is mapped in data population configuration. The square brackets [ ] are literal, and are required.
  • <data population table> - The name of your data population database table. Do not include the angle brackets < >
  • <condition> - Your SQL condition. The left side of the condition statement is the name of the database column you want to filter. Do not include the angle brackets < >
Example:
SELECT [ProcessId] FROM PopulationTable WHERE UserRole='Manager'