Create and Use a Custom Site Filter

Custom Site Filters enable you to filter any list against criteria defined in the Project Statement. For example, you may have defined markets (e.g. France, Ireland and USA) in the Project Statement. If you added a custom Site Filter to a work or issues report, you could see only the items that were relevant to the market you were interested in (e.g. see all high priority issues for Ireland or all late work for France).

At a high level, the set of steps to achieve this include:

• Add Site Column to Project Statement
• Create Copy of Open Work Report
• Add Report to Web Part Page
• Add Project Filter

Add Country Site Column to Project Statement

Add the Country site column you created previously to the Project Statement in a template and sync this template to your training site (alternatively, you can add the Country site column directly to the Project Statement in the training site).

Open the Project Statement for editing and select a value from the Country column (e.g. USA).

Create Copy of Open Work Report

Next, you will create a copy of the open work report.

1. Click Home, then click Site Contents.
2. Click Files | New Document.
3. Click BrightWork Reporter Library.
4. Give the report a name (e.g. Contoso Open Work).
5. Select Copy an existing Reporter Definition from the BrightWork Server Gallery.
6. Select the Templates Work - Open Work report.
7. Click Create.

Add Custom Report

Next, you will replace the open work report in the Project Office with the one you just created.

1. Navigate to the Project Office in your scratch area and click Work on the Quick Launch.
2. Click Customize Reporter Settings on the reporter web part menu.
3. Select BrightWork Reporter Library.
4. Select the custom report you just created and click OK.

   Note: We recommend that you keep this page open whilst you complete the rest of the exercise. Ctrl click on the Home tab on the Top Link bar to go the correct location for the next section.

Add Project and Report Filter

Next, you will add the site filter to your report. First you add a Project Filter and then a Report Filter. The Project Filter contains the CAML that filters the column you added, the Report Filter contains the in-report menu that allows you to dynamically filter the report.

1. Return to the BrightWork Reporter Library, select your report and click Files | Report Editor.
2. Scroll down to the bottom of the page and click Add a new site filter.
3. Select Add Project Filter.
4. Give the filter a display name.
5. Copy and Paste the below CAML code into the report.

   Note: The FieldRef name (Market) queries the site column you added earlier. If you gave the site column a different name you should update it to this.

   The [Market] item between the Value tags is what you will use for the Report Filter internal name. You can use any value you like here but you should remember what you uses as you will reuse it when adding the Report Filter.

   See Working with Query CAML for more information about CAML.

   <Where>

   <Eq>

   <FieldRef Name="Market" />

   <Value Type="Text">[Market]</Value>

   </Eq>

   </Where>

6. Click Create.
7. Click Add a new report filter in the Report Filters section.
8. Enter Market in the Filter Internal Name and Caption fields.
9. Select Choice and leave Values selected.

   Note: In this example we are using the simple Values choice type. For more information on the various choice filter options, see Add a New Report Filter.

10. Enter the choice values you previously added to the Country site column.
    Select Market
    France
    Ireland
    USA
11. Enter Select Market in the Default Value field.
12. Click Create.

Now, if you return to the report page and refresh it, you should see your filter. If you select the value (e.g. USA) you selected in the Project Statement you added the site column to, it should return work items from this site.