List Query Templates define the list to be queried in the reports.

To edit a list query template:

  1. Navigate to the BrightWork Reporter Library, select the report and click Files | Report Editor.
  2. Click the List Type link beside the List Query Template you want to edit.
  3. Specify the Context Settings.

    Context Settings enable you to define a list to use to test your CAML and to build the column mappings. It is important that you select a context first as selecting a new one resets the page.

    1. Select Change Selected Site from the Selected Site menu.
    2. Click a site that has an example of the list you want to query. This SharePoint dialog shows 15 items at a time. There is a link in the top-right of the dialog to see the next 15 items. This also applies when selecting the list context.
    3. Select Change Selected List from the Selected List menu.
    4. Click the list that you will be using to test the CAML and build the column mappings.
  4. Select the List Query type:
    • List Type
      Enter the List Type number(s) - see BrightWork and SharePoint List Types.

      This is the option you will most likely need to use.

      You can only have one instance of each list type per report.

      If you have specified a context, the List Type number will be displayed.

    • List Name
      Enter the list name, for example, to report on all lists called Tasks enter Tasks.
    • Default List
      This option allows you to report off all lists using the same query irrespective of the list name or type (lists already / subsequently specified with List Type or List Name will not be queried by this method).
    • This option can be useful if you want to query all the lists in the scope when you know that they all share common columns that you can query against; however it does return all lists, including Tabs, List of Lists etc.
    • Default Library
      This option allows you to report off all libraries using the same query irrespective of the library name or type (libraries already / subsequently specified with List Type or List Name will not be queried by this method). This option can be useful if you want to query all the libraries in the scope when you know that they all share common columns that you can query against.
    • This option can be useful if you want to query all the libraries in the scope when you know that they all share common columns that you can query against; however it does return all libraries, including BrightWork pages.
  5. Enter the Query CAML (optional).
    See Working with Query CAML.
  6. Specify an Items Returned Limit (optional).
    This option allows you to limit the number of items returned in the report on a per list basis.
  7. Select a Scope (optional).
    • All Items
      This is the default setting. It means that items in folders and subfolders are returned by the report but not folders.
    • All Item and Folders
      This means all items and folders are returned by the report.
    • Top Level Items Only
      This means that only top level items are returned by the report. Folders and items in folders are not returned by the report.
    • Top Level Items and Folders
      This means that only top level items and top level folders. Items in folders and subfolders are not returned by the report.
  8. Click Update.

Was this article useful?

Back to Top