AEM 65 - Assets Admin Search Rail Predicate to check if Metadata Property exists

Goal

Add a new predicate to Assets Admin Search rail to filter assets based on the existence of metadata

Requirement could be to find all assets with specific metadata missing. Here a filter (predicate) is added to filter assets containing / not containing metadata property (configurable) jcr:content/metadata/dc:title

Demo | Package Install | Github


Search Filter



Search form Configuration

Solution

1) Login to CRXDe Lite and create the metadata exists predicate configuration metadataexists  in /apps/settings/dam/search/facets/formbuilderconfig/predicatetypes/items

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root 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"
    jcr:primaryType="cq:Page">
<adminui/>
<search jcr:primaryType="nt:unstructured">
<facets jcr:primaryType="nt:unstructured">
<formbuilderconfig jcr:primaryType="nt:unstructured">
<predicatetypes jcr:primaryType="nt:unstructured">
<items jcr:primaryType="nt:unstructured">
<metadataexists
                            jcr:primaryType="nt:unstructured"
                            fieldLabel="Metadata Property"
                            fieldPropResourceType="/apps/eaem-search-form-metadata-exists-predicate/metadata-exists-field"
                            fieldResourceType="/apps/eaem-search-form-metadata-exists-predicate/metadata-exists-predicate"
                            fieldTitle="Experience AEM Metadata Exists Predicate"
                            fieldViewResourceType="granite/ui/components/foundation/form/formbuilder/checkbox"
                            renderType="checkbox"/>
</items>
</predicatetypes>
</formbuilderconfig>
</facets>
</search>
</jcr:root>

2) Create the configuration page for predicate (fieldPropResourceType in step 1) /apps/eaem-search-form-metadata-exists-predicate/metadata-exists-field/metadata-exists-field.jsp with the following code (metadataexists is for identifying the config page to render under /mnt/overlay/settings/dam/search/facets/formbuilderconfig/predicatetypes/items )

<%@include file="/libs/granite/ui/global.jsp" %>
<%@ page session="false" contentType="text/html" pageEncoding="utf-8"
         import="com.adobe.granite.ui.components.Config" %>

<%
    String key = resource.getName();
    Config cfg = new Config(resource);
    String metaType = "metadataexists";

    String listOrder = cfg.get("listOrder", String.class);
    listOrder = (listOrder == null) ? "" : listOrder;

    String fieldLabel = i18n.get("Metadata Exists Predicate");
%>

<input type="hidden" name="<%= xssAPI.encodeForHTMLAttr("./items/" + key) %>">
<input type="hidden" name="<%= xssAPI.encodeForHTMLAttr("./items/" + key + "/jcr:primaryType") %>" value="nt:unstructured">
<input type="hidden" name="<%= xssAPI.encodeForHTMLAttr("./items/" + key + "/sling:resourceType") %>" value="/apps/eaem-search-form-metadata-exists-predicate/metadata-exists-predicate">
<input type="hidden" name="<%= xssAPI.encodeForHTMLAttr("./items/" + key + "/fieldLabel") %>" value="<%= fieldLabel %>">
<input type="hidden" name="<%= xssAPI.encodeForHTMLAttr("./items/" + key + "/metaType") %>" value="<%= metaType %>">
<input type="hidden" name="<%= xssAPI.encodeForHTMLAttr("./items/" + key + "/listOrder@Delete") %>">
<input type="hidden" name="<%= xssAPI.encodeForHTMLAttr("./items/" + key + "/listOrder@TypeHint") %>" value="String">
<input type="hidden" class="listOrder" name="<%= xssAPI.encodeForHTMLAttr("./items/" + key + "/listOrder") %>" value="<%= xssAPI.encodeForHTMLAttr(listOrder) %>">

<div><h3><%= i18n.get("Metadata Exists Predicate")%></h3></div>

<% request.setAttribute ("com.adobe.cq.datasource.fieldtextplaceholder", i18n.get("Metadata Property"));%>

<sling:include resource="<%= resource %>" resourceType="dam/gui/coral/components/admin/customsearch/formbuilder/predicatefieldproperties/fieldlabelpropertyfield"/>

<sling:include resource="<%= resource %>" resourceType="dam/gui/coral/components/admin/customsearch/formbuilder/predicatefieldproperties/maptopropertyfield"/>

<sling:include resource="<%= resource %>" resourceType="granite/ui/components/foundation/form/formbuilder/formfieldproperties/titlefields"/>

<sling:include resource="<%= resource %>" resourceType="granite/ui/components/foundation/form/formbuilder/formfieldproperties/deletefields"/>

3) Create the predicate widget render html (fieldResourceType in step 1) /apps/eaem-search-form-metadata-exists-predicate/metadata-exists-predicate/metadata-exists-predicate.jsp with following code (it includes clientlib eaem.dam.admin.metadataexists)

<%@include file="/libs/granite/ui/global.jsp" %>
<%@ page session="false" contentType="text/html" pageEncoding="utf-8"
           import="com.adobe.granite.ui.components.Config"%>

<%
    Config cfg = new Config(resource);
    String metaPropName = cfg.get("name", "");

    long predicateIndex = cfg.get("listOrder", 5000L);

    String indexGroup = predicateIndex + "_group";
    String predicateName = indexGroup + ".property";
    String propertyOperation = predicateName + ".operation";

    boolean foldableOpen = cfg.get("open", true);
    String selected = foldableOpen ? "selected":"";
%>

<ui:includeClientLib categories="eaem.dam.admin.metadataexists" />

<coral-accordion variant="large">
<coral-accordion-item "<%=selected%>" data-metaType="checkboxgroup" data-type="metadataexists">
<coral-accordion-item-label><%= xssAPI.encodeForHTML(cfg.get("text", i18n.get("Property"))) %></coral-accordion-item-label>
<coral-accordion-item-content class="coral-Form coral-Form--vertical" id="<%= xssAPI.encodeForHTMLAttr(resource.getPath()) %>">
<input type="hidden" name="<%=predicateName%>" value="<%= xssAPI.encodeForHTMLAttr(metaPropName) %>">
<coral-checkbox class="coral-Form-field eaem-metadata-exists-predicate" name="<%=propertyOperation%>" value="not">
                Not Exists
</coral-checkbox>
<coral-checkbox class="coral-Form-field eaem-metadata-exists-predicate" name="<%=propertyOperation%>" value="exists">
                Exists
</coral-checkbox>
</coral-accordion-item-content>
</coral-accordion-item>
</coral-accordion>

4) Create node /apps/eaem-search-form-metadata-exists-predicate/metadata-exists-predicate/clientlib of type cq:ClientLibraryFolder, add String property categories with value eaem.dam.admin.metadataexists, String[] property dependencies with value lodash

6) Create file (nt:file) /apps/eaem-search-form-metadata-exists-predicate/metadata-exists-predicate/clientlib/js.txt, add

                        metadata-exists.js

7) Create file (nt:file) /apps/eaem-search-form-metadata-exists-predicate/metadata-exists-predicate/clientlib/metadata-exists.js, add the following code

(function($, $document) {
    var EAEM_METADATA_EXISTS_PREDICATE = ".eaem-metadata-exists-predicate";

    $document.on("change", EAEM_METADATA_EXISTS_PREDICATE, function(event) {
        $(EAEM_METADATA_EXISTS_PREDICATE).removeAttr("checked");
        event.currentTarget.checked = true;

        var $form = $(this).closest(".granite-omnisearch-form");
        $form.submit();
    })

})(jQuery, jQuery(document));