Talks about how to modify assets by using an AEM workflow and the AEM APIs

Article summary

Summary

Discusses how to modify digital assets by using Experience Manager workflows. This article also shows you how to build a custom workflow step that uses DS annotations for AEM 6.3/6.4. 

This development article uses these APIs to achieve this use case: 

  • Workflow API - to handle the payload that represents the digital asset
  • JCR API - to get the node and read the jcr:data property to obtain an InputStream 
  • AssetManager API - to place the asset into the Trash folder.

To read AEM Workflow best practices, see https://helpx.adobe.com/experience-manager/6-3/sites/developing/using/workflows-best-practices.html.

A special thank you to Ratna Kumar Kotla, a top AEM community member, for testing this article to ensure it works. In addition, thank you Lokesh BS for helping with this article and presenting Ask the AEM Community Experts that covers this subject matter. 

Digital Marketing Solution(s) Adobe Experience Manager 6.3/6.4
Audience Developer
Required Skills Java, HTML, JavaScript
Version 6.3/6.4
Ask the AEM Community Experts http://bit.ly/ATACE218

Note:

Before following along with this article, create a new folder named trash under /content/dam in the AEM JCR. 

Introduction

When working with Adobe Experience Manager digital assets, you can use workflows to achieve business requirements. Not all business requirements can be achieved by using out of the box Experience Manager components. To achieve some requirements, you need to build custom workflows. In some cases, you need to build custom workflow steps by using the Experience Manager Workflow API.

For example, consider a business requirement where a digital asset has to be archived prior to deleting it. That is, you want to place an asset into a trash folder before deleting it. Using out of the box workflow steps, you cannot acheive this use case. To achieve this requirement, you need to build a custom workflow step that moves the asset to a folder named trash under /content/dam

The following illustration shows the workflow model that moves a digial asset to the trash folder and then deletes it. 

 

Model2
An AEM Workflow Model that places an asset into a Trash folder and deletes the asset

In this model, the step that moves the digital asset to the trash folder is a custom workflow step that uses these AEM APIs: 

  • Workflow API - to handle the payload that represents the digital asset
  • JCR API - to get the node and read the jcr:data property to obtain an InputStream 
  • AssetManager API - to place the asset into the Trash folder.

Note:

To create a custom workflow step for Experience Manager 6.3, you need to use Declarative Services annotations as opposed to Apache Felix SCR Annotations (this is shown in this article).

Setup Maven in your development environment

You can use Maven to build an OSGi bundle that contains a Sling Servlet. Maven manages required JAR files that a Java project needs in its class path. Instead of searching the Internet trying to find and download third-party JAR files to include in your project’s class path, Maven manages these dependencies for you.

You can download Maven 3 from the following URL:

http://maven.apache.org/download.html

After you download and extract Maven, create an environment variable named M3_HOME. Assign the Maven install location to this environment variable. For example:

C:\Programs\Apache\apache-maven-3.0.4

Set up a system environment variable to reference Maven. To test whether you properly setup Maven, enter the following Maven command into a command prompt:

%M3_HOME%\bin\mvn -version

This command provides Maven and Java install details and resembles the following message:

Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Note: It is recommended that you use Maven 3.0.3 or greater. For more information about setting up Maven and the Home variable, see: Maven in 5 Minutes.

Next, copy the Maven configuration file named settings.xml from [install location]\apache-maven-3.0.4\conf\ to your user profile. For example, C:\Users\scottm\.m2\.

You have to configure your settings.xml file to use Adobe’s public repository. For information, see Adobe Public Maven Repository at http://repo.adobe.com/.

The following XML code represents a settings.xml file that you can use.

<?xml version="1.0" encoding="UTF-8"?>
  
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
  
    http://www.apache.org/licenses/LICENSE-2.0
  
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->
  
<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user, 
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in 
 |                 ${maven.home}/conf/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ~/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
  
  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->
  
  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->
  
  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>
  
  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>
  
  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the 'id' attribute below).
     | 
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are 
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->
      
    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
  </servers>
  
  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   | 
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred 
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
     -->
  </mirrors>
    
  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is 
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a 
   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id's for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>
  
      <activation>
        <jdk>1.4</jdk>
      </activation>
  
      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->
  
    <!--
     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |   
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>
  
      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>
  
      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
    
  
<profile>
  
                <id>adobe-public</id>
  
                <activation>
  
                    <activeByDefault>true</activeByDefault>
  
                </activation>
  
                <repositories>
  
                  <repository>
  
                    <id>adobe</id>
  
                    <name>Nexus Proxy Repository</name>
  
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
  
                    <layout>default</layout>
  
                  </repository>
  
                </repositories>
  
                <pluginRepositories>
  
                  <pluginRepository>
  
                    <id>adobe</id>
  
                    <name>Nexus Proxy Repository</name>
  
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
  
                    <layout>default</layout>
  
                  </pluginRepository>
  
                </pluginRepositories>
  
            </profile>
  
</profiles>
  
  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>

Note:

The Adobe repository URL is now made secured. Change http://repo.adobe.com/nexus/content/groups/public/ to https://repo.adobe.com/nexus/content/groups/public/.

Create an AEM Maven 11 archetype project

Create an Experience Manager 11 archetype project by using the Maven archetype plugin. In this example, assume that the working directory is C:\AdobeCQ.

M10
Files generated by Maven 11 Archetype

To create an Experience Manager archetype project, perform these steps:

1. Open the command prompt and go to your working directory (for example, C:\AdobeCQ).

2. Run the following Maven command:

mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeGroupId=com.adobe.granite.archetypes -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=11 -DarchetypeCatalog=https://repo.adobe.com/nexus/content/groups/public/

3. When prompted, specify the following information:

  • groupId - TrashAssetWF63
  • artifactId - TrashAssetWF63
  • version - 1.0-SNAPSHOT
  • package - com.community.asset
  • appsFolderName - TrashAssetWF63
  • artifactName - TrashAssetWF63
  • componentGroupName - TrashAssetWF63
  • contentFolderName - TrashAssetWF63
  • cssId - TrashAssetWF63
  • packageGroup - TrashAssetWF63
  • siteName - TrashAssetWF63

4. When prompted, specify Y.

5. Once done, you will see a message like:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:42 min
[INFO] Finished at: 2016-04-25T14:34:19-04:00
[INFO] Final Memory: 16M/463M
[INFO] ------------------------------------------------------------------------

6. Change the working directory to TrashAssetWF63 and then enter the following command.

mvn eclipse:eclipse

After you run this command, you can import the project into Eclipse as discussed in the next section.

Add Java files to the Maven project using Eclipse

To make it easier to work with the Maven generated project, import it into the Eclipse development environment, as shown in the following illustration.

project
Eclipse Import Project Dialog

Note:

Do not worry about the errors reported in Eclipse. It does not read the POM file where the APIs are resolved. You build the bundle with Maven. Eclipse is used to edit the Java files and the POM file.

After you import the project into Eclipse, notice each module is a separate Eclipse project:

  • core - where Java files that are used in OSGi services and sling servlets are located
  • launcher - where additional Java files are located
  • tests - Java files for tests like JUNIT tests
  • apps - content under /apps
  • content - content under /content

When you want to create an OSGi service, you work under core. Likewise, if you want to create a HTL component, you can work under apps.

The next step is to add Java files to the com.community.asset.core package. The Java class that you create in this section impements the com.adobe.granite.workflow.exec.WorkflowProcess interface. For information, see Interface WorkflowProcess.

Create a Java class named CustomStep and specify the following Declarative Services annotation:

@Component(service=WorkflowProcess.class, property = {"process.label=My Workflow Process"})


public class CustomStep implements WorkflowProcess

In this example, notice that process.label refers to My Workdlow Process. This is the value that appears in the process step when you create a workflow model that uses this custom workflow step. 

Step
A Process Step that uses a custom workflow step

Note:

If you use Apache Felix SCR annotations, then the custom workflow step does not work in Experience Manager 6.3. 

Because the CustomStep class extends WorkflowProccess, you have to create a method named excute. The Java application logic in this method is invoked when the custom workflow step is executed. The execute method has the following signature:

public void execute(WorkItem item, WorkflowSession wfsession,MetaDataMap args) throws WorkflowException

In this development article, the custom step obtains a path of the digital asset. For example, the path can be something like:

/content/dam/we-retail/en/people/womens/women_6.jpg

To retrieve the path of the digital asset, you can use this application logic like this: 

WorkflowData workflowData = item.getWorkflowData(); //gain access to the payload data
String path = workflowData.getPayload().toString();

Once you have the path to the digital asset, you can use the JCR API to get a node instance that represents the asset. 

String newPath = path.replaceFirst("/", "");

//USE JCR API TO get the Asset Data so we can move it to another JCR API location
//Create a node that represents the root node
Node root = session.getRootNode();

Node fileNode = root.getNode(newPath);

 

Note:

In this example, notice that path.replaceFirst method is used. This code modifies the path of the asset. The path returned from the Workflow API is /content/dam/we-retail/en/people/womens/women_6.jpg. You need to remove the 1st / character to use it with the JCR API; otherwise, an exception is thrown. 

The rest of the JCR API business logic retrieves an InputStream that reflects the digital asset. Then using the InputStream and the AssetManager API, a new asset is placed under /content/dam/trash.  

The following Java code represents the custom Workflow step. 

 

package com.community.asset.core;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
   

import javax.jcr.Session;
import javax.jcr.Node; 

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
    
import java.io.StringWriter;
import java.util.Iterator;
import java.util.List;
import java.util.ArrayList;
    
import javax.jcr.Repository; 
import javax.jcr.SimpleCredentials; 
import javax.jcr.Node; 
import javax.jcr.Binary;
import javax.jcr.Property;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.IOException;
import com.day.cq.dam.api.Asset; 
import java.util.Collections;
     
import org.apache.jackrabbit.commons.JcrUtils;
    
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

    
import javax.jcr.Session;
import javax.jcr.Node; 
import org.osgi.framework.Constants;
  
import com.adobe.granite.workflow.WorkflowException;
import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.WorkItem;
import com.adobe.granite.workflow.exec.WorkflowData;
import com.adobe.granite.workflow.exec.WorkflowProcess;
import com.adobe.granite.workflow.metadata.MetaDataMap;

//AssetManager
import com.day.cq.dam.api.AssetManager; 

import java.io.ByteArrayOutputStream;
import java.io.ObjectOutputStream ; 
import java.io.OutputStream ; 
import java.io.ByteArrayInputStream ; 
import java.io.FileOutputStream ; 
  
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
  
   
//Sling Imports
import org.apache.sling.api.resource.ResourceResolverFactory ; 
import org.apache.sling.api.resource.ResourceResolver; 
import org.apache.sling.api.resource.Resource; 
import com.day.cq.wcm.api.Page; 
   

import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

import com.adobe.granite.workflow.model.WorkflowNode;
import com.adobe.granite.workflow.exec.WorkflowData;


@Component(service=WorkflowProcess.class, property = {"process.label=My Workflow Process"})

public class CustomStep implements WorkflowProcess 
{
        
       
/** Default log. */
protected final Logger log = LoggerFactory.getLogger(this.getClass());
       
//Inject a MessageGatewayService 
//Inject a Sling ResourceResolverFactory
@Reference
private ResourceResolverFactory resolverFactory;
 
private Session session;
       
public void execute(WorkItem item, WorkflowSession wfsession,MetaDataMap args) throws WorkflowException {
           
try
{
    log.info("**** Here in execute method");    //ensure that the execute method is invoked    
           
    //Get the Assets from the file system for a test
    WorkflowNode myNode = item.getNode(); 
     
    String myTitle = myNode.getTitle(); //returns the title of the workflow step
     
    log.info("**** The title is "+myTitle);  
     
    WorkflowData workflowData = item.getWorkflowData(); //gain access to the payload data
    String path = workflowData.getPayload().toString();//Get the path of the asset
     
     
    //Get only the name of the asset - including the ext
    int index = path.lastIndexOf("/");
    String fileName = path.substring(index + 1);
       
   //Write the Asset to the Trash folder in the DAM
    String myFile =  writeToDam(path,fileName,wfsession) ;// write to the Trash location
       
   log.info("**** This was was written to the Trash folder " +myFile );  
}
   
    catch (Exception e)
    {
    e.printStackTrace()  ; 
    }
 }
 
 
//Place the Asset into the AEM DAM using AssetManager API
private String writeToDam(String path, String fileName, WorkflowSession wfsession)
{
try
{
    //Inject a ResourceResolver - make sure to whitelist the bundle
	Session session = wfsession.adaptTo(Session.class);
	ResourceResolver resourceResolver = resolverFactory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object) session));  
        
     
   //Remove the first / char - JCR API does not like that
    String newPath = path.replaceFirst("/", "");   
     
    //USE JCR API TO get the Asset Data so we can move it to another JCR location
    Node root = session.getRootNode(); 
    Node fileNode = root.getNode(newPath);
   
     
    //Append the path where the Asset data is stored
    String dataPath = newPath+"/jcr:content/renditions/original/jcr:content";
     
    //Get the InputStream of the Asset
    Node dataPathNode = root.getNode(dataPath);
    
    Property property = dataPathNode.getProperty("jcr:data");
	Binary fileBinary = property.getBinary();
	InputStream content = fileBinary.getStream();
    
    //Use AssetManager to place the file into the AEM DAM
    com.day.cq.dam.api.AssetManager assetMgr = resourceResolver.adaptTo(com.day.cq.dam.api.AssetManager.class);
    String newFile = "/content/dam/trash/"+fileName ; 
    assetMgr.createAsset(newFile, content,"image/jpeg", true);
           
  
    return fileName;
}
catch(Exception e)
{
    e.printStackTrace();
    log.info("**** Error: " +e.getMessage()) ;  
}
return null;
}
}

Note:

When you need to use Sessions in a custom workflow step, it's best practice to use the Session available with the Workflow API, as shown in the above Java code. 

Modify the Maven POM file

Add the following POM dependency to the POM file located at C:\AdobeCQ\TrashAssetWF63. (If you are using 6.3.)

<dependency>
               <groupId>com.adobe.aem</groupId>
               <artifactId>uber-jar</artifactId>
               <version>6.3.0</version>
               <!-- for AEM6.1 use this version     : <version>6.1.0</version> -->
               <!-- for AEM6.1 SP1 use this version : <version>6.1.0-SP1-B0001</version> -->
               <!-- for AEM6.1 SP2 use this version : <version>6.1.0-SP2</version> -->
               <!-- for AEM6.2 use this version     : <version>6.2.0</version> -->
               <classifier>obfuscated-apis</classifier>
               <scope>provided</scope>
           </dependency>
             
           <dependency>
               <groupId>org.apache.geronimo.specs</groupId>
               <artifactId>geronimo-atinject_1.0_spec</artifactId>
               <version>1.0</version>
               <scope>provided</scope>
           </dependency>

If you are using 6.4, then use these POM dependencies. 

<dependency>
    <groupId>com.adobe.aem</groupId>
    <artifactId>uber-jar</artifactId>
    <version>6.4.0</version>
    <classifier>apis</classifier>
    <scope>provided</scope>
</dependency>
               
  <dependency>
       <groupId>org.apache.geronimo.specs</groupId>
       <artifactId>geronimo-atinject_1.0_spec</artifactId>
       <version>1.0</version>
       <scope>provided</scope>
   </dependency>

When you add new Java classes under core, you need to modify a POM file to successfully build the OSGi bundle. You modify the POM file located at C:\AdobeCQ\TrashAssetWF63\core.

The following code represents this POM file.

<?xml version="1.0" encoding="UTF-8"?>
<!--
 |  Copyright 2015 Adobe Systems Incorporated
 |
 |  Licensed under the Apache License, Version 2.0 (the "License");
 |  you may not use this file except in compliance with the License.
 |  You may obtain a copy of the License at
 |
 |      http://www.apache.org/licenses/LICENSE-2.0
 |
 |  Unless required by applicable law or agreed to in writing, software
 |  distributed under the License is distributed on an "AS IS" BASIS,
 |  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 |  See the License for the specific language governing permissions and
 |  limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>TrashAssetWF63</groupId>
        <artifactId>TrashAssetWF63</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>TrashAssetWF63.core</artifactId>
    <packaging>bundle</packaging>
    <name>TrashAssetWF63 - Core</name>
    <description>Core bundle for TrashAssetWF63</description>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.sling</groupId>
                <artifactId>maven-sling-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <executions>
                    <execution>
                        <id>bundle-manifest</id>
                        <phase>process-classes</phase>
                        <goals>
                            <goal>manifest</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <instructions>
                        <!-- Import any version of javax.inject, to allow running on multiple versions of AEM -->
                        <Import-Package>javax.inject;version=0.0.0,*</Import-Package>
                        <Sling-Model-Packages>
                            com.community.asset.core
                        </Sling-Model-Packages>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>

   <dependencies>
        <!-- OSGi Dependencies -->
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>osgi.cmpn</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>osgi.annotation</artifactId>
        </dependency>
        <!-- Other Dependencies -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.jcr</groupId>
            <artifactId>jcr</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>uber-jar</artifactId>
            <classifier>apis</classifier>
        </dependency>
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.models.api</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mockito</groupId>
            <artifactId>mockito-core</artifactId>
        </dependency>
        <dependency>
            <groupId>junit-addons</groupId>
            <artifactId>junit-addons</artifactId>
        </dependency>
    </dependencies>
</project>

Build the OSGi bundle using Maven

To build the OSGi bundle by using Maven, perform these steps:

  1. Open the command prompt and go to the C:\AdobeCQ\TrashAssetWF63.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\TrashAssetWF63\core\target. The file name of the OSGi component is TrashAssetWF63.core-1.0-SNAPSHOT.jar.

The command -PautoInstallPackage automatically deploys the OSGi bundle to AEM.

View the Active OSGi bundle

After you deploy the OSGi bundle by using the Maven command, you can see it in an active state in the Adobe Apache Felix Web Console.

 

OSGi
The OSGi bundle in an Active State

View your OSGi bundle by performing these steps:

  1. Login to Adobe Apache Felix Web Console at http://server:port/system/console/bundles (default admin user = admin with password= admin).
  2. Click the Bundles tab, sort the bundle list by Id, and note the Id of the last bundle.

Create an AEM Workflow that uses the custom workflow step

In this step, create an AEM workflow that moves the asset to the trash folder in the AEM JCR (at /content/dam/trash) and then deletes the asset from the original location.

To create a workflow, you use the Experience Manager Workflow console located at the following URL:

http://localhost:4502/cf#/libs/cq/workflow/content/console.html

To create a workflow that moves the asset and then deletes it from the original location, perform the following tasks:

1. Log into the Experience Manager Workflow console.

2. Click the New button.

3. Enter TrashAsset as the workflow title.

4. Open the TrashAsset workflow by double-clicking on the name located in the grid view. The workflow model has a Start, Step 1, and an End.

5. Edit Step 1 by double-clicking on the step. Enter an updated description.

6. Add a Process step to the workflow by dragging-and-dropping the Process Step component from the sidekick onto the workflow model. Ensure that this is the second step in the workflow model. Double click on this step and click the Process tab. From the Process drop down list, select My Workflow Process. This value represents the custom workflow step that you created.

7. Drag and drop the Delete Node component from the sidekick onto the workflow model. Make this the third step of the workflow, as shown in the illustration at the start of the article.

8. Click Save.

Invoke the TrashAsset Workflow

The final task to perform is to invoke the TrashAsset workflow from the Experience Manager Touch UI Digital Asset view located at:

http://localhost:4502/assets.html/content/dam/we-retail/en/people/mens (for this article, the Touch UI view is used)

Select an Asset, as shown in this illustration. 

AssetTUI
Select a digital asset in the Touch UI

From the top menu, select Create, Workflow as shown in this illustration. 

WF_TouchUI2
Select Timeline

The Workflow dialog appears. Select the TrashAsset workflow, as shown in this illustration. 

WF11
Select the TrashAsset Workflow

From the Asset admin view at:

http://localhost:4502/assets.html/content/dam

click on the messages icon, as shown here. 

Step1TouchUI
The admin message generated by the first step in the TrashAsset workflow

This bring you to the Workflow confirmation view. Click the Complete button and then the OK button. 

Complete
Click the Complete button to complete the TrashAsset workflow

Now you will see that the TrashAsset workflow deleted the original asset and moved the images to the Trash folder, as shown here. 

TrashFolder
The image is moved to the Trash Folder

See also

Join the AEM community at: Adobe Experience Manager Community

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy