This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview

The dashboard report is used to display lists of document management tasks assigned to the user viewing the report. It's great for building custom dashboards.

This is one of several reports available from the Workflow Report Macro.

Permissions

Anyone can see this report, but they'll only see tasks assigned to them.

Adding the report

To add the report to a page:

  1. In the editor, choose Insert → Other Macros → Reporting → Workflow Report
  2. Set the Type setting to dashboard
  3. Choose Insert

Here's how the macro looks on your page:

The content for report will be seen for the current user, in this example Adam Samuel.

Customizing the report

You can customize the report with the following macro settings:

SettingDefaultNotes
Space Key(s)Current space

Which space(s) should be included in the report?

  • Leave empty to report on the current space
  • Specify one space key to report on a specific space
  • List multiple space keys, separated by commas, to report on multiple spaces
  • Specify any to report on all spaces. If you do this, you must specify only one state in the State setting.
Max Entries20The number of results to show per page. †
Label

Should the report be filtered by content label(s)?

  • Leave empty to include all content
  • Specify one label name to filter to a specific label
  • List multiple label names, separated by commas, to filter to content with any of those labels

If using a list of labels, you can prefix the list with & (ampersand) to require that content has all the labels.

Parent Page Filter

Should the report be filtered to a specific parent page and the child pages of the specific page?

  • Leave empty to include all content in the space
  • Specify a page title to include the specified page and its child pages
Sortmodified

Which column of the report should results be sorted by?

Sort OrderdescendingShould the sort be in ascending or descending order?
Hide Header
Should the report title be removed?
† The macro has a 500-page limit for each report. If a larger report is required it may be useful to use the CQL REST API.

See also

Reporting Guide:

Integration Guides:

  • No labels