Article summary

Summary

Discusses how to create a custom workflow step that has a dialog that lets workflow authors enter parameter values used in the workflow. This article also discusses how to use Java code to retrieve those values at run-time.  In addition, this article also demonstrates how to use the Delete Node step in an example workflow. 

A special thank you to Ratna Kumar Kotla, a member of the AEM community for testing this article and ensuring it works. 

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (intermediate)
Required Skills
Java, OSGi, Maven
Tested On  Adobe Experience Manager 5.6, 6.x

Note:

You can download an AEM package that contains the custom workflow component with the dialog and the OSGi service. Download the package and deploy using package manager. The purpose of this code is to show the community these concepts in action. That is, it's to illustrate how to write a custom workflow component with a dialog. This community code is for teaching purposes only and not meant to go into production as is. After you deploy this package, you still have to create the DeleteContentPart workflow as discussed in this article. However - the Logger custom step will be available from the sidekick.

Download

Introduction

You can develop a custom Adobe Experience Manager workflow step that reads data from a workflow dialog. An author enters data into a dialog during design time; typically when the workflow model is developed. The Java logic that belongs to the custom step reads the values and uses the vaules in the AEM workflow during run-time. In this example, the values are simply written to the AEM log file.  

The following illustration shows the workflow step dialog that is created in this development article. 

DialogVals

The following illustration shows the project files created in this development article.

workflowstep

The provious illustration shows JCR nodes that are required to create a dialog for a custom workflow step.

The following describes the files in the previous illustration. 

Section Description
A Configuration files for the dialog. For example, a property under this node branch maps the  dialog to the OSGi service that contains application logic for the custom workflow step. This is how a custom dialog is mapped to a custom OSGi service (this is discussed in more detail later in this development article).  
B JCR nodes that define the dialog for the custom workflow step.
C JCR nodes that defines arguments for the dialog

Note:

If you deploy the package that is shown at the beginning of this article, you can skip steps 1-8. However - it's still recommended that you read the article to understand the concepts. 

Create an Experience Manager folder structure  

Create an Experience Manager application folder structure that contains templates, components, and pages by using CRXDE Lite.  

CQAppSetup

The following describes each application folder:

  • application name: contains all of the resources that an application uses. The resources can be templates, pages, components, and so on. 
  • components: contains components that your application uses. 
  • page: contains page components. A page component is a script such as a JSP file.
    global: contains global components that your application uses.
  • template: contains templates on which you base page components. 
  • src: contains source code that comprises an OSGi component (this development article does not create an OSGi bundle using this folder). 
  • install: contains a compiled OSGi bundles container.

To create an application folder structure:

  1. To view the CQ welcome page, enter the URL http://[host name]:[port] into a web browser. For example, http://localhost:4502.
  2. Select CRXDE Lite.
  3. Right-click the apps folder (or the parent folder), select Create, Create Folder.
  4. Enter the folder name into the Create Folder dialog box. Enter workflowstep
  5. Repeat steps 1-4 for each folder specified in the previous illustration. 
  6. Click the Save All button.

 

Note:

You have to click the Save All button when working in CRXDELite for the changes to be made.

Create the Workflow Step Component

1. Create a folder named workflow under /apps/workflowstep/components.

2. Right click on /apps/workflowstep/components/workflow and then select New, Component. Name the component loggerprocess.

2. Enter the following information into the Create Component dialog box:

  • Label: The name of the component to create. Enter Loggerprocess.
  • Title: The title that is assigned to the component. Enter Logger.
  • Description: The description that is assigned to the component. Enter Writes workflow information to the log file.
  • Super Resource Type: Enter cq/workflow/components/model/process.
  • Group: The group in the side kick where the component appears. Enter Workflow
  • Allowed parents: Enter */parsys.

3. Click Ok.

cq:editConfig JCR nodes

The cq:editConfig node defines configuration values for the custom workflow step, including the OSGi Java class that defines the steps functionality.  

Perform these tasks:

1. Click on /apps/workflowstep/components/workflow/loggerprocess

2. Right click and select Create, Create Node.

3. Enter the following values:

  • Name: cq:editConfig
  • Type: cq:EditConfig

4. Add the following properties to the cq:editConfig node.

  • cq:dialogMode(String) - floating
  • cq:inherit(Boolean) - true
5. Click on /apps/workflowstep/components/workflow/loggerprocess/cq:editConfig.
6. Right click and select Create, Create Node.
7. Enter the following values:
  • Name: cq:formParameters
  • Type: nt:unstructured

8. Add the following properties to the cq:formParameters node.

  • PROCESS(String) - com.mycompany.workflow.impl.process.LoggerProcess (this is the Java class in the OSGi service that defines the custom step logic and is build later in this development article)
  • PROCESS_AUTO_ADVANCE(String) - true
  • jcr:description(String) - Logs workflow values to the log.
  • jcr:title - Logger Process

Loggerprocess dialog

Build a dialog for the custom workflow step and ensure that the nodes resemble the following illustration. 

dialog

Perform these tasks:

1. Select /apps/workflowstep/components/workflow/loggerprocess.

2. Right click and select Create, Create Dialog.

3. In the Title field, enter Logger Process - Step Properties.

4. Click Ok.

5. Delete all nodes under /apps/workflowstep/components/workflow/loggerprocess/dialog.

6. Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/dialog.

7. Right click and select Create, Create Node.

8. Enter the following values:

  • Name: items
  • Type: cq:WidgetCollection

9 . Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/dialog/items.

10. Right click and select Create, Create Node.

11. Enter the following values:

  • Name: tabs
  • Type: cq:TabPanel

12. Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/dialog/items/tabs/.

13. Right click and select Create, Create Node.

14. Enter the following values:

  • Name: items
  • Type: cq:WidgetCollection

15. Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/dialog/items/tabs/items.

16. Right click and select Create, Create Node.

17. Enter the following values:

  • Name: processcommon
  • Type: cq:Widget

18. Add the following properties to this node:

  • path (String) - /libs/cq/workflow/components/model/process/process_head.infinity.json
  • xtype (String) - cqinclude

19. Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/dialog/items/tabs/items.

20. Right click and select Create, Create Node.

21. Enter the following values:

  • Name: /processargs
  • Type: cq:Widget

22. Add the following properties to this node:

  • path (String) - /apps/workflowstep/components/workflow/loggerprocess/processargs.infinity.json
  • xtype (String) - cqinclude

Processargs Nodes

The processargs nodes defines the input parameters for the workflow step's dialog. In this example, two fields are defined:

  • A text input contorl
  • A multifield control

The following illustration shows the JCR processargs nodes.

processargs

Build the processargs JCR nodes by performing these tasks:

1. Select /apps/workflowstep/components/workflow/loggerprocess.

2. Right click and select Create, Create Node.

3. Enter the following values:

    Name: processargs

     Type: cq:Panel

4. Select /apps/workflowstep/components/workflow/loggerprocess/processargs.

5. Right click and select Create, Create Node.

6. Enter the following values:

  • Name: items
  • Type: cq:WidgetCollection

7. Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/processargs/items

8. Right click and select Create, Create Node.

9. Enter the following values:

  • Name: arguments
  • Type: cq:Widget

10. Add the following properties to this node:

  • collapsed (Boolean) - false
  • collapsible (Boolean) - false
  • title (String) - Process Arguments
  • xtype (String) - dialogfieldset

11. Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/processargs/items/arguments

12. Right click and select Create, Create Node.

13. Enter the following values:

  • Name: items
  • Type: cq:WidgetCollection

14. Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/processargs/items/arguments/items.

15. Right click and select Create, Create Node.

16. Enter the following values:

  • Name: singlearg
  • Type: cq:Widget

17. Add the following properties to this node:

  • fieldLabel (String) - Single Argument
  • name (String) - ./metaData/argSingle
  • xtype (String) - textfield

18. Click on the following node: /apps/workflowstep/components/workflow/loggerprocess/processargs/items/arguments/items.

19. Right click and select Create, Create Node.

20. Enter the following values:

  • Name: multiarg
  • Type: cq:Widget

21. Add the following properties to this node:

  • fieldLabel (String) - Multi Arg
  • name (String) - ./metaData/argMulti
  • xtype (String) - multifield

Note:

The name properties set in step 14 and 18 are referenced in the Java code for this custom code. 

Setup Maven in your development environment

You can use Maven to build an OSGi bundle that contains an AEM service. 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:

Java home: C:\Programs\Java64-6\jre
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>

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. 

plugin1


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.mycompany.workflow.impl.process -DartifactId=Logger -Dversion=1.0-SNAPSHOT -Dpackage=com.mycompany.workflow.impl.process -DappsFolderName=myproject -DartifactName="My Project" -DcqVersion="5.6.1" -DpackageGroup="My Company"

3. When prompted for additional information, specify Y.

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

[INFO] Final Memory: 10M/184M

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

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.

Delete the logger-content project from the Eclipse IDE. Work in the logger-bundle project and make sure that you work in the com.mycompany.workflow.impl.process package.

LoggerProcess class

The next step is to add Java files to the com.mycompany.workflow.impl.process 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 LoggerProcess in the com.mycompany.workflow.impl.process package that implements the WorkflowProcess interface. Specify the following Apache Felix SCR annotations:

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

Because the LoggerProcess 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 use case, the values that a workflow author enters into the workflow step's dialog can be retrieved by using the args parameter. The following Java code represents the LoggerProcess Java class. 

package com.mycompany.workflow.impl.process;

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.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.osgi.framework.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
  
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import java.util.Arrays;
  
/**
 * Sample workflow process that logs arguments into the logfile.
 */
@Component
@Service
@Properties({
        @Property(name = Constants.SERVICE_DESCRIPTION, value = "Logger process implementation."),
        @Property(name = Constants.SERVICE_VENDOR, value = "Adobe"),
        @Property(name = "process.label", value = "Logger Process")})
public class LoggerProcess implements WorkflowProcess {
  
   private static final Logger log = LoggerFactory.getLogger(LoggerProcess.class);
  
    public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {
        String singleValue = args.get("argSingle", "not set");
        String[] multiValue = args.get("argMulti", new String[]{"not set"});
  
        log.info("---> Single Value: {}", singleValue);
        log.info("---> Multi Value: {}", Arrays.toString(multiValue));
    }
}

Note:

Notice that the name properties (singleVaule and multiValue ) of the processarg nodes (that you set earlier in this article) are referenced.

Modify the Maven POM file

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

  • org.apache.felix.scr
  • org.apache.felix.scr.annotations
  • org.apache.sling

The following XML represents the POM file. Copy the XML code 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.mycompany.workflow.impl.process</groupId>
        <artifactId>Logger</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>Logger-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</groupId>
          <artifactId>cq-mailer</artifactId>
           <version>5.6.2</version> 
           <scope>provided</scope> 
          </dependency>    
          
          <dependency>
	<groupId>com.day.cq.workflow</groupId>
	<artifactId>cq-workflow-api</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.mycompany.workflow.impl.process.Logger-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 Logger custom step by using Maven, perform these steps:

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

Deploy the bundle to Experience Manager

After you deploy the OSGi bundle, you can see it in the Apache Felix Web Console.

OSGiLogger


After you place the OSGi bundle in an activate state, you can build a workflow that uses this custom  step. This is shown in the next step.

Deploy the key service 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. Click the Bundles tab, 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\Logger\bundle\target).
  5. Click Install.
  6. Click the Refresh Packages button.
  7. Check the bundle with the highest Id.
  8. Click Active.
  9. Your new bundle should now be listed with the status Active.
  10. 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 deletes content and uses the custom step to log messages. 

 

 

WorkflowLogger

To create a workflow that deletes content and logs a message using the custom step, perform the following tasks:

1. Log into the Workflow console at http://localhost:4502/cf#/libs/cq/workflow/content/console.html.

2. Click the New button.

3. Enter DeleteContentPart as the workflow title.

4. Open the DeleteContentPart workflow by double-clicking on the name located in the grid view. The DeleteContentPart 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 Delete Node component  from the sidekick onto the workflow model. Make this the second step of the workflow as shown in the previous illustration.

7. Add the Logger custom step to the workflow by dragging-and-dropping the Logger component from the sidekick onto the workflow model. Ensure that this is the third step in the workflow model. Double click on this step and click the Arguments tab. Enter values into the fields. (These vaules are logged to the AEM log file).

8. Click Save.

Invoke the DeleteContentPart Workflow

The final task to perform is to invoke the DeleteContentPart workflow by selecting a page that you want to delete. When the workflow is executed, the custom workflow step that you developed in this article logs the values.

From the 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 DeleteContentPart workflow, as shown in the following illustration.

WorkflowStart

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.

workadmin

When the administrator clicks the Complete button, the Complete Work Item dialog is shown that specifies the Delete Node step (the second step in the workflow). The piece of content that is specified as the second argument (TestPage) is deleted. The worflow advances to the custom workflow step that logs the values entered into the dialog into the AEM log file. 

16.04.2015 14:28:38.577 *INFO* [JobHandler: /etc/workflow/instances/2015-04-16/model_1214178378261884:/content/TestPage] com.mycompany.workflow.impl.process.LoggerProcess ---> Single Value: My First Value

16.04.2015 14:28:38.577 *INFO* [JobHandler: /etc/workflow/instances/2015-04-16/model_1214178378261884:/content/TestPage] com.mycompany.workflow.impl.process.LoggerProcess ---> Multi Value: [My Second Value, My Third Value, My Fourth Value]

See also

Congratulations, you have just created a custom workflow step that uses a dialog. Please refer to the AEM community page for more articles that discuss how to build AEM services/applications.

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