List widgets (Site List and Project Site List) display items from SharePoint lists in a table format. These widgets have the following parameters:
|
Parameter |
Description |
| Site 1) |
Site URL to pull the data from. |
| List Query | OData query that starts with a list name and determines items and columns that will be displayed in the table. |
| Headers |
Column names that will be applied sequentially to the columns returned by OData query. |
| Formats | Column formats that will be applied sequentially to the columns returned by OData query. |
| Field |
Column to display item link. |
| Path |
Column to that contains link to the item. |
| Show Subprojects 2) | Determines whether Project Site widget should pull items from project sites of sub-projects or not. |
1) Is applicable only to the Site List widget. Please see Site Parameter for details.
2) Is applicable only to the Project Site List widget. Please see Show Subprojects Parameter for details.
Parameters
List Query
List Query is a parameter used to specify OData query. Query should be specified in a relative form, full URL will be determined automatically by the widget.
For example, provide the following as List Query to display a list of issues with all columns:
Issues
List Query parameter also accepts OData Query String Options.
For example, provide the following as List Query to display a list of issues that are active or postponed:
Issues?$select=Title,StatusValue&$filter=StatusValue eq '(1) Active' or StatusValue eq '(2) Postponed'
which will give the output:
Please note: In case the list name contains spaces (e.g. Risks and Issues), in the query there should be no spaces.
Headers
Headers is a parameter used to define a comma-separated list of table headers that will be applied sequentially to the columns returned by List Query.
Headers in EPM Pulse On-Premise
In EPM Pulse On-Premise Headers parameter is set in Tools → Data Tab
For example, if List Query is set to:
Issues?$select=Title,StatusValue
and Headers is set to:
Issue Name, Status
then the output will be:
Headers in EPM Pulse Online
In EPM Pulse Online Headers parameter is set in Settings → Columns Tab. Type Headers names separating them with comma and click Apply button.
In case you have configured the widget in EPM Pulse Online, but there is no data to display, you will see only column names.
Formats
Formats is a parameter used to define a comma-separated list of table column formats that will be applied sequentially to the columns returned by List Query.
Formats in EPM Pulse On-Premise
In EPM Pulse On-Premise Formats parameter is set manually. For example, if List Query is set to:
Issues?$select=Title,DueDate
and Formats is set to:
{0},{0:d}then the output will be:
The following formats are supported:
|
Format Code |
Description |
|
{0} |
Plain text |
| {0:html} | HTML text |
|
{0:#,0} |
Integer |
| {0:#,0.00} | Decimal |
| {0:c} | Cost |
|
{0:#,0.##}% |
Percentage |
| {0:#,0.##} hrs | Duration |
| {0:d} | Date |
Formats in EPM Pulse Online
In EPM Pulse Online Formats parameter is set in Tools → Fields. You can use formats from the list, instead of setting them manually.
Field
Field is a parameter for defining a column name to display a list item link. This should be a field name from raw ODate results even if the field is renamed by Headers option. If you do not want to display item links, then leave this option blank.
Link
Link is a parameter for specifying OData column that contains a list item link. In the environments with English locale this is the Path field, however, it may be named differently in the localized environments.
Examples
Please see below several quick start samples of how to use List Widgets.
List of Active High Priority Issues
| Parameter | Value |
| List Query |
Issues?$select=Title,DueDate&$filter=substringof( 'high',PriorityValue) and substringof( 'active',StatusValue) |
| Headers | Title,Due Date |
| Formats | {0},{0:d} |
List of Active Overdue Issues
| Parameter | Value |
| List Query | Issues?$select=Title,DueDate&$filter=DueDate lt {Now} and substringof( 'active',StatusValue) |
| Headers | Title,Due Date |
| Formats | {0},{0:d} |
List of Active High Exposure (>=7) Risks
| Parameter | Value |
| List Query | Risks?$select=Title,DueDate&$filter=Exposure ge 7 and substringof( 'active',StatusValue) |
| Headers |
Title,Due Date |
| Formats | {0},{0:d} |
List of Deliverables
| Parameter | Value |
| List Query |
Deliverables?$select=Title,DeliverableStart,DeliverableFinish |
| Headers |
Title, Start Date, Finish Date |
| Formats |
{0},{0:d},{0:d} |
List of 'In Progress' Tasks
For Project Online and Project Server 2013 only.
| Parameter |
Value |
| List Query |
Tasks?$select=TaskName,DueDate&$filter=TaskStatusValue eq 'In Progress' |
| Headers |
Title, Finish Date |
| Formats | {0},{0:d} |