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 values. That is, one step in an AEM workflow can set a value and another step can read the value.   

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.

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (intermediate)
Required Skills
Java, Maven
Tested On Adobe Experience Manager 5.6, 6.0, 6.1

Introduction

You can develop a custom Adobe Experience Manager (AEM) workflow step that sets a value that can be retrieved by another step in the same workflow. For example, assume you read a property of a payload 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 values in an AEM workflow, you need to write a custom step. 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 between workflow steps, this article uses the following workflow model.

modelA
An AEM Workflow model that passes values between steps

Values that can be passed between workflow steps are primitive data types like string and integer values. Values are passed within a Map instance. 

If you need to pass non-primitive data (binary data), you can pass it within a byte[]. However if the byte array is too large, a better approach is to write the data to a JCR node in a given step and retrieve it in a later step. Do not try to store data as an InputStream in the Map. 

This development article discusses how to create a custom workflow that sets a string value in one step and then retrieves the value in a later step. In this example, the identifier value of the workflow item is used as the value that is passed between steps. This value is retrieved by invoking the getId method of the workflow item. For information, see, Interface WorkItem.

The Id value is set in the second step:  

*** In Step 2 - this value was set VolatileWorkItem_node2_etc_workflow_instances_server0_2016-04-14_model_73599428872087

In the third step, the Id value is retrieved and written to the AEM log file: 

*** In Step 3 - the Retreieved value is VolatileWorkItem_node2_etc_workflow_instances_server0_2016-04-14_model_73599428872087

Setup Maven in your development environment  

You can use Maven to build an OSGi bundle that uses the AEM Workflow API and deploy to Experience Manager. 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.

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:

OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Note:

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>

Create an Experience Manager archetype project  

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

Maven

 

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 -DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/ -DarchetypeGroupId=com.day.jcr.vault -DarchetypeArtifactId=multimodule-content-package-archetype -DarchetypeVersion=1.0.2 -DgroupId=com.aem.workflowstep -DartifactId=workpassdata -Dversion=1.0-SNAPSHOT -Dpackage=com.aem.workflowstep -DappsFolderName=myproject -DartifactName="My Project" -DcqVersion="5.6.1" -DpackageGroup="My Company"

3. When prompted, specify Y.

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

[INFO] Finished at: Wed Mar 27 13:38:58 EDT 2013
[INFO] Final Memory: 10M/184M

5. Change the command prompt to the generated project. For example: C:\AdobeCQ\workpassdata.

6. Run the following Maven command:

mvn eclipse:eclipse

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

 

Note:

Make sure that you work in the Eclipse project named workpassdata-bundle. You can delete workpassdata-content. Also delete src/test/java source files. Besure to work in the scr/main/java folder.  Delete all default files from the project. Ensure that you only have the two Java files discussed in this section. 

The next step is to add two Java files (each class represents a separate custom workflow step) to the com.aem.workflowstep package.

  • CustomDataStep - sets the data value in a Map. 
  • CustomGetDataStep - reads the data from from the Map

Both Java classes that you create in this section impements the com.adobe.granite.workflow.exec.WorkflowProcess interface. For information, see Interface WorkflowProcess.

Both Java classes implements the WorkflowProcess interface and use these Apache Felix SCR annotations:

  • @Component - defines the class as a component
  • @Service - defines the service interface that is provided by the component
  • @Reference - injects a service into the component
  • @Properties - defines properties of this custom workflow step

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

To successfully create a custom workflow step, specify the Java Properties annotations, as shown here:

@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") })

These values are used when you create a workflow model. Notice the value specified in the process.label name property: Test Payload workflow process step. This value is used in the Process Step dialog to select the custom workflow step, as shown in this illustration.

DialogAA
The Process Step dialog

Note:

A workflow model that uses this custom step is created later in this development article. It's important that you understand the relationship between the Java properties annotation and the values that are displayed in the Step Properties dialog box.

CustomDataStep

The following Java code represents the CustomDataStep class that implements the WorkflowProcess interface. Notice that a value is set using this code: 

 item.getWorkflowData().getMetaDataMap().put("MyIDkey", myID);

Copy this code to your CustomDataStep class.

package com.aem.worflow.service;

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 com.day.cq.mailer.MessageGateway;
import com.day.cq.mailer.MessageGatewayService;
  
import org.apache.commons.mail.Email;
import org.apache.commons.mail.EmailException;
import org.apache.commons.mail.SimpleEmail;
  
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; 
   
//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() ; 
    
 
  
     //Set the Map that is used to pass values to other workflow steps 
    item.getWorkflowData().getMetaDataMap().put("MyIDkey", myID);
    
   
    log.info("*** In Step 2 - this value was sets " + myID);
    
    
}
  
    catch (Exception e)
    {
    e.printStackTrace()  ; 
    }
 }


 
}

Note:

Do not worry about the errors displayed in Eclipse. In this article, Eclipse is used to organize your files, not to build the project. Maven builds the OSGi bundle.  

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 value = item.getWorkflowData().getMetaDataMap().get("MyIDkey", java.lang.String.class);

Notice you pass the Key value, which is MyIDkey in this example and you specify the data type, whcih is a String value. 

Copy the following code to your CustomGetDataStep

 

 

package com.aem.worflow.service;



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 com.day.cq.mailer.MessageGateway;
import com.day.cq.mailer.MessageGatewayService;
  
import org.apache.commons.mail.Email;
import org.apache.commons.mail.EmailException;
import org.apache.commons.mail.SimpleEmail;
  
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; 
   
//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 
{
  
       
      
/** 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 value = item.getWorkflowData().getMetaDataMap().get("MyIDkey", java.lang.String.class);
    log.info("*** In Step 3 - the Retreieved value is " + value);
    
    
}
  
    catch (Exception e)
    {
    e.printStackTrace()  ; 
    }
 }


 
}

Modify the Maven POM file

Modify the POM files to successfully build the OSGi bundle. In the POM file located at C:\AdobeCQ\workpassdata\bundle, add the following dependencies.

  • org.apache.felix.scr
  • org.apache.felix.scr.annotations
  • com.adobe.granite.workflow
  • org.apache.commons.mail
  • com.day.cq.mailer

Because the granite workflow API is used, a Maven dependency for that API exists.

<groupId>com.adobe.granite</groupId>
<artifactId>com.adobe.granite.workflow.api</artifactId>
<version>1.0.0</version>
<scope>provided</scope>
</dependency>

You have to add the following element to your POM file.

 

<?xml version="1.0" encoding="UTF-8"?>
<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/maven-v4_0_0.xsd ">
    <modelVersion>4.0.0</modelVersion>
    <!-- ====================================================================== -->
    <!-- P A R E N T P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->
    <parent>
        <groupId>com.aem.workflowstep</groupId>
        <artifactId>workpassdata</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <!-- ====================================================================== -->
    <!-- P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->

    <artifactId>workpassdata-bundle</artifactId>
    <packaging>bundle</packaging>
    <name>My Project Bundle</name>

   <dependencies>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.compendium</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
           
            
        <dependency>
         <groupId>org.apache.felix</groupId>
     
         <artifactId>org.osgi.core</artifactId>
     
         <version>1.4.0</version>
      </dependency>
           
          
            
    <dependency>
    <groupId>org.apache.jackrabbit</groupId>
    <artifactId>jackrabbit-core</artifactId>
    <version>2.4.3</version>
    </dependency>
         
    <dependency>
    <groupId>org.apache.jackrabbit</groupId>
    <artifactId>jackrabbit-jcr-commons</artifactId>
    <version>2.4.3</version>
    </dependency>
   <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
             
    <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.api</artifactId>
            <version>2.2.4</version>
            <scope>provided</scope>
        </dependency>
           
      <dependency>
         <groupId>javax.jcr</groupId>
         <artifactId>jcr</artifactId>
         <version>2.0</version>
      </dependency>
         
       <dependency>
            <groupId>com.day.cq.wcm</groupId>
            <artifactId>cq-wcm-api</artifactId>
            <version>5.5.0</version>
            <scope>provided</scope>
        </dependency>
           
        <dependency>
            <groupId>com.day.cq</groupId>
            <artifactId>cq-commons</artifactId>
            <version>5.5.0</version>
            <scope>provided</scope>
        </dependency>
          
        <dependency>
            <groupId>com.day.cq.workflow</groupId>
            <artifactId>cq-workflow-api</artifactId>
            <version>5.4.2</version>
            <scope>provided</scope>
        </dependency>
                  
         <dependency> 
         <groupId>com.day.cq</groupId>
          <artifactId>cq-mailer</artifactId>
           <version>5.6.2</version> 
           <scope>provided</scope> 
          </dependency>    
 <dependency>
    <groupId>com.adobe.granite</groupId>
    <artifactId>com.adobe.granite.workflow.api</artifactId>
    <version>1.0.0</version>
    <scope>provided</scope>
</dependency>
                 
    </dependencies>

    <!-- ====================================================================== -->
    <!-- B U I L D D E F I N I T I O N -->
    <!-- ====================================================================== -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-scr-plugin</artifactId>
                <executions>
                    <execution>
                        <id>generate-scr-descriptor</id>
                        <goals>
                            <goal>scr</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <Bundle-SymbolicName>com.aem.workflowstep.workpassdata-bundle</Bundle-SymbolicName>
                    </instructions>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.sling</groupId>
                <artifactId>maven-sling-plugin</artifactId>
                <configuration>
                    <slingUrl>http://${crx.host}:${crx.port}/apps/myproject/install</slingUrl>
                    <usePut>true</usePut>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                 <configuration>
                    <excludePackageNames>
                        *.impl
                    </excludePackageNames>
                 </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Build the OSGi bundle using Maven  

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

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

 

Deploy the bundle to Experience Manager

Once you deploy the OSGi bundle, you are able to use the custom step within an AEM workflow model (this is shown later in this development article). Also, you are able to see it in the Apache Felix Web Console. 

OSGi
Apache Felix Web Console Bundles view

Deploy the OSGi bundle by performing these steps:

  1. Login to Apache Felix Web Console at http://server:port/system/console/bundles (default admin user = admin with password= admin).
  2. Under the OSGi menu item, select Bundles. Sort the bundle list by Id, and note the Id of the last bundle.
  3. Click the Install/Update button.
  4. Browse to the bundle JAR file you just built using Maven. (C:\AdobeCQ\workpassdata\bundle\target).
  5. Click Install.
  6. Click the Refresh Packages button.
  7. Check the bundle with the highest Id.
  8. Click Active. Your new bundle should now be listed with the status Active.
  9. If the status is not Active, check the CQ error.log for exceptions.

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 content is deleted
  • 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.

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 writes out the value to the AEM log file. 

Create a CQ web page to use in 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. 

See also

Congratulations, you have just created an AEM custom workflow step by using an Adobe Maven Archetype project. Please refer to the AEM community page for other articles that discuss how to build AEM services/applications by using an Adobe Maven Archetype project.

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