How to Run Reports in AEM

Navigate to AEM Reports 

1.   Login at author.tnc.org
2.   On the left side of the window, click the hammer icon to access the tools menu
3.   Click on the left menu item "ACS AEM Commons"
4.   Click on the Reports block

TNC Page Properties and History Report

The first report we are recommending is the TNC Page Properties and History report. As suggested by the name, this report can give you a record of everything entered in page properties for a given page, as well as when the page was created, when it was last modified, and by whom. 

If you want to run a report on a page, you must select the parent page in order to see the report for that page. For instance, if you want to find a page published under “Stories in Arizona”, you must select “Stories in Arizona” instead of the page itself. More simply, you must select the page the desired page lives under.

For each page included in the report, you will see what is entered in page properties fields and a history of when the page was published and updated. 

1.   From the reports page, click on TNC Page Properties and History Report
2.   Use the path picker to select a page node (the parent page for all pages that the report will include)
3.   Check the "All Results" box
4.   Click "Execute Report"
5.   View or download the report!

Note: if you want to return to the list of reports to run a different report, click the "Reports" breadcrumb link the top left-hand corner of the page. 

Report Columns 

In the report, you will see a number of columns which you can scroll through horizontally. Most of the columns are self-explanatory (e.g., the title of the page is listed under the Page Title heading). However, there are a few that are worth explaining:

• Path - the relative URL or page path
• Edit - under the edit column heading you will see a gear icon. Click the gear to open a new tab showing the page location within the AEM page tree. 
• Image Path - image path is referring to the page properties field under the image tab. For all columns from Image Path through Press Release Date, the entries are pulled from page properties fields.
• Date Created - this is the date the page was first created and does not refer to any information entered by a page author. The exception is in the case of the AEM migration - any page created before Fall 2018 will likely have a creation date of some time in August 2018 and under "Created By" you will see "admin" listed.  
• Created By - here you can find out who originally built the page. 
• Page Status - "Activated" means that a page is published and "Not Activated" means that a page is not published. 

TNC References Report

The second report we are recommending is the TNC References Report. The TNC References Report will provide a list of pages that link to a designated page.

Let's say that you have an article page on a TNC oyster restoration project, but the page is outdated and recieves poor traffic, so you have decided to fold the info on that page into a broader program overview page about TNC oyster restoration work, and delete the project article page. 

Before deleting that page, you want to find all the places that link to your outdated article. On some of these pages you may want to relink to the broader program overview page, in other places you will want to remove the link entirely. This is a great reason to pull the TNC References report. Directly from the report in AEM, you can open the pages that link to the article and fix the links. 

Or perhaps you have a great article and you want to make sure that it is linked to often. You can pull the TNC References report to find out where and how often the page is linked to.

1.   From the reports page, click on TNC References Report
2.   Use the path picker to select the page for which you want to identify references
3.   Check the "All Results" box
4.   Click "Execute Report"
5.   View or download the report!

Note: if you want to return to the list of reports to run a different report, click the "Reports" breadcrumb link the top left-hand corner of the page. 

Report Columns: 

• Page Path: This should show the relative URL of the page that you are looking up. If the page path shows a sub-page, you may want to repeat the query with the "Exclude sub pages from results" box checked. 
• Referenced by: In this column you will see the relative URLs of all pages that reference the page you selected. 
• Edit: Click the gear icon to open a site tree in AEM on the location of the reference page. 
• Page Title: Title of the page that references your selected page.

The remaining fields give details on the page author and publisher, the publication and update dates, and a few key page properties fields. From the author, publisher, business group, or geolocation, you should hopefully be able to track down the authors of the pages you do not own. 

TNC Component Instances Report

The TNC Component Instances Report will lets you choose a section of pages, then locate all of the uses of a given component within that section. For example, if you want to locate all of the video components used on articles from North Carolina, you could select the "Stories in North Carolina" page from the path selector, then choose the C39 Youtube Video component and run the report. This will pull up all the uses of the C39 Youtube Video component on articles in that section. 

Why would you need to find all uses of a given component? Maybe you have been hearing a lot about optimizing your images for accessibility and you want to go back to every image component and make sure you have included sufficient alt text. Or perhaps we have recently updated a component with new options, like an additional CTA button, and you want to review all your uses of the component to see if you want to take advantage of the new option. 

You may have a new article that you want to add to a related articles component, so you use the report to query all the pages that have this component. 

Note: If you want to find multiple components you can add up to 5 components to the search. The results will pull up every instance of every component you included (NOT every page containing all the components searched). 

1.   From the reports page, click on TNC Component Instances 
2.   Use the path picker to select a section, a parent page under which you want to search for the component
3.   In the first dropdown, select the component you want to locate
4.   Optional - select additional components to locate
5.   Check the "All Results" box
6.   Click "Execute Report"
7.   View or download the report!

Note: if you want to return to the list of reports to run a different report, click the "Reports" breadcrumb link the top left-hand corner of the page. 

Report Columns

• Component Name: If you are querying more than one component, this column will indicate which one was found
• Variation: the report is configured to identify the major variations of components. For example, if you query C79 Text Asset Component, the variation will indicate which secondary component was used with the Text Asset component. 
• Containing Page: This column lists the title of the page that the component is on. You can click this title to bring up the AEM console at the place in the page tree where the page is located. Note that if the page contains multiples of the queried component, the page will be listed in results multiple times. The report shows a line for each usage of a component - NOT a single line for each page containing the component. 
• Template: The template of the page in that line of the results. 
• Replication Status: This column indicates whether or not the page is published. 
• Business Group Leads: Pulled from this field in Page Properties. 
• Occurances: The number of times the component appears on the "Containing Page." However, as noted, each component instance is listed, so the total number of components is the total number of report results and not the total of the "occurances" column.