Connecting AEM Forms with Adobe LiveCycle

Adobe Experience Manager (AEM) LiveCycle connector enables seamless invocation of Adobe LiveCycle ES4 Document Services from within AEM web apps and workflows. LiveCycle provides a rich client SDK, which allows client applications to start LiveCycle services using Java APIs. AEM LiveCycle Connector simplifies using these APIs within the OSGi environment.

Connecting AEM server to Adobe LiveCycle

AEM LiveCycle Connector is part of the AEM Forms add-on package. After installing the AEM Forms add-on package, perform the following steps to add details of LiveCycle server to AEM Web Console.

1. In AEM web console configuration manager, locate the Adobe LiveCycle Client SDK configuration component.
2. Click the component to edit the configuration server URL, user name, and password.
3. Review the settings and click Save.

Although the properties are self explanatory, the important ones are as follows:

• Server URL - Specifies URL to the LiveCycle server. If you want LiveCycle and AEM to communicate over https, start AEM with the following JVM

  argument
   -Djavax.net.ssl.trustStore=<<em>path to LC keystore</em>>
  

  option.

• Username- Specifies user name of the account which is used to establish communication between AEM and LiveCycle. The account is a LiveCycle user account who has the permissions to start Document Services.

• Password- Specifies the password.

• Service Name - Specifies the services which are started using the user credentials provided in Username and Password fields. By default, no credentials are passed while starting LiveCycle services.

Starting document services

Client applications can programmatically start LiveCycle services using a Java API, Web Services, Remoting, and REST. For Java clients, the application can use LiveCycle SDK. The LiveCycle SDK provides a Java API for starting these services remotely. For example, to convert a Microsoft Word Document to PDF, the client starts GeneratePDFService. The invocation flow consists of the following steps:

1. Create a ServiceClientFactory instance.
2. Each service provides a client class. To start a service, create a client instance of the service.
3. Start the service and process the result.

AEM LiveCycle Connector simplifies the flow by exposing these client instances as OSGi services that can be accessed using standard OSGi means. The LiveCycle connector provides the following features:

• Client instances as OSGi Service: The clients packaged as OSGI bundles are listed in the Document Services list section. Each client jar registers the client instance as OSGi service with the OSGi Service Registry.
• User Credential Propagation: The connection details required to connect to LiveCycle server are managed at a central place.
• ServiceClientFactory Service: To start the processes, client application can access the ServiceClientFactory instance.

Starting via Service References from OSGi Service Registry

To start an exposed service from within AEM, perform the following steps:

1. Determine maven dependencies. Add dependency to the required client jar in your maven pom.xml file. At a minimum, add dependency to adobe-livecycle-client and adobe-usermanager-client jars.

   <dependency>
     <groupId>com.adobe.livecycle</groupId>
     <artifactId>adobe-livecycle-client</artifactId>
     <version>11.0.0</version>
   </dependency>
   <dependency>
     <groupId>com.adobe.livecycle</groupId>
     <artifactId>adobe-usermanager-client</artifactId>
     <version>11.0.0</version>
   </dependency>
   <dependency>
     <groupId>com.adobe.livecycle</groupId>
     <artifactId>adobe-cq-integration-api</artifactId>
     <version>11.0.0</version>
   </dependency>
   

   To start a service, add corresponding Maven dependency for the service. For the list of dependencies, see Document Service List. For example, for the Generate PDF service add the following dependency:

   <dependency>
     <groupId>com.adobe.livecycle</groupId>
     <artifactId>adobe-generatepdf-client</artifactId>
     <version>11.0.0</version>
   </dependency>
   

2. Obtain the service reference. Get a handle to the service instance. If you are writing a Java class, you can use the Declarative Services annotations.

   
   import com.adobe.livecycle.generatepdf.client.GeneratePdfServiceClient;
   import com.adobe.livecycle.generatepdf.client.CreatePDFResult;
   import com.adobe.idp.Document;
   
   @Reference
   GeneratePdfServiceClient generatePDF;
   ...
   
   Resource r = resourceResolver.getResource("/path/tp/docx");
   Document sourceDoc = new Document(r.adaptTo(InputStream.class));
   CreatePDFResult result = generatePDF.createPDF2(
                       sourceDoc,
                       extension, //inputFileExtension
                       null, //fileTypeSettings
                       null, //pdfSettings
                       null, //securitySettings
                       settingsDoc, //settingsDoc
                       null //xmpDoc
               );
   

   The above code snippet starts the createPDF API of GeneratePdfServiceClient to convert a document to PDF. You can perform similar invocation in a JSP using the following code. The major difference is the following code uses Sling ScriptHelper to access the GeneratePdfServiceClient.

   
   <%@ page import="com.adobe.livecycle.generatepdf.client.GeneratePdfServiceClient" %>
   <%@ page import="com.adobe.livecycle.generatepdf.client.CreatePDFResult" %>
   <%@ page import="com.adobe.idp.Document" %>
   
   GeneratePdfServiceClient generatePDF = sling.getService(GeneratePdfServiceClient.class);
   Document sourceDoc = ...
   CreatePDFResult result = generatePDF.createPDF2(
                       sourceDoc,
                       extension, //inputFileExtension
                       null, //fileTypeSettings
                       null, //pdfSettings
                       null, //securitySettings
                       settingsDoc, //settingsDoc
                       null //xmpDoc
               );
   

Starting via ServiceClientFactory

The ServiceClientFactory class is required in some cases. For example, you require ServiceClientFactory to call processes.

import com.adobe.livecycle.dsc.clientsdk.ServiceClientFactoryProvider;
import com.adobe.idp.dsc.clientsdk.ServiceClientFactory;

@Reference
ServiceClientFactoryProvider scfProvider;

...
ServiceClientFactory scf = scfProvider.getDefaultServiceClientFactory();
...

RunAs support

Almost every Document Service in LiveCycle requires authentication. You can use any of the following options to start these services without providing explicit credentials in the code:

Allowlist configuration

LiveCycle Client SDK configuration contains a setting about service names. This configuration is a list of services for which the invocation logic uses administrator credential out of the box. For example, if you add DirectoryManager services (part of User Management API) to this list, any client code can directly use the service and the invocation layer automatically passes on the configured credentials as part of the request sent to the LiveCycle server

RunAsManager

As part of the integration, a new service RunAsManager is provided. It allows you to programmatically control credential to be used when making call to LiveCycle server.

import com.adobe.livecycle.dsc.clientsdk.security.PasswordCredential;
import com.adobe.livecycle.dsc.clientsdk.security.PrivilegedAction;
import com.adobe.livecycle.dsc.clientsdk.security.RunAsManager;
import com.adobe.idp.dsc.registry.component.ComponentRegistry;

@Reference
private RunAsManager runAsManager;

List<Component> components = runAsManager.doPrivileged(new PrivilegedAction<List<Component>>() {
            public List<Component> run() {
                return componentRegistry.getComponents();
            }
        });
assertNotNull(components);

If you want to pass different credential, you can use the overloaded method that takes a PasswordCredential instance.

PasswordCredential credential = new PasswordCredential("administrator","password");
List<Component> components = runAsManager.doPrivileged(new PrivilegedAction<List<Component>>() {
    public List<Component> run() {
        return componentRegistry.getComponents();
    }
},credential);

InvocationRequest property

If you call a process or make direct use of the ServiceClientFactory class and create an InvocationRequest, you can specify a property to indicate that invocation layer should use configured credentials.

import com.adobe.idp.dsc.InvocationResponse
import com.adobe.idp.dsc.InvocationRequest
import com.adobe.livecycle.dsc.clientsdk.ServiceClientFactoryProvider
import com.adobe.idp.dsc.clientsdk.ServiceClientFactory
import com.adobe.livecycle.dsc.clientsdk.InvocationProperties

ServiceClientFactoryProvider scfp = sling.getService(ServiceClientFactoryProvider.class)
ServiceClientFactory serviceClientFactory = scfp.getDefaultServiceClientFactory()
InvocationRequest ir = serviceClientFactory.createInvocationRequest("sample/LetterSubmissionProcess", "invoke", new HashMap(), true);

//Here we are invoking the request with system user
ir.setProperty(InvocationProperties.INVOKER_TYPE,InvocationProperties.INVOKER_TYPE_SYSTEM)

InvocationResponse response = serviceClientFactory.getServiceClient().invoke(ir);

Document Services list

Adobe LiveCycle Client SDK API bundle

The following services are available:

• com.adobe.idp.um.api.AuthenticationManager
• com.adobe.idp.um.api.DirectoryManager
• com.adobe.idp.um.api.AuthorizationManager
• com.adobe.idp.dsc.registry.service.ServiceRegistry
• com.adobe.idp.dsc.registry.component.ComponentRegistry

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-livecycle-client</artifactId>
  <version>11.0.0</version>
</dependency>
<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-usermanager-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Client SDK Bundle

The following services are available:

• com.adobe.livecycle.dsc.clientsdk.security.RunAsManager
• com.adobe.livecycle.dsc.clientsdk.ServiceClientFactoryProvider

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-livecycle-cq-integration-api</artifactId>
  <version>1.1.10</version>
</dependency>

Adobe LiveCycle TaskManager Client bundle

The following services are available:

• com.adobe.idp.taskmanager.dsc.client.task.TaskManager
• com.adobe.idp.taskmanager.dsc.client.TaskManagerQueryService
• com.adobe.idp.taskmanager.dsc.client.queuemanager.QueueManager
• com.adobe.idp.taskmanager.dsc.client.emailsettings.EmailSettingService
• com.adobe.idp.taskmanager.dsc.client.endpoint.TaskManagerEndpointClient
• com.adobe.idp.taskmanager.dsc.client.userlist.UserlistService

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-taskmanager-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Workflow Client Bundle

The following service is available:

• com.adobe.idp.workflow.client.WorkflowServiceClient

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-workflow-client-sdk</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle PDF Generator Client bundle

The following service is available:

• com.adobe.livecycle.generatepdf.client.GeneratePdfServiceClient

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-generatepdf-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Application Manager Client bundle

The following services are available:

• com.adobe.idp.applicationmanager.service.ApplicationManager
• com.adobe.livecycle.applicationmanager.client.ApplicationManager
• com.adobe.livecycle.design.service.DesigntimeService

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-applicationmanager-client-sdk</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Assembler Client bundle

The following service is available:

• com.adobe.livecycle.assembler.client.AssemblerServiceClient

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-assembler-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Form Data Integration Client bundle

The following service is available:

• com.adobe.livecycle.formdataintegration.client.FormDataIntegrationClient

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-formdataintegration-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Forms Client bundle

The following service is available:

• com.adobe.livecycle.formsservice.client.FormsServiceClient

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-forms-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Output Client bundle

The following service is available:

• com.adobe.livecycle.output.client.OutputClient

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-output-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Reader Extensions Client bundle

The following service is available:

• com.adobe.livecycle.readerextensions.client.ReaderExtensionsServiceClient

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-reader-extensions-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Rights Manager Client bundle

The following services are available:

• com.adobe.livecycle.rightsmanagement.client.DocumentManager
• com.adobe.livecycle.rightsmanagement.client.EventManager
• com.adobe.livecycle.rightsmanagement.client.ExternalUserManager
• com.adobe.livecycle.rightsmanagement.client.LicenseManager
• com.adobe.livecycle.rightsmanagement.client.WatermarkManager
• com.adobe.livecycle.rightsmanagement.client.PolicyManager
• com.adobe.livecycle.rightsmanagement.client.AbstractPolicyManager

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-rightsmanagement-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Signatures Client bundle

The following service is available:

• com.adobe.livecycle.signatures.client.SignatureServiceClientInterface

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-signatures-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Truststore Client bundle

The following services are available:

• com.adobe.truststore.dsc.TrustConfigurationService
• com.adobe.truststore.dsc.CRLService
• com.adobe.truststore.dsc.CredentialService
• com.adobe.truststore.dsc.CertificateService

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-truststore-client</artifactId>
  <version>11.0.0</version>
</dependency>

Adobe LiveCycle Repository Client bundle

The following services are available:

• com.adobe.repository.bindings.ResourceRepository
• com.adobe.repository.bindings.ResourceSynchronizer

Maven dependencies

<dependency>
  <groupId>com.adobe.livecycle</groupId>
  <artifactId>adobe-repository-client</artifactId>
  <version>11.0.0</version>
</dependency>

Business.Adobe.com resources

Automated Onboarding Targeted Content Asset Collections Content Intelligence Responsive Forms Dynamic Forms