Property Index in AEM - Continued

custom property index
This post illustrate the usage of supporting properties that are part of Oak Property Index with sample use case. 

Use case:
DAM assets have a property called "cq:parentPath" (jcr:content node of type - dam:AssetContent has this property which has the value to be its parent folder path)
Example : /content/dam/we-retail/en/features/cart.png/jcr:content

DAM asset parent path

We will write a query to get all assets from we-retail/en locale which has cq:parentPath property 
  • path=/content/dam/we-retail/en
  • type=dam:AssetContent
  • 1_property=cq:parentPath
  • 1_property.operation=exists
  • p.limit=-1
Create Property Index for "cq:parentPath" with mandatory properties alone. 

Parent Path Property Index

With this set up, this index will be picked for all queries involving this property constraint + any "path" predicate.
Now to make this index to be used/picked for only certain paths we can control using  includedPaths and/or excludedPaths

includedPaths:
  • Add below property in newly created index node - /oak:index/cqParentPath
  • NameTypeValue
    includedPathsString[]/content/dam/we-retail/en
  • Index will be picked if we use the path predicate to be - /content/dam/we-retail/en or anything under /content/dam/we-retail/en/*
  • Index will not be picked if we use any path other than - /content/dam/we-retail/en 
    • Example : /content/dam/we-retail or any other path altogether.
excludedPaths:
  • Add below property in newly created index node - /oak:index/cqParentPath
  • NameTypeValue
    excludedPathsString[]/content/dam/we-retail/en/products
  • Index will not be picked if we use the path predicate to be - /content/dam/we-retail/en/products
  • Index will be picked if we use the path other than the content hierarchy that is part of excludedPaths.
  • Example: 
  • Below paths will let the index gets picked
    • /content/dam/we-retail/en/.* or any other project dam path- /content/dam/learnings
  • But not the below (all 3 are part of excludedPaths)
    • /content/dam
    • /content/dam/we-retail
    • /content/dam/we-retail/en
Both together:
  • If below two properties are available in newly created index node - /oak:index/cqParentPath
  • NameTypeValue
    excludedPathsString[]/content/dam/we-retail/en/products
    includedPathsString[]/content/dam/we-retail/en
  • Index will get picked for all paths under /content/dam/we-retail/en/.* except products.
  • Not for the below (all 3 are part of excludedPaths)
    • /content/dam
    • /content/dam/we-retail
    • /content/dam/we-retail/en (Though this is available in includedPaths, when used together with excludedPaths like above where this hierarchy is a part -> index will not be selected)
Video Demo : 

valuePattern:
Use case : Get all assets which has cq:parentPath value to be - /content/dam/we-retail/en/stores
  • path=/content/dam/we-retail
  • type=dam:AssetContent
  • 1_property=cq:parentPath
  • 1_property.value=/content/dam/we-retail/en/stores
  • p.limit=-1
  • Observing the value of cq:parentPath, regex pattern can be framed as 
    • all lower case alphabets +  contains "/" + can have hyphen(-) which is [a-z/\\-]+
    NameTypeValue
    valuePatternString[a-b/\\-]+
Video Demo:

valueExcludedPrefixes and valueIncludedPrefixes:
Use case : 
In we-retail content, we have pages with jcr:title - "Experience" for Language master, CA and US locale (3 result set)
We will use the prefix "Exp" from this value for illustrating valueExcludedPrefixes and valueIncludedPrefixes

Query to get all pages with jcr:title - Experience
  • path=/content/we-retail
  • type=cq:Page
  • 1_property=@jcr:content/jcr:title
  • 1_property.value=Experience
  • p.limit=-1
Create Property Index for "jcr:title" with mandatory properties alone.

JCR Title Property Index

valueIncludedPrefixes:
  • Add below property in newly created index node - /oak:index/jcrTitle
  • NameTypeValue
    valueIncludedPrefixesString[]Exp
  • Index will be picked if the "property.value" predicate starts with "Exp"
  • Index will not be picked if the "property.value" predicate starts with anything other than "Exp"
valueExcludedPrefixes:
  • Add below property in newly created index node - /oak:index/jcrTitle
  • NameTypeValue
    valueExcludedPrefixesString[]Exp
  • Index will be picked if the "property.value" predicate starts with anything other than "Exp"
  • Index will not be picked if the "property.value" predicate starts with "Exp"
Video Demo: 

declaringNodeTypes and unique:
Usage is available OOB in below Property Index definitions. 
  • /oak:index/principalName
  • /oak:index/authorizableId
For illustrating purpose and easy follow along, have considered using existing properties part of sample content - we.retail (for framing queries)
Play around in your local instance with your custom use case.
In real time projects, choice of index type/mode and hence its supporting properties to be carefully arrived at considering the query predicates used for a specific functionality + content volume on a long run.

Comments

Post a Comment

Popular posts from this blog

Embedding Third party dependency/OSGi bundle in AEM application hosted in AEMasCS

Image
This post illustrate the ways of embedding third party dependency in AEM maven project. Steps are mentioned considering the project structure to be followed for AEMasCS while the same can be followed for classic versions too.  Before we begin, I would like to explain the scenario of including a dependency in our AEM maven project.  When we would like to make use of an API that is not already available in our project, we look for that in maven-central repository and specify the dependency in main pom.xml and desired module's pom.xml file. (Lets say, AWS S3 Java SDK V2 dependency) Upon updating the project in the IDE, we would see our class files (making use of those APIs) are compiled/build successfully without any errors.  Now, in the context of AEM/OSGi environment, when the same package and hence the bundle is deployed to AEM instance, dependencies that we added new might not be resolved/available in the OSGi as a bundle. Something like the below This indicates that the...
Read more

OSGI Factory Configuration implementation

OSGI Factory configuration is used to have many instances of an OSGI config (represented/identified via an identifier) for the single OSGI service/PID. Most often used OOB Factory configurations for example: Logger Factory/writer configuration (for log statements) Service user Mapper service Amendment (for using service resource resolver in projects) Few sample real time use case for the need of OSGI factory config: For multi tenant projects, if we have generic service used across tenants with properties/attributes specific to tenant. For single tenant, generic service targeting all locales with properties/attributes specific to locale. (where generic service -> holds logic in the lines of calling third party service for retrieving/updating information.) Implementation: ( In terms of OSGI R6 annotations ): Create Object Class Definition(OCD) defining desired properties for the OSGI service. - OSGIFactoryConfigOCD.java OSGI Service/Factory service to retrieve ...
Read more

Embed Third party dependency using bnd-maven-plugin

Image
This post explains the use of bnd-maven-plugin to embed third party dependency  Two main instructions of bnd-maven-plugin that serves the purpose are detailed below.  -conditionalpackage  pick packages from respective library and copy them in the bundle. Any dependencies of those copied packages will also be copied if they match the selectors. This means we need to explicitly list all the Java package names of desired dependency as part of this instruction (including its transitive dependencies) More about conditionalpackage instruction from official docs -  https://bnd.bndtools.org/instructions/conditionalpackage.html -includeresource  For including resource inline -includeresource: @artifactId-version.jar!/* For embedding as a jar with an entry in bundle class path -includeresource: artifactId-version.jar;lib:=true For several other possible combinations for including the resource, please check - https://bnd.bndtools.org/instructions/includeresource.html Wi...
Read more