Scenario

A report that shows the count of all direct children pages and descendant (indirect children) pages of a On this page:

Scenario

Create a report showing the number of direct child pages and all descendant pages of a specified parent page.

Result

...

Recipe

Steps

To build this reportthe report shown in the Result section above, follow the these steps below:

1. Create a new page for the report Confluence page, add a Reporting macro, and give it the page a suitable title. Then insert a Reporting macro.

2. In the Reporting window, under Query, type Query section on the left, set up the parent page query by typing the Confluence Query Language (CQL) syntax that will allow you to search for the parent page, whose children and descendants you want to report on. Refer to this Atlassian article for more information on the CQL syntax.
   The example CQL below. For this example, use: type=page AND title="Get Started"will match all pages with the title "Get Started" in the current space???.
   Click Search and to confirm that your CQL syntax is matching the the query matches your parent page.

   Image Removed

3. Now continue to the Report Builder section. We'll start by building the first column for the report (leftmost column), which will contain the employee’s name.

   1. In the dropdown, Choose Scaffolding, then click on Add.

      Image Removed

   2. Click on "Block 0", then under Title, key in "Name", and under Field Group Name, select the correct Field Group from the list. For this example, it is "profile_group". 

      Image Removed

   3. Continue by clicking on Field Name. A list of fields will appear. Select the field that matches the title. For this example, it is "employee_name". Click Update to continue.

      Image Removed

4. Next, we'll add the second column for the report, which will display employees' positions.

   1. Again, choose Scaffolding in the dropdown, then click on Add.

      Image Removed

   2. Click on "Block 1", then under Title, key in "Position", and under Field Group Name, select the correct Field Group from the list. For this example, it is "profile_group". Click on Field Name. A list of fields will appear. Select the field that matches the title. For this example, it is "employee_position". Click Update to continue.

      Image Removed

5. Repeat step 7 for the two remaining columns, "Start date" and "Employee ID". Make sure you match the field to the title each time.

6. Under Report Type, choose Table (the default). Then, we'll add some error handling by filling out the Empty Report section. This text is shown if the report has no results. For this example, we'll enter "No matching profiles were found. Please try again later." You will also see a preview of the report here.

   Image Removed

7. Save your report, Publish the page, and you're done.

Steps

The template mentioned above will generate a report on content created by you. This is specified by a section of the CQL query which is, creator=currentUser().

You can easily create a report on content created by another user just by changing the creator value to the user's account ID. For example, if the user account ID is 621dabxxxxx4c0070ad1fe7,  then the CQL should be:

creator="621dabxxxxx4c0070ad1fe7"

...

You can obtain a user's account ID by following these steps:

1. In Confluence or Jira, click on the People tab, and either select or search for the user you are interested in. View their profile.
   

   Image Removed

2. The URL of their profile page will include their user account ID at the end. It will look a like string of random letters and numbers. You can copy this string and use it for CQL queries.
   

   Image Removed

Notes

...

Caveats

...

1. In the Add Expansions section, check the following boxes to retrieve child and descendant pages:

   • children > page

   • descendants > page
     

     Image Added

2. Now, start building the columns of your report. To display the Parent page title in the first column, go to the Add report blocks section to add the first block, which will also be your first column.

   1. Go to Add Report Blocks, select Basic, then Add block.

   2. For Block title, type Parent page, and set the Value to content.title.
      
      Look at the screenshot to see how the block’s settings and preview should appear:

      Image Added

3. Add another block for the Direct Children Countcolumn, title it Direct Children Count, and set the Value to content.children.page.size

4. Finally, add the block for the third column, title it All Descendants Count, and set the Value to content.descendants.page.size

7. Check the Preview and Save your report.
   The final block configuration should appear as shown in the screenshot below:

   Image Added

8. Publish the page, and you're done.