Add a custom button in AEM DAM console and validate the asset Before Deleting

-

Add a custom button in AEM DAM Console (Touch UI)


Sling Merger is the best way to overlay and hide/add any buttons in components or even AEM consoles.
If you would like to do any custom action on the assets, for ex: Validate the asset before deleting, you can follow the below process.

Use Case Scenario:

When we select the asset and click on the delete, there is no way of holding that activity, we can catch the events by using Event Listeners and do any activity post deletion, but if you would like to make any check's before deletion and stop deleting the asset,

There are a couple of options for this requirement

1. Create a workflow and assign the workflow to the asset to do the activity
2. Add a custom button and call a servlet to do required actions, if you are satisifed the conditions in the servlet, you can delete it directly or you can hold the deletion and send emails or any other actions.

You can even call a workflow from the servlet to do the activity if any user intervention is required


Creating a custom button

Navigate to the dam path in the crx/de
In the scenario, we are doing an activity on the selection of asset, so we will be overlaying the selection node.
Right click on the node (/libs/dam/gui/content/assets/jcr:content/actions/selection) and click on "Overlay Node"



Select the Match Node Types check box to create the overlay nodes with the same structure and node types.

This should create us the overlay structure under /apps folder as /apps/dam/gui/content/assets/jcr:content/actions/selection

Once we have the structure, we can add/hide any buttons.
In this scenario, I am hiding the delete button and create a new button
Create a new node under selection with name as "delete" and type as "nt:unstructured"
Add a property sling:hideResource with Boolean type and value as true.

After this you will not be able to see the delete button in the asset console.

you can copy the existing delete node from "/libs/dam/gui/content/assets/jcr:content/actions/selection/delete" and paste under "/apps/dam/gui/content/assets/jcr:content/actions/selection"


Update the properties as below:


Delete the property actionConfigName

granite-rel : cq-damadmin-admin-actions-request-delete-activator

text : Request for Delete

sling:resourceType : granite/ui/components/coral/foundation/button
Save the Changes


I did not clean up the unwanted properties for now


You should be able to see the new button while selecting any asset in the DAM console



Click Action for the custom button

  • Create a new folder "request-for-deletion" under /apps folder.
  • Create a cq:ClientLibraryFolder under the "request-for-deletion" folder
  • Add the categories multi value property with "dam.gui.actions.coral" as the value  --> Without this your clientlibs will not be called.
  • Create below files under clientlibs folder
    • request-for-deletion.js
    • js.txt
  • Add request-for-deletion.js in the js.txt


Add the below script in the request-for-deletion.js file



(function($, $document) {

    $(document).on("foundation-contentloaded", function(e) {

  /* This value of granite-rel in the custom button should be used here to identify the trigger event*/

        var requestForDeletion = ".cq-damadmin-admin-actions-request-delete-activator";



        $(document).off("click", requestForDeletion).on("click", requestForDeletion, function(e) {

            var paths = [];

            var selectedItems = $(".foundation-selections-item");

            selectedItems.each(function() {

                paths.push($(this).get(0).getAttribute('data-foundation-collection-item-id'));

            });

            $.ajax({

                type: 'GET',

                url: '/bin/flash/deleteassets',

                data: 'assetPaths=' + paths,

                success: function(msg) {

                    alert('Assets are requested for deletion');

                }

            });

        });



    });



})(jQuery, jQuery(document));

The above script will be executed when we select any assets and click on Request For Deletion button. This will make an ajax request to the servlet.

Sling Servlet

package com.flash.aem.core.servlets;

import java.io.IOException;

import javax.jcr.Session;
import javax.servlet.Servlet;
import javax.servlet.ServletException;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.servlets.ServletResolverConstants;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
import org.osgi.framework.Constants;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.day.cq.workflow.WorkflowException;
import com.day.cq.workflow.WorkflowService;
import com.day.cq.workflow.WorkflowSession;
import com.day.cq.workflow.exec.WorkflowData;
import com.day.cq.workflow.model.WorkflowModel;

/**
 * The Class RequestForDeletionServlet.
 * 
 * @author sudheerdvn
 */
@Component(service = Servlet.class, property = { Constants.SERVICE_DESCRIPTION + "=Request for Deletion Servlet",
  ServletResolverConstants.SLING_SERVLET_METHODS + "=GET",
  ServletResolverConstants.SLING_SERVLET_PATHS + "=/bin/flash/deleteassets" })
public class RequestForDeletionServlet extends SlingAllMethodsServlet {

 /** The Constant serialVersionUID. */
 private static final long serialVersionUID = 4675612505863065427L;

 /** The log. */
 protected final Logger log = LoggerFactory.getLogger(this.getClass());

 @Reference
 private WorkflowService workflowService;

 /*
  * (non-Javadoc)
  * 
  * @see
  * org.apache.sling.api.servlets.SlingSafeMethodsServlet#doGet(org.apache.sling.
  * api.SlingHttpServletRequest, org.apache.sling.api.SlingHttpServletResponse)
  */
 @Override
 protected void doGet(final SlingHttpServletRequest request, final SlingHttpServletResponse response)
   throws ServletException, IOException {
  String assetPaths = request.getParameter("assetPaths");
  if (null != assetPaths) {
   log.debug("assetPaths are {}", assetPaths);
   String[] assetPathsArray = assetPaths.split(",");
   ResourceResolver resourceResolver = request.getResourceResolver();
   Session session = resourceResolver.adaptTo(Session.class);
   log.debug("session is {}", session);
   for (String assetPath : assetPathsArray) {
    log.debug("assetPath is {}", assetPath);
    /*
     * In this use case i have simply triggered another workflow for deletion
     * process. We can validate the conditions and start the workflow or do all the
     * validations inside the workflow directly.
     */
    triggerWorkflow(session, assetPath);
   }
   // Do required action with the asset paths
  }
 }

 /**
  * Trigger workflow.
  *
  * @param session
  *            the session
  * @param assetPath
  *            the asset path
  */
 private void triggerWorkflow(Session session, String assetPath) {
  log.debug("In Trigger workflow");
  WorkflowSession workflowSession = workflowService.getWorkflowSession(session);
  WorkflowModel workflowModel;
  try {
   workflowModel = workflowSession.getModel("/var/workflow/models/delete-asset");
   if (null != workflowModel) {
    log.debug("workflowModel is {}", workflowModel);
    WorkflowData wfData = workflowSession.newWorkflowData("JCR_PATH", assetPath);
    workflowSession.startWorkflow(workflowModel, wfData);
    log.debug("Started workflow");
   }
  } catch (WorkflowException e) {
   log.error("WorkflowException occurred while starting the workflow", e);
  }
 }

}


You can refer to the workflow model implementation here (Link to the post in the same blog)

Comments

Post a Comment

Popular posts from this blog

Delete DAM Asset using Workflow

-
This article shows you to create a simple workflow process step and use it for deleting an DAM Asset. You can ask me why do I need a workflow when I can delete it directly using the delete button :) The intention is to validate the asset information before deleting the asset or trigger any other workflow for the asset and do manipulations like updating the asset data to an user before the deletion as you will not be able to get that post deletion. you can catch the events in the Event Listeners, but there will be no data by then. Simple Workflow Process Step Create a workflow process step by using the below example package com.flash.aem.core.workflow; import java.util.HashMap; import java.util.Map; import javax.jcr.Node; import javax.jcr.RepositoryException; import javax.jcr.Session; import org.apache.sling.api.resource.LoginException; import org.apache.sling.api.resource.ResourceResolver; import org.apache.sling.api.resource.ResourceResolverFactory; import org.osgi....
Read more

Groovy Console Integration and executing scripts in AEM

-
Image
Steps to install Groovy in AEM. Below Github have the steps to install the latest Groovy console https://github.com/icfnext/aem-groovy-console You can also navigate to the releases section and download the required package. https://github.com/icfnext/aem-groovy-console/releases I have used 12.0.0 version for this demo. Download the Groovy Package ( Direct link to the package  ) Upload the package to AEM via Package manager  http://localhost:4502/crx/packmgr/index.jsp Once the package is installed, you should be able to access the groovy console  http://localhost:4502/etc/groovyconsole.html Note: From 13.0.0 release, the paths were changed from /etc/ to /apps/ to access Groovy Console Sample Groovy Scripts: Printing a simple String println 'Hello World'; Click on Run Script Displays Hello World in the Console Get a Page Object final def page = getPage('/content/aem-flash') println 'page path is: ' + page.path; Re...
Read more

AEM Project Maven Build - Easy setup and steps to run commands via command line

-
We generally run maven commands every day to deploy the bundles or any other changes in the project to AEM server. There are a lot of options to sync them automatically like using Brackets or AEM Server plugin configurations in IDE's etc.. These are very faster for deployments and changes to be reflected in AEM server In case if you would like to do a complete build, we can run the same from Eclipse by using the run commands or via command prompt using the complete maven command but IDE's generally occupy lot of memory and might slow down sometimes. I generally use Command prompt for the builds. I generally navigate to the repo folder and type the maven command " mvn clean install -PautoInstallPackage,adobe-public " Note: adobe-public can be ignored if you already set the repo in the maven settings I work on different projects and repositories every day and navigating to different folders and typing the same command (You can always copy and paste the comman...
Read more