Asset Grabber – oEmbed a complete asset embed solution

If you are an AEM/CQ developer and had worked on multiple projects, then you might be very well familiar with how exasperating is to create components for embedding assets in for web page. Here’s how actually it goes from development perspective.

Things starts with video component. Now create a component for YouTube, let’s assume you created. Next day client knock’s your door and say’s, “We are now planning to embed Vimeo also, please add this into your requirement and start working“. Somehow you managed to create a Vimeo component. After 2 days, client again shoots a missile, “We had an internal discussion and now we are planning to feature Ted videos as well, please get started“. At this point what development team and with  how much anger they get into you will be aware, But before leaving for the day you run this command: “project XYZ: Completed Ted Video module“. It means you have completed this as well.

When it comes to assets, it’s very strenuous to take care of all scenarios. Let me introduce youoEmbed, we call it as “Assets Grabber”. Yes, you heard right, it’s having secret magnetic attraction power to pull things from other sites and show in yours. That’s so called secret magnetic attraction is it’s ability to handle and support huge amount of sites starting from Vimeo, YouTube for videos to Flickr for images to Infogram for charts to Slideshare for slide to Meetup for meetings.

Read More

Query Builder

Search is always the backbone of many functionalities in an AEM application . It becomes quite critical in Business scenarios to implement the most Optimized Query which fetches the best possible result. To perform search in AEM , Query Builder is highly recommended over simple SQL / XPATH query statements. The Query Builder , if used correctly, will solve all your query implementations and would be a handy way to Optimize your queries for better performance of the page. Through this Blogpost , I would explain the basics of Query builder and then would go to advanced concepts , focusing at each point how you may create any search scenario to Query Builder Predicate form. I hope this post will solve all your Search performances related hurdles in AEM.

---

What is Query Builder?

Query Builder is an API which can be used to create Search queries in JAVA content repository. It is extensible tool by which you may add/remove various predicates in a query using this API. The best way to create predicates is using the Query Builder Debugging Tool : /libs/cq/search/content/querydebug.html . Try to implement your Business use case in the Predicate form using this debugger, Optimize the query and then implement it in the code.

Creating Adobe CQ OSGi bundles that use the Query Builder API

Discusses how to create an OSGi bundle that contains the AEM Query Builder API. This OSGi operation contains application logic to search the AEM repository. This article also discusses how to create a web page that invokes an operation exposed by the OSGi bundle and display the results in a grid control.    

This article uses an Adobe Maven Archetype project to build an OSGi bundle. If you are not familiar with an Adobe Maven Archetype project, it is recommended that you read the following article: Creating your first AEM Service using an Adobe Maven Archetype project.

This article has been updated to replace the use of a SlingRepository instance with a ResourceResolverFactory instance. TheResourceResolverFactory is used to create a Session instance that is required to use the AEM Query Builder API. Now a Session instance is created by using the adaptTo method:

resourceResolver.adaptTo(Session.class);

This article has been updated to use this Maven command to build the OSGi bundle:

mvn archetype:generate -DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/ -DarchetypeGroupId=com.day.jcr.vault -DarchetypeArtifactId=multimodule-content-package-archetype -DarchetypeVersion=1.0.2 -DgroupId=custom.querybuilder -DartifactId=querybuilder -Dversion=1.0-SNAPSHOT -Dpackage=custom.querybuilder -DappsFolderName=myproject -DartifactName="My Project" -DcqVersion="5.6.1" -DpackageGroup="My Company"

Read More

cq5-querybuilder-adapttoberlin

CQ5 QueryBuilder - .adaptTo(Berlin) 2011 from Alexander Klimetschek

Read More >>

Content Finder - Query Builder

Use QueryBuilder HTTP API syntax to drive ContentFinder queries instead of more restrictive GQL.
How to Use

• Install the ACS AEM Commons package
• Create a new Content Finder Tab JS file
• Update the contentfindertab config JS object to include:
  • url: “/bin/wcm/contentfinder/qb/view.json”
  • baseParams: { .. }
    • JS object representing the QueryBuilder API key/value pairs used to drive all of the ContentFinder Tab’s queries
    • If no baseParams are set then the suggestField will populate the query param
  • getParams: { .. }
    • JS object representing the dynamic QueryBuilder API key/value pairs used to drive all of the ContentFinder Tab’s queries (baseParams will be used in conjunction with these)

Query Builder samples

AEM comes with a Query Debugger tool at:

/libs/cq/search/content/querydebug.html

You can execute search queries on the JCR (Java Content Repository) using this tool.  For example, to search for all DAM assets in /content/dam/geometrixx, execute the following query:

type=dam:Asset
path=/content/dam/geometrixx

See screenshot below:

Running this search query should produce a result such as follows:

You can execute more complicated search queries as well.  For example, to search for all DAM assets in /content/dam/geometrixx with the string “.png” in the node name and to to sort the results in the descending order of when the node was last modified, execute the following query:

type=dam:Asset
path=/content/dam/geometrixx
nodename=*.png
orderby=@jcr:content/jcr:lastModified
orderby.sort=desc

More information here.  Excellent blog entry by Thomas Joseph on Oak indexes here.

Other examples:

How many audit events have accumulated:

type=cq:AuditEvent
path=/var/audit

How many unique users have logged in to AEM in the past 12 hours?

A user who has logged in from three different IP addresses (home office, work, mobile phone) will be counted three times.

type=rep:Token
path=/home/users

How many web pages are in the AEM system?

type=cq:Page
path=/content

How many tags have been defined?

type=cq:Tag
path=/etc/tags

How many total users are defined in the AEM system?

type=rep:User
path=/home/users

How many user groups are defined?

type=rep:Group
path=/home/groups

How many Client Libraries?

type=type=cq:ClientLibraryFolder
path=/etc

Read More 

Query Builder

• QueryBuilder is an API used to build Queries for Query Engine.

• The generated queries are compatible with HTML forms also.

• Allows us to add and remove conditions

• Allows us to copy and paste of Queries

•  Easily extensible

• This QueryBuilder resides at server side and accepts a query description, creates and runs an XPath query.

• The Query Description is simply a set of predicates.

• Predicates are nothing but conditions. For each predicate type there is an evaluator component PredicateEvaluator that knows how to handle that specific predicate for XPath, filtering and facet extraction.
• Standard Predicates:
  •  path
  •  property
  • type
  • fulltext
  •  range
  •  daterange
  • nodename
  •  similar
  • tagid & tag
  • language
  • event
  •  Also we can have the following predicates: 
  • group of predicates
  • like brackets 
• order by predicates
• 
  

Simple way to restrict Image type in Pathfield xtype

Let’s say a small scenario where you want author should not be able to select any image type apart from .png. You can restrict the type of image author should select in pathfield xtype. Taking a close look at Pathfield xtype, you will notice we have an property name regex.

Regex ( regular expression ) can be used and a text message can be displayed in case regex doesn’t match. For text message we have property regexText. Here’s how you can achieve it:-

1. Add 2 highlighted properties in pathfield xtype widget

regex: /\.(png)/ -> Shows that only URL with extension .png are allowed

regexText: Please choose an correct file -> This message will be displayed if regex is violated

2. Select an image with .png extension, you will notice it doesn’t shows any error

3. Select an image with .jpg extension, you will notice it will be shown as error and on hover Regex text will be displayed. Author will not be able to submit dialog box in this situation.

 

Servlet to get all tags assigned to a DAM Asset in JSON format

Recently there was a requirement to fetch all tags assigned to a DAM Assets. It can be implemented via servlets where a Ajax call can be made. If you have never worked on such kind of use case then this is a must to learn and implement article for you. Its uses Tag Manager API and return data in JSON format. In our scenario it was easy to get data in JSON format, however you are free to convert it to any bases on your requirement

1. Define the annotaton @slingServlet with path you want to use for accessing it.

1 2	@SlingServlet(paths = "/bin/getDamTags") public class DamTags extends org.apache.sling.api.servlets.SlingAllMethodsServlet

2.  Get the ‘path‘ parameter from request to get the image location. Once received, adapt this resource to Asset class. Start reading the ‘cq:tags‘ property where all tags are stored.

1 2 3 4 5 6 7 8 9 10 11

String path = slingRequest.getParameter("path"); LOGGER.info("Path received.. {}", path); Resource resource = slingRequest.getResourceResolver().getResource(path); Asset asset = resource.adaptTo(Asset.class);   Object[] titleArray = null; Object titleObj = asset.getMetadata("cq:tags"); if (titleObj instanceof Object[]) { titleArray = (Object[]) titleObj; }

3. Now you have tags, but we need to get the title of tags and convert into JSON object that has to be returned.

1 2 3 4 5 6 7 8 9 10

JSONObject damTagsJson = new JSONObject(); JSONArray tags = new JSONArray();   for (Object ob : titleArray) { String a = ob.toString(); TagManager tagManager = null; tagManager = slingRequest.getResourceResolver().adaptTo(TagManager.class); Tag custTag = tagManager.resolve(a); tags.put(custTag.getTitle()); }

4. At last, return the output in JSON format

1 2	// Output tags in json format out.print(damTagsJson.put("damTags", tags));

5. The same request can be made via JS  to get the response

Here is final complete code that can be used

Complete Code

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

package com.simple.util;   import java.io.PrintWriter; import org.apache.felix.scr.annotations.sling.SlingServlet; import org.apache.sling.api.SlingHttpServletRequest; import org.apache.sling.api.SlingHttpServletResponse; import org.apache.sling.api.resource.Resource; import org.apache.sling.commons.json.JSONArray; import org.apache.sling.commons.json.JSONObject; import org.slf4j.Logger; import org.slf4j.LoggerFactory;   import com.day.cq.dam.api.Asset; import com.day.cq.tagging.TagManager; import com.day.cq.tagging.Tag; import com.day.cq.dam.api.Asset;   /** * * @author praveen * */   @SlingServlet(paths = "/bin/getDamTags") public class DamTags extends org.apache.sling.api.servlets.SlingAllMethodsServlet {   private static final Logger LOGGER = LoggerFactory.getLogger(DamTags.class);   protected void doGet(SlingHttpServletRequest slingRequest, SlingHttpServletResponse slingResponse) { try { LOGGER.info("Getting request to ....."); // Get print writer object to output PrintWriter out = slingResponse.getWriter(); String path = slingRequest.getParameter("path"); LOGGER.info("Path received.. {}", path); Resource resource = slingRequest.getResourceResolver().getResource(path); Asset asset = resource.adaptTo(Asset.class);   Object[] titleArray = null; Object titleObj = asset.getMetadata("cq:tags"); if (titleObj instanceof Object[]) { titleArray = (Object[]) titleObj; }   JSONObject damTagsJson = new JSONObject(); JSONArray tags = new JSONArray();   for (Object ob : titleArray) { String a = ob.toString(); TagManager tagManager = null; tagManager = slingRequest.getResourceResolver().adaptTo( TagManager.class); Tag custTag = tagManager.resolve(a); tags.put(custTag.getTitle());   }   // Output tags in json format out.print(damTagsJson.put("damTags", tags));   } catch (Exception e) { LOGGER.info("Exception while fetching DAM assets tags " + e.getMessage()); } } }