Page Properties Report & Export for Confluence

A Page Properties report you can sort, filter and export.

Insert the macro on a page and choose which pages it lists and how. Readers can then sort, filter, and download the rows as Excel or CSV.

The report lists pages that have a Page Properties macro. That macro holds a table on each page: property names in the first column and values in the second, or names in a header row and values in the row below. The report reads both layouts.

1. Insert the macro

1. Edit a Confluence page.
2. Type /Page Properties Report and choose Page Properties Report & Export. Its settings open.
3. Choose the pages, columns, sort, and display options described below. The Preview shows the result; choose Update preview after a change.
4. Choose Save, then publish the page.

To change the settings later, edit the page, select the macro, and edit it from its toolbar. Only people who can edit the page can change the settings. They are saved in the macro on the page.

2. Choose the pages

• Labels: list pages with any or all of the labels you enter. Leave it empty to list pages whatever their labels.
• Spaces: This space, These spaces… (enter the space keys), or All spaces.
• Location: Anywhere, Below this page, or Below the page with ID… (enter the parent page ID).
• Include blog posts: also list blog posts that have Page Properties.

Under More options:

• Page Properties ID: read only Page Properties macros with this ID. Use it when pages have more than one Page Properties macro.
• Extra CQL: a CQL condition added to the search with AND. An ORDER BY clause is ignored; use the sort settings instead.
• Page limit: the most pages the report lists. The default is 1,000 and the maximum is 5,000.

If you choose All spaces with no other condition, the settings warn you that the report covers every page with Page Properties on the whole site.

3. Choose the columns

Each property found on the pages becomes a column. Title links to each page, and you can also show Space, Created, and Last updated. For each column you can:

• tick Show to show or hide it;
• type a new Header;
• set a Width (px), or leave it on auto;
• move it up or down to change the order.

Properties that appear on pages later are added as new columns at the end. Tick Don’t add new properties automatically to keep the column list as it is.

Property names match ignoring case and extra spaces, so “Owner” and “owner ” share a column. If a name appears twice on one page, the first value is used.

4. Sort and filter

• Sort by and Then by: up to two sort levels, each ascending or descending.
• Only rows where: add saved filters on any column, using contains, does not contain, is, is not, is empty, or is not empty. A row must match every filter.

Dates sort as dates, numbers as numbers, and text in natural order, so “Item 2” comes before “Item 10”. Empty values always stay at the bottom.

5. Display

• Rows before “Show more”: how many rows the report shows at first (50 by default).
• Show a filter box for readers and Show Excel and CSV download buttons: both are on by default.

Reading the report

• Click a column header to sort by that column. Click it again to reverse the order. This changes only your view; the saved sort stays for everyone else.
• Type in Filter rows to show only rows that contain all your words. Case and accents are ignored, so “chloe” finds “Chloé”.
• The count above the table shows how many pages match. Choose Show more to see the next rows.
• Click a title to open that page.
• Wide reports scroll sideways.

Every request runs as the person reading, so each reader sees only the pages they are allowed to read. Two readers can see different rows.

Downloads

Choose Excel for an XLSX workbook or CSV for a CSV file. The file has the rows that match the current filter, in the current order, with the visible columns, including rows not yet shown behind Show more. A Page link column with each page’s address is added.

• Status lozenges, dates, mentions, and Jira links are written as readable values.
• In languages that write decimals with a comma, such as German or Czech, the CSV uses semicolons as separators and decimal commas.
• The file is created in your browser. Where you save and share it is up to you.

PDF and Word export

When someone exports the page to PDF or Word from Confluence, the report is included as a table. It is sorted and filtered as saved in the macro settings, and lists up to 500 pages. A reader’s own header clicks and filter-box text are not part of it. The export lists the pages the exporting person is allowed to read.

Copy a built-in report’s settings

If the page already has Confluence’s built-in Page Properties Report, the settings say so and offer Copy its settings. One click copies its CQL, columns, sort, page size, first-column name, and ID. Check the preview, adjust anything you like, and choose Save.

Languages

The app’s text is available in English, German, French, Spanish, Italian, Portuguese (Brazil), Dutch, Polish, Japanese, and Czech. It follows each user’s Confluence language. Property names and values, and headers you rename, are shown as written. Confluence doesn’t tell apps the reader’s language during a PDF or Word export, so there the app’s own text, such as the Title header, is in the language of the person who last saved the macro’s settings.

Limits

• The report reads the published version of each page. Unpublished edits are not shown.
• New pages, and changes that affect which pages match, such as a new label, appear after Confluence’s search has indexed them. This is the same for the built-in report.
• A report lists up to its page limit: 1,000 pages by default, up to 5,000. When more pages match, the report says so.
• PDF and Word exports include up to 500 pages.
• Restricted pages are simply absent for readers who can’t see them.
• Other macros inside property values are shown as their text. Status lozenges, dates, mentions, and Jira links are the exceptions listed above.

Troubleshooting

No pages match

A page is listed when it has a Page Properties macro and matches the report’s settings. Check the labels and the any/all choice, the spaces, the location, the Page Properties ID, and any extra CQL. Pages you have just created or labelled may not be indexed yet. Check that you can open the pages yourself.

“License needed”

The app needs an active license. Ask a Confluence administrator to check the app’s license in Manage apps.

A banner asks to allow access

Choose Allow access. Confluence asks each person once before the app can read pages on their behalf. Until then, the report may say that Confluence did not allow the request.

“Confluence could not run the search”

Check the Extra CQL in the settings.

“Confluence is busy (too many requests)”

Wait a minute and try again.

A column is missing

Check that Show is ticked for it, and whether Don’t add new properties automatically is on. In a wide report, scroll sideways.

Need help?

Email info@druidori.com. See support details and what to include.