Article summary

Summary

Discusses how to develop an AEM custom workflow steps by using AEM Workflow Java APIs. The custom workflow steps set and read binary values. That is, one step in an AEM workflow can set a value and another step can read the value.

A special thank you to Ratna Kumar Kotla, and Prince Shivhare, top AEM community members, for contributing towards this article to ensure it works.

Digital Marketing Solution(s) Adobe Experience Manager 6.2
Audience Developer
Required Skills Java, HTML, JavaScript
Version 6.2

Note:

This article places a PNG file into the AEM DAM. Make sure you create a DAM folder named Travel, as instructed in this development article. 

Introduction

You can develop a custom Adobe Experience Manager (AEM) workflow step that sets a binary value that can be retrieved by another step in the same workflow. For example, assume you read a byte array and you need that value in a later step. You can store the value and retrieve it in a later step.

To read and write binary values in an AEM workflow, you need to write custom steps. A custom workflow step is implemented as an OSGi bundle that you can build using Maven and the AEM Workflow APIs that belong to the com.adobe.granite.workflow.exec package. For information, see Package com.adobe.granite.workflow.exec.

To demonstrate how to pass values in a workflow between steps, this article uses the following workflow model.

modelA
An AEM Workflow model that passes binary values between steps

Binary values, such as a byte[], can be passed between workflow steps within a Map instance. This development article discusses how to create a custom workflow that sets a byte array value in one step and then retrieves the value in a later step. As proof of concept, it then uses the AssetManager API to store the binary data as an image in the AEM DAM. 

DAMPic
A custom workflow step persisted binary data into the AEM DAM

This development article steps you through how to build custom Experience Manager workflow steps by using an AEM Maven Archetype 10 project. 

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 10 archetype project

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

M10
Files generated by Maven 10 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 archetype:generate -DarchetypeGroupId=com.adobe.granite.archetypes -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=10 -DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/

3. When prompted, specify the following information:

  • groupId - binaryStep
  • artifactId - binaryStep
  • version - 1.0-SNAPSHOT
  • package - com.aem.workflowstep
  • appsFolderName - binaryStep
  • artifactName - binaryStep
  • componentGroupName - binaryStep
  • contentFolderName - binaryStep
  • cssId - binaryStep
  • packageGroup - binaryStep
  • siteName - binaryStep

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 binaryStep 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.

project2
Eclipse Import Project Dialog

The Eclipse project that you work in to build the OSGi bundle that uses HTL API is binaryStep.core. You do not have to work in the other projects under binaryStep.

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.

The next step is to add Java files to the com.aem.workflowstep.core package:

  • CustomDataStep - the first custom workflow step that sets the binary data. 
  • CustomGetDataStep - the second custom workflow step that reads the binary data.

CustomDataStep class

The following Java code represents the CustomDataStep class that implements the WorkflowProcess interface. In this example, binary data is serialized into a String value and then stored in the map.

//Get the byte array to pass to another Workflow step
byte[] bytes = getFile();
String byteArrayString = java.util.Arrays.toString(bytes) ;

//Set the Map that is used to pass values to other workflow steps
item.getWorkflowData().getMetaDataMap().put("MyBinkey", byteArrayString);

The following Java code represents the CustomDataStep class.

package com.aem.workflowstep.core;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
    
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.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
      
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 org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import javax.jcr.RepositoryException;
import org.apache.felix.scr.annotations.Reference;
import org.apache.jackrabbit.commons.JcrUtils;
     
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;
 
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 java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;

import java.nio.file.Files;
import java.nio.file.Paths;
import java.nio.file.Path;
    
//This is a component so it can provide or consume services
@Component
    
     
@Service
   
@Properties({
    @Property(name = Constants.SERVICE_DESCRIPTION, value = "Test Payload workflow process step"),
    @Property(name = Constants.SERVICE_VENDOR, value = "Adobe"),
    @Property(name = "process.label", value = "Test Payload workflow process step") })
public class CustomDataStep implements WorkflowProcess 
{
        
       
/** Default log. */
protected final Logger log = LoggerFactory.getLogger(this.getClass());
       
public void execute(WorkItem item, WorkflowSession wfsession,MetaDataMap args) throws WorkflowException {
           
try
{
    log.info("Here in execute method of CustomDataStep");    //ensure that the execute method is invoked    
           
    //lets get Id of the workflow item -  that value can be passed to another workflow step
    String myID = item.getId() ; 
   
  //Get the byte array to pass to another Workflow step    
  byte[] bytes = getFile(); 
  String byteArrayString =  java.util.Arrays.toString(bytes) ;
  
  //Set the Map that is used to pass values to other workflow steps 
  item.getWorkflowData().getMetaDataMap().put("MyBinkey", byteArrayString);
  log.info("*** In Step 2 - the Binary value was set " + myID);

}
   
    catch (Exception e)
    {
    e.printStackTrace()  ; 
    }
 }


 private byte[] getFile()
 {
	 
	 
	 File file = new File("C:/Users/scottm/MalAA.png");
	 FileInputStream is = null;
	 ByteArrayOutputStream buffer = new ByteArrayOutputStream();
	 
	 try {
		 is = new FileInputStream(file);
		 
		 int nRead;
		 byte[] data = new byte[16384];

		 while ((nRead = is.read(data, 0, data.length)) != -1) {
		   buffer.write(data, 0, nRead);
		 }

		 buffer.flush();

		 return buffer.toByteArray();
			

		} catch (Exception e) {
			e.printStackTrace();
		}
	 
	 return null ; 
 }
 
 
  
}

Note:

Notice that code line 111 reads a file from the file system. Replace this line of code with a PNG image file that you have. Otherwise, you will get a Java exception.  

CustomGetDataStep

The CustomGetDataStep is used to retrive the value set in the CustomDataStep class. To retrieve the value, you use the following Java logic to read the value from the Map:

String byteArrayString = item.getWorkflowData().getMetaDataMap().get("MyBinkey", java.lang.String.class);

Once the value is retrieved, it is converted back to a byte array. Because the binary data is a PNG image, it is stored in the AEM DAM using the AssetManager API

The following Java code represents the CustomGetDataStep class.

package com.aem.workflowstep.core;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
     
import java.io.ByteArrayInputStream;
import java.io.InputStream;
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.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
      
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 org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import javax.jcr.RepositoryException;
import org.apache.felix.scr.annotations.Reference;
import org.apache.jackrabbit.commons.JcrUtils;
     
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;
   
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.Byte;
   
    
//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; 



//AssetManager
import com.day.cq.dam.api.AssetManager; 
    
//This is a component so it can provide or consume services
@Component
    
     
@Service
   
@Properties({
    @Property(name = Constants.SERVICE_DESCRIPTION, value = "GET Payload step"),
    @Property(name = Constants.SERVICE_VENDOR, value = "Adobe"),
    @Property(name = "process.label", value = "GET Payload step") })
public class CustomGetDataStep implements WorkflowProcess 
{
   
	//Inject a Sling ResourceResolverFactory
	 @Reference
	 private ResourceResolverFactory resolverFactory;       
       
/** Default log. */
protected final Logger log = LoggerFactory.getLogger(this.getClass());
       
       
public void execute(WorkItem item, WorkflowSession wfsession,MetaDataMap args) throws WorkflowException {
           
try
{
    
	 //GET the value set in map in step 2
	 String byteArrayString = item.getWorkflowData().getMetaDataMap().get("MyBinkey", java.lang.String.class);
    
	
	 String[] byteValues = byteArrayString.substring(1, byteArrayString.length() - 1).split(",");
	 
	 
	 byte[] bytes = new byte[byteValues.length]; // Convert back to byte array	  
	
	 
	 for (int i=0, len=bytes.length; i<len; i++) {
		    bytes[i] = Byte.parseByte(byteValues[i].trim());
		  }
	  InputStream bis = new ByteArrayInputStream(bytes); 
	 
	  int length = bis.available();
	 
	  writeToDam(bis, "WFPic.png");	  
	  
	 log.info("*** In Step 3 - the Binary dara was retrieved " +length);
     
     
}
   
    catch (Exception e)
    {
    e.printStackTrace()  ; 
    }
 }
 

//Save the uploaded file into the AEM DAM using AssetManager APIs
private String writeToDam(InputStream is, String fileName)
{
try
{
    //Inject a ResourceResolver
    ResourceResolver resourceResolver = resolverFactory.getAdministrativeResourceResolver(null);
     
    //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/travel/"+fileName ; 
    assetMgr.createAsset(newFile, is,"image/png", true);
         
    // Return the path to the file was stored
    return newFile;
}
catch(Exception e)
{
    e.printStackTrace();
}
return null;
}
 
  
}

Note:

In the previous code example, notice that they Assets Manager API places the image file in the DAM in a folder named travel. EIther create the travel folder in your AEM DAM or change the location in the code to reflect your DAM structure. 

Also, in the previous code example, notice the use of

ResourceResolver resourceResolver = resolverFactory.getAdministrativeResourceResolver(null).

This is only there to keep the code short. To access an AEM JCR session, you should create a system user and Sling Mapping Service. For information, see this article Querying Adobe Experience Manager 6 data using the Sling getServiceResourceResolver method.  

Modify the Maven POM file

Add the following POM dependency to the POM file located at C:\AdobeCQ\binaryStep.

<dependency>
               <groupId>com.adobe.aem</groupId>
               <artifactId>uber-jar</artifactId>
               <version>6.2.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>

You need to modify two POM files. The first one is the parent POM file shown in this illustration.

MPP
Parent POM

Add the dependency shown above to the Parent POM file. Next, modify the POM file located at C:\AdobeCQ\binaryStep\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>binaryStep</groupId>
        <artifactId>binaryStep</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>binaryStep.core</artifactId>
    <packaging>bundle</packaging>
    <name>binaryStep - Core</name>
    <description>Core bundle for binaryStep</description>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-scr-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <!--
                        <Embed-Dependency>
                            artifactId1,
                            artifactId2;inline=true
                        </Embed-Dependency>
                        -->
                        <Sling-Model-Packages>
                            com.aem.workflowstep.core
                        </Sling-Model-Packages>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <profiles>
        <!-- Development profile: install only the bundle -->
        <profile>
            <id>autoInstallBundle</id>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.sling</groupId>
                        <artifactId>maven-sling-plugin</artifactId>
                        <configuration>
                            <!-- Note that this requires /apps/binaryStep/install to exist!!          -->
                            <!--    This is typically the case when ui.apps is deployed first                -->
                            <!--    Otherwise, create /apps/binaryStep/install manually (CRXDE|Lite)  -->
                            <slingUrlSuffix>/apps/binaryStep/install/</slingUrlSuffix>
                            <failOnError>true</failOnError>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>
    <dependencies>
       <!-- OSGi Dependencies -->
             
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>uber-jar</artifactId>
            <classifier>obfuscated-apis</classifier>
        </dependency>
  
        <dependency>
            <groupId>org.apache.geronimo.specs</groupId>
            <artifactId>geronimo-atinject_1.0_spec</artifactId>
        </dependency>
<dependency>
    <groupId>com.adobe.granite.bundles</groupId>
    <artifactId>json</artifactId>
    <version>20090211_1</version>
    <scope>provided</scope>
</dependency>
  
         <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
        </dependency>
        <dependency>
            <groupId>biz.aQute</groupId>
            <artifactId>bndlib</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.compendium</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>aem-api</artifactId>
        </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-all</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\binaryStep.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\binaryStep\core\target. The file name of the OSGi component is binaryStep.core-1.0-SNAPSHOT.jar.

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

Create an AEM Workflow that uses the custom workflow step

In this step, create an AEM workflow that uses the two custom steps to pass and read a workflow item Id value. (See the illustration at the beginning of this development article.)

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 passes values using custom steps, perform the following tasks:

1. Log into the Experience Manager Workflow console.

2. Click the New button.

3. Enter GetPayload as the workflow title.

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

5. Edit Step 1 by double-clicking on the step. Enter the following property values:

  • Description - Administrator determines if the workflow proceeds to the next step
  • Title - Administrator
  • User/Group - admin

6. Add the second step by dragging-and-dropping the Process Step component from the sidekick onto the workflow model. Make this the second step of the workflow as shown in the illustration shown at the start of the article. Double click on this step and click the Process tab. From the Process drop down list, select Test Payload workflow process step. This value represents the custom workflow step that you created using the CustomDataStep Java class.

7. Add the third step by dragging-and-dropping the Process Step component from the sidekick onto the workflow model. Make this the third step of the workflow as shown in the illustration shown at the start of the article. Double click on this step and click the Process tab. From the Process drop down list, select GET Payload step. This value represents the custom workflow step that you created using the CustomGetDataStep Java class.

8. Click Save.

Note:

In both of the custom steps dialog, ensure that you select the Handler Advance checkbox so that the workflow advances to the next step.

Invoke the GetPayload Workflow

The final task to perform is to invoke the GetPayload workflow by selecting a page. When the workflow is executed, the custom workflow steps that you developed in this article are invoked. The first custom step reads a binary file and the second step places in into the AEM DAM by using the AssetManager API.

From the Experience Manager WebSite view, create a page based on any template and name the page TestPage. Select the TestPage row, click the Workflow button (from the menu), and select the GetPayload workflow, as shown in the following illustration.

Workflow
Invoking the GetPayload workflow

Click the Start button. An email is sent to the administrator (the first step of the worflow). You can access the administrator email at: http://localhost:4502/inbox.

adminUI
An email in the administrators inbox that represents the first step of the GetPayload workflow

When the administrator clicks on the row and then clicks the Complete button, the Complete Work Item dialog is shown that specifies the the second step (the custom step defined by the CustomDataStep Java class).

Step2Dialog
The Complete Work Item dialog

When the administrator clicks OK, the second step is invoked and sets the Map in the Java class with the Id of the workflow item. Then the third step is executed that reads the Map value and places the binary data into the AEM DAM by using the AssetManager API (see the illustration shown at the start of this article).

Invoke the GetPayload workflow.

1. Go to the CQ Websites page at http://[host name]:[port]/siteadmin#/content. For example, http://localhost:4502/siteadmin#/content.

2. Select New Page.

3. Specify the title of the page in the Title field. Name it TestPage.

4. Specify the name of the page in the Name field. Name it TestPage.

5. Select any template from the template list that appears.

6. Select the row of the TestPage page and click the Workflow button.

7. Select GetPayload and click Start.

9. Go to the Admin email located at http://localhost:4502/inbox.

10. Click the email row and complete the step. Once completed, the workflow advances to the next two steps and completes.

11. You can view the image in the DAM at the following URL: http://localhost:4502/damadmin#/content/dam/travel/WFPic.png (assuming you named the file WFPic.png). 

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