{"id":63243,"date":"2024-08-26T11:16:15","date_gmt":"2024-08-26T05:46:15","guid":{"rendered":"https:\/\/www.tothenew.com\/blog\/?p=63243"},"modified":"2024-08-26T11:48:28","modified_gmt":"2024-08-26T06:18:28","slug":"extending-acs-aem-commons-reporting","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/extending-acs-aem-commons-reporting\/","title":{"rendered":"Extending ACS AEM Commons Reporting"},"content":{"rendered":"

ACS AEM Commons Reporting is a collection of reporting tools and utilities designed to enhance the reporting capabilities within AEM. It offers a solid foundation for generating insightful reports, but what if you need to tailor reporting functionalities to meet specific business needs? That’s where extending ACS AEM Commons Reporting comes into play.<\/span><\/p>\n

Problem Statement<\/b><\/h3>\n

The out-of-the-box\u00a0 report editor column in ACS AEM Commons allows users to redirect to the URL or page when executing the report. However, when downloading the report, there is no column for the URL or page path. To address this, we need to extend its default functionality to include a column with the page path in the downloaded report.<\/p>\n

\"execute\"

Execute Report<\/p><\/div>\n

Here, you can see in the image there is no edit column in the downloaded report.<\/p>\n

\"edit\"

Downloaded Report<\/p><\/div>\n

 <\/p>\n

For reports to be truly effective and user-friendly, they need to provide direct, clickable links to each page. This limitation persists even in the latest version of ACS AEM Commons.<\/p>\n

Solution Approach<\/b><\/h3>\n

Extend the ACS AEM Commons Reports to include the full URL.<\/span><\/p>\n

Steps to Achieve the Solution<\/b><\/h3>\n

Step 1. Create a Custom Component:<\/h4>\n

Define the component with<\/p>\n

sling:resourceSuperType= \"acs-commons\/components\/utilities\/report-builder\/columns\/editor\".<\/pre>\n
Component XML Configuration:<\/strong><\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<jcr:root xmlns:sling=\"http:\/\/sling.apache.org\/jcr\/sling\/1.0\" xmlns:cq=\"http:\/\/www.day.com\/jcr\/cq\/1.0\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0xmlns:jcr=\"http:\/\/www.jcp.org\/jcr\/1.0\"\r\n\u00a0\u00a0\u00a0\u00a0jcr:primaryType=\"cq:Component\"\r\n\u00a0\u00a0\u00a0\u00a0jcr:title=\"Custom Report Builder Editor Column\"\r\n\u00a0\u00a0\u00a0\u00a0sling:resourceSuperType=\"acs-commons\/components\/utilities\/report-builder\/columns\/editor\"\r\n\u00a0\u00a0\u00a0\u00a0componentGroup=\"ACS Commons - Report Builder Column\"\/><\/pre>\n
Step 2. Configure the Dialog:<\/h4>\n
Add an exporter to the dialog with the value pointing to the custom model for CSV export. The exporter is responsible for adding the URL column to the CSV file.<\/p>\n
Dialog XML Configuration:<\/strong><\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<jcr:root xmlns:sling=\"http:\/\/sling.apache.org\/jcr\/sling\/1.0\" xmlns:cq=\"http:\/\/www.day.com\/jcr\/cq\/1.0\" xmlns:jcr=\"http:\/\/www.jcp.org\/jcr\/1.0\" xmlns:nt=\"http:\/\/www.jcp.org\/jcr\/nt\/1.0\"\r\n\u00a0\u00a0\u00a0\u00a0jcr:primaryType=\"nt:unstructured\"\r\n\u00a0\u00a0\u00a0\u00a0jcr:title=\"Report Editor Column\"\r\n\u00a0\u00a0\u00a0\u00a0sling:resourceType=\"cq\/gui\/components\/authoring\/dialog\"\r\n\u00a0\u00a0\u00a0\u00a0helpPath=\"https:\/\/adobe-consulting-services.github.io\/acs-aem-commons\/features\/reports\">\r\n\u00a0\u00a0\u00a0\u00a0<content\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0jcr:primaryType=\"nt:unstructured\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0sling:resourceType=\"granite\/ui\/components\/foundation\/container\">\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<layout\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0jcr:primaryType=\"nt:unstructured\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0sling:resourceType=\"granite\/ui\/components\/foundation\/layouts\/fixedcolumns\"\/>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<items jcr:primaryType=\"nt:unstructured\">\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<column\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0jcr:primaryType=\"nt:unstructured\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0sling:resourceType=\"granite\/ui\/components\/foundation\/container\">\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<items jcr:primaryType=\"nt:unstructured\">\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<exporter\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0jcr:primaryType=\"nt:unstructured\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0sling:resourceType=\"granite\/ui\/components\/foundation\/form\/hidden\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0name=\".\/exporter\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0value=\"com.mysite.core.models.CustomPathReportCellCSVExporter\" \/>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/items>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/column>\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/items>\r\n\u00a0\u00a0\u00a0\u00a0<\/content>\r\n<\/jcr:root><\/pre>\n
Step 3. Model Creation<\/h4>\n
We will create our custom model which implements ReportCellCSVExporter and here we will write our custom logic to get a full page Url.<\/p>\n
Java Class for Model Implementation:<\/strong><\/p>\n
import com.adobe.acs.commons.reports.api.ReportCellCSVExporter;\r\nimport org.apache.sling.api.resource.Resource;\r\nimport org.apache.sling.models.annotations.Model;\r\nimport org.apache.sling.models.annotations.Optional;\r\nimport org.apache.sling.models.annotations.injectorspecific.OSGiService;\r\nimport org.apache.sling.models.annotations.injectorspecific.ValueMapValue;\r\nimport javax.annotation.PostConstruct;\r\nimport java.util.Objects;\r\n\r\n@Model(adaptables = Resource.class)\r\npublic class CustomPathReportCellCSVExporter implements ReportCellCSVExporter {\r\n\u00a0\u00a0\u00a0\u00a0@ValueMapValue\r\n\u00a0\u00a0\u00a0\u00a0private String editor;\r\n\r\n\u00a0\u00a0\u00a0\u00a0@ValueMapValue @Optional\r\n\u00a0\u00a0\u00a0\u00a0private String customEditor;\r\n\r\n\u00a0\u00a0\u00a0\u00a0@PostConstruct\r\n\u00a0\u00a0\u00a0\u00a0protected void init() {\r\n\u00a0\u00a0\u00a0\u00a0customEditor = customEditor != null ? customEditor : \"\";\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\u00a0\u00a0\u00a0\u00a0@Override\r\n\u00a0\u00a0\u00a0\u00a0public String getValue(Object result) {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0Resource resource = (Resource) result;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0String url = \"http:\/\/localhost:4502\/\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0if(Objects.equals(editor, \"custom\")) {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return url + customEditor + resource.getPath();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0else{\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return url + editor + resource.getPath();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\r\n\u00a0\u00a0\u00a0\u00a0}\r\n}<\/pre>\n
 <\/p>\n
Creating the Report<\/b><\/h3>\n
Navigate to Report Creation<\/b><\/h4>\n